Workflow schemes

Bulk get workflow schemes

Changed on

Returns a list of workflow schemes by providing workflow scheme IDs or project IDs.

Permissions required:

  • Administer Jira global permission to access all, including project-scoped, workflow schemes
  • Administer projects project permissions to access project-scoped workflow schemes
post/rest/api/3/workflowscheme/read

Request

  • Base URL
    https://your-domain.atlassian.net
  • URL
    https://your-domain.atlassian.net/rest/api/3/workflowscheme/read
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.atlassian.com/authorize
      Token URL: https://auth.atlassian.com/oauth/token scopes: manage:jira-configuration

Request body

projectIdsstring[] nullable

The list of project IDs to query.

workflowSchemeIdsstring[] nullable

The list of workflow scheme IDs to query.

Response

Returned if the request is successful.

descriptionstring nullable

The description of the workflow scheme.

idstring required

The ID of the workflow scheme.

namestring required

The name of the workflow scheme.

taskIdstring nullable

Indicates if there's an asynchronous task for this workflow scheme.

Changes

  • 10c4041677d4Revision changes
    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property //// from the response with the status

    • warning

      deleted the query request parameter expand

    • warning

      removed the optional property / from the response with the status

  • 25c5ce462677Revision changes
    • breaking

      the response property // became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property ///// became nullable for the status

    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the response property ///// became optional for the status

    • breaking

      the response property ///// became optional for the status