Atlassian · Example Payload

Atlassian Atlassianexportarchivedissues Example

CodeCollaborationPlatformProductivitySoftware Development

Atlassian Atlassianexportarchivedissues 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": "atlassianExportarchivedissues",
  "method": "PUT",
  "path": "/rest/api/3/issues/archive/export",
  "summary": "Atlassian Export Archived Issue S",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "archivedBy": [
          "uuid-rep-001",
          "uuid-rep-002"
        ],
        "archivedDate": {
          "dateAfter": "2023-01-01",
          "dateBefore": "2023-01-12"
        },
        "archivedDateRange": {
          "dateAfter": "2023-01-01",
          "dateBefore": "2023-01-12"
        },
        "issueTypes": [
          "10001",
          "10002"
        ],
        "projects": [
          "FOO",
          "BAR"
        ],
        "reporters": [
          "uuid-rep-001",
          "uuid-rep-002"
        ]
      }
    }
  ],
  "responseExamples": [
    {
      "status": "202",
      "contentType": "application/json",
      "example": "{\"payload\":\"{projects=[FOO, BAR], reporters=[uuid-rep-001, uuid-rep-002], issueTypes=[10001, 10002], archivedDate={dateAfterInstant=2023-01-01, dateBeforeInstant=2023-01-12}, archivedBy=[uuid-rep-001, uuid-rep-002]}\",\"progress\":0,\"status\":\"ENQUEUED\",\"submittedTime\":1623230887000,\"taskId\":\"10990\"}"
    },
    {
      "status": "400",
      "contentType": "application/json",
      "example": "[\"Your filter contains invalid values {errorMessage}\"]"
    },
    {
      "status": "401",
      "contentType": "application/json",
      "example": "{\"errorMessages\":[\"User is not logged in.\"],\"errors\":{}}"
    },
    {
      "status": "403",
      "contentType": "application/json",
      "example": "{\"errorMessages\":[\"User is not an admin.\"],\"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\":{}}"
    }
  ]
}