Alteryx Server API V3 — Jobs

naftiko: 1.0.0-alpha2
info:
  label: Alteryx Server API V3 — Jobs
  description: 'Alteryx Server API V3 — Jobs. 2 operations. Lead operation: Get Jobs for a Workflow. Self-contained Naftiko
    capability covering one Alteryx business surface.'
  tags:
  - Alteryx
  - Jobs
  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-jobs
    baseUri: https://{serverHostname}/webapi
    description: Alteryx Server API V3 — Jobs business capability. Self-contained, no shared references.
    resources:
    - name: v3-workflows-workflowId-jobs
      path: /v3/workflows/{workflowId}/jobs
      operations:
      - name: getworkflowjobs
        method: GET
        description: Get Jobs for a Workflow
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: sortField
          in: query
          type: string
          description: Field to sort results by
        - name: direction
          in: query
          type: string
          description: Sort direction
        - name: offset
          in: query
          type: string
          description: Number of records to skip for pagination
        - name: limit
          in: query
          type: string
          description: Maximum number of records to return
        - name: status
          in: query
          type: string
          description: Filter by job status
        - name: resultCode
          in: query
          type: string
          description: Filter by result code
      - name: createjob
        method: POST
        description: Create a New Job for a Workflow
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.ALTERYX_API_KEY}}'
  exposes:
  - type: rest
    namespace: server-api-v3-jobs-rest
    port: 8080
    description: REST adapter for Alteryx Server API V3 — Jobs. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/v3/workflows/{workflowid}/jobs
      name: v3-workflows-workflowid-jobs
      description: REST surface for v3-workflows-workflowId-jobs.
      operations:
      - method: GET
        name: getworkflowjobs
        description: Get Jobs for a Workflow
        call: server-api-v3-jobs.getworkflowjobs
        with:
          sortField: rest.sortField
          direction: rest.direction
          offset: rest.offset
          limit: rest.limit
          status: rest.status
          resultCode: rest.resultCode
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createjob
        description: Create a New Job for a Workflow
        call: server-api-v3-jobs.createjob
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: server-api-v3-jobs-mcp
    port: 9090
    transport: http
    description: MCP adapter for Alteryx Server API V3 — Jobs. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: get-jobs-workflow
      description: Get Jobs for a Workflow
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: server-api-v3-jobs.getworkflowjobs
      with:
        sortField: tools.sortField
        direction: tools.direction
        offset: tools.offset
        limit: tools.limit
        status: tools.status
        resultCode: tools.resultCode
      outputParameters:
      - type: object
        mapping: $.
    - name: create-new-job-workflow
      description: Create a New Job for a Workflow
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: server-api-v3-jobs.createjob
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.