Get workflow transition rule configurations

POST

/rest/atlassian-connect/1/migration/workflow/rule/search

Returns configurations for workflow transition rules migrated from server to cloud and owned by the calling Connect app.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://jira.local:8080/jira/rest//rest/atlassian-connect/1/migration/workflow/rule/search' \
--header 'Atlassian-Transfer-Id;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "expand": "transition",
    "ruleIds": [
        "55d44f1d-c859-42e5-9c27-2c5ec3f340b1"
    ],
    "workflowEntityId": "a498d711-685d-428d-8c3e-bc03bb450ea7"
}'

Response Example

200 - Success

{
    "workflowEntityId": "a498d711-685d-428d-8c3e-bc03bb450ea7",
    "invalidRules": [
        "55d44f1d-c859-42e5-9c27-2c5ec3f340b1"
    ],
    "validRules": [
        {
            "workflowId": {
                "name": "Workflow name",
                "draft": true
            },
            "postFunctions": [
                {
                    "id": "123",
                    "key": "WorkflowKey",
                    "configuration": {
                        "value": "WorkflowValidator"
                    },
                    "transition": {
                        "name": "transition",
                        "id": 123
                    }
                }
            ],
            "conditions": [
                {
                    "id": "123",
                    "key": "WorkflowKey",
                    "configuration": {
                        "value": "WorkflowValidator"
                    },
                    "transition": {
                        "name": "transition",
                        "id": 123
                    }
                }
            ],
            "validators": [
                {
                    "id": "123",
                    "key": "WorkflowKey",
                    "configuration": {
                        "value": "WorkflowValidator"
                    },
                    "transition": {
                        "name": "transition",
                        "id": 123
                    }
                }
            ]
        }
    ]
}

Request

Header Params

Atlassian-Transfer-Id

string

required

The app migration transfer ID.

Body Params application/json

Details of the workflow and its transition rules.

expand

string

optional

Use expand to include additional information in the response. This parameter accepts transition which, for each rule, returns information about the transition the rule is assigned to.

Example:

transition

ruleIds

array[string <uuid>]

required

The list of workflow rule IDs.

>= 1 items<= 10 items

workflowEntityId

string <uuid>

required

The workflow ID.

Example:

a498d711-685d-428d-8c3e-bc03bb450ea7

Examples

Responses

🟢200Returned if the request is successful.

application/json

Body

Details of workflow transition rules.

invalidRules

array[string <uuid>]

optional

List of workflow rule IDs that do not belong to the workflow or can not be found.

validRules

array[object (WorkflowTransitionRules) {4}]

optional

List of valid workflow transition rules.

conditions

array[object (AppWorkflowTransitionRule) {4}]

optional

The list of conditions within the workflow.

postFunctions

array[object (AppWorkflowTransitionRule) {4}]

optional

The list of post functions within the workflow.

validators

array[object (AppWorkflowTransitionRule) {4}]

optional

The list of validators within the workflow.

workflowId

object (WorkflowId)

required

Properties that identify a workflow.

workflowEntityId

string <uuid>

optional

The workflow ID.

Example:

a498d711-685d-428d-8c3e-bc03bb450ea7

🟠400Returned if the request is not valid.

🟠403Returned if the authorisation credentials are incorrect or missing.

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

Bulk update entity properties