Enumerations API

The Xurrent fields in which one option can be selected form a fixed list of values are called enumerations. The Enumerations API provides an easy way to view all enumerations defined by the system.

List enumerations

The enumerations are available in a few formats:

And in several languages (see also internationalization), examples include:

By default all enumerations in the Xurrent application are retrieved in the locale of the API user:

GET /enums

Response

status: 200 OK
{
  "request.status": [
    {
      "id": "declined",
      "txt": "Declined"
    },
    {
      "id": "assigned",
      "txt": "Assigned"
    },
    {
      "id": "accepted",
      "txt": "Accepted"
    },
    "..."
  ],
  "task.category": [
    {
      "id": "risk_and_impact",
      "txt": "Risk & Impact"
    },
    {
      "id": "approval",
      "txt": "Approval"
    },
    {
      "id": "implementation",
      "txt": "Implementation"
    }
  ],
  "language": [
    "..."
  ]
}