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 | URI | Description |
|---|---|---|---|
create | POST | Creates a BlueprintReference object. | |
delete | DELETE | Deletes a BlueprintReference object. | |
get | GET | Retrieves a BlueprintReference object. | |
update | POST | Updates a BlueprintReference object. | |
search | POST | Searches for BlueprintReference objects. |
Operation APIs
Name | HTTP | URI | Description |
|---|---|---|---|
resolve | POST | Resolve the blueprint document referenced by the BlueprintReference |
Relationship APIs
Name | HTTP | URI | Description |
|---|---|---|---|
relation | GET | Retrieves the blueprint relationship. | |
relation | GET | Retrieves the referencedBlueprintDocument relationship. | |
relation | GET | Retrieves the referringBlueprintDocument relationship. | |
relation | GET | Retrieves the serviceOffering relationship. | |
relation | GET | Retrieves the serviceOfferingInstance relationship. | |
relation | GET | Retrieves the provider relationship. | |
relation | GET | 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- | Description |
|---|---|---|---|
blueprint | 1 |
| |
referencedBlueprintDocument | 0..1 |
| |
referringBlueprintDocument | 0..1 |
| |
serviceOffering | 0..1 |
| |
serviceOfferingInstance | 0..1 |
| |
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- | 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 | 0..1 | Date the Cloudobject was modified | |
name | String | 1 | Human-readable name of the object |