Alteryx Server API V3 — Workflows

naftiko: 1.0.0-alpha2
info:
  label: Alteryx Server API V3 — Workflows
  description: 'Alteryx Server API V3 — Workflows. 9 operations. Lead operation: Upload a New Workflow. Self-contained Naftiko
    capability covering one Alteryx business surface.'
  tags:
  - Alteryx
  - Workflows
  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-workflows
    baseUri: https://{serverHostname}/webapi
    description: Alteryx Server API V3 — Workflows business capability. Self-contained, no shared references.
    resources:
    - name: v3-workflows
      path: /v3/workflows
      operations:
      - name: uploadworkflow
        method: POST
        description: Upload a New Workflow
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: getworkflows
        method: GET
        description: Retrieve All Workflows
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: view
          in: query
          type: string
          description: Level of detail in the response
        - name: name
          in: query
          type: string
          description: Filter workflows by name
        - name: ownerId
          in: query
          type: string
          description: Filter workflows by owner ID
        - name: createdAfter
          in: query
          type: string
          description: Filter workflows created after this date (ISO 8601 format)
        - name: createdBefore
          in: query
          type: string
          description: Filter workflows created before this date (ISO 8601 format)
    - name: v3-workflows-workflowId
      path: /v3/workflows/{workflowId}
      operations:
      - name: getworkflow
        method: GET
        description: Retrieve a Specific Workflow
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateworkflow
        method: PUT
        description: Update an Existing Workflow
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteworkflow
        method: DELETE
        description: Delete a Workflow
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: force
          in: query
          type: boolean
          description: Force deletion even if workflow has dependencies
    - name: v3-workflows-workflowId-package
      path: /v3/workflows/{workflowId}/package
      operations:
      - name: downloadworkflowpackage
        method: GET
        description: Download a Workflow Package
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: versionId
          in: query
          type: string
          description: Specific version ID to download
    - name: v3-workflows-workflowId-questions
      path: /v3/workflows/{workflowId}/questions
      operations:
      - name: getworkflowquestions
        method: GET
        description: Retrieve Analytic App Questions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: versionId
          in: query
          type: string
          description: Specific version ID
    - name: v3-workflows-workflowId-transfer
      path: /v3/workflows/{workflowId}/transfer
      operations:
      - name: transferworkflow
        method: PUT
        description: Transfer Workflow Ownership
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v3-workflows-workflowId-versions
      path: /v3/workflows/{workflowId}/versions
      operations:
      - name: uploadworkflowversion
        method: POST
        description: Upload a New Version of an Existing 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-workflows-rest
    port: 8080
    description: REST adapter for Alteryx Server API V3 — Workflows. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v3/workflows
      name: v3-workflows
      description: REST surface for v3-workflows.
      operations:
      - method: POST
        name: uploadworkflow
        description: Upload a New Workflow
        call: server-api-v3-workflows.uploadworkflow
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getworkflows
        description: Retrieve All Workflows
        call: server-api-v3-workflows.getworkflows
        with:
          view: rest.view
          name: rest.name
          ownerId: rest.ownerId
          createdAfter: rest.createdAfter
          createdBefore: rest.createdBefore
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v3/workflows/{workflowid}
      name: v3-workflows-workflowid
      description: REST surface for v3-workflows-workflowId.
      operations:
      - method: GET
        name: getworkflow
        description: Retrieve a Specific Workflow
        call: server-api-v3-workflows.getworkflow
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateworkflow
        description: Update an Existing Workflow
        call: server-api-v3-workflows.updateworkflow
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteworkflow
        description: Delete a Workflow
        call: server-api-v3-workflows.deleteworkflow
        with:
          force: rest.force
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v3/workflows/{workflowid}/package
      name: v3-workflows-workflowid-package
      description: REST surface for v3-workflows-workflowId-package.
      operations:
      - method: GET
        name: downloadworkflowpackage
        description: Download a Workflow Package
        call: server-api-v3-workflows.downloadworkflowpackage
        with:
          versionId: rest.versionId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v3/workflows/{workflowid}/questions
      name: v3-workflows-workflowid-questions
      description: REST surface for v3-workflows-workflowId-questions.
      operations:
      - method: GET
        name: getworkflowquestions
        description: Retrieve Analytic App Questions
        call: server-api-v3-workflows.getworkflowquestions
        with:
          versionId: rest.versionId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v3/workflows/{workflowid}/transfer
      name: v3-workflows-workflowid-transfer
      description: REST surface for v3-workflows-workflowId-transfer.
      operations:
      - method: PUT
        name: transferworkflow
        description: Transfer Workflow Ownership
        call: server-api-v3-workflows.transferworkflow
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v3/workflows/{workflowid}/versions
      name: v3-workflows-workflowid-versions
      description: REST surface for v3-workflows-workflowId-versions.
      operations:
      - method: POST
        name: uploadworkflowversion
        description: Upload a New Version of an Existing Workflow
        call: server-api-v3-workflows.uploadworkflowversion
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: server-api-v3-workflows-mcp
    port: 9090
    transport: http
    description: MCP adapter for Alteryx Server API V3 — Workflows. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: upload-new-workflow
      description: Upload a New Workflow
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: server-api-v3-workflows.uploadworkflow
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-all-workflows
      description: Retrieve All Workflows
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: server-api-v3-workflows.getworkflows
      with:
        view: tools.view
        name: tools.name
        ownerId: tools.ownerId
        createdAfter: tools.createdAfter
        createdBefore: tools.createdBefore
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-specific-workflow
      description: Retrieve a Specific Workflow
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: server-api-v3-workflows.getworkflow
      outputParameters:
      - type: object
        mapping: $.
    - name: update-existing-workflow
      description: Update an Existing Workflow
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: server-api-v3-workflows.updateworkflow
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-workflow
      description: Delete a Workflow
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: server-api-v3-workflows.deleteworkflow
      with:
        force: tools.force
      outputParameters:
      - type: object
        mapping: $.
    - name: download-workflow-package
      description: Download a Workflow Package
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: server-api-v3-workflows.downloadworkflowpackage
      with:
        versionId: tools.versionId
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-analytic-app-questions
      description: Retrieve Analytic App Questions
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: server-api-v3-workflows.getworkflowquestions
      with:
        versionId: tools.versionId
      outputParameters:
      - type: object
        mapping: $.
    - name: transfer-workflow-ownership
      description: Transfer Workflow Ownership
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: server-api-v3-workflows.transferworkflow
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: upload-new-version-existing-workflow
      description: Upload a New Version of an Existing Workflow
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: server-api-v3-workflows.uploadworkflowversion
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.