JIRA 7.6.1

Bulk update workflows

POST

/rest/api/3/workflows/update

Workflows

Update workflows and related statuses.

Permissions required:

Administer Jira project permission to create all, including global-scoped, workflows

Administer projects project permissions to create project-scoped workflows

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://jira.local:8080/jira/rest//rest/api/3/workflows/update' \
--header 'Content-Type: application/json' \
--data-raw '{
    "statuses": [
        {
            "description": "",
            "name": "To Do",
            "statusCategory": "TODO",
            "statusReference": "f0b24de5-25e7-4fab-ab94-63d81db6c0c0"
        },
        {
            "description": "",
            "name": "In Progress",
            "statusCategory": "IN_PROGRESS",
            "statusReference": "c7a35bf0-c127-4aa6-869f-4033730c61d8"
        },
        {
            "description": "",
            "name": "Done",
            "statusCategory": "DONE",
            "statusReference": "6b3fc04d-3316-46c5-a257-65751aeb8849"
        }
    ],
    "workflows": [
        {
            "defaultStatusMappings": [
                {
                    "newStatusReference": "10011",
                    "oldStatusReference": "10010"
                }
            ],
            "description": "",
            "id": "10001",
            "startPointLayout": {
                "x": -100.00030899047852,
                "y": -153.00020599365234
            },
            "statusMappings": [
                {
                    "issueTypeId": "10002",
                    "projectId": "10003",
                    "statusMigrations": [
                        {
                            "newStatusReference": "10011",
                            "oldStatusReference": "10010"
                        }
                    ]
                }
            ],
            "statuses": [
                {
                    "layout": {
                        "x": 114.99993896484375,
                        "y": -16
                    },
                    "properties": {},
                    "statusReference": "f0b24de5-25e7-4fab-ab94-63d81db6c0c0"
                },
                {
                    "layout": {
                        "x": 317.0000915527344,
                        "y": -16
                    },
                    "properties": {},
                    "statusReference": "c7a35bf0-c127-4aa6-869f-4033730c61d8"
                },
                {
                    "layout": {
                        "x": 508.000244140625,
                        "y": -16
                    },
                    "properties": {},
                    "statusReference": "6b3fc04d-3316-46c5-a257-65751aeb8849"
                }
            ],
            "transitions": [
                {
                    "actions": [],
                    "description": "",
                    "from": [],
                    "id": "1",
                    "name": "Create",
                    "properties": {},
                    "to": {
                        "statusReference": "f0b24de5-25e7-4fab-ab94-63d81db6c0c0"
                    },
                    "triggers": [],
                    "type": "INITIAL",
                    "validators": []
                },
                {
                    "actions": [],
                    "description": "",
                    "from": [],
                    "id": "11",
                    "name": "To Do",
                    "properties": {},
                    "to": {
                        "statusReference": "f0b24de5-25e7-4fab-ab94-63d81db6c0c0"
                    },
                    "triggers": [],
                    "type": "GLOBAL",
                    "validators": []
                },
                {
                    "actions": [],
                    "description": "",
                    "from": [],
                    "id": "21",
                    "name": "In Progress",
                    "properties": {},
                    "to": {
                        "statusReference": "c7a35bf0-c127-4aa6-869f-4033730c61d8"
                    },
                    "triggers": [],
                    "type": "GLOBAL",
                    "validators": []
                },
                {
                    "actions": [],
                    "description": "",
                    "from": [],
                    "id": "31",
                    "name": "Done",
                    "properties": {},
                    "to": {
                        "statusReference": "6b3fc04d-3316-46c5-a257-65751aeb8849"
                    },
                    "triggers": [],
                    "type": "GLOBAL",
                    "validators": []
                }
            ],
            "version": {
                "id": "6f6c988b-2590-4358-90c2-5f7960265592",
                "versionNumber": 1
            }
        }
    ]
}'

Response Example

200 - Success

{
  "statuses": [
    {
      "id": "10001",
      "statusReference": "10001",
      "name": "To Do",
      "statusCategory": "TODO",
      "scope": {
        "type": "GLOBAL"
      },
      "description": "",
      "usages": []
    },
    {
      "id": "10002",
      "statusReference": "10002",
      "name": "In Progress",
      "statusCategory": "IN_PROGRESS",
      "scope": {
        "type": "GLOBAL"
      },
      "description": "",
      "usages": []
    },
    {
      "id": "10003",
      "statusReference": "10003",
      "name": "Done",
      "statusCategory": "DONE",
      "scope": {
        "type": "GLOBAL"
      },
      "description": "",
      "usages": []
    }
  ],
  "workflows": [
    {
      "scope": {
        "type": "GLOBAL"
      },
      "version": {
        "versionNumber": 0,
        "id": "f010ac1b-3dd3-43a3-aa66-0ee8a447f76e"
      },
      "id": "b9ff2384-d3b6-4d4e-9509-3ee19f607168",
      "name": "Software workflow 1",
      "description": "",
      "isEditable": true,
      "startPointLayout": {
        "x": -100.00030899047852,
        "y": -153.00020599365234
      },
      "usages": [],
      "statuses": [
        {
          "statusReference": "10001",
          "layout": {
            "x": 114.99993896484375,
            "y": -16
          },
          "properties": {},
          "deprecated": false
        },
        {
          "statusReference": "10002",
          "layout": {
            "x": 317.0000915527344,
            "y": -16
          },
          "properties": {},
          "deprecated": false
        },
        {
          "statusReference": "10003",
          "layout": {
            "x": 508.000244140625,
            "y": -16
          },
          "properties": {},
          "deprecated": false
        }
      ],
      "transitions": [
        {
          "id": "31",
          "type": "GLOBAL",
          "from": [],
          "to": {
            "statusReference": "10003"
          },
          "name": "Done",
          "description": "",
          "actions": [],
          "validators": [],
          "triggers": [],
          "properties": {}
        },
        {
          "id": "11",
          "type": "GLOBAL",
          "from": [],
          "to": {
            "statusReference": "10001"
          },
          "name": "To Do",
          "description": "",
          "actions": [],
          "validators": [],
          "triggers": [],
          "properties": {}
        },
        {
          "id": "21",
          "type": "GLOBAL",
          "from": [],
          "to": {
            "statusReference": "10002"
          },
          "name": "In Progress",
          "description": "",
          "actions": [],
          "validators": [],
          "triggers": [],
          "properties": {}
        },
        {
          "id": "1",
          "type": "INITIAL",
          "from": [],
          "to": {
            "statusReference": "10001"
          },
          "name": "Create",
          "description": "",
          "actions": [],
          "validators": [],
          "triggers": [],
          "properties": {}
        }
      ]
    }
  ],
  "taskId": "10001"
}

Request

Query Params

expand

string

optional

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 is associated with.

statuses.usages Returns the project and issue types that each status is associated with.

Body Params application/json

The update workflows payload.

statuses

array[object (WorkflowStatusUpdate) {6}]

required

The statuses to associate with the workflows.

description

string

optional

The description of the status.

string

optional

The ID of the status.

name

string

required

The name of the status.

statusCategory

enum<string>

required

The category of the status.

Allowed values:

TODOIN_PROGRESSDONE

statusReference

string

required

The reference of the status.

Additional properties

integer | number | string | boolean

optional

workflows

array[object (WorkflowUpdate) {9}]

required

The details of the workflows to update.

defaultStatusMappings

array[object (StatusMigration) {3}]

optional

The mapping of old to new status ID.

description

string

optional

The new description for this workflow.

string

required

The ID of this workflow.

startPointLayout

object (WorkflowLayout) | null

optional

The starting point for the statuses in the workflow.

statusMappings

array[object (StatusMappingDTO) {4}]

optional

The mapping of old to new status ID for a specific project and issue type.

statuses

array[object (StatusLayoutUpdate) {4}]

required

The statuses associated with this workflow.

transitions

array[object (TransitionUpdateDTO) {14}]

required

The transitions of this workflow.

version

object (DocumentVersion)

required

The version details of the workflow.

Additional properties

integer | number | string | boolean

optional

Examples

Responses

🟢200Returned if the request is successful.

application/json

Body

statuses

array[object (JiraWorkflowStatus) {7}]

optional

List of updated statuses.

description

string

optional

The description of the status.

string

optional

The ID of the status.

name

string

optional

The name of the status.

scope

object (WorkflowScope)

optional

The scope of the workflow.

statusCategory

enum<string>

optional

The category of the status.

Allowed values:

TODOIN_PROGRESSDONE

statusReference

string

optional

The reference of the status.

usages

array[object (ProjectIssueTypes) {2}]

optional

The statuses.usages expand is an optional parameter that can be used when reading and updating statuses in Jira. It provides additional information about the projects and issue types associated with the requested statuses.

taskId

string | null

optional

If there is a asynchronous task operation, as a result of this update.

workflows

array[object (JiraWorkflow) {11}]

optional

List of updated workflows.

description

string

optional

The description of the workflow.

string

optional

The ID of the workflow.

isEditable

boolean

optional

Indicates if the workflow can be edited.

name

string

optional

The name of the workflow.

scope

object (WorkflowScope)

optional

The scope of the workflow.

startPointLayout

object (WorkflowLayout) | null

optional

The starting point for the statuses in the workflow.

statuses

array[object (WorkflowReferenceStatus) {4}]

optional

The statuses referenced in this workflow.

taskId

string | null

optional

If there is a current asynchronous task operation for this workflow.

transitions

array[object (WorkflowTransitions) {13}]

optional

The transitions of the workflow.

usages

array[object (ProjectIssueTypes) {2}]

optional

The workflows.usages expand is an optional parameter that can be used when reading and updating workflows in Jira. It provides additional information about the projects and issue types associated with the requested workflows.

version

object (DocumentVersion)

optional

The version details of the workflow.

🟠400Returned if the request is not valid.

🟠401Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation.

Modified at 2023-07-13 03:27:27

Validate create workflows

Validate update workflows