Skip to main content
A newer release of this product is available.

Support EMS messages endpoint overview

Contributors
PDFs

Overview

Allows access to the EMS event catalog. The catalog contains a list of all events supported by the system and their corresponding descriptions, the reason for an event occurrence, and how to correct issues related to the event.

Example

Querying for the first event that has a message name beginning with 'C'

# API
GET /api/support/ems/messages?fields=name&max_records=1&name=C*

# Response
200 OK

# JSON Body
{
"records": [
  {
    "name": "CR.Data.File.Inaccessible",
    "_links": {
      "self": {
        "href": "/api/support/ems/messages/CR.Data.File.Inaccessible"
      }
    }
  }
],
"num_records": 1,
"_links": {
  "self": {
    "href": "/api/support/ems/messages?fields=name&max_records=1&name=C*"
  },
}
}