Atlassian The Jira Cloud platform REST API — Workflow Schemes

naftiko: 1.0.0-alpha2
info:
  label: Atlassian The Jira Cloud platform REST API — Workflow Schemes
  description: 'Atlassian The Jira Cloud platform REST API — Workflow Schemes. 17 operations. Lead operation: Atlassian Get
    All Workflow Schemes. Self-contained Naftiko capability covering one Atlassian business surface.'
  tags:
  - Atlassian
  - Workflow Schemes
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ATLASSIAN_API_KEY: ATLASSIAN_API_KEY
capability:
  consumes:
  - type: http
    namespace: jira-workflow-schemes
    baseUri: https://your-domain.atlassian.net
    description: Atlassian The Jira Cloud platform REST API — Workflow Schemes business capability. Self-contained, no shared
      references.
    resources:
    - name: rest-api-3-workflowscheme
      path: /rest/api/3/workflowscheme
      operations:
      - name: atlassiangetallworkflowschemes
        method: GET
        description: Atlassian Get All Workflow Schemes
        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: atlassiancreateworkflowscheme
        method: POST
        description: Atlassian Create Workflow Scheme
        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-workflowscheme-read
      path: /rest/api/3/workflowscheme/read
      operations:
      - name: atlassianreadworkflowschemes
        method: POST
        description: Atlassian Bulk Get Workflow Schemes
        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-workflowscheme-update
      path: /rest/api/3/workflowscheme/update
      operations:
      - name: atlassianupdateschemes
        method: POST
        description: Atlassian Update Workflow Scheme
        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-workflowscheme-update-mappings
      path: /rest/api/3/workflowscheme/update/mappings
      operations:
      - name: atlassianupdateworkflowschememappings
        method: POST
        description: Atlassian Get Required Status Mappings For Workflow Scheme Update
        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-workflowscheme-id
      path: /rest/api/3/workflowscheme/{id}
      operations:
      - name: atlassiandeleteworkflowscheme
        method: DELETE
        description: Atlassian Delete Workflow Scheme
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: The ID of the workflow scheme. Find this ID by editing the desired workflow scheme in Jira. The ID
            is shown in the URL as `schemeId`. For example, *schemeId=103
          required: true
      - name: atlassiangetworkflowscheme
        method: GET
        description: Atlassian Get Workflow Scheme
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: The ID of the workflow scheme. Find this ID by editing the desired workflow scheme in Jira. The ID
            is shown in the URL as `schemeId`. For example, *schemeId=103
          required: true
        - name: returnDraftIfExists
          in: query
          type: boolean
          description: Returns the workflow scheme's draft rather than scheme itself, if set to true. If the workflow scheme
            does not have a draft, then the workflow scheme is returne
      - name: atlassianupdateworkflowscheme
        method: PUT
        description: Atlassian Classic Update Workflow Scheme
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: The ID of the workflow scheme. Find this ID by editing the desired workflow scheme in Jira. The ID
            is shown in the URL as `schemeId`. For example, *schemeId=103
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-api-3-workflowscheme-id-default
      path: /rest/api/3/workflowscheme/{id}/default
      operations:
      - name: atlassiandeletedefaultworkflow
        method: DELETE
        description: Atlassian Delete Default Workflow
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: The ID of the workflow scheme.
          required: true
        - name: updateDraftIfNeeded
          in: query
          type: boolean
          description: Set to true to create or update the draft of a workflow scheme and delete the mapping from the draft,
            when the workflow scheme cannot be edited. Defaults to `fa
      - name: atlassiangetdefaultworkflow
        method: GET
        description: Atlassian Get Default Workflow
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: The ID of the workflow scheme.
          required: true
        - name: returnDraftIfExists
          in: query
          type: boolean
          description: Set to `true` to return the default workflow for the workflow scheme's draft rather than scheme itself.
            If the workflow scheme does not have a draft, then the d
      - name: atlassianupdatedefaultworkflow
        method: PUT
        description: Atlassian Update Default Workflow
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: The ID of the workflow scheme.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-api-3-workflowscheme-id-issuetype-issueType
      path: /rest/api/3/workflowscheme/{id}/issuetype/{issueType}
      operations:
      - name: atlassiandeleteworkflowschemeissuetype
        method: DELETE
        description: Atlassian Delete Workflow For Issue Type In Workflow Scheme
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: The ID of the workflow scheme.
          required: true
        - name: issueType
          in: path
          type: string
          description: The ID of the issue type.
          required: true
        - name: updateDraftIfNeeded
          in: query
          type: boolean
          description: Set to true to create or update the draft of a workflow scheme and update the mapping in the draft,
            when the workflow scheme cannot be edited. Defaults to `fals
      - name: atlassiangetworkflowschemeissuetype
        method: GET
        description: Atlassian Get Workflow For Issue Type In Workflow Scheme
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: The ID of the workflow scheme.
          required: true
        - name: issueType
          in: path
          type: string
          description: The ID of the issue type.
          required: true
        - name: returnDraftIfExists
          in: query
          type: boolean
          description: Returns the mapping from the workflow scheme's draft rather than the workflow scheme, if set to true.
            If no draft exists, the mapping from the workflow scheme i
      - name: atlassiansetworkflowschemeissuetype
        method: PUT
        description: Atlassian Set Workflow For Issue Type In Workflow Scheme
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: The ID of the workflow scheme.
          required: true
        - name: issueType
          in: path
          type: string
          description: The ID of the issue type.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-api-3-workflowscheme-id-workflow
      path: /rest/api/3/workflowscheme/{id}/workflow
      operations:
      - name: atlassiandeleteworkflowmapping
        method: DELETE
        description: Atlassian Delete Issue Types For Workflow In Workflow Scheme
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: The ID of the workflow scheme.
          required: true
        - name: workflowName
          in: query
          type: string
          description: The name of the workflow.
          required: true
        - name: updateDraftIfNeeded
          in: query
          type: boolean
          description: Set to true to create or update the draft of a workflow scheme and delete the mapping from the draft,
            when the workflow scheme cannot be edited. Defaults to `fa
      - name: atlassiangetworkflow
        method: GET
        description: Atlassian Get Issue Types For Workflows In Workflow Scheme
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: The ID of the workflow scheme.
          required: true
        - name: workflowName
          in: query
          type: string
          description: The name of a workflow in the scheme. Limits the results to the workflow-issue type mapping for the
            specified workflow.
        - name: returnDraftIfExists
          in: query
          type: boolean
          description: Returns the mapping from the workflow scheme's draft rather than the workflow scheme, if set to true.
            If no draft exists, the mapping from the workflow scheme i
      - name: atlassianupdateworkflowmapping
        method: PUT
        description: Atlassian Set Issue Types For Workflow In Workflow Scheme
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: The ID of the workflow scheme.
          required: true
        - name: workflowName
          in: query
          type: string
          description: The name of the workflow.
          required: true
        - 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-workflow-schemes-rest
    port: 8080
    description: REST adapter for Atlassian The Jira Cloud platform REST API — Workflow Schemes. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/api/3/workflowscheme
      name: rest-api-3-workflowscheme
      description: REST surface for rest-api-3-workflowscheme.
      operations:
      - method: GET
        name: atlassiangetallworkflowschemes
        description: Atlassian Get All Workflow Schemes
        call: jira-workflow-schemes.atlassiangetallworkflowschemes
        with:
          startAt: rest.startAt
          maxResults: rest.maxResults
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: atlassiancreateworkflowscheme
        description: Atlassian Create Workflow Scheme
        call: jira-workflow-schemes.atlassiancreateworkflowscheme
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/workflowscheme/read
      name: rest-api-3-workflowscheme-read
      description: REST surface for rest-api-3-workflowscheme-read.
      operations:
      - method: POST
        name: atlassianreadworkflowschemes
        description: Atlassian Bulk Get Workflow Schemes
        call: jira-workflow-schemes.atlassianreadworkflowschemes
        with:
          expand: rest.expand
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/workflowscheme/update
      name: rest-api-3-workflowscheme-update
      description: REST surface for rest-api-3-workflowscheme-update.
      operations:
      - method: POST
        name: atlassianupdateschemes
        description: Atlassian Update Workflow Scheme
        call: jira-workflow-schemes.atlassianupdateschemes
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/workflowscheme/update/mappings
      name: rest-api-3-workflowscheme-update-mappings
      description: REST surface for rest-api-3-workflowscheme-update-mappings.
      operations:
      - method: POST
        name: atlassianupdateworkflowschememappings
        description: Atlassian Get Required Status Mappings For Workflow Scheme Update
        call: jira-workflow-schemes.atlassianupdateworkflowschememappings
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/workflowscheme/{id}
      name: rest-api-3-workflowscheme-id
      description: REST surface for rest-api-3-workflowscheme-id.
      operations:
      - method: DELETE
        name: atlassiandeleteworkflowscheme
        description: Atlassian Delete Workflow Scheme
        call: jira-workflow-schemes.atlassiandeleteworkflowscheme
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: atlassiangetworkflowscheme
        description: Atlassian Get Workflow Scheme
        call: jira-workflow-schemes.atlassiangetworkflowscheme
        with:
          id: rest.id
          returnDraftIfExists: rest.returnDraftIfExists
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: atlassianupdateworkflowscheme
        description: Atlassian Classic Update Workflow Scheme
        call: jira-workflow-schemes.atlassianupdateworkflowscheme
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/workflowscheme/{id}/default
      name: rest-api-3-workflowscheme-id-default
      description: REST surface for rest-api-3-workflowscheme-id-default.
      operations:
      - method: DELETE
        name: atlassiandeletedefaultworkflow
        description: Atlassian Delete Default Workflow
        call: jira-workflow-schemes.atlassiandeletedefaultworkflow
        with:
          id: rest.id
          updateDraftIfNeeded: rest.updateDraftIfNeeded
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: atlassiangetdefaultworkflow
        description: Atlassian Get Default Workflow
        call: jira-workflow-schemes.atlassiangetdefaultworkflow
        with:
          id: rest.id
          returnDraftIfExists: rest.returnDraftIfExists
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: atlassianupdatedefaultworkflow
        description: Atlassian Update Default Workflow
        call: jira-workflow-schemes.atlassianupdatedefaultworkflow
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/workflowscheme/{id}/issuetype/{issuetype}
      name: rest-api-3-workflowscheme-id-issuetype-issuetype
      description: REST surface for rest-api-3-workflowscheme-id-issuetype-issueType.
      operations:
      - method: DELETE
        name: atlassiandeleteworkflowschemeissuetype
        description: Atlassian Delete Workflow For Issue Type In Workflow Scheme
        call: jira-workflow-schemes.atlassiandeleteworkflowschemeissuetype
        with:
          id: rest.id
          issueType: rest.issueType
          updateDraftIfNeeded: rest.updateDraftIfNeeded
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: atlassiangetworkflowschemeissuetype
        description: Atlassian Get Workflow For Issue Type In Workflow Scheme
        call: jira-workflow-schemes.atlassiangetworkflowschemeissuetype
        with:
          id: rest.id
          issueType: rest.issueType
          returnDraftIfExists: rest.returnDraftIfExists
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: atlassiansetworkflowschemeissuetype
        description: Atlassian Set Workflow For Issue Type In Workflow Scheme
        call: jira-workflow-schemes.atlassiansetworkflowschemeissuetype
        with:
          id: rest.id
          issueType: rest.issueType
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/workflowscheme/{id}/workflow
      name: rest-api-3-workflowscheme-id-workflow
      description: REST surface for rest-api-3-workflowscheme-id-workflow.
      operations:
      - method: DELETE
        name: atlassiandeleteworkflowmapping
        description: Atlassian Delete Issue Types For Workflow In Workflow Scheme
        call: jira-workflow-schemes.atlassiandeleteworkflowmapping
        with:
          id: rest.id
          workflowName: rest.workflowName
          updateDraftIfNeeded: rest.updateDraftIfNeeded
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: atlassiangetworkflow
        description: Atlassian Get Issue Types For Workflows In Workflow Scheme
        call: jira-workflow-schemes.atlassiangetworkflow
        with:
          id: rest.id
          workflowName: rest.workflowName
          returnDraftIfExists: rest.returnDraftIfExists
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: atlassianupdateworkflowmapping
        description: Atlassian Set Issue Types For Workflow In Workflow Scheme
        call: jira-workflow-schemes.atlassianupdateworkflowmapping
        with:
          id: rest.id
          workflowName: rest.workflowName
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: jira-workflow-schemes-mcp
    port: 9090
    transport: http
    description: MCP adapter for Atlassian The Jira Cloud platform REST API — Workflow Schemes. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: atlassian-get-all-workflow-schemes
      description: Atlassian Get All Workflow Schemes
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: jira-workflow-schemes.atlassiangetallworkflowschemes
      with:
        startAt: tools.startAt
        maxResults: tools.maxResults
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-create-workflow-scheme
      description: Atlassian Create Workflow Scheme
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: jira-workflow-schemes.atlassiancreateworkflowscheme
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-bulk-get-workflow-schemes
      description: Atlassian Bulk Get Workflow Schemes
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: jira-workflow-schemes.atlassianreadworkflowschemes
      with:
        expand: tools.expand
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-update-workflow-scheme
      description: Atlassian Update Workflow Scheme
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: jira-workflow-schemes.atlassianupdateschemes
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-get-required-status-mappings
      description: Atlassian Get Required Status Mappings For Workflow Scheme Update
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: jira-workflow-schemes.atlassianupdateworkflowschememappings
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-delete-workflow-scheme
      description: Atlassian Delete Workflow Scheme
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: jira-workflow-schemes.atlassiandeleteworkflowscheme
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-get-workflow-scheme
      description: Atlassian Get Workflow Scheme
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: jira-workflow-schemes.atlassiangetworkflowscheme
      with:
        id: tools.id
        returnDraftIfExists: tools.returnDraftIfExists
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-classic-update-workflow-scheme
      description: Atlassian Classic Update Workflow Scheme
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: jira-workflow-schemes.atlassianupdateworkflowscheme
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-delete-default-workflow
      description: Atlassian Delete Default Workflow
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: jira-workflow-schemes.atlassiandeletedefaultworkflow
      with:
        id: tools.id
        updateDraftIfNeeded: tools.updateDraftIfNeeded
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-get-default-workflow
      description: Atlassian Get Default Workflow
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: jira-workflow-schemes.atlassiangetdefaultworkflow
      with:
        id: tools.id
        returnDraftIfExists: tools.returnDraftIfExists
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-update-default-workflow
      description: Atlassian Update Default Workflow
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: jira-workflow-schemes.atlassianupdatedefaultworkflow
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-delete-workflow-issue-type
      description: Atlassian Delete Workflow For Issue Type In Workflow Scheme
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: jira-workflow-schemes.atlassiandeleteworkflowschemeissuetype
      with:
        id: tools.id
        issueType: tools.issueType
        updateDraftIfNeeded: tools.updateDraftIfNeeded
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-get-workflow-issue-type
      description: Atlassian Get Workflow For Issue Type In Workflow Scheme
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: jira-workflow-schemes.atlassiangetworkflowschemeissuetype
      with:
        id: tools.id
        issueType: tools.issueType
        returnDraftIfExists: tools.returnDraftIfExists
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-set-workflow-issue-type
      description: Atlassian Set Workflow For Issue Type In Workflow Scheme
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: jira-workflow-schemes.atlassiansetworkflowschemeissuetype
      with:
        id: tools.id
        issueType: tools.issueType
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-delete-issue-types-workflow
      description: Atlassian Delete Issue Types For Workflow In Workflow Scheme
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: jira-workflow-schemes.atlassiandeleteworkflowmapping
      with:
        id: tools.id
        workflowName: tools.workflowName
        updateDraftIfNeeded: tools.updateDraftIfNeeded
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-get-issue-types-workflows
      description: Atlassian Get Issue Types For Workflows In Workflow Scheme
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: jira-workflow-schemes.atlassiangetworkflow
      with:
        id: tools.id
        workflowName: tools.workflowName
        returnDraftIfExists: tools.returnDraftIfExists
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-set-issue-types-workflow
      description: Atlassian Set Issue Types For Workflow In Workflow Scheme
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: jira-workflow-schemes.atlassianupdateworkflowmapping
      with:
        id: tools.id
        workflowName: tools.workflowName
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.