BlueprintDocument checkin request
Description
Checks-in a workspace document to the repository. It returns a BlueprintDocument representing the checked-in version.
When checking-in a document the user may specify a description of the checked-in document, typically describing the changes applied in that version, and the set of tags to apply for the new version.
The returned document is the same document as the one on which the operation has been invoked, with workspaceCopy switched to false and the version incremented.
The operation fails if the blueprint is retired, or the current user is not the owner of the working copy.
API stability classification
API overview
HTTP |
URI |
Return |
Return type |
---|---|---|---|
|
|
1 |
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 |
---|---|---|---|
|
|
0..1 |
URL to call when the operation finishes |
|
|
0..1 |
Identifier of a callout to run after the operation executes |
|
|
0..1 |
Identifier of a callout to run before the operation executes |
|
|
0..1 |
Timeout setting. For more information about using the timeout, see Synchronous and asynchronous operations. Timeout values:
|
|
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 |
---|---|---|---|
|
|
0..1 |
|
|
0..* |
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.
Comments
Log in or register to comment.