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,
enclosed in square brackets.
the hierarchy which can be specified as:
(Universally Unique Identifier); for example,
notation; for example,
For a list of
available hierarchy UUIDs and their dot notations, refer to the data in the
response of the call:
[pkid] is the ID
of the resource instance. Refer to the List action reference for the resource.
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.
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
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
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
attribute of the schema.
The following is an
extract of the schema of relation/SystemUser:
"description": "The name identifier that is used for
an SSO authenticated user.",
"title": "SSO Username"
"title": "SSO Identity Provider",
"description": "The entity id of the SSO Identity Provider."