Esc

↑↓ move↵ openIndex · Pagefind
REST reference · Core Tools

Documents

9 endpoints9 implementedAll modules →
  1. POST /rest/v1.0/filesCreate project File
  2. GET /rest/v1.0/files/{id}Show project File
  3. PATCH /rest/v1.0/files/{id}Update project File
  4. DELETE /rest/v1.0/files/{id}Delete project File
  5. GET /rest/v1.0/foldersList project folders and files
  6. POST /rest/v1.0/foldersCreate Project Folder
  7. GET /rest/v1.0/folders/{id}Show Project Folder
  8. PATCH /rest/v1.0/folders/{id}Update Project Folder
  9. DELETE /rest/v1.0/folders/{id}Delete Project Folder
POST /rest/v1.0/files

Create project File

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerqueryrequired

Request body

  • file
    objectrequired

Response · 201 · object

  • id
    integer
  • name
    string
  • parent_id
    integer | null
  • size
    integer
  • updated_at
    string (date-time)
  • created_at
    string (date-time)
  • checked_out_until
    string | null (date-time)
  • name_with_path
    string
  • private
    boolean
  • is_tracked
    boolean
  • tracked_folder
    object | null
  • checked_out_by
    object | null
  • file_type
    string
  • file_versions
    object[]
  • legacy_id
    integer | null
  • is_deleted
    boolean
  • custom_fields
    object | null
GET /rest/v1.0/files/{id}

Show project File

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • id
    integerpathrequired
  • project_id
    integerqueryrequired
  • show_latest_version_only
    booleanquery

Response · 200 · object

  • id
    integer
  • name
    string
  • parent_id
    integer | null
  • size
    integer
  • updated_at
    string (date-time)
  • created_at
    string (date-time)
  • checked_out_until
    string | null (date-time)
  • name_with_path
    string
  • private
    boolean
  • is_tracked
    boolean
  • tracked_folder
    object | null
  • checked_out_by
    object | null
  • file_type
    string
  • file_versions
    object[]
  • legacy_id
    integer | null
  • is_deleted
    boolean
  • custom_fields
    object | null
PATCH /rest/v1.0/files/{id}

Update project File

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • id
    integerpathrequired
  • project_id
    integerqueryrequired

Request body

  • file
    objectrequired

Response · 200 · object

  • id
    integer
  • name
    string
  • parent_id
    integer | null
  • size
    integer
  • updated_at
    string (date-time)
  • created_at
    string (date-time)
  • checked_out_until
    string | null (date-time)
  • name_with_path
    string
  • private
    boolean
  • is_tracked
    boolean
  • tracked_folder
    object | null
  • checked_out_by
    object | null
  • file_type
    string
  • file_versions
    object[]
  • legacy_id
    integer | null
  • is_deleted
    boolean
  • custom_fields
    object | null
DELETE /rest/v1.0/files/{id}

Delete project File

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • id
    integerpathrequired
  • project_id
    integerqueryrequired

Response · 200

No response body.

GET /rest/v1.0/folders

List project folders and files

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerqueryrequired
  • exclude_folders
    booleanquery
  • exclude_files
    booleanquery
  • show_latest_file_version_only
    booleanquery

Response · 200 · object

  • id
    integer
  • name
    string
  • parent_id
    integer | null
  • private
    boolean
  • updated_at
    string (date-time)
  • is_tracked
    boolean
  • tracked_folder
    object | null
  • name_with_path
    string
  • folders
    object[]
  • files
    object[]
  • read_only
    boolean
  • is_deleted
    boolean
  • is_recycle_bin
    boolean
  • has_children
    boolean
  • has_children_files
    boolean
  • has_children_folders
    boolean
  • custom_fields
    object | null
POST /rest/v1.0/folders

Create Project Folder

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerqueryrequired

Request body

  • folder
    objectrequired

Response · 201 · object

  • id
    integer
  • name
    string
  • parent_id
    integer | null
  • private
    boolean
  • updated_at
    string (date-time)
  • is_tracked
    boolean
  • tracked_folder
    object | null
  • name_with_path
    string
  • folders
    object[]
  • files
    object[]
  • read_only
    boolean
  • is_deleted
    boolean
  • is_recycle_bin
    boolean
  • has_children
    boolean
  • has_children_files
    boolean
  • has_children_folders
    boolean
  • custom_fields
    object | null
GET /rest/v1.0/folders/{id}

Show Project Folder

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • id
    integerpathrequired
  • project_id
    integerqueryrequired
  • exclude_folders
    booleanquery
  • exclude_files
    booleanquery
  • show_latest_file_version_only
    booleanquery

Response · 200 · object

  • id
    integer
  • name
    string
  • parent_id
    integer | null
  • private
    boolean
  • updated_at
    string (date-time)
  • is_tracked
    boolean
  • tracked_folder
    object | null
  • name_with_path
    string
  • folders
    object[]
  • files
    object[]
  • read_only
    boolean
  • is_deleted
    boolean
  • is_recycle_bin
    boolean
  • has_children
    boolean
  • has_children_files
    boolean
  • has_children_folders
    boolean
  • custom_fields
    object | null
PATCH /rest/v1.0/folders/{id}

Update Project Folder

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • id
    integerpathrequired
  • project_id
    integerqueryrequired

Request body

  • folder
    objectrequired

Response · 200 · object

  • id
    integer
  • name
    string
  • parent_id
    integer | null
  • private
    boolean
  • updated_at
    string (date-time)
  • is_tracked
    boolean
  • tracked_folder
    object | null
  • name_with_path
    string
  • folders
    object[]
  • files
    object[]
  • read_only
    boolean
  • is_deleted
    boolean
  • is_recycle_bin
    boolean
  • has_children
    boolean
  • has_children_files
    boolean
  • has_children_folders
    boolean
  • custom_fields
    object | null
DELETE /rest/v1.0/folders/{id}

Delete Project Folder

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • id
    integerpathrequired
  • project_id
    integerqueryrequired

Response · 200

No response body.

Ask the OS

Reading this page

Ask anything about this page. Answers use what you're reading as context.

Suggested

    AI · may be imperfect · sample data where shown

    Open file