> ## 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.

# Archive a pattern

> Retains history and issued evidence and lists current usages. A repeated archive at the same revision replays.



## OpenAPI

````yaml /api-reference/workforce/openapi.json post /api/v1/workforce/scheduling-patterns/{patternId}/archive
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/{patternId}/archive:
    post:
      summary: Archive a pattern
      description: >-
        Retains history and issued evidence and lists current usages. A repeated
        archive at the same revision replays.
      operationId: 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'
components:
  schemas:
    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
    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.