> ## 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 profile revision

> Read only. Field issues, contradictions with Person-wide restrictions, effective availability and affected drafts and future published commitments.



## OpenAPI

````yaml /api-reference/workforce/openapi.json post /api/v1/workforce/scheduling-profiles/{subjectKind}/{subjectId}/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-profiles/{subjectKind}/{subjectId}/preview:
    post:
      summary: Preview a profile revision
      description: >-
        Read only. Field issues, contradictions with Person-wide restrictions,
        effective availability and affected drafts and future published
        commitments.
      operationId: 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'
components:
  schemas:
    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
                        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
    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.