Atlassian · Example Payload

Atlassian Atlassianarchiveissues Example

CodeCollaborationPlatformProductivitySoftware Development

Atlassian Atlassianarchiveissues 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": "atlassianArchiveissues",
  "method": "PUT",
  "path": "/rest/api/3/issue/archive",
  "summary": "Atlassian Archive Issue S By Issue Id Key",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "issueIdsOrKeys": [
          "PR-1",
          "1001",
          "PROJECT-2"
        ]
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": "{\"errors\":{\"issueIsSubtask\":{\"count\":3,\"issueIdsOrKeys\":[\"ST-1\",\"ST-2\",\"ST-3\"],\"message\":\"Issue is subtask.\"},\"issuesInArchivedProjects\":{\"count\":2,\"issueIdsOrKeys\":[\"AR-1\",\"AR-2\"],\"message\":\"Issue exists in archived project.\"},\"issuesInUnlicensedProjects\":{\"count\":3,\"issueIdsOrKeys\":[\"UL-1\",\"UL-2\",\"UL-3\"],\"message\":\"Issues with these IDs are in unlicensed projects.\"},\"issuesNotFound\":{\"count\":3,\"issueIdsOrKeys\":[\"PR-1\",\"PR-2\",\"PR-3\"],\"message\":\"Issue not found.\"}},\"numberOfIssuesUpdated\":10}"
    },
    {
      "status": "400",
      "contentType": "application/json",
      "example": "{\"errorMessages\":[\"No valid issue to archive or unarchive. Bad request.\"],\"errors\":{}}"
    },
    {
      "status": "401",
      "contentType": "application/json",
      "example": "{\"errorMessages\":[\"User is not logged in.\"],\"errors\":{}}"
    },
    {
      "status": "403",
      "contentType": "application/json",
      "example": "{\"errorMessages\":[\"Only admins can archive or unarchive issues. Access denied.\"],\"errors\":{}}"
    },
    {
      "status": "412",
      "contentType": "application/json",
      "example": "{\"errorMessages\":[\"The number of issues to archive or unarchive exceeds the hard limit of 1000. Precondition failed.\"],\"errors\":{}}"
    }
  ]
}