Sign in

v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Jobs

Get Custom Job Detail Definitions for a Tenant

Returns a list of Custom Details for the Tenant.

get/v1/job/customDetailDefinitions

Headers

RequestIdstring uuid

The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.

Unique request identifier (UUID) used to correlate request data with log entries and events.

FrontOfficeTenantIdinteger

An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.

Tenantstring

Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.

Response

A list of Custom Job Detail Definitions

idinteger

The identifier for the custom job detail definition.

detailNamestring

The name of the custom job detail definition.

detailTypestring

The type of custom job detail. The possible values are 'checkbox', 'minmax', 'numeric', 'text', 'time'.

Example response

[
  {
    "id": 1842,
    "detailName": "Dress Code",
    "detailType": "text"
  }
]