GUIDs and URIs

The BMC Cloud Lifecycle Management API uses globally unique identifiers (GUIDs) and uniform resource identifiers (URIs) to reference cloud objects in HTTP requests and JSON documents.

GUIDs

Each cloud object carries a GUID, which is a 32-digit hexadecimal number that provides a unique reference to the object. The GUID is formatted as a string that is divided into five hyphen-separated segments, as shown in the following example:

7279a217-07fe-4fae-9821-d9b2d550cdb3

If you need to create a GUID, you can use an online generator such as UUID (GUID) Generator on the Web or Online GUID Generator.

The following example shows a GUID used within an HTTP request:

GET /csm/NetworkContainer/01059790-1d14-11e0-ac64-0800200c9a66

The following JSON document snippet shows a GUID that references a cloud object:

"loadBalancerObject":{
   "cloudClass":"com.bmc.cloud.model.beans.LoadBalancer",
   "guid":"d0d5934e-3a7a-4345-93f6-8df874d735db"
}

URIs

A URI is composed of a class name and a unique identifier for an object. The general format of a URI is:

/<class>/<guid>

The following example shows the URI for a ContainerBlueprint class object:

/ContainerBlueprint/b97fb1d4-6f83-42b1-882f-9670aaa3cbe7

The following JSON document snippet shows the URI of a Location class object that is the value for an object named location:

"location" : "/Location/0011cf00-0eed-11e0-ac64-0800200c9a66"

To reference multiple objects, you can use an array of URIs. The following JSON document snippet shows an array that contains values for an object named assignedOrganizations. The array contains a list of URIs for several Organization class objects.

"assignedOrganizations" : [
   "/Organization/0a1b55c0-0ee8-11e0-ac64-0800200c9a66", 
   "/Organization/4c7b85c0-0ee8-11e0-ac64-0800200c9a66",
   "/Organization/a059b0c0-0eef-11e0-ac64-0800200c9a66"
]