Get hosted list file

Home » DOCOON APIs » REST API » Basic functionnalities » Get hosted list file

Docoon REST API provides to you the ability to manage hosted lists. These lists can then be used to create a job (parmeter Hosted into FileReference structure), the contents of the list should not be transmitted and will be recovered directly on Docoon servers.
This basic functionnality illustrate how to get one hosted list file.

Request Informations

Name: /HostedListFiles/{fileName}
Type: GET

Headers:

Name Value
Authorization Value : Authorization token check : Connect to REST API
Content-Type Value : application/json

 

Parameters list:

Parameter Type Description
fileName String File name with extension (abc.txt).
Get hosted list file
GET /api/V1/HostedListFiles/TestList.tab HTTP/1.1
Host: api.odyssey-services.fr
Content-Type: application/json
Authorization: Basic NjAzMDAuYX

 

Successful Response

Parameter Type Description
Name String File name and extension (JobId.xls).
CreationDateTime String First creation time of the report.Example : 2016-12-06T07:20:38.7870548+01:00.
LastModificationDateTime String Last modification time of the report.Example : 2016-12-06T07:20:37.583+01:00.
Size Integer Size in byte of the report.
Successful Response
{
    "Content": "dXNlcm5AZ21haWwuY29tCUpvaG4JTXkgQ29tcGFueQlCaXJ0aERhdGU=",
    "Name": "TestList.tab",
    "CreationDateTime": "2018-07-17T12:06:55.2194008+02:00",
    "LastModificationDateTime": "2018-07-17T12:06:55.2194008+02:00",
    "Size": 41
}