Files

Get a file by Id

Get a file by Id.

get/v1/drives/files/{id}

Request

  • Base URL: https://demo.getcollate.io/api
  • URL: https://demo.getcollate.io/api/v1/drives/files/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Id of the file

Query parameters

fieldsstring
Example:owners,directory,usageSummary,tags,fileExtension,extension,domains,sourceHash,lifeCycle,votes,followers,columns,sampleData

Fields requested in the returned resource

include'all' | 'deleted' | 'non-deleted'

Include all, deleted, or non-deleted entities.

includeRelationsstring
Example:owners:non-deleted,followers:all

Per-relation include control. Format: field:value,field2:value2. Example: owners:non-deleted,followers:all. Valid values: all, deleted, non-deleted. If not specified for a field, uses the entity's include value.

Response

The file

idstring uuid required
namestring required
fullyQualifiedNamestring
displayNamestring
descriptionstring
serviceType'GoogleDrive' | 'SharePoint' | 'Sftp' | 'CustomDrive'
fileType'Document' | 'Spreadsheet' | 'Presentation' | 'Image' | 'Video' | 'Audio' | 'PDF' | 'Archive' | 'Code' | 'Data' | 'CSV' | 'Text' | 'Other'
mimeTypestring
fileExtensionstring
pathstring
sizeinteger
checksumstring
webViewLinkstring uri
downloadLinkstring uri
isSharedboolean
fileVersionstring
createdTimeinteger
modifiedTimeinteger
sourceUrlstring
hrefstring uri
versionnumber double
updatedAtinteger
updatedBystring
impersonatedBystring
deletedboolean
sourceHashstring
extensionobject
entityStatus'Draft' | 'In Review' | 'Approved' | 'Archived' | 'Deprecated' | 'Rejected' | 'Unprocessed'
provider'system' | 'user' | 'automation'

Changes

No recorded changes to this operation across all 1 revision of this API.