API hypermedia

Throughout this API, Hypermedia links members allow automated client applications to navigate to relevant data and execute related operations.

This example from within a listing of template summaries provides a direct link to the API call necessary to access each template object, and describedBy JSON schema used to validate its contents:

{
    "links": [
        {
            "href": "/alerts/v2/alert-templates/s@1",
            "rel": "self"
        },
        {
            "href": "/alerts/v2/json-schema/alert-templates/s@1",
            "rel": "describedBy"
        }
    ]
}

In addition, href elements included within template fields indicate the availability of dynamic access control data. For example, this field definition references the API operation that lists the set of CP codes available to the client when you configure an alert:

{
    "default": [],
    "href": "/alerts/v2/access-control-data?type=cpcode&templateId=s@7",
    "itemType": "cpcode",
    "key": "aca_cpcode",
    "type": "multi-select"
}