Alteryx Server API V3 — Schedules

naftiko: 1.0.0-alpha2
info:
  label: Alteryx Server API V3 — Schedules
  description: 'Alteryx Server API V3 — Schedules. 6 operations. Lead operation: Create a New Schedule. Self-contained Naftiko
    capability covering one Alteryx business surface.'
  tags:
  - Alteryx
  - Schedules
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ALTERYX_API_KEY: ALTERYX_API_KEY
capability:
  consumes:
  - type: http
    namespace: server-api-v3-schedules
    baseUri: https://{serverHostname}/webapi
    description: Alteryx Server API V3 — Schedules business capability. Self-contained, no shared references.
    resources:
    - name: v3-schedules
      path: /v3/schedules
      operations:
      - name: createschedule
        method: POST
        description: Create a New Schedule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: getschedules
        method: GET
        description: Retrieve All Schedules
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: view
          in: query
          type: string
          description: Level of detail in the response
        - name: ownerId
          in: query
          type: string
          description: Filter by schedule owner
        - name: workflowId
          in: query
          type: string
          description: Filter by associated workflow
        - name: runsAfter
          in: query
          type: string
          description: Filter schedules that run after this date (ISO 8601, max 45-day range)
        - name: runsBefore
          in: query
          type: string
          description: Filter schedules that run before this date (ISO 8601, max 45-day range)
    - name: v3-schedules-scheduleId
      path: /v3/schedules/{scheduleId}
      operations:
      - name: getschedule
        method: GET
        description: Retrieve a Specific Schedule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateschedule
        method: PUT
        description: Update a Schedule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: patchschedule
        method: PATCH
        description: Partially Update a Schedule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteschedule
        method: DELETE
        description: Delete a Schedule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.ALTERYX_API_KEY}}'
  exposes:
  - type: rest
    namespace: server-api-v3-schedules-rest
    port: 8080
    description: REST adapter for Alteryx Server API V3 — Schedules. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v3/schedules
      name: v3-schedules
      description: REST surface for v3-schedules.
      operations:
      - method: POST
        name: createschedule
        description: Create a New Schedule
        call: server-api-v3-schedules.createschedule
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getschedules
        description: Retrieve All Schedules
        call: server-api-v3-schedules.getschedules
        with:
          view: rest.view
          ownerId: rest.ownerId
          workflowId: rest.workflowId
          runsAfter: rest.runsAfter
          runsBefore: rest.runsBefore
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v3/schedules/{scheduleid}
      name: v3-schedules-scheduleid
      description: REST surface for v3-schedules-scheduleId.
      operations:
      - method: GET
        name: getschedule
        description: Retrieve a Specific Schedule
        call: server-api-v3-schedules.getschedule
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateschedule
        description: Update a Schedule
        call: server-api-v3-schedules.updateschedule
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: patchschedule
        description: Partially Update a Schedule
        call: server-api-v3-schedules.patchschedule
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteschedule
        description: Delete a Schedule
        call: server-api-v3-schedules.deleteschedule
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: server-api-v3-schedules-mcp
    port: 9090
    transport: http
    description: MCP adapter for Alteryx Server API V3 — Schedules. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: create-new-schedule
      description: Create a New Schedule
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: server-api-v3-schedules.createschedule
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-all-schedules
      description: Retrieve All Schedules
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: server-api-v3-schedules.getschedules
      with:
        view: tools.view
        ownerId: tools.ownerId
        workflowId: tools.workflowId
        runsAfter: tools.runsAfter
        runsBefore: tools.runsBefore
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-specific-schedule
      description: Retrieve a Specific Schedule
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: server-api-v3-schedules.getschedule
      outputParameters:
      - type: object
        mapping: $.
    - name: update-schedule
      description: Update a Schedule
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: server-api-v3-schedules.updateschedule
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: partially-update-schedule
      description: Partially Update a Schedule
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: server-api-v3-schedules.patchschedule
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-schedule
      description: Delete a Schedule
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: server-api-v3-schedules.deleteschedule
      outputParameters:
      - type: object
        mapping: $.