Atlassian · Example Payload

Atlassian Atlassianupdateworkflows Example

CodeCollaborationPlatformProductivitySoftware Development

Atlassian Atlassianupdateworkflows 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

Raw ↑
{
  "operationId": "atlassianUpdateworkflows",
  "method": "POST",
  "path": "/rest/api/3/workflows/update",
  "summary": "Atlassian Bulk Update Workflows",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "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
            }
          }
        ]
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": "{\"statuses\":[{\"description\":\"\",\"id\":\"10001\",\"name\":\"To Do\",\"scope\":{\"type\":\"GLOBAL\"},\"statusCategory\":\"TODO\",\"statusReference\":\"10001\",\"usages\":[]},{\"description\":\"\",\"id\":\"10002\",\"name\":\"In Progress\",\"scope\":{\"type\":\"GLOBAL\"},\"statusCategory\":\"IN_PROGRESS\",\"statusReference\":\"10002\",\"usages\":[]},{\"description\":\"\",\"id\":\"10003\",\"name\":\"Done\",\"scope\":{\"type\":\"GLOBAL\"},\"statusCategory\":\"DONE\",\"statusReference\":\"10003\",\"usages\":[]}],\"taskId\":\"10001\",\"workflows\":[{\"description\":\"\",\"id\":\"b9ff2384-d3b6-4d4e-9509-3ee19f607168\",\"isEditable\":true,\"name\":\"Software workflow 1\",\"scope\":{\"type\":\"GLOBAL\"},\"startPointLayout\":{\"x\":-100.00030899047852,\"y\":-153.00020599365234},\"statuses\":[{\"deprecated\":false,\"layout\":{\"x\":114.99993896484375,\"y\":-16.0},\"properties\":{},\"statusReference\":\"10001\"},{\"deprecated\":false,\"layout\":{\"x\":317.0000915527344,\"y\":-16.0},\"properties\":{},\"statusReference\":\"10002\"},{\"deprecated\":false,\"layout\":{\"x\":508.000244140625,\"y\":-16.0},\"properties\":{},\"statusReference\":\"10003\"}],\"transitions\":[{\"actions\":[],\"description\":\"\",\"from\":[],\"id\":\"31\",\"name\":\"Done\",\"properties\":{},\"to\":{\"statusReference\":\"10003\"},\"triggers\":[],\"type\":\"GLOBAL\",\"validators\":[]},{\"actions\":[],\"description\":\"\",\"from\":[],\"id\":\"11\",\"name\":\"To Do\",\"properties\":{},\"to\":{\"statusReference\":\"10001\"},\"triggers\":[],\"type\":\"GLOBAL\",\"validators\":[]},{\"actions\":[],\"description\":\"\",\"from\":[],\"id\":\"21\",\"name\":\"In Progress\",\"properties\":{},\"to\":{\"statusReference\":\"10002\"},\"triggers\":[],\"type\":\"GLOBAL\",\"validators\":[]},{\"actions\":[],\"description\":\"\",\"from\":[],\"id\":\"1\",\"name\":\"Create\",\"properties\":{},\"to\":{\"statusReference\":\"10001\"},\"triggers\":[],\"type\":\"INITIAL\",\"validators\":[]}],\"usages\":[],\"version\":{\"id\":\"f010ac1b-3dd3-43a3-aa66-0ee8a447f76e\",\"versionNumber\":0}}]}"
    }
  ]
}