Enterprise Public API (1.0)

Download OpenAPI specification:

The Enterprise Public API.

ReferenceData

Get Choice List

Returns the choices (code and label pairs) for the named choice list.

path Parameters

listName

required

string

camelCase identifier of the choice list.

header Parameters

Correlation-Id

string

Correlation Id.

Responses

Response samples

200
400
404
500

Content type

application/json

{"data": {"name": "string",
"scope": "string",
"choices": [{"code": "string",
"label": "string"
}
],
"catalogueVersion": "string",
"catalogueGeneratedAt": "string"
},
"meta": {"requestId": "string",
"timestamp": "string",
"apiVersion": "string"
}
}

List Choice Lists

Returns a manifest of every choice list available in the catalogue.

header Parameters

Correlation-Id

string

Correlation Id.

Responses

Response samples

200
500

Content type

application/json

{"data": {"items": [{"name": "string",
"scope": "string",
"choiceCount": 0
}
],
"catalogueVersion": "string",
"catalogueGeneratedAt": "string"
},
"meta": {"requestId": "string",
"timestamp": "string",
"apiVersion": "string"
}
}

Health

Health check.

header Parameters

Correlation-Id

string

Correlation Id.

Responses

Response samples

200
500

Content type

application/json

{"status": "string",
"entries": { }
}