Atlassian · Example Payload
Atlassian Atlassianvalidatecreateworkflows Example

CodeCollaborationPlatformProductivitySoftware Development
Atlassian Atlassianvalidatecreateworkflows Example is an example object payload from Atlassian, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples
Example Payload

{
  "operationId": "atlassianValidatecreateworkflows",
  "method": "POST",
  "path": "/rest/api/3/workflows/create/validation",
  "summary": "Atlassian Validate Create Workflows",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "payload": {
          "scope": {
            "type": "GLOBAL"
          },
          "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": [
            {
              "description": "",
              "name": "Software workflow 1",
              "startPointLayout": {
                "x": -100.00030899047852,
                "y": -153.00020599365234
              },
              "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": []
                }
              ]
            }
          ]
        },
        "validationOptions": {
          "levels": [
            "ERROR",
            "WARNING"
          ]
        }
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": "{\"errors\":[{\"code\":\"NON_UNIQUE_STATUS_NAME\",\"elementReference\":{\"statusReference\":\"1f0443ff-47e4-4306-9c26-0af696059a43\"},\"level\":\"ERROR\",\"message\":\"You must use a unique status name.\",\"type\":\"STATUS\"}]}"
    }
  ]
}