Atlassian · Example Payload

Atlassian Atlassianmatchissues Example

CodeCollaborationPlatformProductivitySoftware Development

Atlassian Atlassianmatchissues 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": "atlassianMatchissues",
  "method": "POST",
  "path": "/rest/api/3/jql/match",
  "summary": "Atlassian Check Issues Against Jql",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "issueIds": [
          10001,
          1000,
          10042
        ],
        "jqls": [
          "project = FOO",
          "issuetype = Bug",
          "summary ~ \"some text\" AND project in (FOO, BAR)"
        ]
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": "{\"matches\":[{\"matchedIssues\":[10000,10004],\"errors\":[]},{\"matchedIssues\":[100134,10025,10236],\"errors\":[]},{\"matchedIssues\":[],\"errors\":[]},{\"matchedIssues\":[],\"errors\":[\"Invalid JQL: broken = value\"]}]}"
    }
  ]
}