Get hosted document files list

Home » DOCOON APIs » REST API » Basic functionnalities » Get hosted document files list

Docoon REST API provides to you the ability to manage hosted documents. These documents can then be used to create a job (parmeter Hosted into FileReference structure), the contents of the document should not be transmitted and will be recovered directly on Docoon servers.
This basic functionnality illustrate how to all documents for your account.

Request Informations

Name: /HostedDocumentFiles
Type: GET

Headers:

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

 

Parameters list:

Parameter Type Description
none
Get hosted document files
GET /api/V1/HostedDocumentFiles HTTP/1.1
Host: api.odyssey-services.fr
Content-Type: application/json
Authorization: Basic EncodedLogin

Successful Response

Status : 200

Response is a list of HostedFile object

HostedFile object

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
 
[ 
    {
        "Name": "TestDocument.pdf",
        "CreationDateTime": "2018-07-17T12:06:55.2194008+02:00",
        "LastModificationDateTime": "2018-07-17T12:06:55.2194008+02:00",
        "Size": 41
    }, 
    {
        "Name": "TestDocument2.pdf",
        "CreationDateTime": "2018-07-17T12:06:55.2194008+02:00",
        "LastModificationDateTime": "2018-07-17T12:06:55.2194008+02:00",
        "Size": 41
    }
]