Atlassian · Example Payload

Atlassian Atlassianarchiveissuesasync Example

CodeCollaborationPlatformProductivitySoftware Development

Atlassian Atlassianarchiveissuesasync 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": "atlassianArchiveissuesasync",
  "method": "POST",
  "path": "/rest/api/3/issue/archive",
  "summary": "Atlassian Archive Issue S By Jql",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "jql": "project = FOO AND updated < -2y"
      }
    }
  ],
  "responseExamples": [
    {
      "status": "202",
      "contentType": "application/json",
      "example": "\"https://your-domain.atlassian.net/rest/api/3/task/1010\""
    },
    {
      "status": "400",
      "contentType": "application/json",
      "example": "{\"errorMessages\":[\"Invalid JQL. Bad request.\"],\"errors\":{}}"
    },
    {
      "status": "401",
      "contentType": "application/json",
      "example": "{\"errorMessages\":[\"User is not logged in.\"],\"errors\":{}}"
    },
    {
      "status": "403",
      "contentType": "application/json",
      "example": "{\"errorMessages\":[\"Archiving issues is only available for premium editions of Jira.\"],\"errors\":{}}"
    },
    {
      "status": "412",
      "contentType": "application/json",
      "example": "{\"errorMessages\":[\"An issue archival task is already running with ID 1010. To start a new one, cancel the task or wait for it to finish.\"],\"errors\":{}}"
    }
  ]
}