Skip to content

Resume interrupted work

POST
/api/v1/jobs/{id}/resume
curl --request POST \
--url http://127.0.0.1:8080/api/v1/jobs/example/resume \
--header 'Authorization: Bearer <token>'

Send the job revision in If-Match. An import job has no revision and needs none. Completed item results remain; an in-flight mutation whose result could not be checkpointed reports outcome-unknown and is not repeated. Refetch that resource before deciding a new action. Original per-item resource revisions continue to apply.

id
required
string
If-Match
string

OK

Media typeapplication/json
object
code
string
created_at
required
string
download_url
string
expires_at
string
finished
required
integer format: int64
id
required
string
import_job_id
string
kind
required
string
revision
required
integer format: int64
state
required
string
total
required
integer format: int64
key
additional properties
any
Examplegenerated
{
"code": "example",
"created_at": "example",
"download_url": "example",
"expires_at": "example",
"finished": 1,
"id": "example",
"import_job_id": "example",
"kind": "example",
"revision": 1,
"state": "example",
"total": 1
}
ETag
string
Location
string

No valid session or API token (authentication-required), or the credential sent is invalid (invalid-credentials).

Media typeapplication/problem+json
object
code
required
string
detail
required
string
status
required
integer format: int64
title
required
string
type
required
string
key
additional properties
any
Examplegenerated
{
"code": "example",
"detail": "example",
"status": 1,
"title": "example",
"type": "example"
}

Error

Media typeapplication/problem+json
object
code

Stable application error code; clients may also use the problem type suffix.

string
detail

A human-readable explanation specific to this occurrence of the problem.

string
errors

Optional list of individual error details

Array<object> | null
object
location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string
message

Error message text

string
value

The value at the given location

key
additional properties
any
instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri
params

Structured context for the stable error code.

object
key
additional properties
any
status

HTTP status code

integer format: int64
title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string
type

A URI reference to human-readable documentation for the error.

string format: uri
default: about:blank
violations
Array<object>
object
code
required
string
location
required
string
params
object
key
additional properties
any
key
additional properties
any
Example
{
"detail": "Property foo is required but is missing.",
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "about:blank"
}