Update Job Properties
Submits a request to update (and replace) the properties for a specific Job entity in the Server.
Request takes a JSON Name/Value List as content (the Job ID and the new properties), and on success returns a response containing the result of the request for update/replacement (“true”).
Request
| Method Type: |
PUT |
|---|---|
| URI: | |
| Content: | JSON Name/Value List of properties for Job |
| Content Type: |
application/json |
| Add. Headers: |
If server security settings are enabled, then one of the following:
|
Parameters
Path
| Name | Required | Type | Default Value | Description |
|---|---|---|---|---|
| jobId |
– |
– |
– |
The ID of the Job entity in Server |
Response
Success
The following lists status codes indicative of a successful response:
| Status Code | Content | Content-Type | Add. Headers | Description |
|---|---|---|---|---|
| 200 OK |
Result of request to update Job | text/plain | – | Update of Job properties successfully requested (response of “true” for success) |
Error
The following lists status codes indicative of a failed or error response:
| Status Code | Content | Content-Type | Add. Headers | Description |
|---|---|---|---|---|
|
401 Unauthorized |
– |
– |
WWW-Authenticate – BASIC (Basic Authentication credentials are accepted) |
Server authentication is required. Response when neither basic authentication credentials nor an authorization token have been specified in the request headers. |
|
401 Unauthorized |
Error message |
– |
– |
Server authentication has failed. Response when the authorization token specified in the request headers has now expired. |
|
403 Forbidden |
Error message |
– |
– |
Server authentication has failed. Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid. |
|
500 |
– |
– |
– |
Server error or Job ID mismatch in JSON |