Class: Request

Request

new Request()

Request REST resource for querying and executing reindex requests.

Properties:
Name Type Description
connector IConnector

the jira connector instance

Source:

Methods

getProgress(options, callbackopt) → {Promise.<any>}

Retrieves the progress of a single reindex request.

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
requestId string

requestId

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

getProgressBulk(options, callbackopt) → {Promise.<any>}

Retrieves the progress of a multiple reindex requests. Only reindex requests that actually exist will be returned in the results.the reindex request IDs.

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
requestId string

requestId the reindex request IDs.

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

processRequests(options, callbackopt) → {Promise.<any>}

Executes any pending reindex requests. Returns a JSON array containing the IDs of the reindex requests that are being processed. Execution is asynchronous - progress of the returned tasks can be monitored through other REST calls.

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>