jira.js
Guide
GitHub
Preparing search index...
server
searchUsingSearchRequest
Function searchUsingSearchRequest
searchUsingSearchRequest
(
client
:
Client
,
parameters
:
{
expand
?:
string
[]
;
fields
?:
string
[]
;
jql
?:
string
;
maxResults
?:
number
;
startAt
?:
number
;
validateQuery
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
:
Promise
<
{
expand
?:
string
|
null
;
issues
?:
{
changelog
?:
{
histories
?:
{
author
?:
(...)
|
(...)
;
created
?:
(...)
|
(...)
;
historyMetadata
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
items
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
maxResults
?:
number
;
startAt
?:
number
;
total
?:
number
;
[
key
:
string
]:
unknown
;
}
;
editmeta
?:
{
fields
?:
Record
<
string
,
{
allowedValues
?:
(...)
|
(...)
;
autoCompleteUrl
?:
(...)
|
(...)
;
defaultValue
?:
(...)
|
(...)
;
fieldId
?:
(...)
|
(...)
;
hasDefaultValue
?:
(...)
|
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
operations
?:
(...)
|
(...)
;
required
?:
(...)
|
(...)
|
(...)
;
schema
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
,
>
;
[
key
:
string
]:
unknown
;
}
;
fields
?:
Record
<
string
,
any
>
;
fieldsToInclude
?:
{
included
?:
string
[]
;
[
key
:
string
]:
unknown
}
;
id
?:
string
;
key
?:
string
;
names
?:
Record
<
string
,
string
>
;
operations
?:
{
linkGroups
?:
LinkGroup
[]
;
[
key
:
string
]:
unknown
}
;
properties
?:
{
properties
?:
Record
<
string
,
string
>
;
[
key
:
string
]:
unknown
;
}
;
renderedFields
?:
Record
<
string
,
any
>
|
null
;
schema
?:
Record
<
string
,
{
custom
?:
string
;
customId
?:
number
;
items
?:
string
;
system
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
self
?:
string
;
transitionBeans
?:
{
description
?:
string
;
fields
?:
Record
<
string
,
{
allowedValues
?:
...
;
autoCompleteUrl
?:
...
;
defaultValue
?:
...
;
fieldId
?:
...
;
hasDefaultValue
?:
...
;
name
?:
...
;
operations
?:
...
;
required
?:
...
;
schema
?:
...
;
[
key
:
...
]:
...
;
}
,
>
;
id
?:
string
;
name
?:
string
;
opsbarSequence
?:
number
;
to
?:
{
description
?:
(...)
|
(...)
;
iconUrl
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
statusCategory
?:
(...)
|
(...)
;
statusColor
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
[]
;
transitions
?:
{
description
?:
string
;
fields
?:
Record
<
string
,
{
allowedValues
?:
...
;
autoCompleteUrl
?:
...
;
defaultValue
?:
...
;
fieldId
?:
...
;
hasDefaultValue
?:
...
;
name
?:
...
;
operations
?:
...
;
required
?:
...
;
schema
?:
...
;
[
key
:
...
]:
...
;
}
,
>
;
id
?:
string
;
name
?:
string
;
opsbarSequence
?:
number
;
to
?:
{
description
?:
(...)
|
(...)
;
iconUrl
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
statusCategory
?:
(...)
|
(...)
;
statusColor
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
[]
;
versionedRepresentations
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
[]
;
maxResults
?:
number
;
maxResultWindow
?:
number
;
names
?:
Record
<
string
,
string
>
|
null
;
schema
?:
|
Record
<
string
,
{
custom
?:
string
;
customId
?:
number
;
items
?:
string
;
system
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
|
null
;
startAt
?:
number
;
total
?:
number
;
warningMessages
?:
string
[]
|
null
;
[
key
:
string
]:
unknown
;
}
,
>
Performs a search using JQL.
Parameters
client
:
Client
parameters
:
{
expand
?:
string
[]
;
fields
?:
string
[]
;
jql
?:
string
;
maxResults
?:
number
;
startAt
?:
number
;
validateQuery
?:
boolean
;
}
Optional
options
:
RequestOptions
Returns
Promise
<
{
expand
?:
string
|
null
;
issues
?:
{
changelog
?:
{
histories
?:
{
author
?:
(...)
|
(...)
;
created
?:
(...)
|
(...)
;
historyMetadata
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
items
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
maxResults
?:
number
;
startAt
?:
number
;
total
?:
number
;
[
key
:
string
]:
unknown
;
}
;
editmeta
?:
{
fields
?:
Record
<
string
,
{
allowedValues
?:
(...)
|
(...)
;
autoCompleteUrl
?:
(...)
|
(...)
;
defaultValue
?:
(...)
|
(...)
;
fieldId
?:
(...)
|
(...)
;
hasDefaultValue
?:
(...)
|
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
operations
?:
(...)
|
(...)
;
required
?:
(...)
|
(...)
|
(...)
;
schema
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
,
>
;
[
key
:
string
]:
unknown
;
}
;
fields
?:
Record
<
string
,
any
>
;
fieldsToInclude
?:
{
included
?:
string
[]
;
[
key
:
string
]:
unknown
}
;
id
?:
string
;
key
?:
string
;
names
?:
Record
<
string
,
string
>
;
operations
?:
{
linkGroups
?:
LinkGroup
[]
;
[
key
:
string
]:
unknown
}
;
properties
?:
{
properties
?:
Record
<
string
,
string
>
;
[
key
:
string
]:
unknown
;
}
;
renderedFields
?:
Record
<
string
,
any
>
|
null
;
schema
?:
Record
<
string
,
{
custom
?:
string
;
customId
?:
number
;
items
?:
string
;
system
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
self
?:
string
;
transitionBeans
?:
{
description
?:
string
;
fields
?:
Record
<
string
,
{
allowedValues
?:
...
;
autoCompleteUrl
?:
...
;
defaultValue
?:
...
;
fieldId
?:
...
;
hasDefaultValue
?:
...
;
name
?:
...
;
operations
?:
...
;
required
?:
...
;
schema
?:
...
;
[
key
:
...
]:
...
;
}
,
>
;
id
?:
string
;
name
?:
string
;
opsbarSequence
?:
number
;
to
?:
{
description
?:
(...)
|
(...)
;
iconUrl
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
statusCategory
?:
(...)
|
(...)
;
statusColor
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
[]
;
transitions
?:
{
description
?:
string
;
fields
?:
Record
<
string
,
{
allowedValues
?:
...
;
autoCompleteUrl
?:
...
;
defaultValue
?:
...
;
fieldId
?:
...
;
hasDefaultValue
?:
...
;
name
?:
...
;
operations
?:
...
;
required
?:
...
;
schema
?:
...
;
[
key
:
...
]:
...
;
}
,
>
;
id
?:
string
;
name
?:
string
;
opsbarSequence
?:
number
;
to
?:
{
description
?:
(...)
|
(...)
;
iconUrl
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
statusCategory
?:
(...)
|
(...)
;
statusColor
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
[]
;
versionedRepresentations
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
[]
;
maxResults
?:
number
;
maxResultWindow
?:
number
;
names
?:
Record
<
string
,
string
>
|
null
;
schema
?:
|
Record
<
string
,
{
custom
?:
string
;
customId
?:
number
;
items
?:
string
;
system
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
|
null
;
startAt
?:
number
;
total
?:
number
;
warningMessages
?:
string
[]
|
null
;
[
key
:
string
]:
unknown
;
}
,
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
Guide
GitHub
jira.js
Loading...
Performs a search using JQL.