Atlassian · Example Payload

Atlassian Atlassiansanitisejqlqueries Example

CodeCollaborationPlatformProductivitySoftware Development

Atlassian Atlassiansanitisejqlqueries 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": "atlassianSanitisejqlqueries",
  "method": "POST",
  "path": "/rest/api/3/jql/sanitize",
  "summary": "Atlassian Sanitize Jql Queries",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "queries": [
          {
            "query": "project = 'Sample project'"
          },
          {
            "accountId": "5b10ac8d82e05b22cc7d4ef5",
            "query": "project = 'Sample project'"
          },
          {
            "accountId": "cda2aa1395ac195d951b3387",
            "query": "project = 'Sample project'"
          },
          {
            "accountId": "5b10ac8d82e05b22cc7d4ef5",
            "query": "invalid query"
          }
        ]
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": "{\"queries\":[{\"initialQuery\":\"project = 'Sample project'\",\"sanitizedQuery\":\"project = 12345\"},{\"initialQuery\":\"project = 'Sample project'\",\"sanitizedQuery\":\"project = 'Sample project'\",\"accountId\":\"5b10ac8d82e05b22cc7d4ef5\"},{\"initialQuery\":\"project = 'Sample project'\",\"sanitizedQuery\":\"project = 12345\",\"accountId\":\"cda2aa1395ac195d951b3387\"},{\"initialQuery\":\"non-parsable query\",\"errors\":{\"errorMessages\":[\"Error in the JQL Query: Expecting operator but got 'query'. The valid operators are '=', '!=', '<', '>', '<=', '>=', '~', '!~', 'IN', 'NOT IN', 'IS' and 'IS NOT'. (line 1, character 9)\"],\"errors\":{}},\"accountId\":\"5b10ac8d82e05b22cc7d4ef5\"}]}"
    },
    {
      "status": "400",
      "contentType": "application/json",
      "example": "{\"errorMessages\":[\"The queries has to be provided.\"],\"errors\":{}}"
    },
    {
      "status": "403",
      "contentType": "application/json",
      "example": "{\"errorMessages\":[\"You are not authorized to perform this action. Administrator privileges are required.\"],\"errors\":{}}"
    }
  ]
}