JIRA 7.6.1

Validate update workflows

POST

/rest/api/3/workflows/update/validation

Workflows

Validate the payload for bulk update workflows.

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/validation' \
--header 'Content-Type: application/json' \
--data-raw '{
    "payload": {
        "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
                }
            }
        ]
    },
    "validationOptions": {
        "levels": [
            "ERROR",
            "WARNING"
        ]
    }
}'

Response Example

200 - Success

{
  "errors": [
    {
      "type": "STATUS",
      "message": "You must use a unique status name.",
      "code": "NON_UNIQUE_STATUS_NAME",
      "level": "ERROR",
      "elementReference": {
        "statusReference": "1f0443ff-47e4-4306-9c26-0af696059a43"
      }
    }
  ]
}

Request

Body Params application/json

payload

object (WorkflowUpdateRequest)

required

The update workflows payload.

statuses

array[object (WorkflowStatusUpdate) {6}]

required

The statuses to associate with the workflows.

workflows

array[object (WorkflowUpdate) {9}]

required

The details of the workflows to update.

validationOptions

object (ValidationOptionsForUpdate)

optional

The level of validation to return from the API. If no values are provided, the default would return WARNING and ERROR level validation results.

levels

array[string]

optional

<= 2 items

Allowed values:

WARNINGERROR

Examples

Responses

🟢200Returned if the request is successful.

application/json

Body

errors

array[object (WorkflowValidationError) {5}]

optional

The list of validation errors.

code

string

optional

An error code.

elementReference

object (WorkflowElementReference)

optional

A reference to the location of the error. This will be null if the error does not refer to a specific element.

level

enum<string>

optional

The validation error level.

Allowed values:

WARNINGERROR

message

string

optional

An error message.

type

enum<string>

optional

The type of element the error or warning references.

Allowed values:

RULESTATUSSTATUS_LAYOUTSTATUS_PROPERTYWORKFLOWTRANSITIONTRANSITION_PROPERTYSCOPESTATUS_MAPPINGTRIGGER

🟠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

Bulk update workflows

Get workflow transition rule configurations