1. Home
  2. Docs
  3. API Connection Guidelines
  4. Content Management
  5. File

File

A full representation of a file. It could be returned from endpoints list_children and get_item.

id string
The unique identifier that represents a file.

type string
Value is always file.

rev string
The unique identifier that represents a file version.

name string
The name of the file with extension.

size integer
The file size in bytes.

createdAt string / date-time
The date and time when the file was created.

modifiedAt string / date-time
The date and time when the file was last updated.

permissions object

  • canDownload boolean //Scriptation won’t download this file if set to NO
  • canUpload boolean //Reserved for future use. Set to NO
  • canRename boolean //Reserved for future use. Set to NO
  • canDelete boolean //Reserved for future use. Set to NO        
  • canCopy boolean //Allow the user to create other copies or move this file
  • canShare boolean //Allow the user to share or print the file

Response example:

{
  "id": 12345,
  "type": "file",
  “rev”: 12345,
  “name": “myDocument.pdf",
  "size": 629644
  "createdAt": "2020-06-21T20:01:37Z",
  "modifiedAt": "2020-06-21T20:01:37Z0",
  "permissions": {
      "canDownload": YES,
      "canUpload: NO,
      "canRename”: NO,
      "canDelete”: NO,
      "canCopy": YES,
      "canShare":YES,
    }
}