Search and Reconsile Issues Using JQL

Options

Set JQL

Enable to set the optional field JQL

JQL

A JQL expression. For performance reasons, this parameter requires a bounded query. A bounded query is a query with a search restriction.

• Example of an unbounded query: order by key desc.
• Example of a bounded query: assignee = currentUser() order by key.

Additionally, orderBy clause can contain a maximum of 7 fields.

Set Next Page Token

Enable to set the optional field Next Page Token

Next Page Token

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.

Note: The nextPageToken field is not included in the response for the last page, indicating there is no next page.

Set Max Results

Enable to set the optional field Max Results

Max Results

The maximum number of items to return per page. To manage page size, API may return fewer items per page where a large number of fields or properties are requested. The greatest number of items returned per page is achieved when requesting id or key only. It returns max 5000 issues.

Set Fields

Enable to set the optional field Fields

Fields

A list of fields to return for each issue, use it to retrieve a subset of fields. This parameter accepts a comma-separated list. Expand options include:

• *all Returns all fields.
• *navigable Returns navigable fields.
• id Returns only issue IDs.
• Any issue field, prefixed with a minus to exclude.

The default is id.

Examples:

• summary,comment Returns only the summary and comments fields only.
• -description Returns all navigable (default) fields except description.
• *all,-comment Returns all fields except comments.

Multiple fields parameters can be included in a request.

Note: By default, this resource returns IDs only. This differs from GET issue where the default is all fields.

Set Expand

Enable to set the optional field Expand

Expand

Use expand to include additional information about issues in the response. Note that, unlike the majority of instances where expand is specified, expand is defined as a comma-delimited string of values. The expand options are:

• renderedFields Returns field values rendered in HTML format.
• names Returns the display name of each field.
• schema Returns the schema describing a field type.
• transitions Returns all possible transitions for the issue.
• operations Returns all possible operations for the issue.
• editmeta Returns information about how each field can be edited.
• changelog Returns a list of recent updates to an issue, sorted by date, starting from the most recent.
• versionedRepresentations Instead of fields, returns versionedRepresentations a JSON array containing each version of a field's value, with the highest numbered item representing the most recent version.

Examples: "names,changelog" Returns the display name of each field as well as a list of recent updates to an issue.

Set Properties

Enable to set the optional field Properties

Properties

A list of up to 5 issue properties to include in the results. This parameter accepts a comma-separated list.

Set Fields by Keys

Enable to set the optional field Fields by Keys

Fields by Keys

Reference fields by their key (rather than ID). The default is false.

Set Fail Fast

Enable to set the optional field Fail Fast

Fail Fast

Fail this request early if we can't retrieve all field data.

Set Reconcile Issues

Enable to set the optional field Reconcile Issues

Reconcile Issues

Strong consistency issue ids to be reconciled with search results. Accepts max 50 ids

Result Format

Specify how the response should be mapped to the table output. The following formats are available:

Structured Table: Returns a parsed table with data split into rows and columns.

• Changelog: Details of changelogs associated with the issue.
• Editmeta: The metadata for the fields on the issue that can be amended.
• Expand: Expand options that include additional issue details in the response.
• Fields:
• Fields to Include:
• Id: The ID of the issue.
• Key: The key of the issue.
• Names: The ID and name of each field present on the issue.
• Operations: The operations that can be performed on the issue.
• Properties: Details of the issue properties identified in the request.
• Rendered Fields: The rendered value of each field present on the issue.
• Schema: The schema describing each field present on the issue.
• Self: The URL of the issue details.
• Transitions: The transitions that can be performed on the issue.
• Versioned Representations: The versions of each field on the issue.

Raw Response: Returns the raw response in a single row with the following columns:

• body: Response body
• status: HTTP status code

Views

This node has no views

Workflows

• No workflows found

Links

• No links available

Developers