Unsupported content

 

This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

API patterns

Each API conforms to one of the URI patterns listed in the following table. Some cloud objects only provide a subset of these URI patterns, depending on the nature of the object. See the API reference for complete details on the APIs available for each object.

In the URI patterns:

  • <class> represents the name of a cloud object.
  • <guid> represents a unique identifier for the <class> object.
  • <operation> represents the name of a <class> operation.
  • (<relation>)+ represents a relationship between the <class> object and another cloud object.

In the actual APIs, names of specific cloud objects, relationships, and operations take the place of <class>, (<relation>)+, and <operation>. You can specify complex relationships between cloud objects by replacing the (<relation>)+ element with a sequence of relationships separated by forward slashes (see Relationship traversal).

HTTP method

URI pattern

Description

POST

csm/<class>

Creates a new instance of the <class> object

POST

csm/<class>/search

Retrieves a list of all instances of the <class> and its subclasses. See Searches for information about using this URI pattern.

GET

csm/<class>/<guid>

Retrieves information about the <class> object specified by the unique identifier. This request returns a JSON document with the full class definition for the object, including attribute values.

POST

csm/<class>/<guid>

Refreshes the <class> object specified by the unique identifier

PUT

csm/<class>/<guid>

Modifies metadata about the <class> object specified by the unique identifier

DELETE

csm/<class>/<guid>

Deletes the <class> object specified by the unique identifier

POST

csm/<class>/<operation>

Performs a static operation on a <class>

POST

csm/<class>/<guid>/<operation>

Performs the requested operation on the <class> object specified by the unique identifier

GET

csm/<class>/<guid>/(<relation>)+

Traverses a sequence of one or more relationships to retrieve the set of <class> objects associated with the unique identifier

POST

csm/<class>/<guid>/(<relation>)+/<operation>

Traverses a sequence of one or more relationships and performs the requested operation on the set of <class> objects associated with the unique identifier

GET

csm/cloudobjectclass/<class>

Retrieves the JSON document for the <class>

This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

Comments