Inspect workforce configuration evidence

GET

api

workforce

readiness

Error

A valid request URL is required to generate request examples

{
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "observed_at": "2023-11-07T05:31:56Z",
  "counts": {
    "operating_calendars": 1,
    "operating_calendar_bindings": 1,
    "forecast_groups": 1,
    "scheduling_groups": 1
  },
  "state": "unavailable",
  "configuration_state": "incomplete",
  "reason_codes": [
    "<string>"
  ],
  "source_verification": "<string>",
  "queue_settings": {
    "state": "available",
    "queues": [
      {
        "queueId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "serviceGoal": {
          "state": "configured",
          "percentage": {
            "value": 1,
            "effectiveFrom": "2023-11-07T05:31:56Z",
            "effectiveTo": "2023-11-07T05:31:56Z",
            "recordedAt": "2023-11-07T05:31:56Z",
            "sourceSystem": "<string>",
            "attributeValueId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          },
          "seconds": {
            "value": 1,
            "effectiveFrom": "2023-11-07T05:31:56Z",
            "effectiveTo": "2023-11-07T05:31:56Z",
            "recordedAt": "2023-11-07T05:31:56Z",
            "sourceSystem": "<string>",
            "attributeValueId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        }
      }
    ]
  }
}

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

Response

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

workspace_id

string<uuid>

required

observed_at

string<date-time>

required

counts

object

required

Show child attributes

state

any

required

configuration_state

enum<string>

required

Available options:

incomplete,

present_unverified

reason_codes

string[]

required

source_verification

string

queue_settings

object

Option 1
Option 2

Show child attributes

Error

A valid request URL is required to generate request examples

{
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "observed_at": "2023-11-07T05:31:56Z",
  "counts": {
    "operating_calendars": 1,
    "operating_calendar_bindings": 1,
    "forecast_groups": 1,
    "scheduling_groups": 1
  },
  "state": "unavailable",
  "configuration_state": "incomplete",
  "reason_codes": [
    "<string>"
  ],
  "source_verification": "<string>",
  "queue_settings": {
    "state": "available",
    "queues": [
      {
        "queueId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "serviceGoal": {
          "state": "configured",
          "percentage": {
            "value": 1,
            "effectiveFrom": "2023-11-07T05:31:56Z",
            "effectiveTo": "2023-11-07T05:31:56Z",
            "recordedAt": "2023-11-07T05:31:56Z",
            "sourceSystem": "<string>",
            "attributeValueId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          },
          "seconds": {
            "value": 1,
            "effectiveFrom": "2023-11-07T05:31:56Z",
            "effectiveTo": "2023-11-07T05:31:56Z",
            "recordedAt": "2023-11-07T05:31:56Z",
            "sourceSystem": "<string>",
            "attributeValueId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        }
      }
    ]
  }
}

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

Inspect workforce configuration evidence

Authorizations

Headers

Response