Inspect native draft request

Read the state and evidence for a native draft request by its request key.

GET /api/v1/workforce/draft-requests/{requestKey}

Error

A valid request URL is required to generate request examples

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "request_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "actor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "person_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "kind": "generated",
  "input": {},
  "source_context": {},
  "preparation": {},
  "result": {
    "scheduleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdSchedule": true,
    "native": {
      "inserted_shifts": 1,
      "inserted_activities": 1
    },
    "shifts": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "objectRecordId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "startTs": "2023-11-07T05:31:56Z",
        "endTs": "2023-11-07T05:31:56Z"
      }
    ]
  },
  "committed_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

Existing Atlas integration connection with explicit api:connect plus appropriate native domain grants. atlas_ingest_ and browser cookies are not accepted.

Headers

X-Workspace-Id · string<uuid> · required

Selector within saved grants and current issuer authority; never grants authority.

Path Parameters

requestKey · string<uuid> · required

Response

200

application/json

Native evidence or exact command result. Unavailable evidence is explicitly labeled.

id · string<uuid> · required

workspace_id · string<uuid> · required

request_key · string<uuid> · required

actor_id · string<uuid> · required

person_id · string<uuid> · required

kind · enum<string> · required

Available options: generated, rotation

input · object · required

source_context · object · required

Native fenced source snapshot; never replace on retry.

preparation · object · required

Native bounded candidate and constraint/report evidence; not a committed schedule. Each scheduling profile in evidence.profiles lists only its identity, revision, effective dates, weekly and shift hour limits and availability; free-text notes and change reasons are never returned.

result · object | null · required

Show child attributes

committed_at · string<date-time> | null · required

expires_at · string<date-time> · required