BlueprintReference class

The BlueprintReference class represents a reference to a blueprint. It supports three reference semantics: a reference to the latest version of the blueprint, a reference to a specified version of the blueprint, or a reference by tag.

BlueprintReference class APIs

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

Basic APIs

Name

HTTP
method

URI

Description

create

POST

csm/BlueprintReference

Creates a BlueprintReference object.

delete

DELETE

csm/BlueprintReference/guid

Deletes a BlueprintReference object.

get

GET

csm/BlueprintReference/guid

Retrieves a BlueprintReference object.

update

POST

csm/BlueprintReference/guid/update

Updates a BlueprintReference object.

search

POST

csm/BlueprintReference/search

Searches for BlueprintReference objects.

Operation APIs

Name

HTTP
method

URI

Description

resolve

POST

csm/BlueprintReference/guid/resolve

Resolve the blueprint document referenced by the BlueprintReference

Relationship APIs

Name

HTTP
method

URI

Description

relation

GET

csm/BlueprintReference/guid/blueprint

Retrieves the blueprint relationship.

relation

GET

csm/BlueprintReference/guid/referencedBlueprintDocument

Retrieves the referencedBlueprintDocument relationship.

relation

GET

csm/BlueprintReference/guid/referringBlueprintDocument

Retrieves the referringBlueprintDocument relationship.

relation

GET

csm/BlueprintReference/guid/serviceOffering

Retrieves the serviceOffering relationship.

relation

GET

csm/BlueprintReference/guid/serviceOfferingInstance

Retrieves the serviceOfferingInstance relationship.

relation

GET

csm/BlueprintReference/guid/provider

Retrieves the provider relationship.

relation

GET

csm/BlueprintReference/guid/tags

Retrieves the tags relationship.

BlueprintReference class relationships and attributes

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

Relationships

Name

Type

Multi-
plicity

Description

blueprint

Blueprint

1

referencedBlueprintDocument

BlueprintDocument

0..1

referringBlueprintDocument

BlueprintDocument

0..1

serviceOffering

ServiceOffering

0..1

serviceOfferingInstance

ServiceOfferingInstance

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

configurationGuid

String

0..1

If specified, denotes the guid of a configuration within the referenced blueprint

isStaticReference

Boolean

0..1

logicalGuid

String

0..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

Was this page helpful? Yes No Submitting... Thank you

Comments