BlueprintDocument create request
Description
Creates a new blueprint document, based on the received document object. The following BlueprintDocument attributes may be sent:
guid: optional. If not specified, a new guid is generated
workspaceCopy: optional. If not specified, the new document is generated as a working copy.
name: mandatory
category: mandatory
purpose: mandatory
content: mandatory
description: optional
The creation of a new BlueprintDocument also involves the creation of a new Blueprint object for that document.
The created BlueprintDocument has the additional following attributes set:
version = 0
retired = false
author = the user who created the document
workspaceCopy = true by default, unless otherwise specified by the caller.
documentDate = the date/time when the document was created
blueprint = a relation to the newly created blueprint
API stability classification
API overview
HTTP | URI | Return | Return type |
|---|---|---|---|
POST | csm/BlueprintDocument/create |
|
HTTP request message
Query string parameters
This API does not use query string parameters.
Request message headers
This API uses only common headers listed in HTTP-request-and-response-headers.
Request message body
This API uses the following objects in the request message body JSON.
Top-level objects
Name | Type | Multi- | Description |
|---|---|---|---|
callbackURL | String | 0..1 | URL to call when the operation finishes |
postCallout | String | 0..1 | Identifier of a callout to run after the operation executes |
preCallout | String | 0..1 | Identifier of a callout to run before the operation executes |
timeout | Integer | 0..1 | Timeout setting. For more information about using the timeout, see Synchronous-and-asynchronous-operations. Timeout values:
|
operationParams | 1 | Array of input parameters. The following table contains the list of input parameters. For information about setting up the input parameters, see Passing-input-parameters-with-an-API-request. |
Input parameters to include in operationParams
Name | Type | Multi- | Description |
|---|---|---|---|
blueprintDescription | String | 0..1 |
|
blueprintGuid | String | 0..1 |
|
document | 1 |
|
HTTP response message
Response message headers
This API uses only common headers listed in HTTP-request-and-response-headers.
Response message body
The response message body contains a Task object.
Unknown macro: confluence_report-block. Click on this message for details.