Skip to Content
Information
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.

Class definitions

Each class in the object model is defined by a CloudClass object. By using the following API pattern, you can retrieve a JSON document that describes an individual class:

GET csm/cloudobjectclass/<class>

The JSON document that you receive in response to this request describes the class in terms of a CloudClass object, which includes a list of the attributes, relationships, and operations that define the class. A JSON document for each class in the API is available via this mechanism.

The following example shows an HTTP request for the definition of the NetworkContainer class.

GET /csm/cloudobjectclass/networkcontainer HTTP/1.1
Host: <apiServer>
Authentication-Token: <yourToken>

The following response is returned by the request:

HTTP/1.1 200 OK
Date: Fri, 15 Apr 2011 21:55:06 GMT
BMC-Transaction-ID: 110b24f6-b89e-490e-a92d-7344b676a400
Content-Type: application/json; charset=UTF-8
Content-Length: 10875
Server: Jetty(6.1.x)

[
   {
     "attributes" : [
         {
           "cloudClass" : "com.bmc.cloud.model.beans.Attribute",
           "definedInClass" : "com.bmc.cloud.model.beans.CloudObject",
           "guid" : "c971722c-9bb1-4eba-9be3-dc4e74fae509",
           "isStatic" : false,
           "multiplicity" : "1",
           "name" : "guid",
           "type" : "String",
           "visibility" : "PUBLIC"
         },
         {
           "cloudClass" : "com.bmc.cloud.model.beans.Attribute",
           "definedInClass" : "com.bmc.cloud.model.beans.CloudResource",
           "guid" : "470b4631-a16c-4c24-a201-9132b9c0b1a4",
           "isStatic" : false,
           "multiplicity" : "0..1",
           "name" : "tokenID",
           "type" : "String",
           "visibility" : "PUBLIC"
         },
         {
           "cloudClass" : "com.bmc.cloud.model.beans.Attribute",
           "definedInClass" : "com.bmc.cloud.model.beans.CloudObject",
           "guid" : "3a08be22-90df-45ad-a55d-8a2c98ae7475",
           "isStatic" : false,
           "multiplicity" : "0..1",
           "name" : "description",
           "type" : "String",
           "visibility" : "PUBLIC"
         },
         {
           "cloudClass" : "com.bmc.cloud.model.beans.Attribute",
           "definedInClass" : "com.bmc.cloud.model.beans.CloudObject",
           "guid" : "7441d789-651b-49b7-87cc-488b22394691",
           "isStatic" : false,
           "multiplicity" : "1",
           "name" : "name",
           "type" : "String",
           "visibility" : "PUBLIC"
         },
         {
           "cloudClass" : "com.bmc.cloud.model.beans.Attribute",
           "definedInClass" : "com.bmc.cloud.model.beans.CloudResource",
           "guid" : "dd88d47d-218f-4f83-afe7-a795e33a1910",
           "isStatic" : false,
           "multiplicity" : "0..1",
           "name" : "owner",
           "type" : "String",
           "visibility" : "PUBLIC"
         },
         {
           "cloudClass" : "com.bmc.cloud.model.beans.Attribute",
           "definedInClass" : "com.bmc.cloud.model.beans.InfrastructureProvidedResource",
           "guid" : "9b9ad262-4ad0-434d-8602-b6f5bf61c7eb",
           "isStatic" : false,
           "multiplicity" : "1",
           "name" : "isOnboarded",
           "type" : "Boolean",
           "visibility" : "PUBLIC"
         },
         {
           "cloudClass" : "com.bmc.cloud.model.beans.Attribute",
           "definedInClass" : "com.bmc.cloud.model.beans.CloudResource",
           "guid" : "8ed3ecf2-bafa-47ef-a7cf-bb610a6b72fd",
           "isStatic" : false,
           "multiplicity" : "0..1",
           "name" : "externalID",
           "type" : "String",
           "visibility" : "PUBLIC"
         },
         {
           "cloudClass" : "com.bmc.cloud.model.beans.Attribute",
           "definedInClass" : "com.bmc.cloud.model.beans.CloudResource",
           "guid" : "49400564-539c-46a5-b971-bda2a477a491",
           "isStatic" : false,
           "multiplicity" : "0..1",
           "name" : "reconciliationID",
           "type" : "String",
           "visibility" : "PUBLIC"
         }
      ],
     "baseType" : "com.bmc.cloud.model.beans.NetworkInfrastructure",
     "cloudClass" : "com.bmc.cloud.model.beans.CloudClass",
     "guid" : "9e8f253f-3318-4325-94a9-fa6808e3fc2e",
     "isAbstract" : false,
     "name" : "com.bmc.cloud.model.beans.NetworkContainer",
     "operations" : [
         {
           "cloudClass" : "com.bmc.cloud.model.beans.Operation",
           "definedInClass" : "com.bmc.cloud.model.beans.NetworkContainer",
           "guid" : "bfa21240-7f80-4353-b136-a0d8af2f588a",
           "isStatic" : false,
           "name" : "update",
           "parameters" : [
               {
                 "cloudClass" : "com.bmc.cloud.model.beans.Parameter",
                 "direction" : "IN",
                 "guid" : "89facb57-fd77-4893-9c55-f0536954f425",
                 "multiplicity" : "1",
                 "name" : "networkContainer",
                 "type" : "com.bmc.cloud.model.beans.NetworkContainer"
               }
            ],
           "returnType" : "void",
           "returnTypeMultiplicity" : "",
           "visibility" : "PUBLIC"
         },
         {
           "cloudClass" : "com.bmc.cloud.model.beans.Operation",
           "definedInClass" : "com.bmc.cloud.model.beans.NetworkContainer",
           "guid" : "3cd4d8e8-61de-431f-ae96-a6532426b964",
           "isStatic" : true,
           "name" : "onboard",
           "parameters" : [
               {
                 "cloudClass" : "com.bmc.cloud.model.beans.Parameter",
                 "direction" : "IN",
                 "guid" : "fcf79f3a-9b8d-4540-9c18-144b47af8692",
                 "multiplicity" : "0..*",
                 "name" : "networkContainer",
                 "type" : "com.bmc.cloud.model.beans.NetworkContainer"
               }
            ],
           "returnType" : "void",
           "returnTypeMultiplicity" : "",
           "visibility" : "PUBLIC"
         },
         {
           "cloudClass" : "com.bmc.cloud.model.beans.Operation",
           "definedInClass" : "com.bmc.cloud.model.beans.NetworkContainer",
           "guid" : "163ebe45-854d-49ae-891a-166b755756b5",
           "isStatic" : false,
           "name" : "delete",
           "parameters" : [],
           "returnType" : "void",
           "returnTypeMultiplicity" : "",
           "visibility" : "PUBLIC"
         },
         {
           "cloudClass" : "com.bmc.cloud.model.beans.Operation",
           "definedInClass" : "com.bmc.cloud.model.beans.NetworkContainer",
           "guid" : "a3fe6ad0-9233-4e35-9da4-b8511f4987c4",
           "isStatic" : false,
           "name" : "read",
           "parameters" : [],
           "returnType" : "NetworkContainer",
           "returnTypeMultiplicity" : "1",
           "visibility" : "PUBLIC"
         },
         {
           "cloudClass" : "com.bmc.cloud.model.beans.Operation",
           "definedInClass" : "com.bmc.cloud.model.beans.NetworkContainer",
           "guid" : "c022bd28-fc24-4f21-a62f-37fb5810b9a9",
           "isStatic" : false,
           "name" : "create",
           "parameters" : [
               {
                 "cloudClass" : "com.bmc.cloud.model.beans.Parameter",
                 "direction" : "IN",
                 "guid" : "2f362667-227b-47e6-a241-ca29dfe026c6",
                 "multiplicity" : "1",
                 "name" : "containerBlueprint",
                 "type" : "com.bmc.cloud.model.beans.ContainerBlueprint"
               },
               {
                 "cloudClass" : "com.bmc.cloud.model.beans.Parameter",
                 "direction" : "IN",
                 "guid" : "e389b6fd-2704-4713-9fa9-d2d5f7b62095",
                 "multiplicity" : "1",
                 "name" : "networkContainer",
                 "type" : "com.bmc.cloud.model.beans.NetworkContainer"
               },
               {
                 "cloudClass" : "com.bmc.cloud.model.beans.Parameter",
                 "direction" : "IN",
                 "guid" : "930741ed-3881-4515-b398-cc7af23aa3ee",
                 "multiplicity" : "1",
                 "name" : "pod",
                 "type" : "com.bmc.cloud.model.beans.Pod"
               }
            ],
           "returnType" : "void",
           "returnTypeMultiplicity" : "",
           "visibility" : "PUBLIC"
         }
      ],
     "relations" : [
         {
           "cloudClass" : "com.bmc.cloud.model.beans.Relation",
           "definedInClass" : "com.bmc.cloud.model.beans.NetworkContainer",
           "greedy" : false,
           "guid" : "afc28814-03b2-4ccb-8cb3-cfecd255f6d4",
           "inverseRelationName" : "networkContainer",
           "kind" : "ASSOCIATION",
           "multiplicity" : "0..*",
           "name" : "ipAddressPools",
           "type" : "com.bmc.cloud.model.beans.IPAddressPool",
           "visibility" : "PUBLIC"
         },
         {
           "cloudClass" : "com.bmc.cloud.model.beans.Relation",
           "definedInClass" : "com.bmc.cloud.model.beans.CloudObject",
           "greedy" : true,
           "guid" : "9bfdcd02-f74e-4d58-bc2d-6ba8f424f3fb",
           "inverseRelationName" : "",
           "kind" : "ASSOCIATION",
           "multiplicity" : "0..*",
           "name" : "tags",
           "type" : "com.bmc.cloud.model.beans.Tag",
           "visibility" : "PUBLIC"
         },
         {
           "cloudClass" : "com.bmc.cloud.model.beans.Relation",
           "definedInClass" : "com.bmc.cloud.model.beans.NetworkContainer",
           "greedy" : false,
           "guid" : "f70b28b4-d2fa-49dd-9a16-00e94912f67e",
           "inverseRelationName" : "networkContainer",
           "kind" : "AGGREGATION",
           "multiplicity" : "0..*",
           "name" : "hostedResourceSets",
           "type" : "com.bmc.cloud.model.beans.ResourceSet",
           "visibility" : "PUBLIC"
         },
         {
           "cloudClass" : "com.bmc.cloud.model.beans.Relation",
           "definedInClass" : "com.bmc.cloud.model.beans.NetworkContainer",
           "greedy" : false,
           "guid" : "05cfc8d8-571d-4311-adc5-de8bd370fdaa",
           "inverseRelationName" : "forNetworkContainer",
           "kind" : "ASSOCIATION",
           "multiplicity" : "0..*",
           "name" : "staticPools",
           "type" : "com.bmc.cloud.model.beans.StaticPool",
           "visibility" : "PUBLIC"
         },
         {
           "cloudClass" : "com.bmc.cloud.model.beans.Relation",
           "definedInClass" : "com.bmc.cloud.model.beans.NetworkContainer",
           "greedy" : false,
           "guid" : "19233ad8-f1cc-436b-a511-74158d61ec28",
           "inverseRelationName" : "assignedContainers",
           "kind" : "ASSOCIATION",
           "multiplicity" : "0..*",
           "name" : "assignedOrganizations",
           "type" : "com.bmc.cloud.model.beans.Organization",
           "visibility" : "PUBLIC"
         },
         {
           "cloudClass" : "com.bmc.cloud.model.beans.Relation",
           "definedInClass" : "com.bmc.cloud.model.beans.NetworkContainer",
           "greedy" : false,
           "guid" : "e6ead7d8-d997-4c23-8605-60f2b8f787e7",
           "inverseRelationName" : "networkContainers",
           "kind" : "ASSOCIATION",
           "multiplicity" : "0..1",
           "name" : "containerBlueprint",
           "type" : "com.bmc.cloud.model.beans.ContainerBlueprint",
           "visibility" : "PUBLIC"
         },
         {
           "cloudClass" : "com.bmc.cloud.model.beans.Relation",
           "definedInClass" : "com.bmc.cloud.model.beans.CloudObject",
           "greedy" : false,
           "guid" : "7f241c95-beb5-496b-b42e-b3105bfed9a2",
           "inverseRelationName" : "",
           "kind" : "ASSOCIATION",
           "multiplicity" : "1",
           "name" : "cloudClass",
           "type" : "com.bmc.cloud.model.beans.CloudClass",
           "visibility" : "PROTECTED"
         },
         {
           "cloudClass" : "com.bmc.cloud.model.beans.Relation",
           "definedInClass" : "com.bmc.cloud.model.beans.CloudObject",
           "greedy" : false,
           "guid" : "533bca0e-44c5-49f5-a33f-fb38c0aac041",
           "inverseRelationName" : "",
           "kind" : "ASSOCIATION",
           "multiplicity" : "1",
           "name" : "provider",
           "type" : "com.bmc.cloud.model.beans.Provider",
           "visibility" : "PUBLIC"
         },
         {
           "cloudClass" : "com.bmc.cloud.model.beans.Relation",
           "definedInClass" : "com.bmc.cloud.model.beans.NetworkContainer",
           "greedy" : false,
           "guid" : "ca1a35a3-a3d7-4989-82cd-5c709a9bb00b",
           "inverseRelationName" : "container",
           "kind" : "COMPOSITION",
           "multiplicity" : "1..*",
           "name" : "zones",
           "type" : "com.bmc.cloud.model.beans.Zone",
           "visibility" : "PUBLIC"
         },
         {
           "cloudClass" : "com.bmc.cloud.model.beans.Relation",
           "definedInClass" : "com.bmc.cloud.model.beans.NetworkContainer",
           "greedy" : false,
           "guid" : "0a69e5f6-163d-40b7-9c0b-f3e811324212",
           "inverseRelationName" : "networkContainer",
           "kind" : "ASSOCIATION",
           "multiplicity" : "0..*",
           "name" : "containerParameterValues",
           "type" : "com.bmc.cloud.model.beans.ContainerParameterValue",
           "visibility" : "PUBLIC"
         },
         {
           "cloudClass" : "com.bmc.cloud.model.beans.Relation",
           "definedInClass" : "com.bmc.cloud.model.beans.NetworkContainer",
           "greedy" : false,
           "guid" : "f9a7e52f-02c0-4088-bb5c-e96146d28b98",
           "inverseRelationName" : "containers",
           "kind" : "ASSOCIATION",
           "multiplicity" : "1",
           "name" : "pod",
           "type" : "com.bmc.cloud.model.beans.Pod",
           "visibility" : "PUBLIC"
         }
      ],
     "uniqueAttrName" : "guid",
     "version" : "1.0",
     "volatile" : "false"
   }
]

 

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

BMC Cloud Lifecycle Management 4.5