Sign in
latestOpenAPI 3.0.02026-08-214361,0881.3 MB

88a343690a6e

searchJobManagement

Get a search job's status.

Use the search job identifier to obtain the current status of a search job.

get/v2/search/jobs/{jobId}

Path parameters

jobIdstring required

The identifier of the search job.

Response

The search job's status.

warningstring

Warnings value contains the detailed information about the warning while obtaining the current status of a search job.

statestring

Search job state. In case you are checking status for a multi child org query, you might see another status as 'Done Gathering Partial Results' which means that the query failed for some of the child orgs. You can check their reasons in audit logs with the query Id.

messageCountinteger

Number of messages found or produced so far.

recordCountinteger

Number of records found or produced so far.

pendingWarningsstring[]

Pending warnings that have accumulated since the last time the status was requested.

pendingErrorsstring[]

Pending errors that have accumulated since the last time the status was requested.

timeElapsedinteger

Time elapsed in milliseconds since the search job started.

showLogLevelsboolean

Whether log level distribution data is available for this search job.

jobIdstring

The job identifier for this search job.

Example response

{
  "state": "DONE GATHERING RESULTS"
}