Atlassian · Example Payload

Atlassian Atlassianevaluatejiraexpression Example

CodeCollaborationPlatformProductivitySoftware Development

Atlassian Atlassianevaluatejiraexpression 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": "atlassianEvaluatejiraexpression",
  "method": "POST",
  "path": "/rest/api/3/expression/eval",
  "summary": "Atlassian Evaluate Jira Expression",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "context": {
          "board": 10100,
          "custom": {
            "config": {
              "type": "json",
              "value": {
                "userId": "10002"
              }
            },
            "issuesList": [
              {
                "key": "ACJIRA-1471",
                "type": "issue"
              },
              {
                "id": 100001,
                "type": "issue"
              }
            ],
            "myUser": {
              "accountId": "100001",
              "type": "user"
            },
            "nullField": {
              "type": "json"
            }
          },
          "customerRequest": 1450,
          "issue": {
            "key": "ACJIRA-1470"
          },
          "issues": {
            "jql": {
              "maxResults": 100,
              "query": "project = HSP",
              "startAt": 0,
              "validation": "strict"
            }
          },
          "project": {
            "key": "ACJIRA"
          },
          "serviceDesk": 10023,
          "sprint": 10001
        },
        "expression": "{ key: issue.key, type: issue.issueType.name, links: issue.links.map(link => link.linkedIssue.id), listCustomVariable: issuesList.includes(issue), customVariables: myUser.accountId == config.userId}"
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": "{\"value\":\"The expression's result. This value can be any JSON, not necessarily a String\",\"meta\":{\"complexity\":{\"steps\":{\"value\":1,\"limit\":10000},\"expensiveOperations\":{\"value\":3,\"limit\":10},\"beans\":{\"value\":0,\"limit\":1000},\"primitiveValues\":{\"value\":1,\"limit\":10000}},\"issues\":{\"jql\":{\"startAt\":0,\"maxResults\":1000,\"count\":140,\"totalCount\":140,\"validationWarnings\":[\"There is a problem with the JQL query.\"]}}}}"
    },
    {
      "status": "400",
      "contentType": "application/json",
      "example": "{\"errorMessages\":[\"Evaluation failed: \\\"issue['a' + 'b']\\\" - Unrecognized property of `issue`: \\\"ab\\\" ('a' + 'b'). Available properties of type 'Issue' are: 'assignee', 'comments', 'description', 'id', 'issueType', 'key', 'priority', 'project', 'properties', 'reporter', 'status', 'summary'\"],\"errors\":{}}"
    },
    {
      "status": "404",
      "contentType": "application/json",
      "example": "{\"errorMessages\":[\"Issue does not exist or you do not have permission to see it.\"],\"errors\":{}}"
    }
  ]
}