REST APIs

Fetch job

A Fetch Job object contains information about a Fetch Job. The following properties are present:

Name	Type	Description
`self`	Link	A link to the resource for this job
`owner`	Link	A link to the user entity resource that submitted this job.
`state_description`	Labels	A description of the current state
`state`	String	The state of the job. Possible values: Created, Pending, InProgress, Completed.
`condition`	String	The condition of the job. Possible values: Pending, Success, Failure.
`started_on`	String	String containing an ISO 8601 formatted date and time when this job was started.
`completed_on`	String	String containing an ISO 8601 formatted date and time when this job was completed.
`file_count`	Number	The number of files present in the job.
`files_completed`	Number	The number of files that have been completed.
`files`	Link	A link to the files resource for this job.

Example

{
  "state_description":"InProgress",
  "state":"InProgress",
  "condition":"Pending",
  "started_on":"...",
  "completed_on":null,
  "file_count":215,
  "files_completed":100,
  "self":{
    "href":"http://<hostname>/api/fetchjobs/1493",
    "title":"This fetch job."
  },
  "targets":{
    "href":"http/<hostname>/api/fetchjobs/1493/files",
    "title":"The collection of files for this Fetch Job."
  }
}

If you have suggestions for improving this article, let us know!