Atlassian The Jira Cloud platform REST API — Workflows

naftiko: 1.0.0-alpha2
info:
  label: Atlassian The Jira Cloud platform REST API — Workflows
  description: 'Atlassian The Jira Cloud platform REST API — Workflows. 10 operations. Lead operation: Atlassian Get All Workflows.
    Self-contained Naftiko capability covering one Atlassian business surface.'
  tags:
  - Atlassian
  - Workflows
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ATLASSIAN_API_KEY: ATLASSIAN_API_KEY
capability:
  consumes:
  - type: http
    namespace: jira-workflows
    baseUri: https://your-domain.atlassian.net
    description: Atlassian The Jira Cloud platform REST API — Workflows business capability. Self-contained, no shared references.
    resources:
    - name: rest-api-3-workflow
      path: /rest/api/3/workflow
      operations:
      - name: atlassiangetallworkflows
        method: GET
        description: Atlassian Get All Workflows
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workflowName
          in: query
          type: string
          description: The name of the workflow to be returned. Only one workflow can be specified.
      - name: atlassiancreateworkflow
        method: POST
        description: Atlassian Create Workflow
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-api-3-workflow-search
      path: /rest/api/3/workflow/search
      operations:
      - name: atlassiangetworkflowspaginated
        method: GET
        description: Atlassian Get Workflows Paginated
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: startAt
          in: query
          type: integer
          description: The index of the first item to return in a page of results (page offset).
        - name: maxResults
          in: query
          type: integer
          description: The maximum number of items to return per page.
        - name: workflowName
          in: query
          type: array
          description: The name of a workflow to return. To include multiple workflows, provide an ampersand-separated list.
            For example, `workflowName=name1&workflowName=name2`.
        - name: expand
          in: query
          type: string
          description: 'Use [expand](#expansion) to include additional information in the response. This parameter accepts
            a comma-separated list. Expand options include:'
        - name: queryString
          in: query
          type: string
          description: String used to perform a case-insensitive partial match with workflow name.
        - name: orderBy
          in: query
          type: string
          description: '[Order](#ordering) the results by a field:'
        - name: isActive
          in: query
          type: boolean
          description: Filters active and inactive workflows.
    - name: rest-api-3-workflow-entityId
      path: /rest/api/3/workflow/{entityId}
      operations:
      - name: atlassiandeleteinactiveworkflow
        method: DELETE
        description: Atlassian Delete Inactive Workflow
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: entityId
          in: path
          type: string
          description: The entity ID of the workflow.
          required: true
    - name: rest-api-3-workflows
      path: /rest/api/3/workflows
      operations:
      - name: atlassianreadworkflows
        method: POST
        description: Atlassian Bulk Get Workflows
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: expand
          in: query
          type: string
          description: 'Use [expand](#expansion) to include additional information in the response. This parameter accepts
            a comma-separated list. Expand options include:'
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-api-3-workflows-capabilities
      path: /rest/api/3/workflows/capabilities
      operations:
      - name: atlassianworkflowcapabilities
        method: GET
        description: Atlassian Get Available Workflow Capabilities
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workflowId
          in: query
          type: string
        - name: projectId
          in: query
          type: string
        - name: issueTypeId
          in: query
          type: string
    - name: rest-api-3-workflows-create
      path: /rest/api/3/workflows/create
      operations:
      - name: atlassiancreateworkflows
        method: POST
        description: Atlassian Bulk Create Workflows
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-api-3-workflows-create-validation
      path: /rest/api/3/workflows/create/validation
      operations:
      - name: atlassianvalidatecreateworkflows
        method: POST
        description: Atlassian Validate Create Workflows
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-api-3-workflows-update
      path: /rest/api/3/workflows/update
      operations:
      - name: atlassianupdateworkflows
        method: POST
        description: Atlassian Bulk Update Workflows
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: expand
          in: query
          type: string
          description: 'Use [expand](#expansion) to include additional information in the response. This parameter accepts
            a comma-separated list. Expand options include:'
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-api-3-workflows-update-validation
      path: /rest/api/3/workflows/update/validation
      operations:
      - name: atlassianvalidateupdateworkflows
        method: POST
        description: Atlassian Validate Update Workflows
        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.ATLASSIAN_API_KEY}}'
  exposes:
  - type: rest
    namespace: jira-workflows-rest
    port: 8080
    description: REST adapter for Atlassian The Jira Cloud platform REST API — Workflows. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/api/3/workflow
      name: rest-api-3-workflow
      description: REST surface for rest-api-3-workflow.
      operations:
      - method: GET
        name: atlassiangetallworkflows
        description: Atlassian Get All Workflows
        call: jira-workflows.atlassiangetallworkflows
        with:
          workflowName: rest.workflowName
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: atlassiancreateworkflow
        description: Atlassian Create Workflow
        call: jira-workflows.atlassiancreateworkflow
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/workflow/search
      name: rest-api-3-workflow-search
      description: REST surface for rest-api-3-workflow-search.
      operations:
      - method: GET
        name: atlassiangetworkflowspaginated
        description: Atlassian Get Workflows Paginated
        call: jira-workflows.atlassiangetworkflowspaginated
        with:
          startAt: rest.startAt
          maxResults: rest.maxResults
          workflowName: rest.workflowName
          expand: rest.expand
          queryString: rest.queryString
          orderBy: rest.orderBy
          isActive: rest.isActive
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/workflow/{entityid}
      name: rest-api-3-workflow-entityid
      description: REST surface for rest-api-3-workflow-entityId.
      operations:
      - method: DELETE
        name: atlassiandeleteinactiveworkflow
        description: Atlassian Delete Inactive Workflow
        call: jira-workflows.atlassiandeleteinactiveworkflow
        with:
          entityId: rest.entityId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/workflows
      name: rest-api-3-workflows
      description: REST surface for rest-api-3-workflows.
      operations:
      - method: POST
        name: atlassianreadworkflows
        description: Atlassian Bulk Get Workflows
        call: jira-workflows.atlassianreadworkflows
        with:
          expand: rest.expand
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/workflows/capabilities
      name: rest-api-3-workflows-capabilities
      description: REST surface for rest-api-3-workflows-capabilities.
      operations:
      - method: GET
        name: atlassianworkflowcapabilities
        description: Atlassian Get Available Workflow Capabilities
        call: jira-workflows.atlassianworkflowcapabilities
        with:
          workflowId: rest.workflowId
          projectId: rest.projectId
          issueTypeId: rest.issueTypeId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/workflows/create
      name: rest-api-3-workflows-create
      description: REST surface for rest-api-3-workflows-create.
      operations:
      - method: POST
        name: atlassiancreateworkflows
        description: Atlassian Bulk Create Workflows
        call: jira-workflows.atlassiancreateworkflows
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/workflows/create/validation
      name: rest-api-3-workflows-create-validation
      description: REST surface for rest-api-3-workflows-create-validation.
      operations:
      - method: POST
        name: atlassianvalidatecreateworkflows
        description: Atlassian Validate Create Workflows
        call: jira-workflows.atlassianvalidatecreateworkflows
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/workflows/update
      name: rest-api-3-workflows-update
      description: REST surface for rest-api-3-workflows-update.
      operations:
      - method: POST
        name: atlassianupdateworkflows
        description: Atlassian Bulk Update Workflows
        call: jira-workflows.atlassianupdateworkflows
        with:
          expand: rest.expand
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/workflows/update/validation
      name: rest-api-3-workflows-update-validation
      description: REST surface for rest-api-3-workflows-update-validation.
      operations:
      - method: POST
        name: atlassianvalidateupdateworkflows
        description: Atlassian Validate Update Workflows
        call: jira-workflows.atlassianvalidateupdateworkflows
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: jira-workflows-mcp
    port: 9090
    transport: http
    description: MCP adapter for Atlassian The Jira Cloud platform REST API — Workflows. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: atlassian-get-all-workflows
      description: Atlassian Get All Workflows
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: jira-workflows.atlassiangetallworkflows
      with:
        workflowName: tools.workflowName
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-create-workflow
      description: Atlassian Create Workflow
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: jira-workflows.atlassiancreateworkflow
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-get-workflows-paginated
      description: Atlassian Get Workflows Paginated
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: jira-workflows.atlassiangetworkflowspaginated
      with:
        startAt: tools.startAt
        maxResults: tools.maxResults
        workflowName: tools.workflowName
        expand: tools.expand
        queryString: tools.queryString
        orderBy: tools.orderBy
        isActive: tools.isActive
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-delete-inactive-workflow
      description: Atlassian Delete Inactive Workflow
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: jira-workflows.atlassiandeleteinactiveworkflow
      with:
        entityId: tools.entityId
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-bulk-get-workflows
      description: Atlassian Bulk Get Workflows
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: jira-workflows.atlassianreadworkflows
      with:
        expand: tools.expand
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-get-available-workflow-capabilities
      description: Atlassian Get Available Workflow Capabilities
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: jira-workflows.atlassianworkflowcapabilities
      with:
        workflowId: tools.workflowId
        projectId: tools.projectId
        issueTypeId: tools.issueTypeId
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-bulk-create-workflows
      description: Atlassian Bulk Create Workflows
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: jira-workflows.atlassiancreateworkflows
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-validate-create-workflows
      description: Atlassian Validate Create Workflows
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: jira-workflows.atlassianvalidatecreateworkflows
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-bulk-update-workflows
      description: Atlassian Bulk Update Workflows
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: jira-workflows.atlassianupdateworkflows
      with:
        expand: tools.expand
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-validate-update-workflows
      description: Atlassian Validate Update Workflows
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: jira-workflows.atlassianvalidateupdateworkflows
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.