Get current state of a job

get/sessions/{sessionId}/jobs/{jobId}/state

Returns the current state of the specified job.

Request Samples

1

Response Samples

1running

Path Parameters

NameTypeRequiredDescription
jobId
string
true

Specifies the ID of the job to return information for.

sessionId
string<object-id>
true

Specifies the ID of the session.

Query Parameters

NameTypeRequiredDescription
wait
integer
false

Specifies the request time-out, in seconds. This parameter is ignored unless it is specified in combination with the If-None-Match header. If the state of the resource remains unchanged until the specified number of seconds has elapsed, then a status of 304 is returned. The request determines whether the current state matches the state when the ETag was specified via the If-None-Match header. If the state differs within the specified time period, then the new state is returned.

Header Parameters

NameTypeRequiredDescription
If-None-Match
string
false

Specifies the ETag that is associated with a value of the job state.

Responses

StatusMeaningDescription
200OK

The request succeeded.

HeadersSchema
304Not Modified

The session state has not changed since the request was issued using the ETag that is specified in the If-None-Match header.

400Bad Request

The request was invalid. The session is in a state that cannot process this request.

Schema
404Not Found

No resource exists at the requested path.

Schema