Type to search...

Job - API representation

The job resource represents a job in Shardimage.

For a list of methods for this resource, see the end of this page.

Resource Representation

  "jobId": string,
  "status": string,
  "createdAt": unsigned int,
  "completedAt": unsigned int,
    "successCount": unsigned int,
    "failCount": unsigned int,
    "count": unsigned int 
Property name Value Description Notes
jobId string ID of the Job read only
status string Current status of the Job
createdAt unsigned int Time of creation
completedAt unsigned int Time when the Job finished
result object Result object
successCount unsigned int Number of successful tasks
failCount unsigned int Number of failed tasks
count unsigned int Number of tasks overall


Available methods for Jobs resources are as follows:

  • view: Returns the specified job data.
  • exists: Fast way to check does the Job exist.
  • delete: Stopping job if it runs and then delete it.
Table of contents