Update the state of the job

put/jobs/{jobId}/state

Updates the state of the current job. The new state must be set as either the value-query parameter or in the body of the request. The value-query parameter takes precedence if both are specified. If neither is specified, a 400 bad request error response is returned (error code 31505).

Request Samples

1

Response Samples

1Not Available

Path Parameters

NameTypeRequiredDescription
jobId
string
true

The ID of the job.

Query Parameters

NameTypeRequiredDescription
value
string
false

The value of the state. If this value and the body specify a state, then this value takes precedence.

Request Body

The new value of the state.

Responses

StatusMeaningDescription
200OK

The request succeeded.

400Bad Request

The request was invalid. An invalid request occurs in the following scenarios: An invalid state value was provided (error code 31506). The state was not specified in the value query parameter or in the body of the request (error code 31505).

Schema
404Not Found

No job exists at the requested path.

Schema
405Method Not Allowed

The request could not be completed due to a conflict with the current state of the resource. The job has already completed and can no longer be updated (error code 31501).

Schema