Evaluate staffing read-only

POST

api

workforce

scheduling-groups

{groupId}

requirements

evaluate

Error

A valid request URL is required to generate request examples

{
  "sourceMode": "prediction",
  "intervals": [
    {
      "date": "2023-12-25",
      "startTs": "2023-11-07T05:31:56Z",
      "endTs": "2023-11-07T05:31:56Z",
      "slotMinutes": 1,
      "offeredInteractions": 1,
      "workloadSeconds": 1,
      "effectiveAhtSeconds": 1,
      "netRequiredAgents": 1,
      "capped": true,
      "localLabel": "<string>",
      "unrepresentable": true
    }
  ],
  "closedDates": [
    "2023-12-25"
  ],
  "residualUnplannedShrinkage": 1,
  "coverageContract": "productive_supply_after_residual_vs_exact_net_requirement",
  "volumeRun": {},
  "ahtRun": {},
  "calendarSource": "calendar",
  "calendarId": "<string>"
}

{
  "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>"
  }
}

{
  "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

Body

application/json

from

string<date>

required

string<date>

required

residual_unplanned_shrinkage

number

required

Explicit residual unplanned loss after scheduled nonproductive time; never inferred from total shrinkage.

Required range: x >= 0

Response

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

sourceMode

enum<string>

required

Available options:

prediction,

manual,

mixed

intervals

object[]

required

Show child attributes

closedDates

string<date>[]

required

residualUnplannedShrinkage

number

required

Required range: x >= 0

coverageContract

any

required

volumeRun

object | null

ahtRun

object | null

calendarSource

enum<string>

Available options:

calendar,

profile

calendarId

string | null

Error

A valid request URL is required to generate request examples

{
  "sourceMode": "prediction",
  "intervals": [
    {
      "date": "2023-12-25",
      "startTs": "2023-11-07T05:31:56Z",
      "endTs": "2023-11-07T05:31:56Z",
      "slotMinutes": 1,
      "offeredInteractions": 1,
      "workloadSeconds": 1,
      "effectiveAhtSeconds": 1,
      "netRequiredAgents": 1,
      "capped": true,
      "localLabel": "<string>",
      "unrepresentable": true
    }
  ],
  "closedDates": [
    "2023-12-25"
  ],
  "residualUnplannedShrinkage": 1,
  "coverageContract": "productive_supply_after_residual_vs_exact_net_requirement",
  "volumeRun": {},
  "ahtRun": {},
  "calendarSource": "calendar",
  "calendarId": "<string>"
}

{
  "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>"
  }
}

{
  "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

Body

Response