Read staffing requirement evidence

GET

api

workforce

scheduling-groups

{groupId}

requirements

Error

A valid request URL is required to generate request examples

{
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "from": "2023-12-25",
  "to": "2023-12-25",
  "days": [
    {
      "date": "2023-12-25",
      "slotMinutes": 123,
      "openMin": 123,
      "closeMin": 123,
      "requiredBySlot": [
        1
      ],
      "computedAt": "2023-11-07T05:31:56Z",
      "intervalEvidence": {
        "startTs": "2023-11-07T05:31:56Z",
        "endTs": "2023-11-07T05:31:56Z",
        "intervals": [
          {
            "startTs": "2023-11-07T05:31:56Z",
            "endTs": "2023-11-07T05:31:56Z",
            "requiredPeople": 1,
            "netRequiredPeople": 1,
            "residualUnplannedShrinkage": 1,
            "residualAssumption": "no_additional_unplanned_loss"
          }
        ]
      },
      "sourceMode": "<string>",
      "forecastGroupVersionId": "<string>",
      "predictionRunIds": [
        "<string>"
      ]
    }
  ],
  "evidence_state": "complete",
  "missing_days": 1,
  "units": {
    "requiredBySlot": "gross_presence_people",
    "net": "exact_net_required_people_when_retained"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

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

groupId

string<uuid>

required

Query Parameters

from

string<date>

required

string<date>

required

Response

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

workspace_id

string<uuid>

required

group_id

string<uuid>

required

from

string<date>

required

string<date>

required

days

object[]

required

Show child attributes

evidence_state

enum<string>

required

Available options:

complete,

partial,

unavailable

missing_days

integer

required

Required range: x >= 0

units

object

required

Show child attributes

Error

A valid request URL is required to generate request examples

{
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "from": "2023-12-25",
  "to": "2023-12-25",
  "days": [
    {
      "date": "2023-12-25",
      "slotMinutes": 123,
      "openMin": 123,
      "closeMin": 123,
      "requiredBySlot": [
        1
      ],
      "computedAt": "2023-11-07T05:31:56Z",
      "intervalEvidence": {
        "startTs": "2023-11-07T05:31:56Z",
        "endTs": "2023-11-07T05:31:56Z",
        "intervals": [
          {
            "startTs": "2023-11-07T05:31:56Z",
            "endTs": "2023-11-07T05:31:56Z",
            "requiredPeople": 1,
            "netRequiredPeople": 1,
            "residualUnplannedShrinkage": 1,
            "residualAssumption": "no_additional_unplanned_loss"
          }
        ]
      },
      "sourceMode": "<string>",
      "forecastGroupVersionId": "<string>",
      "predictionRunIds": [
        "<string>"
      ]
    }
  ],
  "evidence_state": "complete",
  "missing_days": 1,
  "units": {
    "requiredBySlot": "gross_presence_people",
    "net": "exact_net_required_people_when_retained"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

API foundations

Conversation REST API

Forecasting

Forecasting REST API

Workforce

Workforce REST API

Integrations

Atlas concepts

Build with Atlas

Changes

Authorizations

Headers

Path Parameters

Query Parameters

Response