Jira search and JQL endpoint functions.
Covers issue search, JQL autocomplete, JQL parsing/sanitization, and issue navigator column settings from the Jira Cloud Platform REST API v3.
Jira search and JQL endpoint functions. Covers issue search, JQL autocomplete, JQL parsing/sanitization, and issue navigator column settings from the Jira Cloud Platform REST API v3.
(count-issues client body)(count-issues client body opts)Count issues matching a JQL query (approximate). POST /rest/api/3/search/approximate-count Body: JQLCountRequestBean — keys: :jql
Count issues matching a JQL query (approximate). POST /rest/api/3/search/approximate-count Body: JQLCountRequestBean — keys: :jql
(get-auto-complete client)Get field reference data for JQL autocomplete (GET). GET /rest/api/3/jql/autocompletedata
Get field reference data for JQL autocomplete (GET). GET /rest/api/3/jql/autocompletedata
(get-auto-complete-post client body)(get-auto-complete-post client body opts)Get field reference data for JQL autocomplete (POST). POST /rest/api/3/jql/autocompletedata Body: SearchAutoCompleteFilter — keys: :includeCollapsedFields, :projectIds
Get field reference data for JQL autocomplete (POST). POST /rest/api/3/jql/autocompletedata Body: SearchAutoCompleteFilter — keys: :includeCollapsedFields, :projectIds
(get-field-auto-complete-for-query-string client)(get-field-auto-complete-for-query-string client opts)Get field auto-complete suggestions for a JQL query. GET /rest/api/3/jql/autocompletedata/suggestions opts: :fieldName :fieldValue :predicateName :predicateValue
Get field auto-complete suggestions for a JQL query. GET /rest/api/3/jql/autocompletedata/suggestions opts: :fieldName :fieldValue :predicateName :predicateValue
(get-issue-navigator-default-columns client)Get the default column configuration for the issue navigator. GET /rest/api/3/settings/columns
Get the default column configuration for the issue navigator. GET /rest/api/3/settings/columns
(get-issue-picker client)(get-issue-picker client opts)Get issue picker suggestions matching a text string. GET /rest/api/3/issue/picker opts: :query :currentJQL :currentIssueKey :currentProjectId :showSubTasks :showSubTaskParent
Get issue picker suggestions matching a text string. GET /rest/api/3/issue/picker opts: :query :currentJQL :currentIssueKey :currentProjectId :showSubTasks :showSubTaskParent
(match-issues client body)(match-issues client body opts)Check whether issues match one or more JQL queries. POST /rest/api/3/jql/match Body: IssuesAndJQLQueries — keys: :issueIds, :jqls
Check whether issues match one or more JQL queries. POST /rest/api/3/jql/match Body: IssuesAndJQLQueries — keys: :issueIds, :jqls
(migrate-queries client body)(migrate-queries client body opts)Convert user identifiers to account IDs in JQL queries. POST /rest/api/3/jql/pdcleaner Body: JQLPersonalDataMigrationRequest — keys: :queryStrings
Convert user identifiers to account IDs in JQL queries. POST /rest/api/3/jql/pdcleaner Body: JQLPersonalDataMigrationRequest — keys: :queryStrings
(parse-jql-queries client body)(parse-jql-queries client body opts)Parse and optionally validate one or more JQL queries. POST /rest/api/3/jql/parse Required query param: :validation ("strict", "warn", or "none") Body: JqlQueriesToParse — keys: :queries Pass opts map with :validation key, e.g. {:validation "strict"}
Parse and optionally validate one or more JQL queries.
POST /rest/api/3/jql/parse
Required query param: :validation ("strict", "warn", or "none")
Body: JqlQueriesToParse — keys: :queries
Pass opts map with :validation key, e.g. {:validation "strict"}(sanitise-jql-queries client body)(sanitise-jql-queries client body opts)Sanitize JQL queries by removing clauses that the user doesn't have permission to see. POST /rest/api/3/jql/sanitize Body: JqlQueriesToSanitize — keys: :queries
Sanitize JQL queries by removing clauses that the user doesn't have permission to see. POST /rest/api/3/jql/sanitize Body: JqlQueriesToSanitize — keys: :queries
(search-and-reconsile-issues-using-jql client)(search-and-reconsile-issues-using-jql client opts)Search for issues using JQL enhanced search with cursor-based pagination (GET). GET /rest/api/3/search/jql opts: :jql :nextPageToken :maxResults :fields :expand :properties :fieldsByKeys :failFast :reconcileIssues
Search for issues using JQL enhanced search with cursor-based pagination (GET). GET /rest/api/3/search/jql opts: :jql :nextPageToken :maxResults :fields :expand :properties :fieldsByKeys :failFast :reconcileIssues
(search-and-reconsile-issues-using-jql-post client body)(search-and-reconsile-issues-using-jql-post client body opts)Search for issues using JQL enhanced search with cursor-based pagination (POST). POST /rest/api/3/search/jql Body: SearchAndReconcileRequestBean — keys: :jql, :nextPageToken, :maxResults, :fields, :expand, :properties, :fieldsByKeys, :reconcileIssues
Search for issues using JQL enhanced search with cursor-based pagination (POST). POST /rest/api/3/search/jql Body: SearchAndReconcileRequestBean — keys: :jql, :nextPageToken, :maxResults, :fields, :expand, :properties, :fieldsByKeys, :reconcileIssues
(search-for-issues-using-jql client)(search-for-issues-using-jql client opts)DEPRECATED. Currently being removed. Search for issues using JQL (GET). GET /rest/api/3/search opts: :jql :startAt :maxResults :validateQuery :fields :expand :properties :fieldsByKeys :failFast
DEPRECATED. Currently being removed. Search for issues using JQL (GET). GET /rest/api/3/search opts: :jql :startAt :maxResults :validateQuery :fields :expand :properties :fieldsByKeys :failFast
(search-for-issues-using-jql-post client body)(search-for-issues-using-jql-post client body opts)DEPRECATED. Currently being removed. Search for issues using JQL (POST). POST /rest/api/3/search Body: SearchRequestBean — keys: :jql, :startAt, :maxResults, :validateQuery, :fields, :expand, :properties, :fieldsByKeys
DEPRECATED. Currently being removed. Search for issues using JQL (POST). POST /rest/api/3/search Body: SearchRequestBean — keys: :jql, :startAt, :maxResults, :validateQuery, :fields, :expand, :properties, :fieldsByKeys
(set-issue-navigator-default-columns client body)(set-issue-navigator-default-columns client body opts)Set the default column configuration for the issue navigator. PUT /rest/api/3/settings/columns Body: array of column IDs
Set the default column configuration for the issue navigator. PUT /rest/api/3/settings/columns Body: array of column IDs
cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |