{ "openapi": "3.1.0", "info": { "title": "Atlas workforce API", "version": "2026-10-preview", "description": "Authenticated workforce staffing-to-draft operations. Released together with matching MCP operations. Deploy the reviewed native guard migrations before enabling this feature." }, "servers": [ { "url": "/" } ], "security": [ { "AtlasIntegrationBearer": [] } ], "paths": { "/api/v1/workforce/discovery": { "get": { "operationId": "discover_workforce", "summary": "Discover workforce facts before WFM configuration", "description": "Count-checked, read-only canonical Queue and membership inventory. Source, Person and semantic sections explicitly report denied or unavailable evidence. Summary returns totals and decisions; queue/person views return bounded detail pages after the same complete internal enumeration. No configuration is created.", "x-atlas-mcp-tool": "atlas_discover_workforce", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Workspace selector within saved grants and current native authority." }, { "name": "from", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" }, "description": "Inclusive observation start." }, { "name": "to", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" }, "description": "Exclusive observation end; maximum 31 elapsed days after from." }, { "name": "as_of", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" }, "description": "Effective instant for dated identity and membership." }, { "name": "view", "in": "query", "schema": { "type": "string", "enum": [ "summary", "queues", "people" ], "default": "summary" } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "search", "in": "query", "schema": { "type": "string", "maxLength": 120 }, "description": "Case-insensitive Queue or Person name filter after count-checking the complete authorized inventory." } ], "responses": { "200": { "description": "Versioned discovery facts", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforceDiscovery" } } } }, "400": { "description": "Malformed transport input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid window or page", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Incomplete source or unavailable read", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/workforce/readiness": { "get": { "operationId": "get_workforce_readiness", "summary": "Inspect workforce configuration evidence", "description": "Counts are configuration evidence only. queue_settings contains dated native queue service goals, currently sourced from Zoom catalog attributes, using count-checked pagination for all active queues. Missing or conflicting fields remain unknown. This does not establish observed performance, source freshness or qualified roster completeness.", "x-atlas-mcp-tool": "atlas_get_workforce_readiness", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." } ], "responses": { "200": { "description": "Native evidence or exact command result. Unavailable evidence is explicitly labeled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforceReadiness" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/workforce/scheduling-groups": { "get": { "operationId": "list_schedule_groups", "summary": "List scheduling groups", "description": "List scheduling groups in the selected workspace.", "x-atlas-mcp-tool": "atlas_list_schedule_groups", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." } ], "responses": { "200": { "description": "Native evidence or exact command result. Unavailable evidence is explicitly labeled.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NativeEvidence" } } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "operationId": "create_scheduling_group", "summary": "Create a scheduling group atomically", "description": "Requires workforce write and current manage_schedules. Creates the native group and object together. Optional forecast_group_operation_key binds the latest reviewed forecast publication; a missing or superseded publication is refused.", "x-atlas-mcp-tool": "atlas_create_schedule_group", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Retain the exact key and body across retries and transports." } ], "responses": { "200": { "description": "Authorized native result. Configuration success does not establish operational readiness.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationReceipt" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchedulingGroupCreate" } } } } } }, "/api/v1/workforce/scheduling-groups/{groupId}": { "get": { "operationId": "get_schedule_group", "summary": "Inspect scheduling group and roster", "description": "Read a scheduling group's configuration and roster.", "x-atlas-mcp-tool": "atlas_get_schedule_group", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Native evidence or exact command result. Unavailable evidence is explicitly labeled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NativeEvidence" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/workforce/schedules/{scheduleId}": { "get": { "operationId": "get_schedule", "summary": "Read native schedule and activities", "description": "Read a saved native schedule and its activities.", "x-atlas-mcp-tool": "atlas_get_schedule", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." }, { "name": "scheduleId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Native evidence or exact command result. Unavailable evidence is explicitly labeled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NativeEvidence" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/workforce/scheduling-groups/{groupId}/requirements": { "get": { "operationId": "inspect_staffing_requirements", "summary": "Read staffing requirement evidence", "description": "Read staffing requirement evidence for a scheduling group over the requested date range.", "x-atlas-mcp-tool": "atlas_inspect_staffing_requirements", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." }, { "name": "from", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Native evidence or exact command result. Unavailable evidence is explicitly labeled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StaffingRequirements" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/workforce/scheduling-groups/{groupId}/requirements/evaluate": { "post": { "operationId": "evaluate_staffing_requirements", "summary": "Evaluate staffing read-only", "description": "Requires ready source evidence; does not start a prediction or persist requirements. 1–14 inclusive dates.", "x-atlas-mcp-tool": "atlas_evaluate_staffing_requirements", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Native evidence or exact command result. Unavailable evidence is explicitly labeled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StaffingEvaluation" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Content-Type must be application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StaffingEvaluationInput" } } } } } }, "/api/v1/workforce/scheduling-groups/{groupId}/requirements/compute": { "post": { "operationId": "compute_staffing_requirements", "summary": "Compute and persist staffing evidence", "description": "Native recomputation, not a schedule commitment. Requires authored manual demand or completed forecast evidence; does not start inference. Staffing rows retain the latest computation; this operation is not an exactly-once staffing receipt.", "x-atlas-mcp-tool": "atlas_compute_staffing_requirements", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Stable native request key. Reuse the exact draft key across REST and MCP." } ], "responses": { "200": { "description": "Native evidence or exact command result. Unavailable evidence is explicitly labeled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StaffingComputeResult" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Content-Type must be application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StaffingComputeInput" } } } } } }, "/api/v1/workforce/scheduling-groups/{groupId}/coverage": { "get": { "operationId": "get_workforce_coverage", "summary": "Read compatible coverage evidence", "description": "Read coverage evidence for a scheduling group over the requested date range.", "x-atlas-mcp-tool": "atlas_get_workforce_coverage", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." }, { "name": "from", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "preview", "in": "query", "schema": { "type": "string", "enum": [ "draft" ] } }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Native evidence or exact command result. Unavailable evidence is explicitly labeled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Coverage" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/workforce/draft-requests": { "post": { "operationId": "issue_draft_schedule", "summary": "Issue an exact native draft proposal", "description": "Persists issued request evidence; creates no shifts until commit. Requires usable authored demand and current requirements; unconfigured demand returns generation.demand_unavailable rather than a floor-only proposal. Maximum 14 dates and 200 roster entries. Native rules and source fencing remain authoritative.", "x-atlas-mcp-tool": "atlas_issue_draft_schedule", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Stable native request key. Reuse the exact draft key across REST and MCP." } ], "responses": { "200": { "description": "Native evidence or exact command result. Unavailable evidence is explicitly labeled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DraftRequest" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Content-Type must be application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DraftIssueInput" } } } } } }, "/api/v1/workforce/draft-requests/{requestKey}": { "get": { "operationId": "inspect_draft_schedule", "summary": "Inspect native draft request", "description": "Read the state and evidence for a native draft request by its request key.", "x-atlas-mcp-tool": "atlas_inspect_draft_schedule", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." }, { "name": "requestKey", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Native evidence or exact command result. Unavailable evidence is explicitly labeled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DraftRequest" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/workforce/draft-requests/{requestKey}/commit": { "post": { "operationId": "commit_draft_schedule", "summary": "Commit issued draft exactly once", "description": "No body. Header key must equal path key. Rechecks current authority and native source revisions; identical replay returns the existing result. Does not publish.", "x-atlas-mcp-tool": "atlas_commit_draft_schedule", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." }, { "name": "requestKey", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Stable native request key. Reuse the exact draft key across REST and MCP." } ], "responses": { "200": { "description": "Native evidence or exact command result. Unavailable evidence is explicitly labeled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DraftCommitResult" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/workforce/connections": { "get": { "operationId": "list_provider_connections", "summary": "Discover provider connections", "description": "Requires separate provider-read and current provider setup authority.", "x-atlas-mcp-tool": "atlas_list_provider_connections", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." } ], "responses": { "200": { "description": "Native evidence or exact command result. Unavailable evidence is explicitly labeled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NativeEvidence" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/workforce/connections/{connectionId}/resources": { "get": { "operationId": "list_provider_resources", "summary": "Inspect provider inventory", "description": "List resources from a selected workforce provider connection.", "x-atlas-mcp-tool": "atlas_list_provider_resources", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 100000, "default": 0 } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "connectionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Native evidence or exact command result. Unavailable evidence is explicitly labeled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NativeEvidence" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/workforce/connections/{connectionId}/sync-status": { "get": { "operationId": "get_connection_sync_status", "summary": "Inspect native configuration delivery evidence", "description": "Read synchronization status and configuration delivery evidence for a workforce provider connection.", "x-atlas-mcp-tool": "atlas_get_connection_sync_status", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." }, { "name": "connectionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Native evidence or exact command result. Unavailable evidence is explicitly labeled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NativeEvidence" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/workforce/connections/{connectionId}/preparation": { "get": { "operationId": "get_workspace_preparation", "summary": "Inspect native calendar preparation", "description": "Read native calendar preparation details for a workforce provider connection.", "x-atlas-mcp-tool": "atlas_get_workspace_preparation", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 100000, "default": 0 } }, { "name": "connectionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Native evidence or exact command result. Unavailable evidence is explicitly labeled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NativeEvidence" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/workforce/scheduling-groups/{groupId}/members": { "get": { "operationId": "read_scheduling_group_members", "summary": "Inspect a scheduling group and members", "description": "Read a scheduling group and its member assignments.", "x-atlas-mcp-tool": "atlas_get_schedule_group", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Authorized native result. Configuration success does not establish operational readiness.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NativeEvidence" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "operationId": "create_scheduling_group_member", "summary": "Create a dated member atomically", "description": "Requires workforce write and current manage_workforce_roster. Subject is nested and never identifies the acting principal. Enforce mode requires employment_assignment_id. Validates current assignment, person, overlap and FTE; any needed Agent slot rolls back with a failed membership.", "x-atlas-mcp-tool": "atlas_add_schedule_group_member", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Retain the exact key and body across retries and transports." } ], "responses": { "200": { "description": "Authorized native result. Configuration success does not establish operational readiness.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationReceipt" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchedulingMemberCreate" } } } } } }, "/api/v1/workforce/forecast-groups": { "get": { "operationId": "list_forecast_groups", "summary": "Inspect published forecast groups", "description": "List published forecast groups in the selected workspace, with optional archived groups.", "x-atlas-mcp-tool": "atlas_list_forecast_groups", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." }, { "name": "id", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "include_archived", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Authorized native result. Configuration success does not establish operational readiness.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NativeEvidence" } } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "operationId": "publish_forecast_group", "summary": "Publish an authorized forecast configuration", "description": "Requires mcp:schedules:write and the explicit mcp:schedules:publish grant, plus the issuer’s current native and referenced-source authority. The same grant is rechecked when a saved setup assessment publishes a forecast configuration.", "x-atlas-mcp-tool": "atlas_publish_forecast_group", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Retain the exact key and body across retries and transports." } ], "responses": { "200": { "description": "Authorized native result. Configuration success does not establish operational readiness.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NativeEvidence" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForecastGroupPublication" } } } } } }, "/api/v1/workforce/forecast-groups/options": { "get": { "operationId": "get_forecast_group_options", "summary": "Inspect permissible owners, targets and calendars", "description": "List permissible owners, targets, and calendars for forecast group configuration.", "x-atlas-mcp-tool": "atlas_get_forecast_group_options", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." } ], "responses": { "200": { "description": "Authorized native result. Configuration success does not establish operational readiness.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforceForecastGroupOptions" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/workforce/setup/preview": { "post": { "operationId": "preview_workforce_setup", "summary": "Validate proposed setup without configuration effects", "description": "At most 20 recommendations and 100 total members; bounded admission and a 20-second cooperative computation budget. Native validation determines createReady. Operational readiness remains not_verified. Returned commands and retry keys must be retained. forecastGroupKey links a scheduling recommendation to the exact reviewed forecast publication.", "x-atlas-mcp-tool": "atlas_preview_workforce_setup", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." } ], "responses": { "200": { "description": "Authorized native result. Configuration success does not establish operational readiness.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforceSetupAssessment" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforceSetupPreview" } } } } } }, "/api/v1/workforce/setup/apply": { "post": { "operationId": "apply_workforce_setup", "summary": "Apply one exact saved native assessment command", "description": "The selected assessment must belong to this token owner in this workspace. Reads the command from existing Agent Kernel evidence; rejects configuration substitution. Each selected command already has a stable key, so no separate Idempotency-Key is used. Current native authority and assessment revision are rechecked transactionally. Replay may recover a committed effect after later corrections.", "x-atlas-mcp-tool": "atlas_apply_workforce_setup", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." } ], "responses": { "200": { "description": "Authorized native result. Configuration success does not establish operational readiness.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforceSetupApplyResult" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforceSetupApply" } } } } } }, "/api/v1/workforce/configuration-results/{requestKey}": { "get": { "operationId": "inspect_workforce_configuration", "summary": "Recover a native configuration result", "description": "Read-only lookup for this token Actor. Null is no confirmed result, not proof that a concurrent request failed. Does not create an Actor. A database/read failure is unknown and returns 503.", "x-atlas-mcp-tool": "atlas_inspect_workforce_configuration", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." }, { "name": "requestKey", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "kind", "in": "query", "required": true, "schema": { "enum": [ "group", "member", "forecast_group" ] } } ], "responses": { "200": { "description": "Authorized native result. Configuration success does not establish operational readiness.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ConfigurationReceipt" }, { "$ref": "#/components/schemas/NativeEvidence" }, { "type": "null" } ] } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/workforce/setup/assessments": { "get": { "operationId": "listWorkforceSetupAssessments", "summary": "List the issuing Person’s ten latest setup sessions in this workspace", "description": "Lists the issuing Person’s ten latest setup runs in creation order within the selected workspace. Opening a run does not make it the newest. Closed runs are omitted.", "x-atlas-mcp-tool": "atlas_list_workforce_assessments", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." } ], "responses": { "200": { "description": "Own session metadata only; excludes other people and execution workspaces.", "content": { "application/json": { "schema": { "type": "array", "maxItems": 10, "items": { "type": "object", "required": [ "sessionId", "updatedAt", "status", "startedAt" ], "properties": { "sessionId": { "type": "string", "format": "uuid" }, "updatedAt": { "type": "string", "format": "date-time" }, "status": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "description": "Creation time; opening or updating a run does not change it." }, "needsAttention": { "type": "boolean", "description": "Source-free outcome metadata. A completed run may contain blockers or an inspection-limit failure; true means its result needs attention. This is not scheduling-readiness proof." } } } } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/workforce/setup/check": { "post": { "operationId": "checkWorkforceSetup", "summary": "Preflight or verify exact retained setup selections", "description": "Read-only. Preflight requires the current completed assessment and write grants; verification can recover old committed selections. Each check returns a current native record comparison. No Actor or receipt is created.", "x-atlas-mcp-tool": "atlas_check_workforce_setup", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." } ], "responses": { "200": { "description": "Authorized native result. Configuration success does not establish operational readiness.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforceSetupCheckResult" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforceSetupCheck" } } } } } }, "/api/v1/workforce/setup/assessment": { "get": { "operationId": "readWorkforceSetupAssessment", "summary": "Read an owned retained assessment and its source-authorized conversation", "description": "Current Person authority and source permissions are rechecked. resultRef selects a retained revision; after is a history cursor, not an evidence timestamp. Historical revisions are read-only. Missing source access hides the affected analysis. The token owner selects only their own conversation in the granted workspace. External source-domain grants remain necessary for provider, prediction and semantic evidence. At most 200 unique source checks and a 20-second cooperative budget; capped reads fail explicitly. Use view=summary for polling. Running summaries contain operational metadata only; completed summaries project the selected result and its dependencies, without replaying the entire conversation.", "x-atlas-mcp-tool": "atlas_read_workforce_assessment", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." }, { "name": "sessionId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "resultRef", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 200 } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 100000, "default": 0 } }, { "name": "view", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "history", "summary" ], "default": "history" }, "description": "summary returns lightweight operational progress while running, without replaying source queries. A completed plan still rechecks source access." } ], "responses": { "200": { "description": "Authorized native result. Configuration success does not establish operational readiness.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforceSetupHistory" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "operationId": "deleteWorkforceSetupAssessment", "summary": "Delete the issuing Person’s setup run", "description": "Requires workforce write and current manage_schedules authority. Closes only the token owner’s setup run in this workspace, attributes the request to its token Actor, then uses existing native conversation cleanup. Saved configuration, schedules and command receipts remain. An absent or foreign ID returns the same idempotent success. A closed run awaiting lease/storage cleanup returns cleanupPending=true and is no longer listed. No publication grant is required.", "x-atlas-mcp-tool": "atlas_delete_workforce_assessment", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." }, { "name": "sessionId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "The run is closed or already absent; native cleanup may still be pending.", "content": { "application/json": { "schema": { "type": "object", "required": [ "deleted", "cleanupPending" ], "properties": { "deleted": { "type": "boolean" }, "cleanupPending": { "type": "boolean" } }, "additionalProperties": false } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/workforce/scheduling-groups/{groupId}/intraday": { "get": { "operationId": "get_workforce_intraday", "summary": "Read native workforce intraday activity and provisional interval actuals", "description": "Requires the existing workforce workspace grant, current manage_schedules transport authority, and native view_workforce_actual_activity capability. Returns the native scheduling-group intraday contract, with published schedule, canonical activity, adherence and observed interval facts. Raw provider fields additionally require view_workforce_activity_raw. Active interval actuals are provisional, and unknown source completeness is explicit.", "x-atlas-mcp-tool": "atlas_get_workforce_intraday", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "date", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Scheduling-group local calendar date. Defaults to group-local today." }, { "name": "history", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "deferred" ] }, "description": "deferred omits historical activity reads while retaining current state and interval metadata. MCP uses include_history=false." } ], "responses": { "200": { "description": "Native evidence or exact command result. Unavailable evidence is explicitly labeled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforceIntraday" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/workforce/me/schedule": { "get": { "operationId": "get_my_schedule", "summary": "Read my published schedule", "description": "The bearer owner's own published shifts and activities across groups for 1–62 days (default this Monday–Sunday). Requires the own-schedule grant (`mcp:self:read` with the workspace selector) and current view_own_schedule. Identity comes from the token, never from input.", "x-atlas-mcp-tool": "atlas_get_my_schedule", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Inclusive local start date; supply with to." }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Inclusive local end date." } ], "responses": { "200": { "description": "Native typed result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforceMySchedule" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Content-Type must be application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/workforce/me/scheduling-profile": { "get": { "operationId": "get_my_scheduling_profile", "summary": "Read my scheduling profile", "description": "The bearer owner's effective availability and preferences, revision history, Person-wide terms and own pending changes. Manager notes are never returned. Pass assignment_id when several Assignments apply.", "x-atlas-mcp-tool": "atlas_get_my_scheduling_profile", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." }, { "name": "assignment_id", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" }, "description": "One of the owner's own Assignment ids." }, { "name": "effective_on", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Civil date; default today." } ], "responses": { "200": { "description": "Native typed result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforcePlanningResult" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Content-Type must be application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/workforce/me/scheduling-profile/preview": { "post": { "operationId": "preview_my_scheduling_change", "summary": "Preview my availability or preference change", "description": "Read only. Returns field issues, resulting effective intervals, affected drafts and future published commitments, and whether policy routes the change for review. Only availability and scheduling_preferences may change.", "x-atlas-mcp-tool": "atlas_preview_my_scheduling_change", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforceMySchedulingChangePreview" } } } }, "responses": { "200": { "description": "Native typed result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforcePlanningResult" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Content-Type must be application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/workforce/me/scheduling-profile/changes": { "get": { "operationId": "list_my_scheduling_changes", "summary": "List my scheduling changes", "description": "The owner's own changes, newest first, with status applied, pending_review, withdrawn or rejected.", "x-atlas-mcp-tool": "atlas_list_my_scheduling_changes", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Continuation from the previous page's nextCursor." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 }, "description": "Page size." } ], "responses": { "200": { "description": "Native typed result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforcePlanningPage" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Content-Type must be application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "operationId": "submit_my_scheduling_change", "summary": "Submit my availability or preference change", "description": "Requires `mcp:self:write` and current manage_own_scheduling_preferences. An ordinary change becomes an effective revision; one that conflicts with published commitments, contract minimums or unassessed impact stays pending_review. Never routed through manage_schedules.", "x-atlas-mcp-tool": "atlas_submit_my_scheduling_change", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Stable native operation key. Reuse it as request_key through MCP; a changed body under the same key conflicts." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforceMySchedulingChangeSubmit" } } } }, "responses": { "200": { "description": "Native typed result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforcePlanningResult" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Content-Type must be application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/workforce/me/scheduling-profile/changes/{changeId}/withdraw": { "post": { "operationId": "withdraw_my_scheduling_change", "summary": "Withdraw my pending change", "description": "Only the owner's own pending change. A repeated withdrawal returns the recorded result; an applied or rejected change conflicts.", "x-atlas-mcp-tool": "atlas_withdraw_my_scheduling_change", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." }, { "name": "changeId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Native result; send no request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforcePlanningResult" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Content-Type must be application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/workforce/scheduling-profiles": { "get": { "operationId": "list_scheduling_profiles", "summary": "List effective scheduling profiles", "description": "Person-wide and Assignment-scoped profiles effective on a date. Requires current manage_scheduling_profiles. Notes are omitted.", "x-atlas-mcp-tool": "atlas_list_scheduling_profiles", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." }, { "name": "effective_on", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Civil date; default today." }, { "name": "person_id", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" }, "description": "Repeat to restrict to these People (at most 100)." }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Continuation from the previous page's nextCursor." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 }, "description": "Page size." } ], "responses": { "200": { "description": "Native typed result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforcePlanningPage" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Content-Type must be application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/workforce/scheduling-profiles/{subjectKind}/{subjectId}": { "get": { "operationId": "get_scheduling_profile", "summary": "Read a Person or Assignment profile", "description": "The effective revision, history, structured availability and preferences, contract terms, notes and pending employee changes. Assignment subjects are authorized against that Assignment.", "x-atlas-mcp-tool": "atlas_get_scheduling_profile", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." }, { "name": "subjectKind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "person", "assignment" ] } }, { "name": "subjectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "effective_on", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Civil date; default today." } ], "responses": { "200": { "description": "Native typed result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforcePlanningResult" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Content-Type must be application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/workforce/scheduling-profiles/{subjectKind}/{subjectId}/preview": { "post": { "operationId": "preview_scheduling_profile", "summary": "Preview a profile revision", "description": "Read only. Field issues, contradictions with Person-wide restrictions, effective availability and affected drafts and future published commitments.", "x-atlas-mcp-tool": "atlas_preview_scheduling_profile", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." }, { "name": "subjectKind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "person", "assignment" ] } }, { "name": "subjectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforceSchedulingProfilePreviewInput" } } } }, "responses": { "200": { "description": "Native typed result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforcePlanningResult" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Content-Type must be application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/workforce/scheduling-profiles/{subjectKind}/{subjectId}/revisions": { "post": { "operationId": "save_scheduling_profile", "summary": "Save an effective profile revision", "description": "Creates an immutable revision at expected_revision (0 when none exists) with a reason. Drafts and published schedules are not edited; their impact is reported.", "x-atlas-mcp-tool": "atlas_save_scheduling_profile", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Stable native operation key. Reuse it as request_key through MCP; a changed body under the same key conflicts." }, { "name": "subjectKind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "person", "assignment" ] } }, { "name": "subjectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforceSchedulingProfileRevisionInput" } } } }, "responses": { "200": { "description": "Native typed result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforcePlanningResult" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Content-Type must be application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/workforce/scheduling-profile-changes": { "get": { "operationId": "list_scheduling_profile_changes", "summary": "List employee scheduling changes", "description": "Employee changes by status (default pending_review) for manager review.", "x-atlas-mcp-tool": "atlas_list_scheduling_profile_changes", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "pending_review", "applied", "withdrawn", "rejected" ] }, "description": "Default pending_review." }, { "name": "person_id", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" }, "description": "Restrict to one Person." }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Continuation from the previous page's nextCursor." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 }, "description": "Page size." } ], "responses": { "200": { "description": "Native typed result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforcePlanningPage" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Content-Type must be application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/workforce/scheduling-profile-changes/{changeId}/resolve": { "post": { "operationId": "resolve_scheduling_profile_change", "summary": "Approve or reject an employee change", "description": "Approval creates the effective revision through the profile command and rechecks the change's base revision. A repeated identical resolution replays; self-approval is refused.", "x-atlas-mcp-tool": "atlas_resolve_scheduling_profile_change", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." }, { "name": "changeId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforceSchedulingProfileChangeResolution" } } } }, "responses": { "200": { "description": "Native typed result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforcePlanningResult" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Content-Type must be application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/workforce/scheduling-patterns": { "get": { "operationId": "list_scheduling_patterns", "summary": "List scheduling patterns", "description": "Typed daily, weekly, rotation and historical legacy_rotation patterns at their current revision. Requires manage_rotations.", "x-atlas-mcp-tool": "atlas_list_scheduling_patterns", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." }, { "name": "kind", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "daily", "weekly", "rotation", "legacy_rotation" ] }, "description": "Restrict to one kind." }, { "name": "include_archived", "in": "query", "required": false, "schema": { "type": "boolean", "default": false }, "description": "Include archived patterns." }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Continuation from the previous page's nextCursor." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 }, "description": "Page size." } ], "responses": { "200": { "description": "Native typed result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforcePlanningPage" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Content-Type must be application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "operationId": "create_scheduling_pattern", "summary": "Create a typed pattern", "description": "Validates like preview before saving. A body naming pattern_id or expected_revision is refused; revise an existing pattern with PUT.", "x-atlas-mcp-tool": "atlas_save_scheduling_pattern", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Stable native operation key. Reuse it as request_key through MCP; a changed body under the same key conflicts." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforceSchedulingPatternCreate" } } } }, "responses": { "200": { "description": "Native typed result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforcePlanningResult" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Content-Type must be application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/workforce/scheduling-patterns/preview": { "post": { "operationId": "preview_scheduling_pattern", "summary": "Preview a new pattern", "description": "Read only. Field issues, references and the elapsed, paid, contract and productive minutes of each alternative.", "x-atlas-mcp-tool": "atlas_preview_scheduling_pattern", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforceSchedulingPatternPreviewInput" } } } }, "responses": { "200": { "description": "Native typed result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforcePlanningResult" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Content-Type must be application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/workforce/scheduling-patterns/{patternId}": { "get": { "operationId": "get_scheduling_pattern", "summary": "Read a pattern", "description": "Current revision, immutable revision history and usage by patterns, effective assignments and issued schedules.", "x-atlas-mcp-tool": "atlas_get_scheduling_pattern", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." }, { "name": "patternId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Native typed result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforcePlanningResult" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Content-Type must be application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "put": { "operationId": "revise_scheduling_pattern", "summary": "Revise a pattern", "description": "Saves a new revision at expected_revision with a reason; earlier revisions remain immutable for issued schedules.", "x-atlas-mcp-tool": "atlas_save_scheduling_pattern", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Stable native operation key. Reuse it as request_key through MCP; a changed body under the same key conflicts." }, { "name": "patternId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforceSchedulingPatternRevision" } } } }, "responses": { "200": { "description": "Native typed result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforcePlanningResult" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Content-Type must be application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/workforce/scheduling-patterns/{patternId}/preview": { "post": { "operationId": "preview_scheduling_pattern_revision", "summary": "Preview a pattern revision", "description": "Read only. Includes a stale expected_revision and the usage the revision would affect.", "x-atlas-mcp-tool": "atlas_preview_scheduling_pattern", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." }, { "name": "patternId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforceSchedulingPatternPreviewInput" } } } }, "responses": { "200": { "description": "Native typed result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforcePlanningResult" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Content-Type must be application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/workforce/scheduling-patterns/{patternId}/archive": { "post": { "operationId": "archive_scheduling_pattern", "summary": "Archive a pattern", "description": "Retains history and issued evidence and lists current usages. A repeated archive at the same revision replays.", "x-atlas-mcp-tool": "atlas_archive_scheduling_pattern", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." }, { "name": "patternId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforceSchedulingPatternArchive" } } } }, "responses": { "200": { "description": "Native typed result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforcePlanningResult" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Content-Type must be application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/workforce/rotation-assignments": { "get": { "operationId": "list_rotation_assignments", "summary": "List effective pattern assignments", "description": "Weekly, rotation and historical assignments with anchors and civil date ranges.", "x-atlas-mcp-tool": "atlas_list_rotation_assignments", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." }, { "name": "person_id", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" }, "description": "Restrict to one Person." }, { "name": "active_on", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Effective on this civil date." }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Continuation from the previous page's nextCursor." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 }, "description": "Page size." } ], "responses": { "200": { "description": "Native typed result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforcePlanningPage" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Content-Type must be application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "operationId": "assign_rotation", "summary": "Assign a weekly pattern or rotation", "description": "Assigns a weekly pattern, rotation or historical fixed rotation with a retained anchor week. Daily patterns are not assignable. An unchanged retry returns the recorded assignment.", "x-atlas-mcp-tool": "atlas_assign_rotation", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Stable native operation key. Reuse it as request_key through MCP; a changed body under the same key conflicts." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforceRotationAssignmentCreate" } } } }, "responses": { "200": { "description": "Native typed result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforcePlanningResult" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Content-Type must be application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/workforce/rotation-assignments/{assignmentId}/end": { "post": { "operationId": "end_rotation_assignment", "summary": "End a pattern assignment", "description": "Ends at an inclusive civil date with a reason, retaining history. The same end replays; a different end date conflicts.", "x-atlas-mcp-tool": "atlas_end_rotation_assignment", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." }, { "name": "assignmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforceRotationAssignmentEnd" } } } }, "responses": { "200": { "description": "Native typed result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforcePlanningResult" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Content-Type must be application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/workforce/scheduling-groups/{groupId}/demand-bindings": { "get": { "operationId": "list_workforce_demand_bindings", "summary": "List demand bindings", "description": "Effective Forecast Group bindings of a supplying Scheduling Group, plus the legacy zero-or-one default selection. Requires manage_schedules for the group.", "x-atlas-mcp-tool": "atlas_list_workforce_demand_bindings", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "include_ended", "in": "query", "required": false, "schema": { "type": "boolean", "default": false }, "description": "Include ended bindings." }, { "name": "effective_on", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Civil date; default today." }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Continuation from the previous page's nextCursor." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 }, "description": "Page size." } ], "responses": { "200": { "description": "Native typed result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforcePlanningPage" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Content-Type must be application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "operationId": "save_workforce_demand_binding", "summary": "Save a demand binding", "description": "Binds eligibility, never a copy of demand. Overlapping additive bindings are refused unless they declare a partition, shared pool or distinct sequential stage.", "x-atlas-mcp-tool": "atlas_save_workforce_demand_binding", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Stable native operation key. Reuse it as request_key through MCP; a changed body under the same key conflicts." }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforceDemandBinding" } } } }, "responses": { "200": { "description": "Native typed result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforcePlanningResult" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Content-Type must be application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/workforce/scheduling-groups/{groupId}/demand-bindings/preview": { "post": { "operationId": "preview_workforce_demand_binding", "summary": "Preview a demand binding", "description": "Read only. Overlaps, partition totals, stage identity, qualification references and affected requirements and drafts.", "x-atlas-mcp-tool": "atlas_preview_workforce_demand_binding", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforceDemandBinding" } } } }, "responses": { "200": { "description": "Native typed result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforcePlanningResult" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Content-Type must be application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/workforce/scheduling-groups/{groupId}/demand-bindings/{bindingId}/end": { "post": { "operationId": "end_workforce_demand_binding", "summary": "End a demand binding", "description": "Ends at an inclusive civil date with a reason, retaining history.", "x-atlas-mcp-tool": "atlas_end_workforce_demand_binding", "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Selector within saved grants and current issuer authority; never grants authority." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Stable native operation key. Reuse it as request_key through MCP; a changed body under the same key conflicts." }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "bindingId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforceDemandBindingEnd" } } } }, "responses": { "200": { "description": "Native typed result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkforcePlanningResult" } } } }, "400": { "description": "Missing or malformed transport fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired bearer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Saved grant or current authority denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale source/revision or conflicting request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Body exceeds 64 KiB", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "Content-Type must be application/json", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or unsupported input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrent compute limit; retry after 5 seconds", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Required evidence or service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } } }, "components": { "securitySchemes": { "AtlasIntegrationBearer": { "type": "http", "scheme": "bearer", "bearerFormat": "atlas_mcp_", "description": "Existing Atlas integration connection with explicit api:connect plus appropriate native domain grants. atlas_ingest_ and browser cookies are not accepted." } }, "schemas": { "Error": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false }, "Range": { "type": "object", "properties": { "from": { "type": "string", "format": "date" }, "to": { "type": "string", "format": "date" } }, "required": [ "from", "to" ], "additionalProperties": false }, "StaffingEvaluationInput": { "type": "object", "properties": { "from": { "type": "string", "format": "date" }, "to": { "type": "string", "format": "date" }, "residual_unplanned_shrinkage": { "type": "number", "minimum": 0, "exclusiveMaximum": 1, "description": "Explicit residual unplanned loss after scheduled nonproductive time; never inferred from total shrinkage." } }, "required": [ "from", "to", "residual_unplanned_shrinkage" ], "additionalProperties": false }, "StaffingComputeInput": { "type": "object", "properties": { "from": { "type": "string", "format": "date" }, "to": { "type": "string", "format": "date" }, "requested_at": { "type": "string", "format": "date-time" }, "residual_unplanned_shrinkage": { "type": "number", "minimum": 0, "exclusiveMaximum": 1, "description": "Explicit residual unplanned loss after scheduled nonproductive time; never inferred from total shrinkage." } }, "required": [ "from", "to", "requested_at", "residual_unplanned_shrinkage" ], "additionalProperties": false }, "DraftIssueInput": { "type": "object", "properties": { "target": { "oneOf": [ { "type": "object", "properties": { "schedule_id": { "type": "string", "format": "uuid" } }, "required": [ "schedule_id" ], "additionalProperties": false }, { "type": "object", "properties": { "group_id": { "type": "string", "format": "uuid" }, "period_start": { "type": "string", "format": "date" }, "period_end": { "type": "string", "format": "date" } }, "required": [ "group_id", "period_start", "period_end" ], "additionalProperties": false } ] }, "options": { "type": "object", "properties": { "shiftLengthHours": { "type": "number", "minimum": 1, "maximum": 12 }, "earliestStartMin": { "type": "integer", "minimum": 0, "maximum": 1440 }, "latestEndMin": { "type": "integer", "minimum": 0, "maximum": 2880 }, "maxWeeklyHours": { "type": "number", "minimum": 1, "maximum": 40 }, "optimize": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "target" ], "additionalProperties": false }, "NativeEvidence": { "type": "object", "description": "Native domain evidence. Inspect state, errors, source_context and result; an issued request is not a committed schedule.", "additionalProperties": true }, "WorkforceReadiness": { "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid" }, "observed_at": { "type": "string", "format": "date-time" }, "counts": { "type": "object", "properties": { "operating_calendars": { "type": "integer", "minimum": 0 }, "operating_calendar_bindings": { "type": "integer", "minimum": 0 }, "forecast_groups": { "type": "integer", "minimum": 0 }, "scheduling_groups": { "type": "integer", "minimum": 0 } }, "required": [ "operating_calendars", "operating_calendar_bindings", "forecast_groups", "scheduling_groups" ], "additionalProperties": true }, "state": { "const": "unavailable" }, "configuration_state": { "enum": [ "incomplete", "present_unverified" ] }, "reason_codes": { "type": "array", "items": { "type": "string" } }, "source_verification": { "type": "string" }, "queue_settings": { "oneOf": [ { "type": "object", "required": [ "state", "queues" ], "properties": { "state": { "const": "available" }, "queues": { "type": "array", "maxItems": 200, "items": { "type": "object", "required": [ "queueId", "name", "serviceGoal" ], "properties": { "queueId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "serviceGoal": { "type": "object", "required": [ "state", "percentage", "seconds" ], "properties": { "state": { "enum": [ "configured", "unknown", "conflicting" ] }, "percentage": { "anyOf": [ { "$ref": "#/components/schemas/WorkforceQueueSetting" }, { "type": "null" } ] }, "seconds": { "anyOf": [ { "$ref": "#/components/schemas/WorkforceQueueSetting" }, { "type": "null" } ] } } } } } } } }, { "type": "object", "required": [ "state", "reason_codes" ], "properties": { "state": { "const": "unavailable" }, "reason_codes": { "type": "array", "items": { "type": "string" } } } } ] } }, "required": [ "workspace_id", "observed_at", "counts", "state", "configuration_state", "reason_codes" ], "additionalProperties": true }, "RequirementPortion": { "type": "object", "properties": { "startTs": { "type": "string", "format": "date-time" }, "endTs": { "type": "string", "format": "date-time" }, "requiredPeople": { "type": "number", "minimum": 0, "description": "Gross presence people, including configured total shrinkage." }, "netRequiredPeople": { "type": "number", "minimum": 0, "description": "Exact native net demand. Absent on historical evidence; never reconstructed from gross." }, "residualUnplannedShrinkage": { "type": "number", "minimum": 0, "exclusiveMaximum": 1 }, "residualAssumption": { "enum": [ "no_additional_unplanned_loss", "explicit_residual_unplanned_loss" ] } }, "required": [ "startTs", "endTs", "requiredPeople" ], "additionalProperties": true }, "RequirementDay": { "type": "object", "properties": { "date": { "type": "string", "format": "date" }, "slotMinutes": { "type": "number" }, "openMin": { "type": "number" }, "closeMin": { "type": "number" }, "requiredBySlot": { "type": "array", "items": { "type": "number", "minimum": 0 }, "description": "Gross presence people." }, "computedAt": { "type": [ "string", "null" ], "format": "date-time" }, "sourceMode": { "type": [ "string", "null" ] }, "intervalEvidence": { "oneOf": [ { "type": "null" }, { "type": "object", "properties": { "startTs": { "type": "string", "format": "date-time" }, "endTs": { "type": "string", "format": "date-time" }, "intervals": { "type": "array", "items": { "$ref": "#/components/schemas/RequirementPortion" } } }, "required": [ "startTs", "endTs", "intervals" ], "additionalProperties": true } ] }, "forecastGroupVersionId": { "type": [ "string", "null" ] }, "predictionRunIds": { "type": [ "array", "null" ], "items": { "type": "string" } } }, "required": [ "date", "slotMinutes", "openMin", "closeMin", "requiredBySlot", "computedAt", "intervalEvidence" ], "additionalProperties": true }, "StaffingRequirements": { "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid" }, "group_id": { "type": "string", "format": "uuid" }, "from": { "type": "string", "format": "date" }, "to": { "type": "string", "format": "date" }, "days": { "type": "array", "items": { "$ref": "#/components/schemas/RequirementDay" } }, "evidence_state": { "enum": [ "complete", "partial", "unavailable" ] }, "missing_days": { "type": "integer", "minimum": 0 }, "units": { "type": "object", "properties": { "requiredBySlot": { "const": "gross_presence_people" }, "net": { "const": "exact_net_required_people_when_retained" } }, "required": [], "additionalProperties": true } }, "required": [ "workspace_id", "group_id", "from", "to", "days", "evidence_state", "missing_days", "units" ], "additionalProperties": true }, "PreparedDemandInterval": { "type": "object", "properties": { "date": { "type": "string", "format": "date" }, "startTs": { "type": "string", "format": "date-time" }, "endTs": { "type": "string", "format": "date-time" }, "localLabel": { "type": "string" }, "slotMinutes": { "type": "number", "minimum": 0 }, "offeredInteractions": { "type": "number", "minimum": 0 }, "workloadSeconds": { "type": "number", "minimum": 0 }, "effectiveAhtSeconds": { "type": "number", "minimum": 0 }, "netRequiredAgents": { "type": "number", "minimum": 0 }, "capped": { "type": "boolean" }, "unrepresentable": { "type": "boolean" } }, "required": [ "date", "startTs", "endTs", "slotMinutes", "offeredInteractions", "workloadSeconds", "effectiveAhtSeconds", "netRequiredAgents", "capped" ], "additionalProperties": true }, "StaffingEvaluation": { "type": "object", "properties": { "sourceMode": { "enum": [ "prediction", "manual", "mixed" ] }, "intervals": { "type": "array", "items": { "$ref": "#/components/schemas/PreparedDemandInterval" } }, "closedDates": { "type": "array", "items": { "type": "string", "format": "date" } }, "residualUnplannedShrinkage": { "type": "number", "minimum": 0, "exclusiveMaximum": 1 }, "coverageContract": { "const": "productive_supply_after_residual_vs_exact_net_requirement" }, "volumeRun": { "type": [ "object", "null" ] }, "ahtRun": { "type": [ "object", "null" ] }, "calendarSource": { "enum": [ "calendar", "profile" ] }, "calendarId": { "type": [ "string", "null" ] } }, "required": [ "sourceMode", "intervals", "closedDates", "residualUnplannedShrinkage", "coverageContract" ], "additionalProperties": true }, "StaffingComputeResult": { "type": "object", "properties": { "days": { "type": "integer", "minimum": 0 }, "predictionRunId": { "type": [ "string", "null" ] } }, "required": [ "days", "predictionRunId" ], "additionalProperties": true }, "DraftEffect": { "type": "object", "properties": { "scheduleId": { "type": "string", "format": "uuid" }, "createdSchedule": { "type": "boolean" }, "native": { "type": "object", "properties": { "inserted_shifts": { "type": "integer", "minimum": 0 }, "inserted_activities": { "type": "integer", "minimum": 0 } }, "required": [ "inserted_shifts", "inserted_activities" ], "additionalProperties": true }, "shifts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "objectRecordId": { "type": "string", "format": "uuid" }, "startTs": { "type": "string", "format": "date-time" }, "endTs": { "type": "string", "format": "date-time" } }, "required": [ "id", "objectRecordId", "startTs", "endTs" ], "additionalProperties": true } } }, "required": [ "scheduleId", "createdSchedule", "native", "shifts" ], "additionalProperties": true }, "DraftRequest": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workspace_id": { "type": "string", "format": "uuid" }, "request_key": { "type": "string", "format": "uuid" }, "actor_id": { "type": "string", "format": "uuid" }, "person_id": { "type": "string", "format": "uuid" }, "kind": { "enum": [ "generated", "rotation" ] }, "input": { "type": "object" }, "source_context": { "type": "object", "description": "Native fenced source snapshot; never replace on retry." }, "preparation": { "type": "object", "description": "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": { "oneOf": [ { "$ref": "#/components/schemas/DraftEffect" }, { "type": "null" } ] }, "committed_at": { "type": [ "string", "null" ], "format": "date-time" }, "expires_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "workspace_id", "request_key", "actor_id", "person_id", "kind", "input", "source_context", "preparation", "result", "committed_at", "expires_at" ], "additionalProperties": true }, "DraftCommitResult": { "type": "object", "properties": { "request": { "$ref": "#/components/schemas/DraftRequest" }, "replayed": { "type": "boolean" } }, "required": [ "request", "replayed" ], "additionalProperties": true }, "CoverageDay": { "type": "object", "additionalProperties": true, "properties": { "date": { "type": "string", "format": "date" }, "state": { "type": "string", "enum": [ "sufficient", "critical", "full", "uncovered", "unknown" ] }, "reason_codes": { "type": "array", "items": { "type": "string" } }, "supply_basis": { "type": "string" }, "requirement_basis": { "type": [ "string", "null" ] }, "productive_people_by_interval": { "type": [ "array", "null" ], "items": { "type": "number" } }, "effective_productive_people_by_interval": { "type": [ "array", "null" ], "items": { "type": "number" } }, "net_required_people_by_interval": { "type": [ "array", "null" ], "items": { "type": "number" } }, "demand_timeline": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "start_ts": { "type": "string", "format": "date-time" }, "end_ts": { "type": "string", "format": "date-time" }, "net_required_people": { "type": "number" }, "residual_unplanned_shrinkage": { "type": "number", "minimum": 0, "exclusiveMaximum": 1 }, "productive_people": { "type": "number" }, "effective_productive_people": { "type": "number" }, "net_people": { "type": "number" } }, "required": [ "start_ts", "end_ts", "net_required_people", "residual_unplanned_shrinkage", "productive_people", "effective_productive_people", "net_people" ] } }, "assessment": { "type": "string", "enum": [ "assessed", "not_assessed", "not_applicable" ], "description": "Missing exact net or residual evidence is not_assessed, never positive coverage. Physical supply remains available; demand facts are null." } }, "required": [ "date", "state", "reason_codes", "supply_basis", "requirement_basis", "demand_timeline", "assessment" ] }, "Coverage": { "type": "object", "properties": { "unscheduled_dates": { "type": "array", "items": { "type": "string", "format": "date" } }, "days": { "type": "array", "items": { "$ref": "#/components/schemas/CoverageDay" } } }, "required": [ "unscheduled_dates", "days" ] }, "SchedulingGroupCreate": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "timezone": { "type": "string" }, "operating_open": { "type": "string", "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d)?$" }, "operating_close": { "type": "string", "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d)?$" }, "slot_minutes": { "default": 30, "type": "integer", "minimum": 1, "maximum": 240 }, "allowed_max_ooo_pct": { "default": 100, "type": "number", "exclusiveMinimum": 0, "maximum": 100 }, "ceiling_profile": { "default": null, "anyOf": [ { "type": "object", "propertyNames": { "type": "string", "enum": [ "mon", "tue", "wed", "thu", "fri", "sat", "sun" ] }, "additionalProperties": { "type": "number", "exclusiveMinimum": 0, "maximum": 100 } }, { "type": "null" } ] }, "minimum_floor": { "default": null, "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "warn_threshold": { "default": null, "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "include_pending": { "default": true, "type": "boolean" }, "operating_profile": { "default": null, "anyOf": [ { "type": "object", "propertyNames": { "type": "string", "enum": [ "mon", "tue", "wed", "thu", "fri", "sat", "sun" ] }, "additionalProperties": { "type": "object", "properties": { "open": { "type": "string", "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d)?$" }, "close": { "type": "string", "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d)?$" }, "closed": { "type": "boolean" } }, "required": [ "open", "close", "closed" ], "additionalProperties": false } }, { "type": "null" } ] }, "default_forecast_group_id": { "default": null, "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "forecast_group_operation_key": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "request_key": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "expected_forecast_revision": { "type": "integer", "minimum": 1, "description": "Expected current revision when linking an existing forecast group. Setup preview captures this automatically." } }, "required": [ "name", "timezone", "operating_open", "operating_close" ], "additionalProperties": false }, "SchedulingMemberCreate": { "type": "object", "properties": { "request_key": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "subject": { "anyOf": [ { "type": "object", "properties": { "person_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "person_id" ], "additionalProperties": false }, { "type": "object", "properties": { "employment_assignment_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "employment_assignment_id" ], "additionalProperties": false } ] }, "valid_from": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "valid_to": { "default": null, "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, { "type": "null" } ] }, "is_primary": { "default": false, "type": "boolean" }, "fte_weight": { "default": 1, "type": "number", "exclusiveMinimum": 0, "maximum": 1 }, "member_state": { "default": "active", "type": "string", "enum": [ "active", "on_leave", "in_training", "ramping" ] }, "reason": { "type": "string", "minLength": 1, "maxLength": 2000 } }, "required": [ "subject", "valid_from", "reason" ], "additionalProperties": false }, "ForecastGroupPublication": { "type": "object", "properties": { "forecastGroupId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "operationKey": { "type": "string", "minLength": 1, "maxLength": 256 }, "effectiveFrom": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "expectedSourceFingerprint": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "configuration": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "ownerActorId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "scope": { "type": "object", "properties": { "objectType": { "type": "string", "minLength": 1 }, "objectId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "filters": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "targetType": { "type": "string", "enum": [ "object", "attribute", "metric", "time" ] }, "ref": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "enum": [ "eq", "neq", "in", "not_in", "gt", "gte", "lt", "lte", "between", "contains", "is_null", "is_not_null" ] }, "value": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, { "type": "null" } ] } }, "required": [ "targetType", "ref", "operator" ], "additionalProperties": false } }, { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, { "type": "null" } ] } } ] }, "time": { "oneOf": [ { "type": "object", "properties": { "mode": { "type": "string", "const": "event_time" } }, "required": [ "mode" ], "additionalProperties": false }, { "type": "object", "properties": { "mode": { "type": "string", "const": "reconstruction" }, "effectiveAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" } }, "required": [ "mode", "effectiveAt" ], "additionalProperties": false } ] } }, "required": [ "objectType", "objectId", "filters" ], "additionalProperties": false }, "demand": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "prediction", "manual" ] }, "prediction_definition_id": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "queue_object_record_id": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "aht_seconds": { "type": "number", "exclusiveMinimum": 0 }, "aht_source": { "type": "string", "enum": [ "config", "forecast" ] }, "service_level": { "type": "object", "properties": { "pct": { "type": "number", "exclusiveMinimum": 0, "maximum": 100 }, "seconds": { "type": "number", "minimum": 0 } }, "required": [ "pct", "seconds" ] }, "service_model": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "live_voice" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "concurrent_messaging" }, "average_conversation_seconds": { "type": "number", "exclusiveMinimum": 0 }, "max_concurrent_conversations_per_person": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "kind", "average_conversation_seconds", "max_concurrent_conversations_per_person" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "backlog" }, "opening_backlog_work_seconds": { "type": "number", "minimum": 0 }, "rework_rate": { "type": "number", "minimum": 0, "maximum": 1 }, "due_work_rate": { "type": "number", "minimum": 0, "maximum": 1 } }, "required": [ "kind", "opening_backlog_work_seconds", "rework_rate", "due_work_rate" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "ai" }, "service_seconds_per_attempt": { "type": "number", "exclusiveMinimum": 0 }, "tokens_per_attempt": { "type": "number", "minimum": 0 }, "max_concurrency": { "type": "number", "exclusiveMinimum": 0 }, "request_limit": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "token_limit": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "attempt_success_rate": { "type": "number", "minimum": 0, "maximum": 1 }, "max_retries": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "escalation_rate": { "type": "number", "minimum": 0, "maximum": 1 }, "human_seconds_per_escalation": { "type": "number", "minimum": 0 } }, "required": [ "kind", "service_seconds_per_attempt", "tokens_per_attempt", "max_concurrency", "request_limit", "token_limit", "attempt_success_rate", "max_retries", "escalation_rate", "human_seconds_per_escalation" ], "additionalProperties": false } ] }, "shrinkage_pct": { "default": 0, "type": "number", "minimum": 0, "exclusiveMaximum": 100 }, "occupancy_cap_pct": { "anyOf": [ { "type": "number", "exclusiveMinimum": 0, "maximum": 100 }, { "type": "null" } ] }, "min_agents": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "manual_volume_profile": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string", "pattern": "^(sun|mon|tue|wed|thu|fri|sat)$" }, "additionalProperties": { "type": "array", "items": { "type": "number", "minimum": 0 } } }, { "type": "null" } ] } }, "required": [ "mode", "aht_seconds", "service_level" ] }, { "type": "object", "properties": { "mode": { "type": "string", "const": "off" } }, "required": [ "mode" ] } ] }, { "type": "null" } ] }, "calendarId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "serviceTargetId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "grainMinutes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 240 }, "planningTimezone": { "type": "string" }, "reportingTimezone": { "type": "string" }, "horizonDays": { "type": "integer", "exclusiveMinimum": 0, "maximum": 730 }, "cadence": { "anyOf": [ { "type": "object", "properties": { "localTime": { "type": "string", "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$" } }, "required": [ "localTime" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "name", "ownerActorId", "scope", "demand", "calendarId", "serviceTargetId", "grainMinutes", "planningTimezone", "reportingTimezone", "horizonDays" ], "additionalProperties": false } }, "required": [ "forecastGroupId", "expectedRevision", "effectiveFrom", "configuration" ], "additionalProperties": false }, "WorkforceSetupPreview": { "type": "object", "properties": { "window": { "type": "object", "properties": { "start": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "end": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "timezone": { "type": "string", "minLength": 1 } }, "required": [ "start", "end", "timezone" ], "additionalProperties": false }, "recommendations": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "minLength": 1, "maxLength": 100 }, "kind": { "type": "string", "enum": [ "forecast_group", "scheduling_group", "scheduling_profile", "scheduling_pattern", "rotation_assignment", "demand_binding" ] }, "reason": { "type": "string", "maxLength": 2000 }, "evidenceRefs": { "maxItems": 50, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "assumptions": { "maxItems": 30, "type": "array", "items": { "type": "string", "maxLength": 1000 } }, "configuration": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "forecastGroupKey": { "type": "string", "minLength": 1, "maxLength": 100 }, "refs": { "type": "object", "propertyNames": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 100 } }, "review": { "type": "object", "properties": { "planning": { "type": "object", "properties": { "from": { "type": "string" }, "to": { "type": "string" }, "timezone": { "type": "string" }, "residualUnplannedShrinkage": { "type": "number", "minimum": 0, "exclusiveMaximum": 1 }, "basis": { "type": "string", "minLength": 1, "maxLength": 2000 }, "evidenceRefs": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } } }, "required": [ "from", "to", "timezone", "residualUnplannedShrinkage", "basis", "evidenceRefs" ], "additionalProperties": false }, "queues": { "default": [], "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "maxLength": 200 }, "name": { "type": "string", "maxLength": 2000 }, "interactions": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] }, "handleTime": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] }, "calendar": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] }, "serviceTarget": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] }, "grain": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] }, "evidenceRefs": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } } }, "required": [ "id", "name", "interactions", "handleTime", "calendar", "serviceTarget", "grain", "evidenceRefs" ], "additionalProperties": false } }, "people": { "default": [], "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 2000 }, "personId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "memberRequestKey": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "providerLink": { "type": "string", "maxLength": 2000 }, "workHandled": { "type": "string", "maxLength": 2000 }, "assignment": { "type": "string", "maxLength": 2000 }, "qualification": { "type": "string", "maxLength": 2000 }, "availability": { "type": "string", "maxLength": 2000 }, "exclusion": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] }, "evidenceRefs": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } } }, "required": [ "name", "personId", "memberRequestKey", "providerLink", "workHandled", "assignment", "qualification", "availability", "exclusion", "evidenceRefs" ], "additionalProperties": false } }, "decisions": { "default": [], "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "maxLength": 100 }, "question": { "type": "string", "maxLength": 2000 }, "explanation": { "type": "string", "maxLength": 2000 }, "field": { "type": "string", "enum": [ "calendar", "service_target", "context" ] } }, "required": [ "key", "question", "explanation", "field" ], "additionalProperties": false } }, "evidence": { "default": [], "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "summary": { "type": "string", "maxLength": 2000 }, "resultRefs": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } } }, "required": [ "summary", "resultRefs" ], "additionalProperties": false } }, "reuses": { "default": [], "maxItems": 30, "type": "array", "items": { "type": "string", "maxLength": 2000 } } }, "additionalProperties": false }, "members": { "default": [], "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "request_key": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "subject": { "anyOf": [ { "type": "object", "properties": { "person_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "person_id" ], "additionalProperties": false }, { "type": "object", "properties": { "employment_assignment_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "employment_assignment_id" ], "additionalProperties": false } ] }, "valid_from": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "valid_to": { "default": null, "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, { "type": "null" } ] }, "is_primary": { "default": false, "type": "boolean" }, "fte_weight": { "default": 1, "type": "number", "exclusiveMinimum": 0, "maximum": 1 }, "member_state": { "default": "active", "type": "string", "enum": [ "active", "on_leave", "in_training", "ramping" ] }, "reason": { "type": "string", "minLength": 1, "maxLength": 2000 } }, "required": [ "request_key", "subject", "valid_from", "reason" ], "additionalProperties": false } } }, "required": [ "key", "kind", "reason", "evidenceRefs", "assumptions", "configuration" ], "additionalProperties": false } }, "issues": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "maxLength": 120 }, "message": { "type": "string", "maxLength": 2000 }, "category": { "type": "string", "enum": [ "decision", "staffing", "evidence" ] }, "reason": { "type": "string", "enum": [ "missing", "denied", "unavailable", "stale", "incomplete", "choice" ] }, "recommendationKeys": { "maxItems": 20, "type": "array", "items": { "type": "string", "maxLength": 100 } }, "evidenceRefs": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } } }, "required": [ "code", "message" ], "additionalProperties": false } } }, "required": [ "recommendations", "issues" ], "additionalProperties": false }, "WorkforceSetupApply": { "type": "object", "properties": { "sessionId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "resultRef": { "type": "string", "minLength": 1, "maxLength": 200 }, "key": { "type": "string", "minLength": 1, "maxLength": 100 }, "memberRequestKey": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "sessionId", "resultRef", "key" ], "additionalProperties": false }, "ConfigurationReceipt": { "type": "object", "properties": { "outcome": { "const": "committed" }, "replayed": { "type": "boolean" }, "request_key": { "type": "string", "format": "uuid" }, "record_id": { "type": "string", "format": "uuid" }, "request": { "type": "object", "description": "Immutable original actor, person, kind, parent and configuration evidence." }, "record": { "type": "object", "description": "Current native group or membership row; the original request is retained separately." } }, "required": [ "outcome", "replayed", "request_key", "record_id", "request", "record" ] }, "WorkforceSetupAssessment": { "type": "object", "properties": { "kind": { "const": "workforce_setup_assessment" }, "workspaceId": { "type": "string", "format": "uuid" }, "revision": { "type": "string", "format": "uuid" }, "observedAt": { "type": "string", "format": "date-time" }, "recommendations": { "type": "array", "maxItems": 20, "items": { "type": "object", "properties": { "key": { "type": "string" }, "kind": { "enum": [ "forecast_group", "scheduling_group" ] }, "reason": { "type": "string" }, "configuration": { "type": "object" }, "command": { "type": [ "object", "null" ], "description": "Exact native command, including generated retry key and captured source fingerprint. Null when validation fails." }, "createReady": { "type": "boolean" }, "operationalReadiness": { "const": "not_verified" }, "issues": { "type": "array", "items": { "type": "string" } }, "evidenceRefs": { "type": "array", "items": { "type": "string" } }, "assumptions": { "type": "array", "items": { "type": "string" } }, "forecastGroupKey": { "type": "string" }, "members": { "type": "array", "maxItems": 100, "items": { "$ref": "#/components/schemas/SchedulingMemberCreate" } }, "review": { "$ref": "#/components/schemas/WorkforceSetupReview" } }, "required": [ "key", "kind", "configuration", "command", "createReady", "operationalReadiness", "issues", "members" ] } }, "issues": { "type": "array", "items": { "$ref": "#/components/schemas/WorkforceSetupFinding" } }, "window": { "$ref": "#/components/schemas/WorkforceAssessmentWindow" } }, "required": [ "kind", "workspaceId", "revision", "observedAt", "recommendations", "issues" ] }, "WorkforceSetupApplyResult": { "type": "object", "properties": { "outcome": { "const": "committed" }, "kind": { "enum": [ "forecast_group", "scheduling_group", "member" ] }, "recordId": { "type": "string", "format": "uuid" }, "receipt": { "type": "object", "description": "Native publication version or configuration receipt." } }, "required": [ "outcome", "kind", "recordId", "receipt" ] }, "WorkforceAssessmentWindow": { "type": "object", "additionalProperties": false, "required": [ "start", "end", "timezone" ], "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "timezone": { "type": "string", "description": "Valid IANA history timezone" } }, "description": "Requested historical evidence window, strictly positive and at most 366 elapsed days. Does not assert source completeness." }, "WorkforceSetupCheckResult": { "type": "object", "required": [ "checkedAt", "revision", "checks" ], "properties": { "checkedAt": { "type": "string", "format": "date-time" }, "revision": { "type": "string" }, "checks": { "type": "array", "maxItems": 120, "items": { "type": "object", "required": [ "key", "status", "message" ], "properties": { "key": { "type": "string" }, "status": { "enum": [ "ready", "verified", "not_confirmed", "changed", "blocked", "unknown" ] }, "message": { "type": "string" }, "recordId": { "type": "string" } } } } } }, "WorkforceSetupHistory": { "type": "object", "required": [ "sessionId", "history", "historyLength", "workforceAssessment", "workforceAssessmentResultRef", "assessmentVersions", "state", "assessmentAvailability" ], "properties": { "sessionId": { "type": "string", "format": "uuid" }, "history": { "type": "array", "items": { "type": "object" } }, "historySources": { "type": "array", "items": { "type": [ "string", "null" ] } }, "historyLength": { "type": "integer" }, "workforceAssessment": { "anyOf": [ { "$ref": "#/components/schemas/WorkforceSetupAssessment" }, { "type": "null" } ] }, "workforceAssessmentResultRef": { "type": [ "string", "null" ] }, "assessmentWorkspace": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" } } }, "assessmentWindow": { "type": [ "object", "null" ], "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "timezone": { "type": "string" } } }, "assessmentVersions": { "type": "array", "items": { "type": "object", "properties": { "resultRef": { "type": "string" }, "revision": { "type": "integer" }, "current": { "type": "boolean" }, "observedAt": { "type": "string", "format": "date-time" } } } }, "state": { "type": "object", "properties": { "status": { "type": "string" }, "turnId": { "type": "string" }, "step": { "type": "integer" }, "error": { "type": "string" } } }, "assessmentAvailability": { "type": "object", "required": [ "state" ], "properties": { "state": { "enum": [ "available", "unavailable", "pending", "wrong_workspace" ] }, "reason": { "type": "string" }, "code": { "type": "string", "description": "Actionable evidence-read code, including workforce.budget_exceeded." }, "capped": { "type": "boolean", "description": "True when evidence reauthorization reached its bound. No partially checked source content is returned; authorized run status and stop controls remain available." } } }, "progress": { "type": "object", "required": [ "startedAt", "steps" ], "properties": { "startedAt": { "type": "string", "format": "date-time" }, "steps": { "type": "array", "items": { "type": "object", "required": [ "id", "label", "detail", "state" ], "properties": { "id": { "enum": [ "sources", "demand", "people", "plan" ] }, "label": { "type": "string" }, "detail": { "type": "string" }, "state": { "enum": [ "waiting", "checking", "checked", "needs_attention" ] } } } }, "timezone": { "type": "string", "description": "Operating timezone of the requested setup history window, when available." } } } } }, "WorkforceSetupCheck": { "type": "object", "properties": { "sessionId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "resultRef": { "type": "string", "minLength": 1, "maxLength": 200 }, "mode": { "type": "string", "enum": [ "preflight", "verify" ] }, "keys": { "minItems": 1, "maxItems": 120, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 } } }, "required": [ "sessionId", "resultRef", "mode", "keys" ], "additionalProperties": false }, "WorkforceSetupRead": { "type": "object", "properties": { "sessionId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "resultRef": { "type": "string", "minLength": 1, "maxLength": 200 }, "after": { "default": 0, "type": "integer", "minimum": 0, "maximum": 100000 }, "view": { "default": "history", "type": "string", "enum": [ "history", "summary" ] } }, "required": [ "sessionId" ], "additionalProperties": false }, "WorkforceSetupReview": { "type": "object", "properties": { "planning": { "type": "object", "properties": { "from": { "type": "string" }, "to": { "type": "string" }, "timezone": { "type": "string" }, "residualUnplannedShrinkage": { "type": "number", "minimum": 0, "exclusiveMaximum": 1 }, "basis": { "type": "string", "minLength": 1, "maxLength": 2000 }, "evidenceRefs": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } } }, "required": [ "from", "to", "timezone", "residualUnplannedShrinkage", "basis", "evidenceRefs" ], "additionalProperties": false }, "queues": { "default": [], "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "maxLength": 200 }, "name": { "type": "string", "maxLength": 2000 }, "interactions": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] }, "handleTime": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] }, "calendar": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] }, "serviceTarget": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] }, "grain": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] }, "evidenceRefs": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } } }, "required": [ "id", "name", "interactions", "handleTime", "calendar", "serviceTarget", "grain", "evidenceRefs" ], "additionalProperties": false } }, "people": { "default": [], "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 2000 }, "personId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "memberRequestKey": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "providerLink": { "type": "string", "maxLength": 2000 }, "workHandled": { "type": "string", "maxLength": 2000 }, "assignment": { "type": "string", "maxLength": 2000 }, "qualification": { "type": "string", "maxLength": 2000 }, "availability": { "type": "string", "maxLength": 2000 }, "exclusion": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] }, "evidenceRefs": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } } }, "required": [ "name", "personId", "memberRequestKey", "providerLink", "workHandled", "assignment", "qualification", "availability", "exclusion", "evidenceRefs" ], "additionalProperties": false } }, "decisions": { "default": [], "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "maxLength": 100 }, "question": { "type": "string", "maxLength": 2000 }, "explanation": { "type": "string", "maxLength": 2000 }, "field": { "type": "string", "enum": [ "calendar", "service_target", "context" ] } }, "required": [ "key", "question", "explanation", "field" ], "additionalProperties": false } }, "evidence": { "default": [], "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "summary": { "type": "string", "maxLength": 2000 }, "resultRefs": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } } }, "required": [ "summary", "resultRefs" ], "additionalProperties": false } }, "reuses": { "default": [], "maxItems": 30, "type": "array", "items": { "type": "string", "maxLength": 2000 } } }, "additionalProperties": false }, "WorkforceSetupFinding": { "type": "object", "properties": { "code": { "type": "string", "maxLength": 120 }, "message": { "type": "string", "maxLength": 2000 }, "category": { "type": "string", "enum": [ "decision", "staffing", "evidence" ] }, "reason": { "type": "string", "enum": [ "missing", "denied", "unavailable", "stale", "incomplete", "choice" ] }, "recommendationKeys": { "maxItems": 20, "type": "array", "items": { "type": "string", "maxLength": 100 } }, "evidenceRefs": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } } }, "required": [ "code", "message" ], "additionalProperties": false }, "WorkforceForecastGroupOptions": { "type": "object", "required": [ "owners", "serviceTargets", "calendars" ], "properties": { "reportingTimezone": { "type": [ "string", "null" ], "description": "The configured workspace reporting timezone. Never inferred from the client device." }, "owners": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "displayName": { "type": "string" } } } }, "serviceTargets": { "type": "array", "items": { "type": "object", "description": "Current authorized compatible Metric Target with metric and serviceLevel evidence." } }, "calendars": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "timezone": { "type": "string" } } } } } }, "WorkforceSetupDelete": { "type": "object", "properties": { "sessionId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "sessionId" ], "additionalProperties": false }, "WorkforceQueueSetting": { "type": "object", "required": [ "value", "effectiveFrom", "effectiveTo", "recordedAt", "sourceSystem", "attributeValueId" ], "properties": { "value": { "type": "number", "minimum": 0 }, "effectiveFrom": { "type": "string", "format": "date-time" }, "effectiveTo": { "type": [ "string", "null" ], "format": "date-time" }, "recordedAt": { "type": "string", "format": "date-time" }, "sourceSystem": { "type": "string" }, "attributeValueId": { "type": "string", "format": "uuid" } } }, "WorkforceDiscovery": { "type": "object", "required": [ "contractVersion", "workspaceId", "observedAt", "asOf", "window", "view", "timezone", "sections", "totals", "queues", "people", "questions", "page" ], "properties": { "contractVersion": { "const": 1 }, "workspaceId": { "type": "string" }, "observedAt": { "type": "string", "format": "date-time" }, "asOf": { "type": "string", "format": "date-time" }, "window": { "type": "object", "properties": { "from": { "type": "string", "format": "date-time" }, "to": { "type": "string", "format": "date-time" } } }, "view": { "enum": [ "summary", "queues", "people" ] }, "timezone": { "$ref": "#/components/schemas/DiscoveryFact" }, "sections": { "type": "object", "additionalProperties": { "type": "object", "properties": { "state": { "type": "string" }, "count": { "type": [ "integer", "null" ] }, "complete": { "type": "boolean" }, "reason": { "type": [ "string", "null" ] } } } }, "totals": { "type": "object", "properties": { "queues": { "type": [ "integer", "null" ] }, "queueMemberships": { "type": [ "integer", "null" ] }, "agentSlots": { "type": [ "integer", "null" ] }, "resolvedPeople": { "type": [ "integer", "null" ] } } }, "queues": { "type": "array", "description": "Each Queue includes providerSupervisors as a dated provider fact. It reports the current supervisor count when verified and does not grant an Atlas role.", "items": { "type": "object", "additionalProperties": true } }, "people": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "questions": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "page": { "type": "object", "properties": { "offset": { "type": "integer" }, "limit": { "type": "integer" }, "total": { "type": "integer" } } } } }, "DiscoveryFact": { "type": "object", "required": [ "state", "meaning", "unit", "value", "source", "effectiveAt", "observedAt", "complete", "decisionBlocking", "evidence" ], "properties": { "state": { "enum": [ "observed", "authored", "imported", "inferred", "missing", "conflicting", "stale", "denied", "unavailable", "not_applicable" ] }, "meaning": { "type": "string" }, "unit": { "type": [ "string", "null" ] }, "value": {}, "source": { "type": [ "string", "null" ] }, "effectiveAt": { "type": [ "string", "null" ] }, "observedAt": { "type": [ "string", "null" ] }, "complete": { "type": "boolean" }, "decisionBlocking": { "type": "boolean" }, "evidence": { "type": "array", "items": { "type": "string" } } } }, "WorkforceIntraday": { "type": "object", "required": [ "group", "date", "generated_at", "requirement", "schedule_references", "intervals", "forecast_actuals", "now", "agents", "present_available", "warnings" ], "properties": { "group": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "timezone": { "type": "string" }, "slot_minutes": { "type": "number" } } }, "date": { "type": "string", "format": "date" }, "generated_at": { "type": "string", "format": "date-time" }, "requirement": { "type": [ "object", "null" ], "properties": { "computed_at": { "type": [ "string", "null" ] }, "mode": { "type": [ "string", "null" ] }, "stale": { "type": "boolean" } } }, "schedule_references": { "type": "array", "items": { "type": "object" } }, "intervals": { "type": "array", "items": { "type": "object", "properties": { "required": { "type": [ "number", "null" ] }, "scheduled_headcount": { "type": [ "number", "null" ] }, "scheduled_people": { "type": [ "number", "null" ] }, "scheduled_person_seconds": { "type": [ "number", "null" ] }, "scheduled_productive_headcount": { "type": [ "number", "null" ] }, "scheduled_productive_people": { "type": [ "number", "null" ] }, "productive_person_seconds": { "type": [ "number", "null" ] }, "present_headcount": { "type": [ "number", "null" ] }, "present_people": { "type": [ "number", "null" ] }, "present_person_seconds": { "type": [ "number", "null" ] }, "start_minute": { "type": "number" }, "end_minute": { "type": "number" }, "start_ts": { "type": "string", "format": "date-time" }, "end_ts": { "type": "string", "format": "date-time" }, "present_evidence": { "type": "string", "enum": [ "complete", "partial", "unknown", "unavailable", "pending" ] }, "observation": { "type": "object", "required": [ "phase", "status", "elapsed_seconds", "remaining_seconds", "observed_through", "stabilized_through", "observed_seconds" ], "properties": { "phase": { "type": "string", "enum": [ "future", "active", "closed" ] }, "status": { "type": "string", "enum": [ "pending", "provisional", "final", "unavailable" ] }, "elapsed_seconds": { "type": "number", "minimum": 0 }, "remaining_seconds": { "type": "number", "minimum": 0 }, "observed_through": { "type": [ "string", "null" ] }, "stabilized_through": { "type": [ "string", "null" ] }, "observed_seconds": { "type": [ "number", "null" ] } } } } } }, "forecast_actuals": { "type": "array", "items": { "type": "object", "properties": { "run_id": { "type": "string" }, "metric_ref": { "type": "string" }, "grain": { "type": "string" }, "timezone": { "type": "string" }, "dimension_key": { "type": "object" }, "interval_start_ts": { "type": "string", "format": "date-time" }, "interval_end_ts": { "type": "string", "format": "date-time" }, "forecast_full_interval": { "type": "number" }, "actual_so_far": { "type": [ "number", "null" ] }, "requested_through_ts": { "type": [ "string", "null" ] }, "observed_through_ts": { "type": [ "string", "null" ] }, "source_completeness": { "type": "string" }, "phase": { "type": "string", "enum": [ "future", "active", "closed" ] }, "final": { "const": false }, "target_object_type": { "type": "string" }, "target_object_id": { "type": [ "string", "null" ] }, "metric_label": { "type": [ "string", "null" ] } }, "description": "Live semantic comparison at the original forecast grain and timezone. It never finalizes a PredictionActualService record. observed_through_ts remains null when the semantic source does not publish a trustworthy cutoff." } }, "now": { "type": [ "object", "null" ], "description": "Native current-state staffing and adherence facts, present only for group-local today." }, "agents": { "type": "array", "items": { "type": "object" }, "description": "Native scoped Agent and Person identities, published scheduled activity, canonical current activity, source evidence and adherence. raw_status and raw_substatus are withheld without native raw capability." }, "present_available": { "type": "boolean" }, "warnings": { "type": "array", "items": { "type": "string" } } } }, "WorkforceMySchedulingChangePreview": { "type": "object", "properties": { "assignment_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "valid_from": { "type": "string" }, "terms": { "type": "object", "properties": { "availability": { "anyOf": [ { "oneOf": [ { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "state": { "type": "string", "const": "unknown" } }, "required": [ "version", "state" ], "additionalProperties": false }, { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "state": { "type": "string", "const": "unrestricted" }, "zone": { "type": "string" }, "source": { "type": "string", "enum": [ "employee_declared", "manager_recorded", "employer_requirement" ] } }, "required": [ "version", "state", "zone", "source" ], "additionalProperties": false }, { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "state": { "type": "string", "const": "restricted" }, "zone": { "type": "string" }, "source": { "type": "string", "enum": [ "employee_declared", "manager_recorded", "employer_requirement" ] }, "weekly": { "type": "object", "propertyNames": { "type": "string", "enum": [ "sun", "mon", "tue", "wed", "thu", "fri", "sat" ] }, "additionalProperties": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "closed" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "unrestricted" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "windows" }, "windows": { "minItems": 1, "maxItems": 6, "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string" }, "end": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "kind", "windows" ], "additionalProperties": false } ] } }, "exceptions": { "default": [], "maxItems": 366, "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string" }, "rule": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "closed" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "unrestricted" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "windows" }, "windows": { "minItems": 1, "maxItems": 6, "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string" }, "end": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "kind", "windows" ], "additionalProperties": false } ] } }, "required": [ "date", "rule" ], "additionalProperties": false } } }, "required": [ "version", "state", "zone", "source", "weekly" ], "additionalProperties": false } ] }, { "type": "null" } ] }, "scheduling_preferences": { "anyOf": [ { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "zone": { "type": "string" }, "startWindows": { "default": [], "maxItems": 21, "type": "array", "items": { "type": "object", "properties": { "days": { "minItems": 1, "maxItems": 7, "type": "array", "items": { "type": "string", "enum": [ "sun", "mon", "tue", "wed", "thu", "fri", "sat" ] } }, "earliest": { "type": "string" }, "latest": { "type": "string" }, "strength": { "type": "string", "enum": [ "weak", "moderate", "strong" ] }, "rank": { "type": "integer", "minimum": 1, "maximum": 21 } }, "required": [ "earliest", "latest" ], "additionalProperties": false } }, "finishWindows": { "default": [], "maxItems": 21, "type": "array", "items": { "type": "object", "properties": { "days": { "minItems": 1, "maxItems": 7, "type": "array", "items": { "type": "string", "enum": [ "sun", "mon", "tue", "wed", "thu", "fri", "sat" ] } }, "earliest": { "type": "string" }, "latest": { "type": "string" }, "strength": { "type": "string", "enum": [ "weak", "moderate", "strong" ] } }, "required": [ "earliest", "latest", "strength" ], "additionalProperties": false } }, "shiftLengths": { "default": [], "maxItems": 21, "type": "array", "items": { "type": "object", "properties": { "minMinutes": { "type": "integer", "minimum": 15, "maximum": 1440 }, "maxMinutes": { "type": "integer", "minimum": 15, "maximum": 1440 }, "strength": { "type": "string", "enum": [ "weak", "moderate", "strong" ] } }, "required": [ "minMinutes", "maxMinutes", "strength" ], "additionalProperties": false } }, "workingDays": { "default": [], "maxItems": 7, "type": "array", "items": { "type": "object", "properties": { "day": { "type": "string", "enum": [ "sun", "mon", "tue", "wed", "thu", "fri", "sat" ] }, "strength": { "type": "string", "enum": [ "weak", "moderate", "strong" ] } }, "required": [ "day", "strength" ], "additionalProperties": false } }, "daysOff": { "default": [], "maxItems": 7, "type": "array", "items": { "type": "object", "properties": { "day": { "type": "string", "enum": [ "sun", "mon", "tue", "wed", "thu", "fri", "sat" ] }, "rank": { "type": "integer", "minimum": 1, "maximum": 21 } }, "required": [ "day", "rank" ], "additionalProperties": false } }, "weeklyPatterns": { "default": [], "maxItems": 21, "type": "array", "items": { "type": "object", "properties": { "patternId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "rank": { "type": "integer", "minimum": 1, "maximum": 21 } }, "required": [ "patternId", "rank" ], "additionalProperties": false } } }, "required": [ "version" ], "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": [ "terms" ], "additionalProperties": false }, "WorkforceMySchedulingChangeSubmit": { "type": "object", "properties": { "assignment_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "valid_from": { "type": "string" }, "terms": { "type": "object", "properties": { "availability": { "anyOf": [ { "oneOf": [ { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "state": { "type": "string", "const": "unknown" } }, "required": [ "version", "state" ], "additionalProperties": false }, { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "state": { "type": "string", "const": "unrestricted" }, "zone": { "type": "string" }, "source": { "type": "string", "enum": [ "employee_declared", "manager_recorded", "employer_requirement" ] } }, "required": [ "version", "state", "zone", "source" ], "additionalProperties": false }, { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "state": { "type": "string", "const": "restricted" }, "zone": { "type": "string" }, "source": { "type": "string", "enum": [ "employee_declared", "manager_recorded", "employer_requirement" ] }, "weekly": { "type": "object", "propertyNames": { "type": "string", "enum": [ "sun", "mon", "tue", "wed", "thu", "fri", "sat" ] }, "additionalProperties": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "closed" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "unrestricted" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "windows" }, "windows": { "minItems": 1, "maxItems": 6, "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string" }, "end": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "kind", "windows" ], "additionalProperties": false } ] } }, "exceptions": { "default": [], "maxItems": 366, "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string" }, "rule": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "closed" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "unrestricted" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "windows" }, "windows": { "minItems": 1, "maxItems": 6, "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string" }, "end": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "kind", "windows" ], "additionalProperties": false } ] } }, "required": [ "date", "rule" ], "additionalProperties": false } } }, "required": [ "version", "state", "zone", "source", "weekly" ], "additionalProperties": false } ] }, { "type": "null" } ] }, "scheduling_preferences": { "anyOf": [ { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "zone": { "type": "string" }, "startWindows": { "default": [], "maxItems": 21, "type": "array", "items": { "type": "object", "properties": { "days": { "minItems": 1, "maxItems": 7, "type": "array", "items": { "type": "string", "enum": [ "sun", "mon", "tue", "wed", "thu", "fri", "sat" ] } }, "earliest": { "type": "string" }, "latest": { "type": "string" }, "strength": { "type": "string", "enum": [ "weak", "moderate", "strong" ] }, "rank": { "type": "integer", "minimum": 1, "maximum": 21 } }, "required": [ "earliest", "latest" ], "additionalProperties": false } }, "finishWindows": { "default": [], "maxItems": 21, "type": "array", "items": { "type": "object", "properties": { "days": { "minItems": 1, "maxItems": 7, "type": "array", "items": { "type": "string", "enum": [ "sun", "mon", "tue", "wed", "thu", "fri", "sat" ] } }, "earliest": { "type": "string" }, "latest": { "type": "string" }, "strength": { "type": "string", "enum": [ "weak", "moderate", "strong" ] } }, "required": [ "earliest", "latest", "strength" ], "additionalProperties": false } }, "shiftLengths": { "default": [], "maxItems": 21, "type": "array", "items": { "type": "object", "properties": { "minMinutes": { "type": "integer", "minimum": 15, "maximum": 1440 }, "maxMinutes": { "type": "integer", "minimum": 15, "maximum": 1440 }, "strength": { "type": "string", "enum": [ "weak", "moderate", "strong" ] } }, "required": [ "minMinutes", "maxMinutes", "strength" ], "additionalProperties": false } }, "workingDays": { "default": [], "maxItems": 7, "type": "array", "items": { "type": "object", "properties": { "day": { "type": "string", "enum": [ "sun", "mon", "tue", "wed", "thu", "fri", "sat" ] }, "strength": { "type": "string", "enum": [ "weak", "moderate", "strong" ] } }, "required": [ "day", "strength" ], "additionalProperties": false } }, "daysOff": { "default": [], "maxItems": 7, "type": "array", "items": { "type": "object", "properties": { "day": { "type": "string", "enum": [ "sun", "mon", "tue", "wed", "thu", "fri", "sat" ] }, "rank": { "type": "integer", "minimum": 1, "maximum": 21 } }, "required": [ "day", "rank" ], "additionalProperties": false } }, "weeklyPatterns": { "default": [], "maxItems": 21, "type": "array", "items": { "type": "object", "properties": { "patternId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "rank": { "type": "integer", "minimum": 1, "maximum": 21 } }, "required": [ "patternId", "rank" ], "additionalProperties": false } } }, "required": [ "version" ], "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false }, "note": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] } }, "required": [ "terms" ], "additionalProperties": false }, "WorkforceSchedulingProfilePreviewInput": { "type": "object", "properties": { "valid_from": { "type": "string" }, "expected_revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "terms": { "type": "object", "properties": { "employment_type": { "anyOf": [ { "type": "string", "enum": [ "full_time", "part_time", "flex" ] }, { "type": "null" } ] }, "contract_min_hours_week": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 168 }, { "type": "null" } ] }, "contract_max_hours_week": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 168 }, { "type": "null" } ] }, "min_shift_hours": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 24 }, { "type": "null" } ] }, "max_shift_hours": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 24 }, { "type": "null" } ] }, "availability": { "anyOf": [ { "oneOf": [ { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "state": { "type": "string", "const": "unknown" } }, "required": [ "version", "state" ], "additionalProperties": false }, { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "state": { "type": "string", "const": "unrestricted" }, "zone": { "type": "string" }, "source": { "type": "string", "enum": [ "employee_declared", "manager_recorded", "employer_requirement" ] } }, "required": [ "version", "state", "zone", "source" ], "additionalProperties": false }, { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "state": { "type": "string", "const": "restricted" }, "zone": { "type": "string" }, "source": { "type": "string", "enum": [ "employee_declared", "manager_recorded", "employer_requirement" ] }, "weekly": { "type": "object", "propertyNames": { "type": "string", "enum": [ "sun", "mon", "tue", "wed", "thu", "fri", "sat" ] }, "additionalProperties": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "closed" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "unrestricted" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "windows" }, "windows": { "minItems": 1, "maxItems": 6, "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string" }, "end": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "kind", "windows" ], "additionalProperties": false } ] } }, "exceptions": { "default": [], "maxItems": 366, "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string" }, "rule": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "closed" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "unrestricted" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "windows" }, "windows": { "minItems": 1, "maxItems": 6, "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string" }, "end": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "kind", "windows" ], "additionalProperties": false } ] } }, "required": [ "date", "rule" ], "additionalProperties": false } } }, "required": [ "version", "state", "zone", "source", "weekly" ], "additionalProperties": false } ] }, { "type": "null" } ] }, "scheduling_preferences": { "anyOf": [ { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "zone": { "type": "string" }, "startWindows": { "default": [], "maxItems": 21, "type": "array", "items": { "type": "object", "properties": { "days": { "minItems": 1, "maxItems": 7, "type": "array", "items": { "type": "string", "enum": [ "sun", "mon", "tue", "wed", "thu", "fri", "sat" ] } }, "earliest": { "type": "string" }, "latest": { "type": "string" }, "strength": { "type": "string", "enum": [ "weak", "moderate", "strong" ] }, "rank": { "type": "integer", "minimum": 1, "maximum": 21 } }, "required": [ "earliest", "latest" ], "additionalProperties": false } }, "finishWindows": { "default": [], "maxItems": 21, "type": "array", "items": { "type": "object", "properties": { "days": { "minItems": 1, "maxItems": 7, "type": "array", "items": { "type": "string", "enum": [ "sun", "mon", "tue", "wed", "thu", "fri", "sat" ] } }, "earliest": { "type": "string" }, "latest": { "type": "string" }, "strength": { "type": "string", "enum": [ "weak", "moderate", "strong" ] } }, "required": [ "earliest", "latest", "strength" ], "additionalProperties": false } }, "shiftLengths": { "default": [], "maxItems": 21, "type": "array", "items": { "type": "object", "properties": { "minMinutes": { "type": "integer", "minimum": 15, "maximum": 1440 }, "maxMinutes": { "type": "integer", "minimum": 15, "maximum": 1440 }, "strength": { "type": "string", "enum": [ "weak", "moderate", "strong" ] } }, "required": [ "minMinutes", "maxMinutes", "strength" ], "additionalProperties": false } }, "workingDays": { "default": [], "maxItems": 7, "type": "array", "items": { "type": "object", "properties": { "day": { "type": "string", "enum": [ "sun", "mon", "tue", "wed", "thu", "fri", "sat" ] }, "strength": { "type": "string", "enum": [ "weak", "moderate", "strong" ] } }, "required": [ "day", "strength" ], "additionalProperties": false } }, "daysOff": { "default": [], "maxItems": 7, "type": "array", "items": { "type": "object", "properties": { "day": { "type": "string", "enum": [ "sun", "mon", "tue", "wed", "thu", "fri", "sat" ] }, "rank": { "type": "integer", "minimum": 1, "maximum": 21 } }, "required": [ "day", "rank" ], "additionalProperties": false } }, "weeklyPatterns": { "default": [], "maxItems": 21, "type": "array", "items": { "type": "object", "properties": { "patternId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "rank": { "type": "integer", "minimum": 1, "maximum": 21 } }, "required": [ "patternId", "rank" ], "additionalProperties": false } } }, "required": [ "version" ], "additionalProperties": false }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "maxLength": 4000 }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": [ "terms" ], "additionalProperties": false }, "WorkforceSchedulingProfileRevisionInput": { "type": "object", "properties": { "valid_from": { "type": "string" }, "expected_revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "terms": { "type": "object", "properties": { "employment_type": { "anyOf": [ { "type": "string", "enum": [ "full_time", "part_time", "flex" ] }, { "type": "null" } ] }, "contract_min_hours_week": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 168 }, { "type": "null" } ] }, "contract_max_hours_week": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 168 }, { "type": "null" } ] }, "min_shift_hours": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 24 }, { "type": "null" } ] }, "max_shift_hours": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 24 }, { "type": "null" } ] }, "availability": { "anyOf": [ { "oneOf": [ { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "state": { "type": "string", "const": "unknown" } }, "required": [ "version", "state" ], "additionalProperties": false }, { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "state": { "type": "string", "const": "unrestricted" }, "zone": { "type": "string" }, "source": { "type": "string", "enum": [ "employee_declared", "manager_recorded", "employer_requirement" ] } }, "required": [ "version", "state", "zone", "source" ], "additionalProperties": false }, { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "state": { "type": "string", "const": "restricted" }, "zone": { "type": "string" }, "source": { "type": "string", "enum": [ "employee_declared", "manager_recorded", "employer_requirement" ] }, "weekly": { "type": "object", "propertyNames": { "type": "string", "enum": [ "sun", "mon", "tue", "wed", "thu", "fri", "sat" ] }, "additionalProperties": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "closed" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "unrestricted" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "windows" }, "windows": { "minItems": 1, "maxItems": 6, "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string" }, "end": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "kind", "windows" ], "additionalProperties": false } ] } }, "exceptions": { "default": [], "maxItems": 366, "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string" }, "rule": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "closed" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "unrestricted" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "windows" }, "windows": { "minItems": 1, "maxItems": 6, "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string" }, "end": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "kind", "windows" ], "additionalProperties": false } ] } }, "required": [ "date", "rule" ], "additionalProperties": false } } }, "required": [ "version", "state", "zone", "source", "weekly" ], "additionalProperties": false } ] }, { "type": "null" } ] }, "scheduling_preferences": { "anyOf": [ { "type": "object", "properties": { "version": { "type": "number", "const": 1 }, "zone": { "type": "string" }, "startWindows": { "default": [], "maxItems": 21, "type": "array", "items": { "type": "object", "properties": { "days": { "minItems": 1, "maxItems": 7, "type": "array", "items": { "type": "string", "enum": [ "sun", "mon", "tue", "wed", "thu", "fri", "sat" ] } }, "earliest": { "type": "string" }, "latest": { "type": "string" }, "strength": { "type": "string", "enum": [ "weak", "moderate", "strong" ] }, "rank": { "type": "integer", "minimum": 1, "maximum": 21 } }, "required": [ "earliest", "latest" ], "additionalProperties": false } }, "finishWindows": { "default": [], "maxItems": 21, "type": "array", "items": { "type": "object", "properties": { "days": { "minItems": 1, "maxItems": 7, "type": "array", "items": { "type": "string", "enum": [ "sun", "mon", "tue", "wed", "thu", "fri", "sat" ] } }, "earliest": { "type": "string" }, "latest": { "type": "string" }, "strength": { "type": "string", "enum": [ "weak", "moderate", "strong" ] } }, "required": [ "earliest", "latest", "strength" ], "additionalProperties": false } }, "shiftLengths": { "default": [], "maxItems": 21, "type": "array", "items": { "type": "object", "properties": { "minMinutes": { "type": "integer", "minimum": 15, "maximum": 1440 }, "maxMinutes": { "type": "integer", "minimum": 15, "maximum": 1440 }, "strength": { "type": "string", "enum": [ "weak", "moderate", "strong" ] } }, "required": [ "minMinutes", "maxMinutes", "strength" ], "additionalProperties": false } }, "workingDays": { "default": [], "maxItems": 7, "type": "array", "items": { "type": "object", "properties": { "day": { "type": "string", "enum": [ "sun", "mon", "tue", "wed", "thu", "fri", "sat" ] }, "strength": { "type": "string", "enum": [ "weak", "moderate", "strong" ] } }, "required": [ "day", "strength" ], "additionalProperties": false } }, "daysOff": { "default": [], "maxItems": 7, "type": "array", "items": { "type": "object", "properties": { "day": { "type": "string", "enum": [ "sun", "mon", "tue", "wed", "thu", "fri", "sat" ] }, "rank": { "type": "integer", "minimum": 1, "maximum": 21 } }, "required": [ "day", "rank" ], "additionalProperties": false } }, "weeklyPatterns": { "default": [], "maxItems": 21, "type": "array", "items": { "type": "object", "properties": { "patternId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "rank": { "type": "integer", "minimum": 1, "maximum": 21 } }, "required": [ "patternId", "rank" ], "additionalProperties": false } } }, "required": [ "version" ], "additionalProperties": false }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "maxLength": 4000 }, { "type": "null" } ] } }, "additionalProperties": false }, "reason": { "type": "string", "minLength": 1, "maxLength": 2000 } }, "required": [ "expected_revision", "terms", "reason" ], "additionalProperties": false }, "WorkforceSchedulingProfileChangeResolution": { "type": "object", "properties": { "outcome": { "type": "string", "enum": [ "approve", "reject" ] }, "note": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] } }, "required": [ "outcome" ], "additionalProperties": false }, "WorkforceSchedulingPatternPreviewInput": { "type": "object", "properties": { "expected_revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "description": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] }, "pattern": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "daily" }, "version": { "type": "number", "const": 1 }, "zoneBasis": { "default": "scheduling_group", "anyOf": [ { "type": "string", "const": "scheduling_group" }, { "type": "object", "properties": { "zone": { "type": "string" } }, "required": [ "zone" ], "additionalProperties": false } ] }, "start": { "type": "object", "properties": { "earliest": { "type": "string" }, "latest": { "type": "string" }, "incrementMinutes": { "type": "integer", "minimum": 5, "maximum": 720 } }, "required": [ "earliest", "latest", "incrementMinutes" ], "additionalProperties": false }, "duration": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "range" }, "minMinutes": { "type": "integer", "minimum": 15, "maximum": 1440 }, "maxMinutes": { "type": "integer", "minimum": 15, "maximum": 1440 }, "incrementMinutes": { "type": "integer", "minimum": 5, "maximum": 720 } }, "required": [ "kind", "minMinutes", "maxMinutes", "incrementMinutes" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "options" }, "minutes": { "minItems": 1, "maxItems": 24, "type": "array", "items": { "type": "integer", "minimum": 15, "maximum": 1440 } } }, "required": [ "kind", "minutes" ], "additionalProperties": false } ] }, "split": { "default": null, "anyOf": [ { "type": "object", "properties": { "gapActivityTypeSlug": { "type": "string", "pattern": "^[a-z0-9][a-z0-9_]{0,99}$" }, "gapMinutes": { "type": "integer", "minimum": 30, "maximum": 720 }, "earliestOffsetMinutes": { "type": "integer", "minimum": 15, "maximum": 1440 }, "latestOffsetMinutes": { "type": "integer", "minimum": 15, "maximum": 1440 } }, "required": [ "gapActivityTypeSlug", "gapMinutes", "earliestOffsetMinutes", "latestOffsetMinutes" ], "additionalProperties": false }, { "type": "null" } ] }, "activities": { "default": [], "maxItems": 12, "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "pattern": "^[a-z0-9][a-z0-9_.-]{0,63}$" }, "activityTypeSlug": { "type": "string", "pattern": "^[a-z0-9][a-z0-9_]{0,99}$" }, "trigger": { "default": {}, "type": "object", "properties": { "minShiftMinutes": { "type": "integer", "minimum": 0, "maximum": 1440 }, "maxShiftMinutes": { "type": "integer", "minimum": 0, "maximum": 1440 } }, "additionalProperties": false }, "durationMinutes": { "type": "integer", "minimum": 5, "maximum": 720 }, "window": { "oneOf": [ { "type": "object", "properties": { "basis": { "type": "string", "const": "shift_start" }, "earliestOffsetMinutes": { "type": "integer", "minimum": 0, "maximum": 1440 }, "latestOffsetMinutes": { "type": "integer", "minimum": 0, "maximum": 1440 } }, "required": [ "basis", "earliestOffsetMinutes", "latestOffsetMinutes" ], "additionalProperties": false }, { "type": "object", "properties": { "basis": { "type": "string", "const": "shift_end" }, "earliestOffsetMinutes": { "type": "integer", "minimum": 0, "maximum": 1440 }, "latestOffsetMinutes": { "type": "integer", "minimum": 0, "maximum": 1440 } }, "required": [ "basis", "earliestOffsetMinutes", "latestOffsetMinutes" ], "additionalProperties": false }, { "type": "object", "properties": { "basis": { "type": "string", "const": "wall_clock" }, "earliest": { "type": "string" }, "latest": { "type": "string" } }, "required": [ "basis", "earliest", "latest" ], "additionalProperties": false } ] }, "precedence": { "default": 0, "type": "integer", "minimum": 0, "maximum": 100 }, "after": { "type": "string", "pattern": "^[a-z0-9][a-z0-9_.-]{0,63}$" }, "minSeparationMinutes": { "default": 0, "type": "integer", "minimum": 0, "maximum": 720 }, "maxContiguousWorkMinutes": { "type": "integer", "minimum": 15, "maximum": 1440 }, "recurrence": { "default": { "kind": "every_shift" }, "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "every_shift" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "weekly" }, "days": { "minItems": 1, "maxItems": 7, "type": "array", "items": { "type": "string", "enum": [ "sun", "mon", "tue", "wed", "thu", "fri", "sat" ] } } }, "required": [ "kind", "days" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "every_n_weeks" }, "everyWeeks": { "type": "integer", "minimum": 2, "maximum": 8 }, "anchorWeekStart": { "type": "string" }, "days": { "minItems": 1, "maxItems": 7, "type": "array", "items": { "type": "string", "enum": [ "sun", "mon", "tue", "wed", "thu", "fri", "sat" ] } } }, "required": [ "kind", "everyWeeks", "anchorWeekStart", "days" ], "additionalProperties": false } ] }, "movement": { "default": "movable", "type": "string", "enum": [ "movable", "deferrable", "cancelable", "protected" ] }, "required": { "default": true, "type": "boolean" }, "eligibleQualificationIds": { "default": [], "maxItems": 10, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": [ "key", "activityTypeSlug", "durationMinutes", "window" ], "additionalProperties": false } }, "maxContiguousWorkMinutes": { "default": null, "anyOf": [ { "type": "integer", "minimum": 15, "maximum": 1440 }, { "type": "null" } ] }, "contractBasis": { "default": "paid", "type": "string", "enum": [ "paid", "elapsed", "productive" ] }, "eligibleWork": { "default": { "qualificationIds": [] }, "type": "object", "properties": { "qualificationIds": { "default": [], "maxItems": 20, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "additionalProperties": false }, "applicability": { "default": {}, "type": "object", "properties": { "days": { "minItems": 1, "maxItems": 7, "type": "array", "items": { "type": "string", "enum": [ "sun", "mon", "tue", "wed", "thu", "fri", "sat" ] } }, "schedulingGroupIds": { "maxItems": 50, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "additionalProperties": false } }, "required": [ "kind", "version", "start", "duration" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "weekly" }, "version": { "type": "number", "const": 1 }, "weekStart": { "default": "monday", "type": "string", "const": "monday" }, "days": { "type": "object", "propertyNames": { "type": "string", "enum": [ "sun", "mon", "tue", "wed", "thu", "fri", "sat" ] }, "additionalProperties": { "type": "object", "properties": { "dailyPatternIds": { "minItems": 1, "maxItems": 8, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": [ "dailyPatternIds" ], "additionalProperties": false } }, "workdays": { "type": "object", "properties": { "min": { "type": "integer", "minimum": 0, "maximum": 7 }, "max": { "type": "integer", "minimum": 0, "maximum": 7 } }, "required": [ "min", "max" ], "additionalProperties": false }, "hours": { "default": null, "anyOf": [ { "type": "object", "properties": { "basis": { "type": "string", "enum": [ "paid", "contract", "elapsed", "productive" ] }, "minMinutes": { "type": "integer", "minimum": 0, "maximum": 10080 }, "maxMinutes": { "type": "integer", "minimum": 0, "maximum": 10080 } }, "required": [ "basis" ], "additionalProperties": false }, { "type": "null" } ] }, "minRestMinutes": { "default": null, "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 2880 }, { "type": "null" } ] }, "maxConsecutiveDays": { "default": null, "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 14 }, { "type": "null" } ] }, "consistentStart": { "default": null, "anyOf": [ { "type": "object", "properties": { "toleranceMinutes": { "type": "integer", "minimum": 0, "maximum": 720 } }, "required": [ "toleranceMinutes" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "kind", "version", "days", "workdays" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "rotation" }, "version": { "type": "number", "const": 1 }, "weeks": { "minItems": 1, "maxItems": 52, "type": "array", "items": { "type": "object", "properties": { "weeklyPatternId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "weeklyPatternId" ], "additionalProperties": false } } }, "required": [ "kind", "version", "weeks" ], "additionalProperties": false } ] } }, "required": [ "name", "pattern" ], "additionalProperties": false }, "WorkforceSchedulingPatternCreate": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "description": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] }, "pattern": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "daily" }, "version": { "type": "number", "const": 1 }, "zoneBasis": { "default": "scheduling_group", "anyOf": [ { "type": "string", "const": "scheduling_group" }, { "type": "object", "properties": { "zone": { "type": "string" } }, "required": [ "zone" ], "additionalProperties": false } ] }, "start": { "type": "object", "properties": { "earliest": { "type": "string" }, "latest": { "type": "string" }, "incrementMinutes": { "type": "integer", "minimum": 5, "maximum": 720 } }, "required": [ "earliest", "latest", "incrementMinutes" ], "additionalProperties": false }, "duration": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "range" }, "minMinutes": { "type": "integer", "minimum": 15, "maximum": 1440 }, "maxMinutes": { "type": "integer", "minimum": 15, "maximum": 1440 }, "incrementMinutes": { "type": "integer", "minimum": 5, "maximum": 720 } }, "required": [ "kind", "minMinutes", "maxMinutes", "incrementMinutes" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "options" }, "minutes": { "minItems": 1, "maxItems": 24, "type": "array", "items": { "type": "integer", "minimum": 15, "maximum": 1440 } } }, "required": [ "kind", "minutes" ], "additionalProperties": false } ] }, "split": { "default": null, "anyOf": [ { "type": "object", "properties": { "gapActivityTypeSlug": { "type": "string", "pattern": "^[a-z0-9][a-z0-9_]{0,99}$" }, "gapMinutes": { "type": "integer", "minimum": 30, "maximum": 720 }, "earliestOffsetMinutes": { "type": "integer", "minimum": 15, "maximum": 1440 }, "latestOffsetMinutes": { "type": "integer", "minimum": 15, "maximum": 1440 } }, "required": [ "gapActivityTypeSlug", "gapMinutes", "earliestOffsetMinutes", "latestOffsetMinutes" ], "additionalProperties": false }, { "type": "null" } ] }, "activities": { "default": [], "maxItems": 12, "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "pattern": "^[a-z0-9][a-z0-9_.-]{0,63}$" }, "activityTypeSlug": { "type": "string", "pattern": "^[a-z0-9][a-z0-9_]{0,99}$" }, "trigger": { "default": {}, "type": "object", "properties": { "minShiftMinutes": { "type": "integer", "minimum": 0, "maximum": 1440 }, "maxShiftMinutes": { "type": "integer", "minimum": 0, "maximum": 1440 } }, "additionalProperties": false }, "durationMinutes": { "type": "integer", "minimum": 5, "maximum": 720 }, "window": { "oneOf": [ { "type": "object", "properties": { "basis": { "type": "string", "const": "shift_start" }, "earliestOffsetMinutes": { "type": "integer", "minimum": 0, "maximum": 1440 }, "latestOffsetMinutes": { "type": "integer", "minimum": 0, "maximum": 1440 } }, "required": [ "basis", "earliestOffsetMinutes", "latestOffsetMinutes" ], "additionalProperties": false }, { "type": "object", "properties": { "basis": { "type": "string", "const": "shift_end" }, "earliestOffsetMinutes": { "type": "integer", "minimum": 0, "maximum": 1440 }, "latestOffsetMinutes": { "type": "integer", "minimum": 0, "maximum": 1440 } }, "required": [ "basis", "earliestOffsetMinutes", "latestOffsetMinutes" ], "additionalProperties": false }, { "type": "object", "properties": { "basis": { "type": "string", "const": "wall_clock" }, "earliest": { "type": "string" }, "latest": { "type": "string" } }, "required": [ "basis", "earliest", "latest" ], "additionalProperties": false } ] }, "precedence": { "default": 0, "type": "integer", "minimum": 0, "maximum": 100 }, "after": { "type": "string", "pattern": "^[a-z0-9][a-z0-9_.-]{0,63}$" }, "minSeparationMinutes": { "default": 0, "type": "integer", "minimum": 0, "maximum": 720 }, "maxContiguousWorkMinutes": { "type": "integer", "minimum": 15, "maximum": 1440 }, "recurrence": { "default": { "kind": "every_shift" }, "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "every_shift" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "weekly" }, "days": { "minItems": 1, "maxItems": 7, "type": "array", "items": { "type": "string", "enum": [ "sun", "mon", "tue", "wed", "thu", "fri", "sat" ] } } }, "required": [ "kind", "days" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "every_n_weeks" }, "everyWeeks": { "type": "integer", "minimum": 2, "maximum": 8 }, "anchorWeekStart": { "type": "string" }, "days": { "minItems": 1, "maxItems": 7, "type": "array", "items": { "type": "string", "enum": [ "sun", "mon", "tue", "wed", "thu", "fri", "sat" ] } } }, "required": [ "kind", "everyWeeks", "anchorWeekStart", "days" ], "additionalProperties": false } ] }, "movement": { "default": "movable", "type": "string", "enum": [ "movable", "deferrable", "cancelable", "protected" ] }, "required": { "default": true, "type": "boolean" }, "eligibleQualificationIds": { "default": [], "maxItems": 10, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": [ "key", "activityTypeSlug", "durationMinutes", "window" ], "additionalProperties": false } }, "maxContiguousWorkMinutes": { "default": null, "anyOf": [ { "type": "integer", "minimum": 15, "maximum": 1440 }, { "type": "null" } ] }, "contractBasis": { "default": "paid", "type": "string", "enum": [ "paid", "elapsed", "productive" ] }, "eligibleWork": { "default": { "qualificationIds": [] }, "type": "object", "properties": { "qualificationIds": { "default": [], "maxItems": 20, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "additionalProperties": false }, "applicability": { "default": {}, "type": "object", "properties": { "days": { "minItems": 1, "maxItems": 7, "type": "array", "items": { "type": "string", "enum": [ "sun", "mon", "tue", "wed", "thu", "fri", "sat" ] } }, "schedulingGroupIds": { "maxItems": 50, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "additionalProperties": false } }, "required": [ "kind", "version", "start", "duration" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "weekly" }, "version": { "type": "number", "const": 1 }, "weekStart": { "default": "monday", "type": "string", "const": "monday" }, "days": { "type": "object", "propertyNames": { "type": "string", "enum": [ "sun", "mon", "tue", "wed", "thu", "fri", "sat" ] }, "additionalProperties": { "type": "object", "properties": { "dailyPatternIds": { "minItems": 1, "maxItems": 8, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": [ "dailyPatternIds" ], "additionalProperties": false } }, "workdays": { "type": "object", "properties": { "min": { "type": "integer", "minimum": 0, "maximum": 7 }, "max": { "type": "integer", "minimum": 0, "maximum": 7 } }, "required": [ "min", "max" ], "additionalProperties": false }, "hours": { "default": null, "anyOf": [ { "type": "object", "properties": { "basis": { "type": "string", "enum": [ "paid", "contract", "elapsed", "productive" ] }, "minMinutes": { "type": "integer", "minimum": 0, "maximum": 10080 }, "maxMinutes": { "type": "integer", "minimum": 0, "maximum": 10080 } }, "required": [ "basis" ], "additionalProperties": false }, { "type": "null" } ] }, "minRestMinutes": { "default": null, "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 2880 }, { "type": "null" } ] }, "maxConsecutiveDays": { "default": null, "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 14 }, { "type": "null" } ] }, "consistentStart": { "default": null, "anyOf": [ { "type": "object", "properties": { "toleranceMinutes": { "type": "integer", "minimum": 0, "maximum": 720 } }, "required": [ "toleranceMinutes" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "kind", "version", "days", "workdays" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "rotation" }, "version": { "type": "number", "const": 1 }, "weeks": { "minItems": 1, "maxItems": 52, "type": "array", "items": { "type": "object", "properties": { "weeklyPatternId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "weeklyPatternId" ], "additionalProperties": false } } }, "required": [ "kind", "version", "weeks" ], "additionalProperties": false } ] }, "reason": { "type": "string", "minLength": 1, "maxLength": 2000 } }, "required": [ "name", "pattern", "reason" ], "additionalProperties": false }, "WorkforceSchedulingPatternRevision": { "type": "object", "properties": { "expected_revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "description": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] }, "pattern": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "daily" }, "version": { "type": "number", "const": 1 }, "zoneBasis": { "default": "scheduling_group", "anyOf": [ { "type": "string", "const": "scheduling_group" }, { "type": "object", "properties": { "zone": { "type": "string" } }, "required": [ "zone" ], "additionalProperties": false } ] }, "start": { "type": "object", "properties": { "earliest": { "type": "string" }, "latest": { "type": "string" }, "incrementMinutes": { "type": "integer", "minimum": 5, "maximum": 720 } }, "required": [ "earliest", "latest", "incrementMinutes" ], "additionalProperties": false }, "duration": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "range" }, "minMinutes": { "type": "integer", "minimum": 15, "maximum": 1440 }, "maxMinutes": { "type": "integer", "minimum": 15, "maximum": 1440 }, "incrementMinutes": { "type": "integer", "minimum": 5, "maximum": 720 } }, "required": [ "kind", "minMinutes", "maxMinutes", "incrementMinutes" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "options" }, "minutes": { "minItems": 1, "maxItems": 24, "type": "array", "items": { "type": "integer", "minimum": 15, "maximum": 1440 } } }, "required": [ "kind", "minutes" ], "additionalProperties": false } ] }, "split": { "default": null, "anyOf": [ { "type": "object", "properties": { "gapActivityTypeSlug": { "type": "string", "pattern": "^[a-z0-9][a-z0-9_]{0,99}$" }, "gapMinutes": { "type": "integer", "minimum": 30, "maximum": 720 }, "earliestOffsetMinutes": { "type": "integer", "minimum": 15, "maximum": 1440 }, "latestOffsetMinutes": { "type": "integer", "minimum": 15, "maximum": 1440 } }, "required": [ "gapActivityTypeSlug", "gapMinutes", "earliestOffsetMinutes", "latestOffsetMinutes" ], "additionalProperties": false }, { "type": "null" } ] }, "activities": { "default": [], "maxItems": 12, "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "pattern": "^[a-z0-9][a-z0-9_.-]{0,63}$" }, "activityTypeSlug": { "type": "string", "pattern": "^[a-z0-9][a-z0-9_]{0,99}$" }, "trigger": { "default": {}, "type": "object", "properties": { "minShiftMinutes": { "type": "integer", "minimum": 0, "maximum": 1440 }, "maxShiftMinutes": { "type": "integer", "minimum": 0, "maximum": 1440 } }, "additionalProperties": false }, "durationMinutes": { "type": "integer", "minimum": 5, "maximum": 720 }, "window": { "oneOf": [ { "type": "object", "properties": { "basis": { "type": "string", "const": "shift_start" }, "earliestOffsetMinutes": { "type": "integer", "minimum": 0, "maximum": 1440 }, "latestOffsetMinutes": { "type": "integer", "minimum": 0, "maximum": 1440 } }, "required": [ "basis", "earliestOffsetMinutes", "latestOffsetMinutes" ], "additionalProperties": false }, { "type": "object", "properties": { "basis": { "type": "string", "const": "shift_end" }, "earliestOffsetMinutes": { "type": "integer", "minimum": 0, "maximum": 1440 }, "latestOffsetMinutes": { "type": "integer", "minimum": 0, "maximum": 1440 } }, "required": [ "basis", "earliestOffsetMinutes", "latestOffsetMinutes" ], "additionalProperties": false }, { "type": "object", "properties": { "basis": { "type": "string", "const": "wall_clock" }, "earliest": { "type": "string" }, "latest": { "type": "string" } }, "required": [ "basis", "earliest", "latest" ], "additionalProperties": false } ] }, "precedence": { "default": 0, "type": "integer", "minimum": 0, "maximum": 100 }, "after": { "type": "string", "pattern": "^[a-z0-9][a-z0-9_.-]{0,63}$" }, "minSeparationMinutes": { "default": 0, "type": "integer", "minimum": 0, "maximum": 720 }, "maxContiguousWorkMinutes": { "type": "integer", "minimum": 15, "maximum": 1440 }, "recurrence": { "default": { "kind": "every_shift" }, "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "every_shift" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "weekly" }, "days": { "minItems": 1, "maxItems": 7, "type": "array", "items": { "type": "string", "enum": [ "sun", "mon", "tue", "wed", "thu", "fri", "sat" ] } } }, "required": [ "kind", "days" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "every_n_weeks" }, "everyWeeks": { "type": "integer", "minimum": 2, "maximum": 8 }, "anchorWeekStart": { "type": "string" }, "days": { "minItems": 1, "maxItems": 7, "type": "array", "items": { "type": "string", "enum": [ "sun", "mon", "tue", "wed", "thu", "fri", "sat" ] } } }, "required": [ "kind", "everyWeeks", "anchorWeekStart", "days" ], "additionalProperties": false } ] }, "movement": { "default": "movable", "type": "string", "enum": [ "movable", "deferrable", "cancelable", "protected" ] }, "required": { "default": true, "type": "boolean" }, "eligibleQualificationIds": { "default": [], "maxItems": 10, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": [ "key", "activityTypeSlug", "durationMinutes", "window" ], "additionalProperties": false } }, "maxContiguousWorkMinutes": { "default": null, "anyOf": [ { "type": "integer", "minimum": 15, "maximum": 1440 }, { "type": "null" } ] }, "contractBasis": { "default": "paid", "type": "string", "enum": [ "paid", "elapsed", "productive" ] }, "eligibleWork": { "default": { "qualificationIds": [] }, "type": "object", "properties": { "qualificationIds": { "default": [], "maxItems": 20, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "additionalProperties": false }, "applicability": { "default": {}, "type": "object", "properties": { "days": { "minItems": 1, "maxItems": 7, "type": "array", "items": { "type": "string", "enum": [ "sun", "mon", "tue", "wed", "thu", "fri", "sat" ] } }, "schedulingGroupIds": { "maxItems": 50, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "additionalProperties": false } }, "required": [ "kind", "version", "start", "duration" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "weekly" }, "version": { "type": "number", "const": 1 }, "weekStart": { "default": "monday", "type": "string", "const": "monday" }, "days": { "type": "object", "propertyNames": { "type": "string", "enum": [ "sun", "mon", "tue", "wed", "thu", "fri", "sat" ] }, "additionalProperties": { "type": "object", "properties": { "dailyPatternIds": { "minItems": 1, "maxItems": 8, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": [ "dailyPatternIds" ], "additionalProperties": false } }, "workdays": { "type": "object", "properties": { "min": { "type": "integer", "minimum": 0, "maximum": 7 }, "max": { "type": "integer", "minimum": 0, "maximum": 7 } }, "required": [ "min", "max" ], "additionalProperties": false }, "hours": { "default": null, "anyOf": [ { "type": "object", "properties": { "basis": { "type": "string", "enum": [ "paid", "contract", "elapsed", "productive" ] }, "minMinutes": { "type": "integer", "minimum": 0, "maximum": 10080 }, "maxMinutes": { "type": "integer", "minimum": 0, "maximum": 10080 } }, "required": [ "basis" ], "additionalProperties": false }, { "type": "null" } ] }, "minRestMinutes": { "default": null, "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 2880 }, { "type": "null" } ] }, "maxConsecutiveDays": { "default": null, "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 14 }, { "type": "null" } ] }, "consistentStart": { "default": null, "anyOf": [ { "type": "object", "properties": { "toleranceMinutes": { "type": "integer", "minimum": 0, "maximum": 720 } }, "required": [ "toleranceMinutes" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "kind", "version", "days", "workdays" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "rotation" }, "version": { "type": "number", "const": 1 }, "weeks": { "minItems": 1, "maxItems": 52, "type": "array", "items": { "type": "object", "properties": { "weeklyPatternId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "weeklyPatternId" ], "additionalProperties": false } } }, "required": [ "kind", "version", "weeks" ], "additionalProperties": false } ] }, "reason": { "type": "string", "minLength": 1, "maxLength": 2000 } }, "required": [ "expected_revision", "name", "pattern", "reason" ], "additionalProperties": false }, "WorkforceSchedulingPatternArchive": { "type": "object", "properties": { "expected_revision": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "reason": { "type": "string", "minLength": 1, "maxLength": 2000 } }, "required": [ "expected_revision", "reason" ], "additionalProperties": false }, "WorkforceRotationAssignmentCreate": { "type": "object", "properties": { "template_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "subject": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "person" }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "kind", "id" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "assignment" }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "kind", "id" ], "additionalProperties": false } ] }, "anchor_week_start": { "type": "string" }, "valid_from": { "type": "string" }, "valid_to": { "default": null, "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reason": { "type": "string", "minLength": 1, "maxLength": 2000 } }, "required": [ "template_id", "subject", "anchor_week_start", "valid_from", "reason" ], "additionalProperties": false }, "WorkforceRotationAssignmentEnd": { "type": "object", "properties": { "valid_to": { "type": "string" }, "reason": { "type": "string", "minLength": 1, "maxLength": 2000 } }, "required": [ "valid_to", "reason" ], "additionalProperties": false }, "WorkforceDemandBinding": { "type": "object", "properties": { "forecast_group_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "valid_from": { "type": "string" }, "valid_to": { "default": null, "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "interpretation": { "type": "string", "enum": [ "shared_pool", "partition", "sequential_stage" ] }, "share": { "default": null, "anyOf": [ { "type": "object", "properties": { "min": { "type": "number", "minimum": 0, "maximum": 1 }, "max": { "type": "number", "minimum": 0, "maximum": 1 } }, "required": [ "min", "max" ], "additionalProperties": false }, { "type": "null" } ] }, "stage_key": { "default": null, "anyOf": [ { "type": "string", "pattern": "^[a-z0-9][a-z0-9_.-]{0,63}$" }, { "type": "null" } ] }, "qualification_ids": { "default": [], "maxItems": 20, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "reason": { "type": "string", "minLength": 1, "maxLength": 2000 } }, "required": [ "forecast_group_id", "valid_from", "interpretation", "reason" ], "additionalProperties": false }, "WorkforceDemandBindingEnd": { "type": "object", "properties": { "valid_to": { "type": "string" }, "reason": { "type": "string", "minLength": 1, "maxLength": 2000 } }, "required": [ "valid_to", "reason" ], "additionalProperties": false }, "WorkforcePlanningPage": { "type": "object", "description": "One page of native records. `complete` is false while `nextCursor` continues the list; a failed read is an error, never an empty page.", "properties": { "items": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "nextCursor": { "type": [ "string", "null" ] }, "complete": { "type": "boolean" } }, "required": [ "items", "nextCursor", "complete" ], "additionalProperties": true }, "WorkforcePlanningResult": { "type": "object", "description": "Native typed outcome. Depending on the operation: records and effective revisions, `issues` with code, field path, severity and source references, applied constraints, soft preference effects, affected drafts and future published commitments with `complete`, missing or unsupported evidence, `replayed` for an exact retry and verified effect references. Authored availability, preference and pattern bodies round-trip unchanged.", "additionalProperties": true }, "WorkforceMySchedule": { "type": "object", "description": "The bearer owner's published shifts with complete activities and the published revision of each schedule. Drafts are never returned; observed operational actuals are a separate read.", "properties": { "person_id": { "type": "string", "format": "uuid" }, "from": { "type": "string", "format": "date" }, "to": { "type": "string", "format": "date" }, "published_only": { "const": true }, "observed_actuals": { "const": "separate_operation" }, "shifts": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "schedules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "version": { "type": "integer" }, "published_at": { "type": [ "string", "null" ] } }, "required": [ "id", "version", "published_at" ], "additionalProperties": false } } }, "required": [ "person_id", "from", "to", "published_only", "observed_actuals", "shifts", "schedules" ], "additionalProperties": false } } } }