logo
logo

Get a file from a Fetch Job

GET /fetchjobs/:fetchJobsId/files/:fileId

Replace these placeholders:

placeholderdescription
:fetchJobIdthe id of the fetch job that contains the file.
:fileIdthe id of the file that belongs to a fetch job

Response

ResponseDescription
200 OkReturns the fetch job file in the body if it was found

Response examples

Status: 200 OK

{
    "items": [
        {
            "file": {
                "type": "File",
                "path": "S:\\Import\\M.Extensions\\BISTECCA-FIORENTINA-1.jpg"
            },
            "job": {
                "href": "/fetchjobs/6168",
                "title": "The Fetch Job to which this file belongs"
            },
            "state_description": "File processed",
            "state": "Completed",
            "condition": "Success",
            "started_on": "2018-01-08T12:18:02.9527099Z",
            "completed_on": "2018-01-08T12:18:05.4367172Z",
            "self": {
                "href": "/fetchjobs/6168/files/6283",
                "title": "The file which belongs to a Fetch Job."
            }
        }
    ],
    "total_items": 1,
    "returned_items": 1,
    "self": {
        "href": "/fetchjobs/6168/files",
        "title": "This collection"
    }
}}

Can we improve this article ? Provide feedback