Patch a job by IDDeprecated

patch/compute-ops-mgmt/v1beta2/jobs/{id}

Note: This path operation is going to be deprecated and sunset!

  • Deprecated at: Fri, 1 Dec 2023 23:59:59 GMT
  • Sunset at : Mon, 1 Jan 2024 23:59:59 GMT
  • Successor version: compute-ops-mgmt/v1beta3/jobs/id

Updates an existing job

URI PATH PREFIX RENAME

This API now supports the URI path prefix /compute-ops-mgmt which used to be /compute-ops. The /compute-ops prefix is deprecated and might become unresponsive after Tuesday, April 1, 2025. The Guide provides more information about this change.

SecurityBearer
Request
path Parameters
id
required
string <uuid>

Unique Job identifier

header Parameters
Content-Type
required
string

Content-Type header must designate 'application/merge-patch+json' in order for the request to be performed.

Value: "application/merge-patch+json"
Tenant-Acid
string <uuid>

Tenant-Acid header can be used by an MSP workspace to make API calls on behalf of their tenant by specifying the tenant's application customer ID.

In order to make such an API call, the Bearer token must belong to an MSP workspace and this header value must be the application customer ID of a tenant within the MSP workspace. Use the /compute-ops-mgmt/v1beta1/accounts API to determine the application customer IDs for your tenant accounts.

Request Body schema: application/merge-patch+json
required

Job update data

state
string

New state for the job (currently only Error is supported)

Value: "ERROR"
object

Additional input (optional) for the job

Responses
200

Job data

400

Bad request

401

Unauthorized

403

Forbidden

404

Not found

406

Not acceptable

412

Precondition failed

415

Unsupported media type

500

Internal server error

Request samples
application/merge-patch+json
{
  • "state": "ERROR",
  • "input": {
    }
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "parentJobId": "f191323c-cca3-42d1-b291-1b7622b505c0",
  • "type": "compute-ops-mgmt/job",
  • "resourceUri": "/compute-ops-mgmt/v1beta2/jobs/2500759c-b7dd-4c68-ab7e-6b644bcf4b9c",
  • "name": "string",
  • "generation": 1,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "jobTemplateUri": "string",
  • "associatedResourceUri": "string",
  • "resource": {
    },
  • "data": {
    },
  • "results": {
    },
  • "state": "PENDING",
  • "status": "string",
  • "statusDetails": { }
}