Unsupported content This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

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

Unassigned

API overview

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
The [confluence_table-plus] macro is a standalone macro and it cannot be used inline. Click on this message for details.

Input parameters to include in operationParams
The [confluence_table-plus] macro is a standalone macro and it cannot be used inline. Click on this message for details.

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.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*