Fetch job file

A Fetch Job File object contains the details for a file to be added by a Fetch Job. The following properties are present:

Name

Type

Description

self

Link

A link to the resource for this file

job

Link

A link to the Fetch Job resource for this file.

state_description

Labels

A description of the current state of this file.

state

String

The state of the Fetch Job File. Possible values: Pending, InProgress, Completed.

condition

String

The condition of the Fetch Job File. Possible values: Pending, Success, Failure.

started_on

String

String containing an ISO 8601 formatted date and time when this Fetch Job File was started.

completed_on

String

String containing an ISO 8601 formatted date and time when this Fetch Job File was completed.

Example

RequestResponse

{
  "self":{
    "href":"http://<hostname>/api/fetchjobs/500/files/1932",
    "title":"This fetch job file."
  },
  "job":{
    "href":"http://<hostname>/api/fetchjobs/500",
    "title":"The Fetch Job for this file."
  },
  "state_description":{
    "en-US":"Pending"
  },
  "state":"Pending",
  "condition":"Pending",
  "started_on":null,
  "completed_on":null
}

Do you have some feedback for us?

If you have suggestions for improving this article,