POST /rest/api/2/workflowscheme/read

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

Permissions required:

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Query parameters

Name Type Required Description
expand String No

Deprecated. See the deprecation notice for details.

Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:

  • workflows.usages Returns the project and issue types that each workflow in the workflow scheme is associated with.

Request body fields

Name Type Required Description
projectIds[] Array No

The list of project IDs to query.

workflowSchemeIds[] Array No

The list of workflow scheme IDs to query.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.