The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
For each resource, a study of the general Reference for Actions in conjunction with the lists of actions for a resource provides the reference for the resource. An examination of the Field Reference for a resource provides payload details.
In addition, a number of conventions are followed some general guidelines should be noted.
The full URL includes the host name: https://[hostname]; for example, https://172.29.232.62
Variables are enclosed in square brackets.
[hierarchy] is the hierarchy which can be specified as:
UUID (Universally Unique Identifier); for example, 1c012432c0deab00da595101 or
In dot notation; for example, ProviderName.CustomerName.LocationName
For a list of available hierarchy UUIDs and their dot notations, refer to the data in the response of the call:
GET /api/data/HierarchyNode/?format=json
[PKID] is the ID of the resource instance. Refer to the List action reference for the resource.
[filename] refers to a file.
where a custom action (with "+" in the URL) is available, the POST method is used to execute the Provisioning workflow with the name following the "+". For more information, consult the custom workflow section of the API Guide.
Relations, Domain models, and Views may have parameters where the choices are constructed from unexposed models (and that may not be available in the API Reference). You can obtain these choices by using the URL specified in the target attribute of the schema of parameter.
To illustrate, below is an extract of the schema for a model called relation/SystemUser that contains a parameter SSOUser, which links a user in the system to a user in an SSO identity provider server. This is done by mapping the SSO user name (sso_username) of the user in the SSO server (sso_idp) to a user in the system (data/User).
The schema of relation/SystemUser shows that the choices that are available from SSO Identity provider servers are stored in the model data/SsoIdentityProvider. The list of SSO identity providers could be obtained by using the URL in the target attribute of the schema.
GET /api/relation/SystemUser/?hierarchy=[hierarchy] &format=json &schema=1
The following is an extract of the schema of relation/SystemUser:
... "SSOUser": { "items": { "type": "object", "properties": { "sso_username": { "required": true, "type": "string", "description": "The name identifier that is used for an SSO authenticated user.", "title": "SSO Username" }, "sso_idp": { "target": "/api/data/SsoIdentityProvider/choices/ ?hierarchy=[hierarchy] &field=entity_id &format=json &auth_token=[auth_token]", "format": "uri", "required": true, "choices": [], "target_attr": "entity_id", "target_model_type": "data/SsoIdentityProvider", "title": "SSO Identity Provider", "type": "string", "description": "The entity id of the SSO Identity Provider." }, ...
The schema for a resource is obtained in the request parameter: ?format=json&schema=1. This way of requesting the schema is only available when requesting an Add form or when viewing a resource.
A specific url is also available for obtaining the schema of a resource:
GET /api/{model_type}/{model_name}/schema/?format=json&hierarchy=pkid
All the schemas are in JSON format.
For more information on the specific API schemas, refer to the Cisco Unified Communications Domain Manager, API Schema Reference Guide
The APIs which are available to the service provider are determined by the role of the user corresponding to the credentials provided in the API. The Cisco Unified Communications Domain Manager 10.6(x) system has a number of roles that are available for different types of administrators (provider, reseller, customer, site). See the Cisco Unified Communications Domain Manager, GUI Access by Role for the complete list of available APIs.
Note | For the most accurate information, gather the schema from the system. |
Cisco Unified Communications Domain Manager APIs support sending out notifications when instances of certain models are added, deleted or changed. For more details on which models are supported for notifications, and how to configure these notifications please refer to the Cisco Unified Communications Domain Manager, Release 10.6(3) Maintain and Operate Guide