Jobs API
Jobs API is used to fetch and interact with the issued jobs. Job is a unit of work that is executed in an asynchronous way.
Since it takes a couple of seconds to confirm a blockchain transaction, the transaction is wrapped in a job. The job issuer gets a jobId and can check the job's status. He can also retry the job in case it failed. Jobs are used extensively in the Admin API.

Fetch job by correlationId

Fetches agenda job by job's correlationId
1
GET api/v2/jobs/correlationId/:correlationId
Copied!

Headers

Name
Type
Description
Authorization
String
JWT Authorization in a format "Bearer {jwtToken}"

Success 200

Name
Type
Description
data
Object
Job object

Fetch job by id

Fetch job by id
1
GET api/v2/jobs/:jobId
Copied!

Headers

Name
Type
Description
Authorization
String
JWT Authorization in a format "Bearer {jwtToken}"

Success 200

Name
Type
Description
data
Object
Job object

Retry failed job by id

Retry failed job by id
1
GET api/v2/jobs/retry/:jobId
Copied!

Headers

Name
Type
Description
Authorization
String
JWT Authorization in a format "Bearer {jwtToken}"

Success 200

Name
Type
Description
data
Object
Job object

Retry failed job by query

Retry failed job by id
1
GET api/v2/jobs/retry
Copied!

Headers

Name
Type
Description
Authorization
String
JWT Authorization in a format "Bearer {jwtToken}"

Success 200

Name
Type
Description
data
Object
Job object