API v1 ReferenceComment Files

Uploads a new file by providing an url.

The file needs to be a public available url. The file size must not exceed 100MB.

Path parameters

commentIdUUIDRequired

The id of the comment the file is linked to.

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
urlstring or nullOptional

The public url to the file.

namestring or nullOptional

The name of the file.

descriptionstring or nullOptional

The description of the file.

Response

OK

namestring or nullOptional

The user-specified name of the file.

descriptionstring or nullOptional

The description of the file.

idUUIDOptional

The id of the file info.

entityIdUUID or nullOptional

The id of the linked entity.

fileNamestring or nullOptional

The name of the file.

entityTypestring or nullOptional

The name of the linked entity type.

mimeTypestring or nullOptional

The MIME type of the file.

createdOndatetimeOptional

The date this file was created.

createdByUUIDOptional

The id of the user who created this file.

updatedOndatetimeOptional

The date this file was last modified.

updatedByUUIDOptional

The id of the user who last modified this file.

fileVersionslist of objectsOptional

List of all versions.

isCommentFilebooleanOptional

Whether the file is related to a comment.

externalProviderstring or nullOptional

The external provider for the file. Like ‘google’ or ‘onedrive’.

externalFileUrlstring or nullOptional

The file url of the external provider.

isHiddenForConnectUsersbooleanOptional

Whether the file is hidden for connect users.