Class IssueSearchService

This resource represents various ways to search for issues. Use it to search for issues with a JQL query and find issues to populate an issue picker.

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-search

Hierarchy

CommonHttpService
- IssueSearchService

Index

Constructors

constructor

Methods

countIssues getIssuePickerResource matchIssues searchAndReconsileIssuesUsingJql searchAndReconsileIssuesUsingJqlPost searchForIssuesIds searchForIssuesUsingJql searchForIssuesUsingJqlPost initialize

Constructors

constructor

new IssueSearchService(getClientInstance): IssueSearchService
Internal
Create a new instance of the service.
Parameters
- getClientInstance: (() => CommonHttpClient)
  - - (): CommonHttpClient
    - Returns CommonHttpClient
Returns IssueSearchService
Inherited from CommonHttpService.constructor

Methods

countIssues

countIssues(params): Promise<JqlCountResultsBean>
Provide an estimated count of the issues that match the JQL. Recent updates might not be immediately visible in the returned output. This endpoint requires JQL to be bounded.

This operation can be accessed anonymously.

Permissions required: Issues are included in the response where the user has:
- Browse projects project permission for the project containing the issue.
- If issue-level security is configured, issue-level security permission to view the issue.
Parameters
- params: {
  jqlCountRequestBean: JqlCountRequestBean;
  }
  - jqlCountRequestBean: JqlCountRequestBean
    A JSON object containing the search request.
    
    Example
Returns Promise<JqlCountResultsBean>
Returned if the request is successful.

example:
```
{
  "count": 153
}
```
Path
POST /rest/api/3/search/approximate-count @scopes-current read:jira-work @scopes-beta read:issue-details:jira, read:field.default-value:jira, read:field.option:jira, read:field:jira, read:group:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-search#api-rest-api-3-search-approximate-count-post

getIssuePickerResource

getIssuePickerResource(params?): Promise<IssuePickerSuggestions>
Returns lists of issues matching a query string. Use this resource to provide auto-completion suggestions when the user is looking for an issue using a word or string.

This operation returns two lists:
- History Search which includes issues from the user's history of created, edited, or viewed issues that contain the string in the query parameter.
- Current Search which includes issues that match the JQL expression in currentJQL and contain the string in the query parameter.
This operation can be accessed anonymously.

Permissions required: None.
Parameters
- params: {
      currentIssueKey?: string;
      currentJql?: string;
      currentProjectId?: string;
      query?: string;
      showSubTaskParent?: boolean;
      showSubTasks?: boolean;
  } = {}
  - OptionalcurrentIssueKey?: string
    The key of an issue to exclude from search results. For example, the issue the user is viewing when they perform this query.
  - OptionalcurrentJql?: string
    A JQL query defining a list of issues to search for the query term. Note that username and userkey cannot be used as search terms for this parameter, due to privacy reasons. Use accountId instead.
  - OptionalcurrentProjectId?: string
    The ID of a project that suggested issues must belong to.
  - Optionalquery?: string
    A string to match against text fields in the issue such as title, description, or comments.
  - OptionalshowSubTaskParent?: boolean
    When currentIssueKey is a subtask, whether to include the parent issue in the suggestions if it matches the query.
  - OptionalshowSubTasks?: boolean
    Indicate whether to include subtasks in the suggestions list.
Returns Promise<IssuePickerSuggestions>
Returned if the request is successful.

Path
GET /rest/api/3/issue/picker @scopes-current read:jira-work @scopes-beta read:issue-details:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-search#api-rest-api-3-issue-picker-get

matchIssues

matchIssues(params): Promise<IssueMatches>
Checks whether one or more issues would be returned by one or more JQL queries.

Permissions required: None, however, issues are only matched against JQL queries where the user has:
- Browse projects project permission for the project that the issue is in.
- If issue-level security is configured, issue-level security permission to view the issue.
Parameters
- params: {
  issuesAndJqlQueries: IssuesAndJqlQueries;
  }
  - issuesAndJqlQueries: IssuesAndJqlQueries
    Example
Returns Promise<IssueMatches>
Returned if the request is successful.

example:
```
{
  "matches": [
    {
      "matchedIssues": [
        10000,
        10004
      ],
      "errors": []
    },
    {
      "matchedIssues": [
        100134,
        10025,
        10236
      ],
      "errors": []
    },
    {
      "matchedIssues": [],
      "errors": []
    },
    {
      "matchedIssues": [],
      "errors": [
        "Invalid JQL: broken = value"
      ]
    }
  ]
}
```
Path
POST /rest/api/3/jql/match @scopes-current read:jira-work @scopes-beta read:issue-details:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-search#api-rest-api-3-jql-match-post

searchAndReconsileIssuesUsingJql

searchAndReconsileIssuesUsingJql(params?): Promise<SearchAndReconcileResults>

Searches for issues using JQL. Recent updates might not be immediately visible in the returned search results. If you need read-after-write consistency, you can utilize the reconcileIssues parameter to ensure stronger consistency assurances. This operation can be accessed anonymously.

If the JQL query expression is too large to be encoded as a query parameter, use the POST version of this resource.

Permissions required: Issues are included in the response where the user has:

Browse projects project permission for the project containing the issue.
If issue-level security is configured, issue-level security permission to view the issue.

Parameters

params: {
    expand?: string;
    failFast?: boolean;
    fields?: string[];
    fieldsByKeys?: boolean;
    jql?: string;
    maxResults?: number;
    nextPageToken?: string;
    properties?: string[];
    reconcileIssues?: number[];
} = {}
- Optionalexpand?: string
  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.
- OptionalfailFast?: boolean
  Fail this request early if we can't retrieve all field data.
- Optionalfields?: string[]
  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.
- OptionalfieldsByKeys?: boolean
  Reference fields by their key (rather than ID). The default is false.
- Optionaljql?: string
  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.
- OptionalmaxResults?: number
  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 are requested. The greatest number of items returned per page is achieved when requesting id or key only. It returns max 5000 issues.
- OptionalnextPageToken?: string
  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.
- Optionalproperties?: string[]
  A list of up to 5 issue properties to include in the results. This parameter accepts a comma-separated list.
- OptionalreconcileIssues?: number[]
  Strong consistency issue ids to be reconciled with search results. Accepts max 50 ids. All issues must exist.

Returns Promise<SearchAndReconcileResults>

Returned if the request is successful.

example:

{
  "issues": [
    {
      "expand": "",
      "fields": {
        "watcher": {
          "isWatching": false,
          "self": "https://your-domain.atlassian.net/rest/api/3/issue/EX-1/watchers",
          "watchCount": 1
        },
        "attachment": [
          {
            "author": {
              "accountId": "5b10a2844c20165700ede21g",
              "accountType": "atlassian",
              "active": false,
              "avatarUrls": {
                "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
                "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
                "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
                "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
              },
              "displayName": "Mia Krystof",
              "key": "",
              "name": "",
              "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
            },
            "content": "https://your-domain.atlassian.net/jira/rest/api/3/attachment/content/10001",
            "created": "2023-06-24T19:24:50.000+0000",
            "filename": "debuglog.txt",
            "id": 10001,
            "mimeType": "text/plain",
            "self": "https://your-domain.atlassian.net/rest/api/2/attachments/10001",
            "size": 2460
          }
        ],
        "sub-tasks": [
          {
            "id": "10000",
            "outwardIssue": {
              "fields": {
                "status": {
                  "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
                  "name": "Open"
                }
              },
              "id": "10003",
              "key": "ED-2",
              "self": "https://your-domain.atlassian.net/rest/api/3/issue/ED-2"
            },
            "type": {
              "id": "10000",
              "inward": "Parent",
              "name": "",
              "outward": "Sub-task"
            }
          }
        ],
        "description": "Main order flow broken",
        "project": {
          "avatarUrls": {
            "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
            "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
            "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
            "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
          },
          "id": "10000",
          "insight": {
            "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
            "totalIssueCount": 100
          },
          "key": "EX",
          "name": "Example",
          "projectCategory": {
            "description": "First Project Category",
            "id": "10000",
            "name": "FIRST",
            "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
          },
          "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
          "simplified": false,
          "style": "classic"
        },
        "comment": [
          {
            "author": {
              "accountId": "5b10a2844c20165700ede21g",
              "active": false,
              "displayName": "Mia Krystof",
              "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
            },
            "body": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.",
            "created": "2021-01-17T12:34:00.000+0000",
            "id": "10000",
            "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
            "updateAuthor": {
              "accountId": "5b10a2844c20165700ede21g",
              "active": false,
              "displayName": "Mia Krystof",
              "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
            },
            "updated": "2021-01-18T23:45:00.000+0000",
            "visibility": {
              "identifier": "Administrators",
              "type": "role",
              "value": "Administrators"
            }
          }
        ],
        "issuelinks": [
          {
            "id": "10001",
            "outwardIssue": {
              "fields": {
                "status": {
                  "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
                  "name": "Open"
                }
              },
              "id": "10004L",
              "key": "PR-2",
              "self": "https://your-domain.atlassian.net/rest/api/3/issue/PR-2"
            },
            "type": {
              "id": "10000",
              "inward": "depends on",
              "name": "Dependent",
              "outward": "is depended by"
            }
          },
          {
            "id": "10002",
            "inwardIssue": {
              "fields": {
                "status": {
                  "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
                  "name": "Open"
                }
              },
              "id": "10004",
              "key": "PR-3",
              "self": "https://your-domain.atlassian.net/rest/api/3/issue/PR-3"
            },
            "type": {
              "id": "10000",
              "inward": "depends on",
              "name": "Dependent",
              "outward": "is depended by"
            }
          }
        ],
        "worklog": [
          {
            "author": {
              "accountId": "5b10a2844c20165700ede21g",
              "active": false,
              "displayName": "Mia Krystof",
              "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
            },
            "comment": "I did some work here.",
            "id": "100028",
            "issueId": "10002",
            "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
            "started": "2021-01-17T12:34:00.000+0000",
            "timeSpent": "3h 20m",
            "timeSpentSeconds": 12000,
            "updateAuthor": {
              "accountId": "5b10a2844c20165700ede21g",
              "active": false,
              "displayName": "Mia Krystof",
              "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
            },
            "updated": "2021-01-18T23:45:00.000+0000",
            "visibility": {
              "identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
              "type": "group",
              "value": "jira-developers"
            }
          }
        ],
        "updated": 1,
        "timetracking": {
          "originalEstimate": "10m",
          "originalEstimateSeconds": 600,
          "remainingEstimate": "3m",
          "remainingEstimateSeconds": 200,
          "timeSpent": "6m",
          "timeSpentSeconds": 400
        }
      },
      "id": "10002",
      "key": "ED-1",
      "self": "https://your-domain.atlassian.net/rest/api/3/issue/10002"
    }
  ]
}

Path

GET /rest/api/3/search/jql @scopes-current read:jira-work @scopes-beta read:issue-details:jira, read:audit-log:jira, read:avatar:jira, read:field-configuration:jira, read:issue-meta:jira

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-search#api-rest-api-3-search-jql-get

searchAndReconsileIssuesUsingJqlPost

searchAndReconsileIssuesUsingJqlPost(params): Promise<SearchAndReconcileResults>

Permissions required: Issues are included in the response where the user has:

Browse projects project permission for the project containing the issue.
If issue-level security is configured, issue-level security permission to view the issue.

Parameters

params: {
searchAndReconcileRequestBean: SearchAndReconcileRequestBean;
}
- searchAndReconcileRequestBean: SearchAndReconcileRequestBean

Returns Promise<SearchAndReconcileResults>

Returned if the request is successful.

example:

{
  "issues": [
    {
      "expand": "",
      "fields": {
        "watcher": {
          "isWatching": false,
          "self": "https://your-domain.atlassian.net/rest/api/3/issue/EX-1/watchers",
          "watchCount": 1
        },
        "attachment": [
          {
            "author": {
              "accountId": "5b10a2844c20165700ede21g",
              "accountType": "atlassian",
              "active": false,
              "avatarUrls": {
                "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
                "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
                "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
                "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
              },
              "displayName": "Mia Krystof",
              "key": "",
              "name": "",
              "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
            },
            "content": "https://your-domain.atlassian.net/jira/rest/api/3/attachment/content/10001",
            "created": "2023-06-24T19:24:50.000+0000",
            "filename": "debuglog.txt",
            "id": 10001,
            "mimeType": "text/plain",
            "self": "https://your-domain.atlassian.net/rest/api/2/attachments/10001",
            "size": 2460
          }
        ],
        "sub-tasks": [
          {
            "id": "10000",
            "outwardIssue": {
              "fields": {
                "status": {
                  "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
                  "name": "Open"
                }
              },
              "id": "10003",
              "key": "ED-2",
              "self": "https://your-domain.atlassian.net/rest/api/3/issue/ED-2"
            },
            "type": {
              "id": "10000",
              "inward": "Parent",
              "name": "",
              "outward": "Sub-task"
            }
          }
        ],
        "description": "Main order flow broken",
        "project": {
          "avatarUrls": {
            "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
            "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
            "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
            "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
          },
          "id": "10000",
          "insight": {
            "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
            "totalIssueCount": 100
          },
          "key": "EX",
          "name": "Example",
          "projectCategory": {
            "description": "First Project Category",
            "id": "10000",
            "name": "FIRST",
            "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
          },
          "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
          "simplified": false,
          "style": "classic"
        },
        "comment": [
          {
            "author": {
              "accountId": "5b10a2844c20165700ede21g",
              "active": false,
              "displayName": "Mia Krystof",
              "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
            },
            "body": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.",
            "created": "2021-01-17T12:34:00.000+0000",
            "id": "10000",
            "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
            "updateAuthor": {
              "accountId": "5b10a2844c20165700ede21g",
              "active": false,
              "displayName": "Mia Krystof",
              "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
            },
            "updated": "2021-01-18T23:45:00.000+0000",
            "visibility": {
              "identifier": "Administrators",
              "type": "role",
              "value": "Administrators"
            }
          }
        ],
        "issuelinks": [
          {
            "id": "10001",
            "outwardIssue": {
              "fields": {
                "status": {
                  "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
                  "name": "Open"
                }
              },
              "id": "10004L",
              "key": "PR-2",
              "self": "https://your-domain.atlassian.net/rest/api/3/issue/PR-2"
            },
            "type": {
              "id": "10000",
              "inward": "depends on",
              "name": "Dependent",
              "outward": "is depended by"
            }
          },
          {
            "id": "10002",
            "inwardIssue": {
              "fields": {
                "status": {
                  "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
                  "name": "Open"
                }
              },
              "id": "10004",
              "key": "PR-3",
              "self": "https://your-domain.atlassian.net/rest/api/3/issue/PR-3"
            },
            "type": {
              "id": "10000",
              "inward": "depends on",
              "name": "Dependent",
              "outward": "is depended by"
            }
          }
        ],
        "worklog": [
          {
            "author": {
              "accountId": "5b10a2844c20165700ede21g",
              "active": false,
              "displayName": "Mia Krystof",
              "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
            },
            "comment": "I did some work here.",
            "id": "100028",
            "issueId": "10002",
            "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
            "started": "2021-01-17T12:34:00.000+0000",
            "timeSpent": "3h 20m",
            "timeSpentSeconds": 12000,
            "updateAuthor": {
              "accountId": "5b10a2844c20165700ede21g",
              "active": false,
              "displayName": "Mia Krystof",
              "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
            },
            "updated": "2021-01-18T23:45:00.000+0000",
            "visibility": {
              "identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
              "type": "group",
              "value": "jira-developers"
            }
          }
        ],
        "updated": 1,
        "timetracking": {
          "originalEstimate": "10m",
          "originalEstimateSeconds": 600,
          "remainingEstimate": "3m",
          "remainingEstimateSeconds": 200,
          "timeSpent": "6m",
          "timeSpentSeconds": 400
        }
      },
      "id": "10002",
      "key": "ED-1",
      "self": "https://your-domain.atlassian.net/rest/api/3/issue/10002"
    }
  ]
}

Path

POST /rest/api/3/search/jql @scopes-current read:jira-work @scopes-beta read:issue-details:jira, read:field.default-value:jira, read:field.option:jira, read:field:jira, read:group:jira

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-search#api-rest-api-3-search-jql-post

searchForIssuesIds

searchForIssuesIds(params): Promise<IdSearchResults>
Searches for IDs of issues using JQL.

Use the Search endpoint if you need to fetch more than just issue IDs. The Search endpoint returns more information, but may take much longer to respond to requests. This is because it uses a different mechanism for ordering results than this endpoint and doesn't provide the total number of results for your query.

This operation can be accessed anonymously.

Permissions required: Issues are included in the response where the user has:
- Browse projects project permission for the project containing the issue.
- If issue-level security is configured, issue-level security permission to view the issue.
Parameters
- params: {
  idSearchRequestBean: IdSearchRequestBean;
  }
  - idSearchRequestBean: IdSearchRequestBean
    A JSON object containing the search request.
    
    Example
Returns Promise<IdSearchResults>
Returned if the request is successful.

example:
```
{
  "issueIds": [
    10000,
    10001,
    10002
  ],
  "nextPageToken": "EgQIlMIC"
}
```
Deprecated
Path
POST /rest/api/3/search/id @scopes-current read:jira-work @scopes-beta read:issue-details:jira, read:field.default-value:jira, read:field.option:jira, read:field:jira, read:group:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-search#api-rest-api-3-search-id-post

searchForIssuesUsingJql

searchForIssuesUsingJql(params?): Promise<SearchResults>

Searches for issues using JQL.

If the JQL query expression is too large to be encoded as a query parameter, use the POST version of this resource.

This operation can be accessed anonymously.

Permissions required: Issues are included in the response where the user has:

Browse projects project permission for the project containing the issue.
If issue-level security is configured, issue-level security permission to view the issue.

Parameters

params: {
    expand?: string;
    failFast?: boolean;
    fields?: string[];
    fieldsByKeys?: boolean;
    jql?: string;
    maxResults?: number;
    properties?: string[];
    startAt?: number;
    validateQuery?:
        | "false"
        | "none"
        | "strict"
        | "true"
        | "warn";
} = {}
- Optionalexpand?: string
  Use expand to include additional information about issues in the response. This parameter accepts a comma-separated list. Expand options include:
  - 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.
- OptionalfailFast?: boolean
  Whether to fail the request quickly in case of an error while loading fields for an issue. For failFast=true, if one field fails, the entire operation fails. For failFast=false, the operation will continue even if a field fails. It will return a valid response, but without values for the failed field(s).
- Optionalfields?: string[]
  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.
  - Any issue field, prefixed with a minus to exclude.
  Examples:
  - summary,comment Returns only the summary and comments fields.
  - -description Returns all navigable (default) fields except description.
  - *all,-comment Returns all fields except comments.
  This parameter may be specified multiple times. For example, fields=field1,field2&fields=field3.
  
  Note: All navigable fields are returned by default. This differs from GET issue where the default is all fields.
- OptionalfieldsByKeys?: boolean
  Reference fields by their key (rather than ID).
- Optionaljql?: string
  The JQL that defines the search. Note:
  - If no JQL expression is provided, all issues are returned.
  - username and userkey cannot be used as search terms due to privacy reasons. Use accountId instead.
  - If a user has hidden their email address in their user profile, partial matches of the email address will not find the user. An exact match is required.
- OptionalmaxResults?: number
  The maximum number of items to return per page. To manage page size, Jira may return fewer items per page where a large number of fields are requested. The greatest number of items returned per page is achieved when requesting id or key only.
- Optionalproperties?: string[]
  A list of issue property keys for issue properties to include in the results. This parameter accepts a comma-separated list. Multiple properties can also be provided using an ampersand separated list. For example, properties=prop1,prop2&properties=prop3. A maximum of 5 issue property keys can be specified.
- OptionalstartAt?: number
  The index of the first item to return in a page of results (page offset).
- OptionalvalidateQuery?:
      | "false"
      | "none"
      | "strict"
      | "true"
      | "warn"
  Determines how to validate the JQL query and treat the validation results. Supported values are:
  - strict Returns a 400 response code if any errors are found, along with a list of all errors (and warnings).
  - warn Returns all errors as warnings.
  - none No validation is performed.
  - true Deprecated A legacy synonym for strict.
  - false Deprecated A legacy synonym for warn.
  Note: If the JQL is not correctly formed a 400 response code is returned, regardless of the validateQuery value.

Returns Promise<SearchResults>

Returned if the request is successful.

example:

{
  "expand": "names,schema",
  "issues": [
    {
      "expand": "",
      "fields": {
        "watcher": {
          "isWatching": false,
          "self": "https://your-domain.atlassian.net/rest/api/3/issue/EX-1/watchers",
          "watchCount": 1
        },
        "attachment": [
          {
            "author": {
              "accountId": "5b10a2844c20165700ede21g",
              "accountType": "atlassian",
              "active": false,
              "avatarUrls": {
                "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
                "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
                "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
                "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
              },
              "displayName": "Mia Krystof",
              "key": "",
              "name": "",
              "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
            },
            "content": "https://your-domain.atlassian.net/jira/rest/api/3/attachment/content/10000",
            "created": "2022-10-06T07:32:47.000+0000",
            "filename": "picture.jpg",
            "id": 10000,
            "mimeType": "image/jpeg",
            "self": "https://your-domain.atlassian.net/rest/api/3/attachments/10000",
            "size": 23123,
            "thumbnail": "https://your-domain.atlassian.net/jira/rest/api/3/attachment/thumbnail/10000"
          }
        ],
        "sub-tasks": [
          {
            "id": "10000",
            "outwardIssue": {
              "fields": {
                "status": {
                  "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
                  "name": "Open"
                }
              },
              "id": "10003",
              "key": "ED-2",
              "self": "https://your-domain.atlassian.net/rest/api/3/issue/ED-2"
            },
            "type": {
              "id": "10000",
              "inward": "Parent",
              "name": "",
              "outward": "Sub-task"
            }
          }
        ],
        "description": {
          "type": "doc",
          "version": 1,
          "content": [
            {
              "type": "paragraph",
              "content": [
                {
                  "type": "text",
                  "text": "Main order flow broken"
                }
              ]
            }
          ]
        },
        "project": {
          "avatarUrls": {
            "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
            "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
            "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
            "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
          },
          "id": "10000",
          "insight": {
            "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
            "totalIssueCount": 100
          },
          "key": "EX",
          "name": "Example",
          "projectCategory": {
            "description": "First Project Category",
            "id": "10000",
            "name": "FIRST",
            "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
          },
          "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
          "simplified": false,
          "style": "classic"
        },
        "comment": [
          {
            "author": {
              "accountId": "5b10a2844c20165700ede21g",
              "active": false,
              "displayName": "Mia Krystof",
              "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
            },
            "body": {
              "type": "doc",
              "version": 1,
              "content": [
                {
                  "type": "paragraph",
                  "content": [
                    {
                      "type": "text",
                      "text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper."
                    }
                  ]
                }
              ]
            },
            "created": "2021-01-17T12:34:00.000+0000",
            "id": "10000",
            "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
            "updateAuthor": {
              "accountId": "5b10a2844c20165700ede21g",
              "active": false,
              "displayName": "Mia Krystof",
              "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
            },
            "updated": "2021-01-18T23:45:00.000+0000",
            "visibility": {
              "identifier": "Administrators",
              "type": "role",
              "value": "Administrators"
            }
          }
        ],
        "issuelinks": [
          {
            "id": "10001",
            "outwardIssue": {
              "fields": {
                "status": {
                  "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
                  "name": "Open"
                }
              },
              "id": "10004L",
              "key": "PR-2",
              "self": "https://your-domain.atlassian.net/rest/api/3/issue/PR-2"
            },
            "type": {
              "id": "10000",
              "inward": "depends on",
              "name": "Dependent",
              "outward": "is depended by"
            }
          },
          {
            "id": "10002",
            "inwardIssue": {
              "fields": {
                "status": {
                  "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
                  "name": "Open"
                }
              },
              "id": "10004",
              "key": "PR-3",
              "self": "https://your-domain.atlassian.net/rest/api/3/issue/PR-3"
            },
            "type": {
              "id": "10000",
              "inward": "depends on",
              "name": "Dependent",
              "outward": "is depended by"
            }
          }
        ],
        "worklog": [
          {
            "author": {
              "accountId": "5b10a2844c20165700ede21g",
              "active": false,
              "displayName": "Mia Krystof",
              "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
            },
            "comment": {
              "type": "doc",
              "version": 1,
              "content": [
                {
                  "type": "paragraph",
                  "content": [
                    {
                      "type": "text",
                      "text": "I did some work here."
                    }
                  ]
                }
              ]
            },
            "id": "100028",
            "issueId": "10002",
            "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
            "started": "2021-01-17T12:34:00.000+0000",
            "timeSpent": "3h 20m",
            "timeSpentSeconds": 12000,
            "updateAuthor": {
              "accountId": "5b10a2844c20165700ede21g",
              "active": false,
              "displayName": "Mia Krystof",
              "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
            },
            "updated": "2021-01-18T23:45:00.000+0000",
            "visibility": {
              "identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
              "type": "group",
              "value": "jira-developers"
            }
          }
        ],
        "updated": 1,
        "timetracking": {
          "originalEstimate": "10m",
          "originalEstimateSeconds": 600,
          "remainingEstimate": "3m",
          "remainingEstimateSeconds": 200,
          "timeSpent": "6m",
          "timeSpentSeconds": 400
        }
      },
      "id": "10002",
      "key": "ED-1",
      "self": "https://your-domain.atlassian.net/rest/api/3/issue/10002"
    }
  ],
  "maxResults": 50,
  "startAt": 0,
  "total": 1,
  "warningMessages": [
    "The value 'bar' does not exist for the field 'foo'."
  ]
}

Deprecated

Path

GET /rest/api/3/search @scopes-current read:jira-work @scopes-beta read:issue-details:jira, read:audit-log:jira, read:avatar:jira, read:field-configuration:jira, read:issue-meta:jira

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-search#api-rest-api-3-search-get

searchForIssuesUsingJqlPost

searchForIssuesUsingJqlPost(params): Promise<SearchResults>

Searches for issues using JQL.

There is a GET version of this resource that can be used for smaller JQL query expressions.

This operation can be accessed anonymously.

Permissions required: Issues are included in the response where the user has:

Browse projects project permission for the project containing the issue.
If issue-level security is configured, issue-level security permission to view the issue.

Parameters

params: {
searchRequestBean: SearchRequestBean;
}
- searchRequestBean: SearchRequestBean
  A JSON object containing the search request.
  
  Example

Returns Promise<SearchResults>

Returned if the request is successful.

example:

{
  "expand": "names,schema",
  "issues": [
    {
      "expand": "",
      "fields": {
        "watcher": {
          "isWatching": false,
          "self": "https://your-domain.atlassian.net/rest/api/3/issue/EX-1/watchers",
          "watchCount": 1
        },
        "attachment": [
          {
            "author": {
              "accountId": "5b10a2844c20165700ede21g",
              "accountType": "atlassian",
              "active": false,
              "avatarUrls": {
                "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
                "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
                "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
                "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
              },
              "displayName": "Mia Krystof",
              "key": "",
              "name": "",
              "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
            },
            "content": "https://your-domain.atlassian.net/jira/rest/api/3/attachment/content/10000",
            "created": "2022-10-06T07:32:47.000+0000",
            "filename": "picture.jpg",
            "id": 10000,
            "mimeType": "image/jpeg",
            "self": "https://your-domain.atlassian.net/rest/api/3/attachments/10000",
            "size": 23123,
            "thumbnail": "https://your-domain.atlassian.net/jira/rest/api/3/attachment/thumbnail/10000"
          }
        ],
        "sub-tasks": [
          {
            "id": "10000",
            "outwardIssue": {
              "fields": {
                "status": {
                  "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
                  "name": "Open"
                }
              },
              "id": "10003",
              "key": "ED-2",
              "self": "https://your-domain.atlassian.net/rest/api/3/issue/ED-2"
            },
            "type": {
              "id": "10000",
              "inward": "Parent",
              "name": "",
              "outward": "Sub-task"
            }
          }
        ],
        "description": {
          "type": "doc",
          "version": 1,
          "content": [
            {
              "type": "paragraph",
              "content": [
                {
                  "type": "text",
                  "text": "Main order flow broken"
                }
              ]
            }
          ]
        },
        "project": {
          "avatarUrls": {
            "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
            "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
            "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
            "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
          },
          "id": "10000",
          "insight": {
            "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
            "totalIssueCount": 100
          },
          "key": "EX",
          "name": "Example",
          "projectCategory": {
            "description": "First Project Category",
            "id": "10000",
            "name": "FIRST",
            "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
          },
          "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
          "simplified": false,
          "style": "classic"
        },
        "comment": [
          {
            "author": {
              "accountId": "5b10a2844c20165700ede21g",
              "active": false,
              "displayName": "Mia Krystof",
              "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
            },
            "body": {
              "type": "doc",
              "version": 1,
              "content": [
                {
                  "type": "paragraph",
                  "content": [
                    {
                      "type": "text",
                      "text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper."
                    }
                  ]
                }
              ]
            },
            "created": "2021-01-17T12:34:00.000+0000",
            "id": "10000",
            "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
            "updateAuthor": {
              "accountId": "5b10a2844c20165700ede21g",
              "active": false,
              "displayName": "Mia Krystof",
              "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
            },
            "updated": "2021-01-18T23:45:00.000+0000",
            "visibility": {
              "identifier": "Administrators",
              "type": "role",
              "value": "Administrators"
            }
          }
        ],
        "issuelinks": [
          {
            "id": "10001",
            "outwardIssue": {
              "fields": {
                "status": {
                  "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
                  "name": "Open"
                }
              },
              "id": "10004L",
              "key": "PR-2",
              "self": "https://your-domain.atlassian.net/rest/api/3/issue/PR-2"
            },
            "type": {
              "id": "10000",
              "inward": "depends on",
              "name": "Dependent",
              "outward": "is depended by"
            }
          },
          {
            "id": "10002",
            "inwardIssue": {
              "fields": {
                "status": {
                  "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
                  "name": "Open"
                }
              },
              "id": "10004",
              "key": "PR-3",
              "self": "https://your-domain.atlassian.net/rest/api/3/issue/PR-3"
            },
            "type": {
              "id": "10000",
              "inward": "depends on",
              "name": "Dependent",
              "outward": "is depended by"
            }
          }
        ],
        "worklog": [
          {
            "author": {
              "accountId": "5b10a2844c20165700ede21g",
              "active": false,
              "displayName": "Mia Krystof",
              "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
            },
            "comment": {
              "type": "doc",
              "version": 1,
              "content": [
                {
                  "type": "paragraph",
                  "content": [
                    {
                      "type": "text",
                      "text": "I did some work here."
                    }
                  ]
                }
              ]
            },
            "id": "100028",
            "issueId": "10002",
            "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
            "started": "2021-01-17T12:34:00.000+0000",
            "timeSpent": "3h 20m",
            "timeSpentSeconds": 12000,
            "updateAuthor": {
              "accountId": "5b10a2844c20165700ede21g",
              "active": false,
              "displayName": "Mia Krystof",
              "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
            },
            "updated": "2021-01-18T23:45:00.000+0000",
            "visibility": {
              "identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
              "type": "group",
              "value": "jira-developers"
            }
          }
        ],
        "updated": 1,
        "timetracking": {
          "originalEstimate": "10m",
          "originalEstimateSeconds": 600,
          "remainingEstimate": "3m",
          "remainingEstimateSeconds": 200,
          "timeSpent": "6m",
          "timeSpentSeconds": 400
        }
      },
      "id": "10002",
      "key": "ED-1",
      "self": "https://your-domain.atlassian.net/rest/api/3/issue/10002"
    }
  ],
  "maxResults": 50,
  "startAt": 0,
  "total": 1,
  "warningMessages": [
    "The value 'bar' does not exist for the field 'foo'."
  ]
}

Deprecated

Path

POST /rest/api/3/search @scopes-current read:jira-work @scopes-beta read:issue-details:jira, read:field.default-value:jira, read:field.option:jira, read:field:jira, read:group:jira

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-search#api-rest-api-3-search-post

`Protected` `Static`initialize

initialize(): void
Method to initialize the class. Normally used to set up validation rules.

Returns void
Overrides CommonHttpService.initialize

Class IssueSearchService

See

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CommonHttpClient

Returns IssueSearchService

Methods

countIssues

Parameters

jqlCountRequestBean: JqlCountRequestBean

Example

Returns Promise<JqlCountResultsBean>

Path

See

getIssuePickerResource

Parameters

OptionalcurrentIssueKey?: string

OptionalcurrentJql?: string

OptionalcurrentProjectId?: string

Optionalquery?: string

OptionalshowSubTaskParent?: boolean

OptionalshowSubTasks?: boolean

Returns Promise<IssuePickerSuggestions>

Path

See

matchIssues

Parameters

issuesAndJqlQueries: IssuesAndJqlQueries

Example

Returns Promise<IssueMatches>

Path

See

searchAndReconsileIssuesUsingJql

Parameters

Optionalexpand?: string

OptionalfailFast?: boolean

Optionalfields?: string[]

OptionalfieldsByKeys?: boolean

Optionaljql?: string

OptionalmaxResults?: number

OptionalnextPageToken?: string

Optionalproperties?: string[]

OptionalreconcileIssues?: number[]

Returns Promise<SearchAndReconcileResults>

Path

See

searchAndReconsileIssuesUsingJqlPost

Parameters

searchAndReconcileRequestBean: SearchAndReconcileRequestBean

Returns Promise<SearchAndReconcileResults>

Path

See

searchForIssuesIds

Parameters

idSearchRequestBean: IdSearchRequestBean

Example

Returns Promise<IdSearchResults>

Deprecated

Path

See

searchForIssuesUsingJql

Parameters

Optionalexpand?: string

OptionalfailFast?: boolean

Optionalfields?: string[]

OptionalfieldsByKeys?: boolean

Optionaljql?: string

OptionalmaxResults?: number

Optionalproperties?: string[]

OptionalstartAt?: number

OptionalvalidateQuery?: | "false" | "none" | "strict" | "true" | "warn"

Returns Promise<SearchResults>

Deprecated

Path

See

`Optional`currentIssueKey?: string

`Optional`currentJql?: string

`Optional`currentProjectId?: string

`Optional`query?: string

`Optional`showSubTaskParent?: boolean

`Optional`showSubTasks?: boolean

`Optional`expand?: string

`Optional`failFast?: boolean

`Optional`fields?: string[]

`Optional`fieldsByKeys?: boolean

`Optional`jql?: string

`Optional`maxResults?: number

`Optional`nextPageToken?: string

`Optional`properties?: string[]

`Optional`reconcileIssues?: number[]

`Optional`expand?: string

`Optional`failFast?: boolean

`Optional`fields?: string[]

`Optional`fieldsByKeys?: boolean

`Optional`jql?: string

`Optional`maxResults?: number

`Optional`properties?: string[]

`Optional`startAt?: number

`Optional`validateQuery?:
| "false"
| "none"
| "strict"
| "true"
| "warn"

`Protected` `Static`initialize