> ## Documentation Index > Fetch the complete documentation index at: https://docs.aioncx.com/llms.txt > Use this file to discover all available pages before exploring further. # Preview a new pattern > Read only. Field issues, references and the elapsed, paid, contract and productive minutes of each alternative. ## OpenAPI ````yaml /api-reference/workforce/openapi.json post /api/v1/workforce/scheduling-patterns/preview 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/scheduling-patterns/preview: post: summary: Preview a new pattern description: >- Read only. Field issues, references and the elapsed, paid, contract and productive minutes of each alternative. operationId: 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' components: schemas: 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 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 Error: type: object properties: error: type: object properties: code: type: string message: type: string details: {} required: - code - message additionalProperties: false required: - error additionalProperties: false 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. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.