Atlassian · Example Payload

Atlassian Atlassianparsejqlqueries Example

CodeCollaborationPlatformProductivitySoftware Development

Atlassian Atlassianparsejqlqueries 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": "atlassianParsejqlqueries",
  "method": "POST",
  "path": "/rest/api/3/jql/parse",
  "summary": "Atlassian Parse Jql Query",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "queries": [
          "summary ~ test AND (labels in (urgent, blocker) OR lastCommentedBy = currentUser()) AND status CHANGED AFTER startOfMonth(-1M) ORDER BY updated DESC",
          "issue.property[\"spaces here\"].value in (\"Service requests\", Incidents)",
          "invalid query",
          "summary = test",
          "summary in test",
          "project = INVALID",
          "universe = 42"
        ]
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": "{\"queries\":[{\"query\":\"summary ~ test AND (labels in (urgent, blocker) OR lastCommentedBy = currentUser()) AND status CHANGED AFTER -5d ORDER BY updated DESC\",\"structure\":{\"orderBy\":{\"fields\":[{\"direction\":\"desc\",\"field\":{\"encodedName\":\"updated\",\"name\":\"updated\"}}]},\"where\":{\"clauses\":[{\"field\":{\"encodedName\":\"summary\",\"name\":\"summary\"},\"operand\":{\"encodedValue\":\"test\",\"value\":\"test\"},\"operator\":\"~\"},{\"clauses\":[{\"field\":{\"encodedName\":\"labels\",\"name\":\"labels\"},\"operand\":{\"encodedOperand\":\"urgent, blocker)\",\"values\":[{\"encodedValue\":\"urgent\",\"value\":\"urgent\"},{\"encodedValue\":\"blocker\",\"value\":\"blocker\"}]},\"operator\":\"in\"},{\"field\":{\"encodedName\":\"lastCommentedBy\",\"name\":\"lastCommentedBy\",\"property\":[{\"entity\":\"issue\",\"key\":\"propertyKey\",\"path\":\"path.in.property\",\"type\":\"user\"}]},\"operand\":{\"arguments\":[],\"encodedOperand\":\"currentUser()\",\"function\":\"currentUser\"},\"operator\":\"=\"}],\"operator\":\"or\"},{\"field\":{\"encodedName\":\"status\",\"name\":\"status\"},\"operator\":\"changed\",\"predicates\":[{\"operand\":{\"arguments\":[\"-1M\"],\"encodedOperand\":\"startOfMonth(-1M)\",\"function\":\"startOfMonth\"},\"operator\":\"after\"}]}],\"operator\":\"and\"}}},{\"query\":\"issue.property[\\\"spaces here\\\"].value in (\\\"Service requests\\\", Incidents)\",\"structure\":{\"where\":{\"field\":{\"encodedName\":\"issue.property[\\\"spaces here\\\"].value\",\"name\":\"issue.property[spaces here].value\",\"property\":[{\"entity\":\"issue\",\"key\":\"spaces here\",\"path\":\"value\"}]},\"operand\":{\"encodedOperand\":\"(\\\"Service requests\\\", Incidents)\",\"values\":[{\"encodedValue\":\"\\\"Service requests\\\"\",\"value\":\"Service requests\"},{\"encodedValue\":\"Incidents\",\"value\":\"Incidents\"}]},\"operator\":\"in\"}}},{\"errors\":[\"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)\"],\"query\":\"invalid query\"},{\"errors\":[\"The operator '=' is not supported by the 'summary' field.\"],\"query\":\"summary = test\"},{\"errors\":[\"Operator 'in' does not support the non-list value '\\\"test\\\"' for field 'summary'.\"],\"query\":\"summary in test\"},{\"errors\":[\"The value 'INVALID' does not exist for the field 'project'.\"],\"query\":\"project = INVALID\"},{\"errors\":[\"Field 'universe' does not exist or you do not have permission to view it.\"],\"query\":\"universe = 42\"}]}"
    }
  ]
}