Add hosted document file

Home » DOCOON APIs » REST API » Basic functionnalities » Add hosted document file

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 add hosted document file.

Sending request Informations

Name: /HostedDocumentFiles
Type: POST

Headers:

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

 

Parameters list:

Parameter Type Description
Name String File name with extension (abc.txt).
Content String File content encoded in Base64.
Add hosted document file
{
  "Name": "TestDocument.pdf",
  "Content": "dXNlcm5AZ21haWwuY29tCUpvaG4JTXkgQ29tcGFueQlCaXJ0aERhdGU="
}

 

Successful Response

Status : 200

Parameter Type Description
Name String File name with extension (abc.txt).
Content String File content encoded in Base64.
CreationDateTime
DateTime File creation date.
LastModificationDateTime
DateTime Date of the last modification of the file.
Size int Size in byte of the file.
Sucessful response
{
  "Content": "dXNlcm5AZ21haWwuY29tCUpvaG4JTXkgQ29tcGFueQlCaXJ0aERhdGU=",
  "Name": "TestDocument.pdf",
  "CreationDateTime": "2018-07-17T10:39:04.6788636+02:00",
  "LastModificationDateTime": "2018-07-17T10:39:04.6788636+02:00",
  "Size": 41
}