BlueprintDocument getDocumentTree request
Description
Returns a List<BlueprintDocument> that represents the transitive closure of the blueprint document.
The first element in the list is always the top-level document. If there are no blueprint references for this document, this would be the only element in the list.
If there are blueprint references, the documents included in the returned value depend on value of the injectRecursiveDocuments argument:
DO_NOT_INJECT: all the referenced documents (recursively) are included in the response in a topological order.
INJECT_NESTED: the referenced documents are first resolved as described in Blueprint Document Injection and only then included in the response. In other words: in this case only the direct document references are returned in the response, but these documents are modified so that all their recursive references are injected.
INJECT_ALL: all referenced documents are injected. In this case, only a single document is returned.
During the invocation of this operation (unless the INJECT_ALL option is used), blueprint references are resolved, and all returned BlueprintReferece objects have the referencedBlueprintDocument relation filled.
For example, in case of a BlueprintReference that uses the latest version of the blueprint, the latest document at the time of the request will be fetched.
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 |
|
|
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.
Comments
Log in or register to comment.