openapi: 3.2.0
info:
  contact:
    email: ecosystem@atlassian.com
  description: Jira Cloud platform REST API documentation
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  termsOfService: https://developer.atlassian.com/platform/marketplace/atlassian-developer-terms/
  title: Jira Cloud platform REST Jira expressions API
  version: 1001.0.0-SNAPSHOT-82b018affa468e58f284fbe4df33536469d757df
servers:
- url: https://your-domain.atlassian.net
tags:
- description: This resource is a collection of operations for Jira expressions.
  name: Jira Expressions
paths:
  /rest/api/3/expression/analyse:
    post:
      deprecated: false
      description: 'Analyses and validates Jira expressions.


        As an experimental feature, this operation can also attempt to type-check the expressions.


        Learn more about Jira expressions in the documentation.


        **Permissions required**: None.'
      operationId: analyseExpression
      parameters:
      - description: "The check to perform:\n\n *  `syntax` Each expression's syntax is checked to ensure the expression can be parsed. Also, syntactic limits are validated. For example, the expression's length.\n *  `type` EXPERIMENTAL. Each expression is type checked and the final type of the expression inferred. Any type errors that would result in the expression failure at runtime are reported. For example, accessing properties that don't exist or passing the wrong number of arguments to functions. Also performs the syntax check.\n *  `complexity` EXPERIMENTAL. Determines the formulae for how many [expensive operations](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/#expensive-operations) each expression may execute."
        in: query
        name: check
        schema:
          default: syntax
          enum:
          - syntax
          - type
          - complexity
          type: string
      requestBody:
        content:
          application/json:
            example:
              contextVariables:
                listOfStrings: List<String>
                record: '{ a: Number, b: String }'
                value: User
              expressions:
              - issues.map(issue => issue.properties['property_key'])
            schema:
              $ref: '#/components/schemas/JiraExpressionForAnalysis'
        description: The Jira expressions to analyse.
        required: true
      responses:
        '200':
          content:
            application/json:
              example: '{"results":[{"expression":"analysed expression","errors":[{"line":1,"column":4,"message":"!, -, typeof, (, IDENTIFIER, null, true, false, NUMBER, STRING, TEMPLATE_LITERAL, new, [ or { expected, > encountered.","type":"syntax"},{"message":"Jira expression is too long (1040), limit: 1000 characters","type":"other"},{"message":"Jira expression has too many nodes (150), limit: 100 leaves","type":"other"}],"valid":false},{"expression":"issues.map(i => {idAndKey: [i.id, i.key], summary: i.summary, comments: i.comments})","valid":true,"type":"List<{idAndKey: [Number, String], summary: String, comments: List<Comment>}>","complexity":{"expensiveOperations":"N","variables":{"N":"issues"}}},{"expression":"issues.map(i => i.id > ''0'')","errors":[{"expression":"i.id > 0","message":"Can''t compare Number to String.","type":"type"}],"valid":false,"type":"TypeError"}]}'
              schema:
                $ref: '#/components/schemas/JiraExpressionsAnalysis'
          description: Returned if the request is successful.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: 400 response
        '401':
          description: Returned if the authentication credentials are incorrect or missing.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: 404 response
      security:
      - basicAuth: []
      - OAuth2:
        - read:jira-work
        - read:jira-user
      - {}
      summary: Analyse Jira expression
      tags:
      - Jira Expressions
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: true
      x-atlassian-oauth2-scopes:
      - scheme: OAuth2
        scopes:
        - read:jira-work
        - read:jira-user
        state: Current
      - scheme: OAuth2
        scopes:
        - read:field:jira
        - read:jira-expressions:jira
        state: Beta
      x-atlassian-connect-scope: READ
  /rest/api/3/expression/eval:
    post:
      deprecated: true
      description: 'Endpoint is currently being removed. More details


        Evaluates a Jira expression and returns its value.


        This resource can be used to test Jira expressions that you plan to use elsewhere, or to fetch data in a flexible way. Consult the Jira expressions documentation for more details.


        #### Context variables ####


        The following context variables are available to Jira expressions evaluated by this resource. Their presence depends on various factors; usually you need to manually request them in the context object sent in the payload, but some of them are added automatically under certain conditions.


        * `user` (User): The current user. Always available and equal to `null` if the request is anonymous.

        * `app` (App): The Connect app that made the request. Available only for authenticated requests made by Connect Apps (read more here: Authentication for Connect apps).

        * `issue` (Issue): The current issue. Available only when the issue is provided in the request context object.

        * `issues` (List of Issues): A collection of issues matching a JQL query. Available only when JQL is provided in the request context object.

        * `project` (Project): The current project. Available only when the project is provided in the request context object.

        * `sprint` (Sprint): The current sprint. Available only when the sprint is provided in the request context object.

        * `board` (Board): The current board. Available only when the board is provided in the request context object.

        * `serviceDesk` (ServiceDesk): The current service desk. Available only when the service desk is provided in the request context object.

        * `customerRequest` (CustomerRequest): The current customer request. Available only when the customer request is provided in the request context object.


        Also, custom context variables can be passed in the request with their types. Those variables can be accessed by key in the Jira expression. These variable types are available for use in a custom context:


        * `user`: A user specified as an Atlassian account ID.

        * `issue`: An issue specified by ID or key. All the fields of the issue object are available in the Jira expression.

        * `json`: A JSON object containing custom content.

        * `list`: A JSON list of `user`, `issue`, or `json` variable types.


        This operation can be accessed anonymously.


        **Permissions required**: None. However, an expression may return different results for different users depending on their permissions. For example, different users may see different comments on the same issue.

        Permission to access Jira Software is required to access Jira Software context variables (`board` and `sprint`) or fields (for example, `issue.sprint`).'
      operationId: evaluateJiraExpression
      parameters:
      - description: Use [expand](#expansion) to include additional information in the response. This parameter accepts `meta.complexity` that returns information about the expression complexity. For example, the number of expensive operations used by the expression and how close the expression is to reaching the [complexity limit](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/#restrictions). Useful when designing and debugging your expressions.
        in: query
        name: expand
        schema:
          type: string
      requestBody:
        content:
          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}'
            schema:
              $ref: '#/components/schemas/JiraExpressionEvalRequestBean'
        description: The Jira expression and the evaluation context.
        required: true
      responses:
        '200':
          content:
            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."]}}}}'
              schema:
                $ref: '#/components/schemas/JiraExpressionResult'
          description: Returned if the evaluation results in a value. The result is a JSON primitive value, list, or object.
        '400':
          content:
            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":{}}'
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: "Returned if:\n\n *  the request is invalid, that is:\n    \n     *  invalid data is provided, such as a request including issue ID and key.\n     *  the expression is invalid and can not be parsed.\n *  evaluation fails at runtime. This may happen for various reasons. For example, accessing a property on a null object (such as the expression `issue.id` where `issue` is `null`). In this case an error message is provided."
        '401':
          description: Returned if the authentication credentials are incorrect or missing.
        '404':
          content:
            application/json:
              example: '{"errorMessages":["Issue does not exist or you do not have permission to see it."],"errors":{}}'
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: Returned if any object provided in the request context is not found or the user does not have permission to view it.
      security:
      - basicAuth: []
      - OAuth2:
        - read:jira-work
        - read:jira-user
      - {}
      summary: Currently being removed. Evaluate Jira expression
      tags:
      - Jira Expressions
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
      x-atlassian-oauth2-scopes:
      - scheme: OAuth2
        scopes:
        - read:jira-work
        - read:jira-user
        state: Current
      - scheme: OAuth2
        scopes:
        - read:jira-expressions:jira
        state: Beta
      x-changes:
      - announced: '2024-10-31'
        details: https://developer.atlassian.com/changelog/#CHANGE-2046
        effective: '2025-05-01'
        type: removed
      x-atlassian-connect-scope: READ
  /rest/api/3/expression/evaluate:
    post:
      deprecated: false
      description: 'Evaluates a Jira expression and returns its value. The difference between this and `eval` is that this endpoint uses the enhanced search API when evaluating JQL queries. This API is eventually consistent, unlike the strongly consistent `eval` API. This allows for better performance and scalability. In addition, this API''s response for JQL evaluation is based on a scrolling view (backed by a `nextPageToken`) instead of a paginated view (backed by `startAt` and `totalCount`).


        This resource can be used to test Jira expressions that you plan to use elsewhere, or to fetch data in a flexible way. Consult the Jira expressions documentation for more details.


        #### Context variables ####


        The following context variables are available to Jira expressions evaluated by this resource. Their presence depends on various factors; usually you need to manually request them in the context object sent in the payload, but some of them are added automatically under certain conditions.


        * `user` (User): The current user. Always available and equal to `null` if the request is anonymous.

        * `app` (App): The Connect app that made the request. Available only for authenticated requests made by Connect apps (read more here: Authentication for Connect apps).

        * `issue` (Issue): The current issue. Available only when the issue is provided in the request context object.

        * `issues` (List of Issues): A collection of issues matching a JQL query. Available only when JQL is provided in the request context object.

        * `project` (Project): The current project. Available only when the project is provided in the request context object.

        * `sprint` (Sprint): The current sprint. Available only when the sprint is provided in the request context object.

        * `board` (Board): The current board. Available only when the board is provided in the request context object.

        * `serviceDesk` (ServiceDesk): The current service desk. Available only when the service desk is provided in the request context object.

        * `customerRequest` (CustomerRequest): The current customer request. Available only when the customer request is provided in the request context object.


        In addition, you can pass custom context variables along with their types. You can then access them from the Jira expression by key. You can use the following variables in a custom context:


        * `user`: A user specified as an Atlassian account ID.

        * `issue`: An issue specified by ID or key. All the fields of the issue object are available in the Jira expression.

        * `json`: A JSON object containing custom content.

        * `list`: A JSON list of `user`, `issue`, or `json` variable types.


        This operation can be accessed anonymously.


        **Permissions required**: None. However, an expression may return different results for different users depending on their permissions. For example, different users may see different comments on the same issue.

        Permission to access Jira Software is required to access Jira Software context variables (`board` and `sprint`) or fields (for example, `issue.sprint`).'
      operationId: evaluateJSISJiraExpression
      parameters:
      - description: Use [expand](#expansion) to include additional information in the response. This parameter accepts `meta.complexity` that returns information about the expression complexity. For example, the number of expensive operations used by the expression and how close the expression is to reaching the [complexity limit](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/#restrictions). Useful when designing and debugging your expressions.
        in: query
        name: expand
        schema:
          type: string
      requestBody:
        content:
          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
                    nextPageToken: EgQIlMIC
                    query: project = HSP
                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}'
            schema:
              $ref: '#/components/schemas/JiraExpressionEvaluateRequestBean'
        description: The Jira expression and the evaluation context.
        required: true
      responses:
        '200':
          content:
            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":{"nextPageToken":"EgQIlMIC","isLast":false}}}}'
              schema:
                $ref: '#/components/schemas/JExpEvaluateJiraExpressionResultBean'
          description: Returned if the evaluation results in a value. The result is a JSON primitive value, list, or object.
        '400':
          content:
            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":{}}'
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: "Returned if:\n\n *  the request is invalid, that is:\n    \n     *  invalid data is provided, such as a request including issue ID and key.\n     *  the expression is invalid and can not be parsed.\n *  evaluation fails at runtime. This may happen for various reasons. For example, accessing a property on a null object (such as the expression `issue.id` where `issue` is `null`). In this case an error message is provided.\n *  If jql is unbounded or empty.\n *  If nextPageToken is invalid"
        '401':
          description: Returned if the authentication credentials are incorrect or missing.
        '404':
          content:
            application/json:
              example: '{"errorMessages":["Issue does not exist or you do not have permission to see it."],"errors":{}}'
              schema:
                $ref: '#/components/schemas/ErrorCollection'
          description: Returned if any object provided in the request context is not found or the user does not have permission to view it.
      security:
      - basicAuth: []
      - OAuth2:
        - read:jira-work
        - read:jira-user
      - {}
      summary: Evaluate Jira expression using enhanced search API
      tags:
      - Jira Expressions
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
      x-atlassian-oauth2-scopes:
      - scheme: OAuth2
        scopes:
        - read:jira-work
        - read:jira-user
        state: Current
      - scheme: OAuth2
        scopes:
        - read:jira-expressions:jira
        state: Beta
      x-atlassian-connect-scope: READ
components:
  schemas:
    JiraExpressionEvaluationMetaDataBean:
      additionalProperties: false
      properties:
        complexity:
          allOf:
          - $ref: '#/components/schemas/JiraExpressionsComplexityBean'
          description: Contains information about the expression complexity. For example, the number of steps it took to evaluate the expression.
        issues:
          allOf:
          - $ref: '#/components/schemas/IssuesMetaBean'
          description: Contains information about the `issues` variable in the context. For example, is the issues were loaded with JQL, information about the page will be included here.
      type: object
    JiraExpressionEvalContextBean:
      additionalProperties: false
      properties:
        board:
          description: The ID of the board that is available under the `board` variable when evaluating the expression.
          format: int64
          type: integer
        custom:
          description: "Custom context variables and their types. These variable types are available for use in a custom context:\n\n *  `user`: A [user](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#user) specified as an Atlassian account ID.\n *  `issue`: An [issue](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#issue) specified by ID or key. All the fields of the issue object are available in the Jira expression.\n *  `json`: A JSON object containing custom content.\n *  `list`: A JSON list of `user`, `issue`, or `json` variable types."
          items:
            $ref: '#/components/schemas/CustomContextVariable'
          type: array
        customerRequest:
          description: The ID of the customer request that is available under the `customerRequest` variable when evaluating the expression. This is the same as the ID of the underlying Jira issue, but the customer request context variable will have a different type.
          format: int64
          type: integer
        issue:
          allOf:
          - $ref: '#/components/schemas/IdOrKeyBean'
          description: The issue that is available under the `issue` variable when evaluating the expression.
        issues:
          allOf:
          - $ref: '#/components/schemas/JexpIssues'
          description: The collection of issues that is available under the `issues` variable when evaluating the expression.
        project:
          allOf:
          - $ref: '#/components/schemas/IdOrKeyBean'
          description: The project that is available under the `project` variable when evaluating the expression.
        serviceDesk:
          description: The ID of the service desk that is available under the `serviceDesk` variable when evaluating the expression.
          format: int64
          type: integer
        sprint:
          description: The ID of the sprint that is available under the `sprint` variable when evaluating the expression.
          format: int64
          type: integer
      type: object
    JsonContextVariable:
      description: A JSON object with custom content.
      properties:
        type:
          description: Type of custom context variable.
          type: string
        value:
          description: A JSON object containing custom content.
          type: object
      required:
      - type
      type: object
    IdOrKeyBean:
      additionalProperties: false
      properties:
        id:
          description: The ID of the referenced item.
          format: int64
          type: integer
        key:
          description: The key of the referenced item.
          type: string
      type: object
    JexpIssues:
      additionalProperties: false
      description: The JQL specifying the issues available in the evaluated Jira expression under the `issues` context variable.
      properties:
        jql:
          allOf:
          - $ref: '#/components/schemas/JexpJqlIssues'
          description: The JQL query that specifies the set of issues available in the Jira expression.
      type: object
    JExpEvaluateMetaDataBean:
      additionalProperties: false
      description: Contains information about the expression evaluation. This bean will be replacing `JiraExpressionEvaluationMetaDataBean` bean as part of new `evaluate` endpoint
      properties:
        complexity:
          allOf:
          - $ref: '#/components/schemas/JiraExpressionsComplexityBean'
          description: Contains information about the expression complexity. For example, the number of steps it took to evaluate the expression.
        issues:
          allOf:
          - $ref: '#/components/schemas/JExpEvaluateIssuesMetaBean'
          description: Contains information about the `issues` variable in the context. For example, is the issues were loaded with JQL, information about the page will be included here.
      type: object
    JExpEvaluateIssuesJqlMetaDataBean:
      additionalProperties: false
      description: The description of the page of issues loaded by the provided JQL query.This bean will be replacing IssuesJqlMetaDataBean bean as part of new `evaluate` endpoint
      properties:
        isLast:
          description: Indicates whether this is the last page of the paginated response.
          readOnly: true
          type: boolean
        nextPageToken:
          description: Next Page token for the next page of issues.
          type: string
      required:
      - nextPageToken
      type: object
    JexpJqlIssues:
      additionalProperties: false
      description: The JQL specifying the issues available in the evaluated Jira expression under the `issues` context variable. Not all issues returned by the JQL query are loaded, only those described by the `startAt` and `maxResults` properties. To determine whether it is necessary to iterate to ensure all the issues returned by the JQL query are evaluated, inspect `meta.issues.jql.count` in the response.
      properties:
        maxResults:
          description: The maximum number of issues to return from the JQL query. Inspect `meta.issues.jql.maxResults` in the response to ensure the maximum value has not been exceeded.
          format: int32
          type: integer
        query:
          description: The JQL query.
          type: string
        startAt:
          description: The index of the first issue to return from the JQL query.
          format: int64
          type: integer
        validation:
          default: strict
          description: Determines how to validate the JQL query and treat the validation results.
          enum:
          - strict
          - warn
          - none
          type: string
      type: object
    JiraExpressionEvaluateContextBean:
      additionalProperties: false
      properties:
        board:
          description: The ID of the board that is available under the `board` variable when evaluating the expression.
          format: int64
          type: integer
        custom:
          description: "Custom context variables and their types. These variable types are available for use in a custom context:\n\n *  `user`: A [user](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#user) specified as an Atlassian account ID.\n *  `issue`: An [issue](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#issue) specified by ID or key. All the fields of the issue object are available in the Jira expression.\n *  `json`: A JSON object containing custom content.\n *  `list`: A JSON list of `user`, `issue`, or `json` variable types."
          items:
            $ref: '#/components/schemas/CustomContextVariable'
          type: array
        customerRequest:
          description: The ID of the customer request that is available under the `customerRequest` variable when evaluating the expression. This is the same as the ID of the underlying Jira issue, but the customer request context variable will have a different type.
          format: int64
          type: integer
        issue:
          allOf:
          - $ref: '#/components/schemas/IdOrKeyBean'
          description: The issue that is available under the `issue` variable when evaluating the expression.
        issues:
          allOf:
          - $ref: '#/components/schemas/JexpEvaluateCtxIssues'
          description: The collection of issues that is available under the `issues` variable when evaluating the expression.
        project:
          allOf:
          - $ref: '#/components/schemas/IdOrKeyBean'
          description: The project that is available under the `project` variable when evaluating the expression.
        serviceDesk:
          description: The ID of the service desk that is available under the `serviceDesk` variable when evaluating the expression.
          format: int64
          type: integer
        sprint:
          description: The ID of the sprint that is available under the `sprint` variable when evaluating the expression.
          format: int64
          type: integer
      type: object
    JiraExpressionForAnalysis:
      additionalProperties: false
      description: Details of Jira expressions for analysis.
      properties:
        contextVariables:
          additionalProperties:
            description: Context variables and their types. The type checker assumes that <a href="https://developer.atlassian.com/cloud/jira/platform/jira-expressions/#context-variables">common context variables</a>, such as <code>issue</code> or <code>project</code>, are available in context and sets their type. Use this property to override the default types or provide details of new variables.
            type: string
          description: Context variables and their types. The type checker assumes that [common context variables](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/#context-variables), such as `issue` or `project`, are available in context and sets their type. Use this property to override the default types or provide details of new variables.
          type: object
        expressions:
          description: The list of Jira expressions to analyse.
          example: issues.map(issue => issue.properties['property_key'])
          items:
            description: The list of Jira expressions to analyse.
            example: issues.map(issue => issue.properties['property_key'])
            type: string
          type: array
      required:
      - expressions
      type: object
    JiraExpressionAnalysis:
      additionalProperties: false
      description: Details about the analysed Jira expression.
      properties:
        complexity:
          $ref: '#/components/schemas/JiraExpressionComplexity'
        errors:
          description: A list of validation errors. Not included if the expression is valid.
          items:
            $ref: '#/components/schemas/JiraExpressionValidationError'
          type: array
        expression:
          description: The analysed expression.
          type: string
        type:
          description: EXPERIMENTAL. The inferred type of the expression.
          type: string
        valid:
          description: Whether the expression is valid and the interpreter will evaluate it. Note that the expression may fail at runtime (for example, if it executes too many expensive operations).
          type: boolean
      required:
      - expression
      - valid
      type: object
    CustomContextVariable:
      additionalProperties: false
      discriminator:
        mapping:
          issue: '#/components/schemas/IssueContextVariable'
          json: '#/components/schemas/JsonContextVariable'
          user: '#/components/schemas/UserContextVariable'
        propertyName: type
      oneOf:
      - $ref: '#/components/schemas/UserContextVariable'
      - $ref: '#/components/schemas/IssueContextVariable'
      - $ref: '#/components/schemas/JsonContextVariable'
      properties:
        type:
          description: Type of custom context variable.
          type: string
      required:
      - type
      type: object
    IssuesMetaBean:
      additionalProperties: false
      description: Meta data describing the `issues` context variable.
      properties:
        jql:
          $ref: '#/components/schemas/IssuesJqlMetaDataBean'
      type: object
    JiraExpressionComplexity:
      additionalProperties: false
      description: Details about the complexity of the analysed Jira expression.
      properties:
        expensiveOperations:
          description: "Information that can be used to determine how many [expensive operations](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/#expensive-operations) the evaluation of the expression will perform. This information may be a formula or number. For example:\n\n *  `issues.map(i => i.comments)` performs as many expensive operations as there are issues on the issues list. So this parameter returns `N`, where `N` is the size of issue list.\n *  `new Issue(10010).comments` gets comments for one issue, so its complexity is `2` (`1` to retrieve issue 10010 from the database plus `1` to get its comments)."
          type: string
        variables:
          additionalProperties:
            description: Variables used in the formula, mapped to the parts of the expression they refer to.
            type: string
          description: Variables used in the formula, mapped to the parts of the expression they refer to.
          type: object
      required:
      - expensiveOperations
      type: object
    JiraExpressionResult:
      additionalProperties: false
      description: The result of evaluating a Jira expression.
      properties:
        meta:
          allOf:
          - $ref: '#/components/schemas/JiraExpressionEvaluationMetaDataBean'
          description: Contains various characteristics of the performed expression evaluation.
        value:
          description: The value of the evaluated expression. It may be a primitive JSON value or a Jira REST API object. (Some expressions do not produce any meaningful results—for example, an expression that returns a lambda function—if that's the case a simple string representation is returned. These string representations should not be relied upon and may change without notice.)
      required:
      - value
      type: object
    JiraExpressionsAnalysis:
      additionalProperties: false
      description: Details about the analysed Jira expression.
      properties:
        results:
          description: The results of Jira expressions analysis.
          items:
            $ref: '#/components/schemas/JiraExpressionAnalysis'
          type: array
      required:
      - results
      type: object
    JExpEvaluateIssuesMetaBean:
      additionalProperties: false
      description: Meta data describing the `issues` context variable.This bean will be replacing IssuesMetaBean bean as part of new `evaluate` endpoint
      properties:
        jql:
          $ref: '#/components/schemas/JExpEvaluateIssuesJqlMetaDataBean'
      type: object
    ErrorCollection:
      additionalProperties: false
      description: Error messages from an operation.
      properties:
        errorMessages:
          description: The list of error messages produced by this operation. For example, "input parameter 'key' must be provided"
          items:
            type: string
          type: array
        errors:
          additionalProperties:
            type: string
          description: 'The list of errors by parameter returned by the operation. For example,"projectKey": "Project keys must start with an uppercase letter, followed by one or more uppercase alphanumeric characters."'
          type: object
        status:
          format: int32
          type: integer
      type: object
    JexpEvaluateCtxJqlIssues:
      additionalProperties: false
      description: The JQL specifying the issues available in the evaluated Jira expression under the `issues` context variable. Not all issues returned by the JQL query are loaded, only those described by the `nextPageToken` and `maxResults` properties. This bean will be replacing JexpJqlIssues bean as part of new `evaluate` endpoint
      properties:
        maxResults:
          description: The maximum number of issues to return from the JQL query. max results value considered may be lower than the number specific here.
          format: int32
          type: integer
        nextPageToken:
          description: The token for a page to fetch that is not the first page. The first page has a `nextPageToken` of `null`. Use the `nextPageToken` to fetch the next page of issues.
          type: string
        query:
          description: The JQL query, required to be bounded. Additionally, `orderBy` clause can contain a maximum of 7 fields
          type: string
      type: object
    JiraExpressionsComplexityBean:
      additionalProperties: false
      properties:
        beans:
          allOf:
          - $ref: '#/components/schemas/JiraExpressionsComplexityValueBean'
          description: The number of Jira REST API beans returned in the response.
        expensiveOperations:
          allOf:
          - $ref: '#/components/schemas/JiraExpressionsComplexityValueBean'
          description: The number of expensive operations executed while evaluating the expression. Expensive operations are those that load additional data, such as entity properties, comments, or custom fields.
        primitiveValues:
          allOf:
          - $ref: '#/components/schemas/JiraExpressionsComplexityValueBean'
          description: The number of primitive values returned in the response.
        steps:
          allOf:
          - $ref: '#/components/schemas/JiraExpressionsComplexityValueBean'
          description: The number of steps it took to evaluate the expression, where a step is a high-level operation performed by the expression. A step is an operation such as arithmetic, accessing a property, accessing a context variable, or calling a function.
      required:
      - beans
      - expensiveOperations
      - primitiveValues
      - steps
      type: object
    IssuesJqlMetaDataBean:
      additionalProperties: false
      description: The description of the page of issues loaded by the provided JQL query.
      properties:
        count:
          description: The number of issues that were loaded in this evaluation.
          format: int32
          type: integer
        maxResults:
          description: The maximum number of issues that could be loaded in this evaluation.
          format: int32
          type: integer
        startAt:
          description: The index of the first issue.
          format: int64
          type: integer
        totalCount:
          description: The total number of issues the JQL returned.
          format: int64
          type: integer
        validationWarnings:
          description: Any warnings related to the JQL query. Present only if the validation mode was set to `warn`.
          items:
            type: string
          type: array
      required:
      - count
      - maxResults
      - startAt
      - totalCount
      type: object
    JiraExpressionValidationError:
      additionalProperties: false
      description: "Details about syntax and type errors. The error details apply to the entire expression, unless the object includes:\n\n *  `line` and `column`\n *  `expression`"
      properties:
        column:
          description: The text column in which the error occurred.
          format: int32
          type: integer
        expression:
          description: The part of the expression in which the error occurred.
          type: string
        line:
          description: The text line in which the error occurred.
          format: int32
          type: integer
        message:
          description: Details about the error.
          example: '!, -, typeof, (, IDENTIFIER, null, true, false, NUMBER, STRING, TEMPLATE_LITERAL, new, [ or { expected, > encountered.'
          type: string
        type:
          description: The error type.
          enum:
          - syntax
          - type
          - other
          type: string
      required:
      - message
      - type
      type: object
    JiraExpressionEvalRequestBean:
      additionalProperties: false
      properties:
        context:
          allOf:
          - $ref: '#/components/schemas/JiraExpressionEvalContextBean'
          description: The context in which the Jira expression is evaluated.
        expression:
          description: The Jira expression to evaluate.
          example: '{ key: issue.key, type: issue.issueType.name, links: issue.links.map(link => link.linkedIssue.id) }'
          type: string
      required:
      - expression
      type: object
    UserContextVariable:
      description: A [user](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#user) specified as an Atlassian account ID.
      properties:
        accountId:
          description: The account ID of the user.
          type: string
        type:
          description: Type of custom context variable.
          type: string
      required:
      - accountId
      - type
      type: object
    JExpEvaluateJiraExpressionResultBean:
      additionalProperties: false
      description: The result of evaluating a Jira expression.This bean will be replacing `JiraExpressionResultBean` bean as part of new evaluate endpoint
      properties:
        meta:
          allOf:
          - $ref: '#/components/schemas/JExpEvaluateMetaDataBean'
          description: Contains various characteristics of the performed expression evaluation.
        value:
          description: The value of the evaluated expression. It may be a primitive JSON value or a Jira REST API object. (Some expressions do not produce any meaningful results—for example, an expression that returns a lambda function—if that's the case a simple string representation is returned. These string representations should not be relied upon and may change without notice.)
      required:
      - value
      type: object
    IssueContextVariable:
      description: An [issue](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#issue) specified by ID or key. All the fields of the issue object are available in the Jira expression.
      properties:
        id:
          description: The issue ID.
          format: int64
          type: integer
        key:
          description: The issue key.
          type: string
        type:
          description: Type of custom context variable.
          type: string
      required:
      - type
      type: object
    JexpEvaluateCtxIssues:
      additionalProperties: false
      description: The JQL specifying the issues available in the evaluated Jira expression under the `issues` context variable. This bean will be replacing `JexpIssues` bean as part of new `evaluate` endpoint
      properties:
        jql:
          allOf:
          - $ref: '#/components/schemas/JexpEvaluateCtxJqlIssues'
          description: The JQL query that specifies the set of issues available in the Jira expression.
      type: object
    JiraExpressionsComplexityValueBean:
      additionalProperties: false
      properties:
        limit:
          description: The maximum allowed complexity. The evaluation will fail if this value is exceeded.
          format: int32
          type: integer
        value:
          description: The complexity value of the current expression.
          format: int32
          type: integer
      required:
      - limit
      - value
      type: object
    JiraExpressionEvaluateRequestBean:
      additionalProperties: false
      description: The request to evaluate a Jira expression. This bean will be replacing `JiraExpressionEvaluateRequest` as part of new `evaluate` endpoint
      properties:
        context:
          allOf:
          - $ref: '#/components/schemas/JiraExpressionEvaluateContextBean'
          description: The context in which the Jira expression is evaluated.
        expression:
          description: The Jira expression to evaluate.
          example: '{ key: issue.key, type: issue.issueType.name, links: issue.links.map(link => link.linkedIssue.id) }'
          type: string
      required:
      - expression
      type: object
  securitySchemes:
    OAuth2:
      description: OAuth2 scopes for Jira
      flows:
        authorizationCode:
          authorizationUrl: https://auth.atlassian.com/authorize
          scopes:
            delete:async-task:jira: Delete asynchronous task.
            delete:attachment:jira: Delete issue attachments.
            delete:avatar:jira: Delete system and custom avatars.
            delete:comment.property:jira: Delete issue comment properties.
            delete:comment:jira: Delete issue comments.
            delete:dashboard.property:jira: Delete dashboard properties.
            delete:dashboard:jira: Delete dashboards.
            delete:field-configuration-scheme:jira: Delete field configuration schemes.
            delete:field-configuration:jira: Delete field configurations.
            delete:field.option:jira: Delete field options.
            delete:field:jira: Delete fields.
            delete:filter.column:jira: Delete filter columns.
            delete:filter:jira: Delete filters.
            delete:group:jira: Delete user groups.
            delete:issue-link-type:jira: Delete issue link types.
            delete:issue-link:jira: Delete issue links.
            delete:issue-type-scheme:jira: Delete issue type schemes.
            delete:issue-type-screen-scheme:jira: Delete issue type screen schemes.
            delete:issue-type.property:jira: Delete issue type properties.
            delete:issue-type:jira: Delete issue types.
            delete:issue-worklog.property:jira: Delete issue worklog properties.
            delete:issue-worklog:jira: Delete issue worklogs.
            delete:issue.property:jira: Delete issue properties.
            delete:issue.remote-link:jira: Delete issue remote links.
            delete:issue:jira: Delete issues.
            delete:permission-scheme:jira: Delete permission schemes.
            delete:permission:jira: Delete permissions.
            delete:project-category:jira: Delete project categories.
            delete:project-role:jira: Delete project roles.
            delete:project-version:jira: Delete project versions.
            delete:project.avatar:jira: Delete project avatars.
            delete:project.component:jira: Delete project components.
            delete:project.property:jira: Delete project properties.
            delete:project:jira: Delete projects and their details, such as issue types, project lead, and avatars.
            delete:screen-scheme:jira: Delete screen schemes.
            delete:screen-tab:jira: Delete screen tabs.
            delete:screen:jira: Delete screens.
            delete:screenable-field:jira: Delete screenable fields.
            delete:user-configuration:jira: Delete user configurations.
            delete:user.property:jira: Delete user properties.
            delete:webhook:jira: Delete webhooks.
            delete:workflow-scheme:jira: Delete workflow schemes.
            delete:workflow.property:jira: Delete workflow properties.
            delete:workflow:jira: Delete workflows.
            manage:jira-configuration: Configure Jira settings that require the Jira administrators permission, for example, create projects and custom fields, view workflows, manage issue link types.
            manage:jira-project: Create and edit project settings and create new project-level objects, for example, versions, components.
            manage:jira-webhook: Manage Jira webhooks. Enables an OAuth app to register and unregister dynamic webhooks in Jira. It also provides for fetching of registered webhooks.
            read:app-data:jira: Read app data.
            read:application-role:jira: View application roles.
            read:attachment:jira: View issue attachments.
            read:audit-log:jira: View audit logs.
            read:avatar:jira: View system and custom avatars.
            read:comment.property:jira: View issue comment properties.
            read:comment:jira: View issue comments.
            read:custom-field-contextual-configuration:jira: Read custom field contextual configurations.
            read:dashboard.property:jira: View dashboard properties.
            read:dashboard:jira: View dashboards.
            read:email-address:jira: View email addresses of all users regardless of the user's profile visibility settings.
            read:field-configuration-scheme:jira: View field configuration schemes.
            read:field-configuration:jira: Read field configurations.
            read:field.default-value:jira: View field default values.
            read:field.option:jira: View field options.
            read:field.options:jira: Read field options.
            read:field:jira: View fields.
            read:filter.column:jira: View filter columns.
            read:filter.default-share-scope:jira: View filter default share scopes.
            read:filter:jira: View filters.
            read:group:jira: View user groups.
            read:instance-configuration:jira: View instance configurations.
            read:issue-details:jira: View issue details.
            read:issue-event:jira: Read issue events.
            read:issue-field-values:jira: View issue field valueses.
            read:issue-link-type:jira: View issue link types.
            read:issue-link:jira: View issue links.
            read:issue-meta:jira: View issue meta.
            read:issue-security-level:jira: View issue security levels.
            read:issue-security-scheme:jira: View issue security schemes.
            read:issue-status:jira: View issue statuses.
            read:issue-type-hierarchy:jira: Read issue type hierarchies.
            read:issue-type-scheme:jira: View issue type schemes.
            read:issue-type-screen-scheme:jira: View issue type screen schemes.
            read:issue-type.property:jira: View issue type properties.
            read:issue-type:jira: View issue types.
            read:issue-worklog.property:jira: View issue worklog properties.
            read:issue-worklog:jira: View issue worklogs.
            read:issue.changelog:jira: View issue changelogs.
            read:issue.property:jira: View issue properties.
            read:issue.remote-link:jira: View issue remote links.
            read:issue.time-tracking:jira: View issue time trackings.
            read:issue.transition:jira: View issue transitions.
            read:issue.vote:jira: View issue votes.
            read:issue.votes:jira: View issue voteses.
            read:issue.watcher:jira: View issue watchers.
            read:issue:jira: View issues.
            read:jira-expressions:jira: View jira expressions.
            read:jira-user: View user information in Jira that you have access to, including usernames, email addresses, and avatars.
            read:jira-work: Read project and issue data. Search for issues and objects associated with issues (such as attachments and worklogs).
            read:jql:jira: View JQL.
            read:label:jira: View labels.
            read:license:jira: View licenses.
            read:notification-scheme:jira: View notification schemes.
            read:permission-scheme:jira: View permission schemes.
            read:permission:jira: View permissions.
            read:priority:jira: View priorities.
            read:project-category:jira: View project categories.
            read:project-role:jira: View project roles.
            read:project-type:jira: View project types.
            read:project-version:jira: View project versions.
            read:project.avatar:jira: Read project avatars.
            read:project.component:jira: View project components.
            read:project.email:jira: View project emails.
            read:project.feature:jira: Read project features.
            read:project.property:jira: View project properties.
            read:project:jira: View projects.
            read:resolution:jira: View resolutions.
            read:role:jira: View roles.
            read:screen-field:jira: View screen fields.
            read:screen-scheme:jira: View screen schemes.
            read:screen-tab:jira: View screen tabs.
            read:screen:jira: View screens.
            read:screenable-field:jira: View screenable fields.
            read:status:jira: View statuses.
            read:user-configuration:jira: View user configurations.
            read:user.columns:jira: View user columnses.
            read:user.property:jira: View user properties.
            read:user:jira: View users.
            read:webhook:jira: View webhooks.
            read:workflow-scheme:jira: View workflow schemes.
            read:workflow.property:jira: View workflow properties.
            read:workflow:jira: View workflows.
            send:notification:jira: Send notifications.
            validate:jql:jira: Validate JQL.
            write:app-data:jira: Write app data.
            write:attachment:jira: Create and update issue attachments.
            write:avatar:jira: Create and update system and custom avatars.
            write:comment.property:jira: Create and update issue comment properties.
            write:comment:jira: Create and update issue comments.
            write:custom-field-contextual-configuration:jira: Save custom field contextual configurations.
            write:dashboard.property:jira: Create and update dashboard properties.
            write:dashboard:jira: Create and update dashboards.
            write:field-configuration-scheme:jira: Create and update field configuration schemes.
            write:field-configuration:jira: Save field configurations.
            write:field.default-value:jira: Create and update field default values.
            write:field.option:jira: Create and update field options.
            write:field:jira: Create and update fields.
            write:filter.column:jira: Create and update filter columns.
            write:filter.default-share-scope:jira: Create and update filter default share scopes.
            write:filter:jira: Create and update filters.
            write:group:jira: Create and update user groups.
            write:instance-configuration:jira: Create and update instance configurations.
            write:issue-link-type:jira: Create and update issue link types.
            write:issue-link:jira: Create and update issue links.
            write:issue-type-scheme:jira: Create and update issue type schemes.
            write:issue-type-screen-scheme:jira: Create and update issue type screen schemes.
            write:issue-type.property:jira: Create and update issue type properties.
            write:issue-type:jira: Create and update issue types.
            write:issue-worklog.property:jira: Create and update issue worklog properties.
            write:issue-worklog:jira: Create and update issue worklogs.
            write:issue.property:jira: Create and update issue properties.
            write:issue.remote-link:jira: Create and update issue remote links.
            write:issue.time-tracking:jira: Create and update issue time trackings.
            write:issue.vote:jira: Create and update issue votes.
            write:issue.watcher:jira: Create and update issue watchers.
            write:issue:jira: Create and update issues.
            write:jira-work: Create and edit issues in Jira, post comments, create worklogs, and delete issues.
            write:permission-scheme:jira: Create and update permission schemes.
            write:permission:jira: Create and update permissions.
            write:project-category:jira: Create and update project categories.
            write:project-role:jira: Create and update project roles.
            write:project-version:jira: Create and update project versions.
            write:project.avatar:jira: Create and update project avatars.
            write:project.component:jira: Create and update project components.
            write:project.email:jira: Create and update project emails.
            write:project.feature:jira: Save project features.
            write:project.property:jira: Create and update project properties.
            write:project:jira: Create and update projects.
            write:screen-scheme:jira: Create and update screen schemes.
            write:screen-tab:jira: Create and update screen tabs.
            write:screen:jira: Create and update screens.
            write:screenable-field:jira: Create and update screenable fields.
            write:user-configuration:jira: Create and update user configurations.
            write:user.property:jira: Create and update user properties.
            write:webhook:jira: Create and update webhooks.
            write:workflow-scheme:jira: Create and update workflow schemes.
            write:workflow.property:jira: Create and update workflow properties.
            write:workflow:jira: Create and update workflows.
          tokenUrl: https://auth.atlassian.com/oauth/token
      type: oauth2
    basicAuth:
      description: You can access this resource via basic auth.
      scheme: basic
      type: http
externalDocs:
  description: Find out more about Atlassian products and services.
  url: http://www.atlassian.com
x-atlassian-narrative:
  documents:
  - anchor: about
    body: "The Jira REST API enables you to interact with Jira programmatically. Use this API to \n[build apps](https://developer.atlassian.com/cloud/jira/platform/integrating-with-jira-cloud/), script interactions with \nJira, or develop any other type of integration. This page documents the REST resources available in Jira Cloud, including \nthe HTTP response codes and example requests and responses."
    title: About
  - anchor: version
    body: "This documentation is for **version 3** of the Jira Cloud platform REST API, which is the latest\nversion. [Version 2](https://developer.atlassian.com/cloud/jira/platform/rest/v2/) and\nversion 3 of the API offer the same collection of operations. However, version 3 provides support for\nthe [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/)\n(ADF) in:\n- `body` in comments, including where comments are used in issue, issue link, and transition resources.\n- `comment` in worklogs.\n- `description` and `environment` fields in issues.\n- `textarea` type custom fields (multi-line text fields) in issues. Single line custom fields\n  (`textfield`) accept a string and don't handle Atlassian Document Format content.\n"
    title: Version
  - anchor: authentication
    body: "### Forge apps\n\nFor Forge apps, [REST API scopes](https://developer.atlassian.com/cloud/jira/platform/scopes-for-oauth-2-3LO-and-forge-apps/) \nare used when authenticating with Jira Cloud platform. See [Add scopes to call an Atlassian REST API](https://developer.atlassian.com/platform/forge/add-scopes-to-call-an-atlassian-rest-api/) for more details.\n\nThe URIs for Forge app REST API calls have this structure:\n\n`/rest/api/3/<resource-name>`\n\nFor example, `/rest/api/3/issue/DEMO-1`\n\n### Connect apps\n\nFor Connect apps, authentication (JWT-based) is built into the Connect libraries. Authorization is implemented using either \nscopes (shown as _App scope required_ for operations on this page) or user impersonation. See \n[Security for Connect apps](https://developer.atlassian.com/cloud/jira/platform/security-for-connect-apps/) \nfor details.\n\nThe URIs for Connect app REST API calls have this structure:\n\n`https://<site-url>/rest/api/3/<resource-name>`\n\nFor example, `https://your-domain.atlassian.net/rest/api/3/issue/DEMO-1`\n\n### Other integrations\n\nFor integrations that are not Forge or Connect apps, use OAuth 2.0 authorization code grants (3LO) for security \n(3LO scopes are shown as for operations _OAuth scopes required_). See \n[OAuth 2.0 (3LO) apps](https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps/) \nfor details.\n\nThe URIs for OAuth 2.0 (3LO) app REST API calls have this structure:\n\n`https://api.atlassian.com/ex/jira/<cloudId>/rest/api/3/<resource-name>`\n\nFor example, `https://api.atlassian.com/ex/jira/35273b54-3f06-40d2-880f-dd28cf8daafa/rest/api/3/issue/DEMO-1`\n\n### Ad-hoc API calls\n\nFor personal scripts, bots, and ad-hoc execution of the REST APIs use basic authentication. See [Basic auth for REST APIs](https://developer.atlassian.com/cloud/jira/platform/basic-auth-for-rest-apis/) for details. \n\nThe URIs for basic authentication REST API calls have this structure:\n\n`https://<site-url>/rest/api/3/<resource-name>`\n\nFor example, `https://your-domain.atlassian.net/rest/api/3/issue/DEMO-1`\n"
    title: Authentication and authorization
  - anchor: permissions
    body: "### Operation permissions\n\nMost operations in this API require permissions. The calling user must have the required permissions for an operation to \nuse it. Note that for Connect apps, the app user must have the required permissions for the operation and the app must \nhave scopes that permit the operation.\n\nA permission can be granted to a group, project role, or issue role that the user is a member of, or granted directly to a user. \nSee [Permissions overview](https://confluence.atlassian.com/x/FQiiLQ) for details. The most common permissions are:\n\n- **Administer the Cloud site**: Users in the _site-admins_ group have this \npermission. See [Manage groups](https://confluence.atlassian.com/x/24xjL) for details.\n- **Administer Jira**: Granted by the _Jira Administrators_ global permission. There is a default group for this permission. \nSee [Manage groups](https://confluence.atlassian.com/x/24xjL) and [Managing global permissions](https://confluence.atlassian.com/x/x4dKLg) for details.\n- **Administer a project in Jira**: Granted by the _Administer projects_ project permission for a project. This can be \ngranted to a user, a group, a project role, and more. \nSee [Managing project permissions](https://confluence.atlassian.com/x/yodKLg) for details.\n- **Access a project in Jira**: Granted by the _Browse projects_ project permission for a project. This can be \ngranted to a user, a group, a project role, and more. \nSee [Managing project permissions](https://confluence.atlassian.com/x/yodKLg) for details.\n- **Access Jira**: Granted by the _Jira Users_ global permission. Users in the default product access group (for example, \n_jira-software-users-acmesite_) have this permission. \nSee [Manage groups](https://confluence.atlassian.com/x/24xjL) and \n[Managing global permissions](https://confluence.atlassian.com/x/x4dKLg) for details.\n\n### Anonymous access\n\nSome operations provide support for anonymous access. However, anonymous access is only available if \nthe Jira permission needed to access the object or records returned by the operation is granted to \nthe _Public_ group. See [Allowing anonymous access to your project](https://confluence.atlassian.com/x/GDxxLg) \nfor details.\n\nIf an operation is called anonymously and anonymous access is not available, the operation will return \nan error. Note that not all operations that correspond to objects that can be given public access \nprovide for anonymous access.\n"
    title: Permissions
  - anchor: expansion
    body: "### Expansion\n\nThe Jira REST API uses resource expansion, which means that some parts of a resource are not returned unless specified \nin the request. This simplifies responses and minimizes network traffic.\n\nTo expand part of a resource in a request, use the expand query parameter and specify the object(s) to be expanded. \nIf you need to expand nested objects, use the `.` dot notation. If you need to expand multiple objects, use a \ncomma-separated list. \n\nFor example, the following request expands the `names` and `renderedFields` properties for the _JRACLOUD-34423_ issue:\n\n`GET issue/JRACLOUD-34423?expand=names,renderedFields`\n\nTo discover which object can be expanded, refer to the `expand` property in the object. \nIn the JSON example below, the resource declares `widgets` as expandable.\n\n```json\n{\n  \"expand\": \"widgets\", \n  \"self\": \"https://your-domain.atlassian.net/rest/api/3/resource/KEY-1\", \n  \"widgets\": {\n    \"widgets\": [],\n    \"size\": 5\n   }\n}\n```\n\n### Pagination\n\nThe Jira REST API uses pagination to improve performance. Pagination is enforced for operations that could return a large \ncollection of items. When you make a request to a paginated resource, the response wraps the returned array of values in \na JSON object with paging metadata. For example:\n\n```json\n{\n    \"startAt\" : 0,\n    \"maxResults\" : 10,\n    \"total\": 200,\n    \"isLast\": false,\n    \"values\": [\n        { /* result 0 */ },\n        { /* result 1 */ },\n        { /* result 2 */ }\n    ]\n}\n```\n\n*   `startAt` is the index of the first item returned in the page.\n*   `maxResults` is the maximum number of items that a page can return. Each operation can have a different limit for\n    the number of items returned, and these limits may change without notice. To find the maximum number of items \n    that an operation could return, set `maxResults` to a large number—for example, over 1000—and if the returned value of `maxResults` is less than the requested value, the returned value is the maximum.\n*    `total` is the total number of items contained in all pages. This number **_may change_** as the client \nrequests the subsequent pages, therefore the client should always assume that the requested page can be empty. Note \nthat this property is not returned for all operations.\n*   `isLast` indicates whether the page returned is the last one. Note that this property is not returned for all operations.\n\n### Ordering\n\nSome operations support ordering the elements of a response by a field. Check the documentation for the operation to \nconfirm whether ordering of a response is supported and which fields can be used. Responses are listed in ascending order \nby default. You can change the order using the `orderby` query parameter with a `-` or `+` symbol. For example:\n\n*   `?orderBy=name` to order by `name` field ascending.\n*   `?orderBy=+name` to order by `name` field ascending.\n*   `?orderBy=-name` to order by `name` field descending.\n\n\n"
    title: Expansion, pagination, and ordering
  - anchor: timestamps
    body: 'By default, top-level timestamps (e.g. updated and created) are returned in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format, in the system default user time zone.


      To return date time data in the logged in user''s timezone, please refer to `renderedFields` property under the `expand` query parameter in relevant APIs.

      '
    title: Timestamps
  - anchor: special-request-headers
    body: 'The following request and response headers define important metadata for the Jira Cloud REST API resources.


      -   `X-Atlassian-Token` (request): Operations that accept multipart/form-data must include the `X-Atlassian-Token: no-check`

      header in requests. Otherwise the request is blocked by cross-site request forgery (CSRF/XSRF) protection.

      -   `X-Force-Accept-Language` (request): controls how the standard HTTP `Accept-Language` header is processed.

      By default `Accept-Language` is ignored and the response is in the language configured in the user''s profile or,

      when no language is configured for the user, the default Jira instance language. For the response to recognize

      `Accept-Language` send `X-Force-Accept-Language = true` as well. If `Accept-Language` requests a language that Jira

      can return the response is in that language, otherwise Jira returns the response in the default language. If

      `Accept-Language` is not specified the response is in the default language.

      -   `X-AAccountId` (response): This response header contains the Atlassian account ID of the authenticated user.'
    title: Special headers
  - anchor: anonymous-operations
    body: " Jira provides for all permissions, except the [global permission](https://confluence.atlassian.com/x/x4dKLg) Administer Jira, to be assigned to *Anyone*. Once a permission is assigned to *Anyone*, anyone knowing a project's URL is able to use the features in Jira enabled by the permission. However, the Jira REST API does not enable anonymous access for operations by default. This means that an anonymous user who may be able to perform an action through Jira, may not be able to perform the same action where it's enabled by the REST API. \n\n The operations that provide anonymous access are annotated \"This operation can be accessed anonymously.\""
    title: Anonymous operations
  - anchor: async-operations
    body: "Some Jira REST API operations may trigger long-running or computationally expensive tasks. In these cases, the operation \nwill schedule an asynchronous task and return a `303 (See Other)` response, indicating the location of the queued task \nin the `Location` header. You can query this task to get progress updates.\n\nWhen the task finishes, the response object will contain the `result` field. The content of the field is specific to the \noperation that created the task. Refer to the operation’s documentation for more information.\n\nNote that asynchronous tasks are not guaranteed to be run in order. In other words, if you need your tasks to execute \nin a certain order, you should start a task only after the prerequisite task(s) have finished."
    title: Asynchronous operations
  - anchor: experimental
    body: "Features and methods marked as experimental may change without notice. Feedback on experimental functionality is welcome. \nReport issues to [Developer and Marketplace support](https://developer.atlassian.com/support) (preferred) or use the \n**Give docs feedback** link at the top of this page. \n"
    title: Experimental features
  - anchor: status-codes
    body: "The Jira Cloud platform REST API uses the [standard HTTP status codes](https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).\n\nOperations that return an error status code may also return a response body containing details of the error or errors. \nThe schema for the response body is shown below:\n\n\n```json\n{\n  \"id\": \"https://docs.atlassian.com/jira/REST/schema/error-collection#\",\n  \"title\": \"Error Collection\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"errorMessages\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"string\"\n      }\n    },\n    \"errors\": {\n      \"type\": \"object\",\n      \"patternProperties\": {\n        \".+\": {\n          \"type\": \"string\"\n        }\n      },\n      \"additionalProperties\": false\n    },\n    \"status\": { \n      \"type\": \"integer\"\n    }\n  },\n  \"additionalProperties\": false\n}\n```"
    title: Status codes