Blueprint class

The Blueprint class represents a CLM blueprint. It could be used as a handle to access all the versions of that blueprints (namely the repository documents), as well as the current workspace document.

Blueprint class APIs

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

Basic APIs

Name	HTTP method	URI	Description
delete	`DELETE`	`csm/Blueprint/guid`	Deletes a `Blueprint` object.
get	`GET`	`csm/Blueprint/guid`	Retrieves a `Blueprint` object.
update	`POST`	`csm/Blueprint/guid/update`	Updates a `Blueprint` object.
search	`POST`	`csm/Blueprint/search`	Searches for `Blueprint` objects.

Operation APIs

Name	HTTP method	URI	Description
restore	`POST`	`csm/Blueprint/guid/restore`	Restore a retired blueprint
retire	`POST`	`csm/Blueprint/guid/retire`	Retire a blueprint. This makes a blueprint obsolete, or out-of-service. Once a blueprint is retired, one cannot further develop it or create new references to it. However, blueprint retirement doesn't invalidate existing references to that blueprint

Relationship APIs

Name	HTTP method	URI	Description
relation	`GET`	`csm/Blueprint/guid/blueprintReferences`	Retrieves the `blueprintReferences` relationship.
relation	`GET`	`csm/Blueprint/guid/deploymentModels`	Retrieves the `deploymentModels` relationship.
relation	`GET`	`csm/Blueprint/guid/functionalModels`	Retrieves the `functionalModels` relationship.
relation	`GET`	`csm/Blueprint/guid/latestVersion`	Retrieves the `latestVersion` relationship.
relation	`GET`	`csm/Blueprint/guid/versions`	Retrieves the `versions` relationship.
relation	`GET`	`csm/Blueprint/guid/workingCopy`	Retrieves the `workingCopy` relationship.
relation	`GET`	`csm/Blueprint/guid/provider`	Retrieves the `provider` relationship.
relation	`GET`	`csm/Blueprint/guid/tags`	Retrieves the `tags` relationship.

Blueprint class relationships and attributes

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

Relationships

Name	Type	Multi- plicity	Description
`blueprintReferences`	`BlueprintReference`	0..*
`deploymentModels`	`DeploymentModel`	0..*
`functionalModels`	`FunctionalModel`	0..*
`latestVersion`	`BlueprintDocument`	0..1
`versions`	`BlueprintDocument`	0..*
`workingCopy`	`BlueprintDocument`	0..1
`cloudClass`	`CloudClass`	1	Fully-qualified name of the class to which the object belongs
`provider`	`Provider`	1	Provider that created the object
`tags`	`Tag`	0..*	Tags associated with the object

Attributes

Name	Type	Multi- plicity	Description
`author`	`String`	1
`category`	`String`	1	The category of the blueprint
`purpose`	`String`	0..1
`state`	`BlueprintState`	1
`description`	`String`	0..1	Text that describes the object
`guid`	`String`	1	Globally unique identifier for the object
`labels`	`String`	0..*
`modifiedDate`	`Date`	0..1	Date the Cloudobject was modified
`name`	`String`	1	Human-readable name of the object