API v1 ReferenceDocument Files

Creates a new document file for the document with the specified id..

Uploads a new document file for the document with the specified id. Use this to upload a file as a form value along with the basic file meta data. The file size must not exceed 1GB.

Path parameters

documentIdstringRequiredformat: "uuid"
The id of the document.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects a multipart form containing a file.
FilefileRequired

Response

OK
namestring or null

The user-specified name of the file.

descriptionstring or null
The description of the file.
idstring or nullformat: "uuid"
The id of the file info.
entityIdstring or nullformat: "uuid"
The id of the linked entity.
fileNamestring or null
The name of the file.
entityTypestring or null
The name of the linked entity type.
mimeTypestring or null
The MIME type of the file.
createdOnstring or nullformat: "date-time"
The date this file was created.
createdBystring or nullformat: "uuid"
The id of the user who created this file.
updatedOnstring or nullformat: "date-time"
The date this file was last modified.
updatedBystring or nullformat: "uuid"
The id of the user who last modified this file.
fileVersionslist of objects or null
List of all versions.
isCommentFileboolean or null
Whether the file is related to a comment.
externalProviderstring or null
The external provider for the file. Like 'google' or 'onedrive'.
externalFileUrlstring or null
The file url of the external provider.
isHiddenForConnectUsersboolean or null
Whether the file is hidden for connect users.

Errors