Unsupported content This version of the product has reached end of support. The documentation is available for your convenience. However, you must be logged in to access it. You will not be able to leave comments.

BlueprintDocument class

The BlueprintDocument class represents a blueprint document.

BlueprintDocument class APIs

The following tables list the basic APIs, operation APIs, and relationship APIs for the BlueprintDocument class.

Basic APIs

 

Name

HTTP
method

URI

Description

create

POST

Creates a BlueprintDocument object.

delete

DELETE

Deletes a BlueprintDocument object.

get

GET

Retrieves a BlueprintDocument object.

update

POST

Updates a BlueprintDocument object.

search

POST

Searches for BlueprintDocument objects.

 

Operation APIs

 

Name

HTTP
method

URI

Description

checkin

POST

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.

checkout

POST

Checks-out a blueprint document. It returns a new BlueprintDocument representing the checked-out version.
 This is a new document (new guid) having the same content as the one on which the operation was invoked, but having workspaceCopy = true.

clone

POST

Clone a document. The operation receives a name string, representing the new name to assign to the cloned document. It creates a new document in the workspace (version = 0) which is a copy of the source document, and a corresponding new blueprint.

export

POST

Exports a blueprint document, including all referenced documents (recursively), returning a document bundle.

getDocumentTree

POST

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.

import

POST

Imports a document bundle

makeLatest

POST

Creates a new version of this document as the latest version of the blueprint.
 This operation is only applicable to blueprint versions that are not the latest for their blueprints.

 

Relationship APIs

 

Name

HTTP
method

URI

Description

relation

GET

Retrieves the baseDocument relationship.

relation

GET

Retrieves the blueprint relationship.

relation

GET

Retrieves the blueprintReferences relationship.

relation

GET

Retrieves the customFieldDefinitions relationship.

relation

GET

Retrieves the deploymentParameterValues relationship.

relation

GET

Retrieves the derivedDocuments relationship.

relation

GET

Retrieves the logicalHostingEnvironmentBlueprint relationship.

relation

GET

Retrieves the errors relationship.

relation

GET

Retrieves the provider relationship.

relation

GET

Retrieves the tags relationship.

 

BlueprintDocument class relationships and attributes

The following tables list the relationships and attributes of the BlueprintDocument class.

Relationships

 

Name

Type

Multi-
plicity

Description

baseDocument

0..1

 

blueprint

1

 

blueprintReferences

0..*

 

customFieldDefinitions

CustomFieldDefinition

0..*

 

deploymentParameterValues

0..*

 

derivedDocuments

0..*

 

logicalHostingEnvironmentBlueprint

0..1

 

errors

0..*

 

cloudClass

1

Fully-qualified name of the class to which the object belongs

provider

1

Provider that created the object

tags

0..*

Tags associated with the object

 

Attributes

 

Name

Type

Multi-
plicity

Description

workspaceCopy
Boolean

0..1

Specifies whether the blueprint document is a workspace copy. When false (by default), the document represents a version in the repository.

author
String

1

The name of the person who wrote the document.

category
String

1

The category of the content of the document file, for example a ServiceBlueprint or a ServiceInfrastructureBlueprint

content
String

1

The content of the document

documentDate

1

The date and time the document was created

purpose
String

0..1

The purpose of the content of the document file, for example a ServiceModel or a FunctionalModel (for service blueprints)

schemaVersion
String

0..1

The schema version of the document

description
String

0..1

Text that describes the object

guid
String

1

Globally unique identifier for the object

labels
String

0..*

 

modifiedDate

0..1

Date the Cloudobject was modified

name
String

1

Human-readable name of the object

 

 

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