API docs by Redocly

Enterprise Public API (1.0)

Download OpenAPI specification:OpenAPI (JSON)OpenAPI (YAML)

The Enterprise Public API.

ReferenceData

Get the values of a named choice list

Returns the choices (code + label pairs) for the named choice list. Internal numeric identifiers and platform-specific field names are implementation details and are intentionally omitted from the response.

path Parameters
listName
required
string

camelCase identifier of the choice list. Case-sensitive exact match against the catalogue.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

List available choice lists (manifest)

Returns a lightweight manifest of every choice list available in the catalogue. Clients call GET /v1/reference-data/{listName} to retrieve the choices themselves.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Health

Health check.

Health check.

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "entries": { }
}

Webhooks

Receive a rendering provider callback

Receives the rendering provider's completion notification and passes it to the Document Generation Adapter, which decides whether it is genuine. Nothing is verified, parsed or logged here.

path Parameters
callbackReference
required
string <uuid>

The reference this platform issued to the provider for this render.

header Parameters
Authorization
required
string

The per-render secret this platform issued. Forwarded unread. It is not a bearer token, despite the header.

Request Body schema: application/json

The provider's callback message, forwarded unparsed.

object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "code": "string",
  • "errors": [
    ]
}