Projects

>>>

GET /api/v1/projects/:id/teams
Display all teams and their access rights in regards to a project.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the project to serve as a base for finding related teams.

Validations:

  • Must be a String
>>>

GET /api/v1/projects/:id/effective_access_rights
Show all users mapped to the teams that give them access rights to a project.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the project

Validations:

  • Must be a String
>>>

PUT /api/v1/projects/:id/teams
Update access rights of a team to a project.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the project.

Validations:

  • Must be a String
team_id
required

ID of the team.

Validations:

  • Must be a String
write
optional
true | false

Indicates whether the access to the project should be read/write or read-only. Default: false

Validations:

  • Must be a String
>>>

DELETE /api/v1/projects/:id/teams/:team_id
Remove access rights of a team to a project.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the project.

Validations:

  • Must be a String
team_id
required

ID of the team.

Validations:

  • Must be a String
>>>

PUT /api/v1/projects/:id/update_teams
Bulk update access rights for a project.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the project.

Validations:

  • Must be a String
own_teams
required

Apply update to users (own teams) or normal teams.

Validations:

  • Must be one of: true, false.
revoke
optional

Revoke all access rights to the project

Validations:

  • Must be one of: true, false.
write
optional

Grant write access to the projects (default is read only)

Validations:

  • Must be one of: true, false.
>>>

PUT /api/v1/projects/update_teams/:team_id
Bulk update access rights for a projects for a specific team id.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
team_id
required

ID of the project.

Validations:

  • Must be a String
revoke
optional

Revoke all access rights to the project

Validations:

  • Must be one of: true, false.
write
optional

Grant write access to the projects (default is read only)

Validations:

  • Must be one of: true, false.
>>>

PUT /api/v1/projects/:id/update_metadata
Update metadata of a projects.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the project metadata of which will be updated.

Validations:

  • Must be a String
custom_metadata
required

A Hash of Hashes. First level keys are indices of the elements. Second level keys are ‘value’ and ‘custom_metadata_field’.

Validations:

  • Must be a Hash
>>>

GET /api/v1/projects/:id/custom_metadata
Display metadata of a projects.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the project metadata of which will be displayed.

Validations:

  • Must be a String
>>>

GET /api/v1/projects
Display a list of all projects.

Metadata

- Authentication: The user must be authenticated to perform this action.
>>>

GET /api/v1/projects/search
Search for projects containing :name substring in their name.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
name
required

The string used in the search.

Validations:

  • Must be a String
>>>

POST /api/v1/projects
Create a new project.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
project
optional , nil allowed

Validations:

  • Must be a Hash
project[name]
required

Name of the project.

Validations:

  • Must be a String
project[templatename]
required

The name of the project’s template.

Validations:

  • Must be a String
>>>

POST /api/v1/projects/validate
Validate project attributes.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
project
optional , nil allowed

Validations:

  • Must be a Hash
project[name]
optional

Name of the project.

Validations:

  • Must be a String
project[templatename]
optional

The name of the project’s template.

Validations:

  • Must be a String
>>>

PUT /api/v1/projects/:id
Update a project.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the project to be updated.

Validations:

  • Must be a String
project
optional , nil allowed

Validations:

  • Must be a Hash
project[name]
optional

Name of the project.

Validations:

  • Must be a String
project[templatename]
optional

The name of the project’s template.

Validations:

  • Must be a String
>>>

DELETE /api/v1/projects/:id
Delete a project.

Metadata

- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
    action.

Params

Param name Description
id
required

ID of the project to be deleted.

Validations:

  • Must be a String
>>>

PUT /api/v1/projects/:id/open
Open a project.

Metadata

- Authentication: The user must be authenticated to perform this action.
- X-PAM-CLIENT: Required HTTP header set by FsClient. If present, it means that FsClient
    (not a browser) is connecting to the application.
- X-PAM-EDIT: Required HTTP header set by FsClient. It contains the edit name.

Params

Param name Description
id
required

ID of the project to be opened.

Validations:

  • Must be a String
>>>

PUT /api/v1/projects/:id/sync
Save and reload a project. Sync is done in order to bring user's subprojects up to date as well as to update user's project in other projects that uses it.

Metadata

- Authentication: The user must be authenticated to perform this action.
- X-PAM-CLIENT: Required HTTP header set by FsClient. If present, it means that FsClient
    (not a browser) is connecting to the application.
- X-PAM-EDIT: Required HTTP header set by FsClient. It contains the edit name.

Params

Param name Description
id
required

ID of the project to be synchronized.

Validations:

  • Must be a String
>>>

DELETE /api/v1/projects/:id/close
Close a project.

Metadata

- Authentication: The user must be authenticated to perform this action.
- X-PAM-CLIENT: Required HTTP header set by FsClient. If present, it means that FsClient
    (not a browser) is connecting to the application.
- X-PAM-EDIT: Required HTTP header set by FsClient. It contains the edit name.

Params

Param name Description
id
required

ID of the project to be closed.

Validations:

  • Must be a String
>>>

DELETE /api/v1/projects/:id/forceclose
Force a project to close.

Metadata

- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
    action.

Params

Param name Description
id
required

ID of the project to be force closed.

Validations:

  • Must be a String
>>>

PUT /api/v1/projects/:id/addsubproject
Add a subproject to a project.

Metadata

- Authentication: The user must be authenticated to perform this action.
- X-PAM-CLIENT: Required HTTP header set by FsClient. If present, it means that FsClient
    (not a browser) is connecting to the application.
- X-PAM-EDIT: Required HTTP header set by FsClient. It contains the edit name.

Params

Param name Description
id
required

ID of the project a subproject is going to be added to (parent).

Validations:

  • Must be a String
subproject_id
required

ID of the project to be added as a subproject (child).

Validations:

  • Must be a String
>>>

DELETE /api/v1/projects/:id/removesubproject
Remove a subproject from a project.

Metadata

- Authentication: The user must be authenticated to perform this action.
- X-PAM-CLIENT: Required HTTP header set by FsClient. If present, it means that FsClient
    (not a browser) is connecting to the application.
- X-PAM-EDIT: Required HTTP header set by FsClient. It contains the edit name.

Params

Param name Description
id
required

ID of the project a subproject is going to be removed from (parent).

Validations:

  • Must be a String
subproject_id
required

ID of the subproject to be removed (child).

Validations:

  • Must be a String
>>>

PUT /api/v1/projects/:id/addtemplate
Add a template to a project.

Metadata

- Authentication: The user must be authenticated to perform this action.
- X-PAM-CLIENT: Required HTTP header set by FsClient. If present, it means that FsClient
    (not a browser) is connecting to the application.
- X-PAM-EDIT: Required HTTP header set by FsClient. It contains the edit name.

Params

Param name Description
id
required

ID of the project the template is going to be added to.

Validations:

  • Must be a String
templatename
required

Name of the template to be added to the project.

Validations:

  • Must be a String
>>>

PUT /api/v1/projects/:id/mount
Mount a project.

Metadata

- Authentication: The user must be authenticated to perform this action.
- X-PAM-CLIENT: Required HTTP header set by FsClient. If present, it means that FsClient
    (not a browser) is connecting to the application.
- X-PAM-EDIT: Required HTTP header set by FsClient. It contains the edit name.

Params

Param name Description
id
required

ID of the project to be mounted.

Validations:

  • Must be a String
>>>

PUT /api/v1/projects/:id/mountsubproject
MOunts a subproject to a project.

Metadata

- Authentication: The user must be authenticated to perform this action.
- X-PAM-CLIENT: Required HTTP header set by FsClient. If present, it means that FsClient
    (not a browser) is connecting to the application.
- X-PAM-EDIT: Required HTTP header set by FsClient. It contains the edit name.

Params

Param name Description
id
required

ID of the project a subproject is going to be added to (parent).

Validations:

  • Must be a String
subproject_id
required

ID of the project to be added as a subproject (child).

Validations:

  • Must be a String
>>>

DELETE /api/v1/projects/:id/umount
Umount a project.

Metadata

- Authentication: The user must be authenticated to perform this action.
- X-PAM-CLIENT: Required HTTP header set by FsClient. If present, it means that FsClient
    (not a browser) is connecting to the application.
- X-PAM-EDIT: Required HTTP header set by FsClient. It contains the edit name.

Params

Param name Description
id
required

ID of the project to be umounted.

Validations:

  • Must be a String
>>>

DELETE /api/v1/projects/:id/umountsubproject
Umount a subproject from a project.

Metadata

- Authentication: The user must be authenticated to perform this action.
- X-PAM-CLIENT: Required HTTP header set by FsClient. If present, it means that FsClient
    (not a browser) is connecting to the application.
- X-PAM-EDIT: Required HTTP header set by FsClient. It contains the edit name.

Params

Param name Description
id
required

ID of the project a subproject is going to be umounted from (parent).

Validations:

  • Must be a String
subproject_id
required

ID of the subproject to be removed (child).

Validations:

  • Must be a String
>>>

PUT /api/v1/projects/:id/refreshmountedproject
Refresh a mounted project.

Metadata

- Authentication: The user must be authenticated to perform this action.
- X-PAM-CLIENT: Required HTTP header set by FsClient. If present, it means that FsClient
    (not a browser) is connecting to the application.
- X-PAM-EDIT: Required HTTP header set by FsClient. It contains the edit name.

Params

Param name Description
id
required

ID of the mounted project.

Validations:

  • Must be a String
>>>

PUT /api/v1/projects/:id/reindex
Reindex project.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the project to be reindex-ed.

Validations:

  • Must be a String
>>>

PUT /api/v1/projects/:id/rescan
Rescan assets with OtherProxy in a project for new metadata.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the project to be reencoded.

Validations:

  • Must be a String
>>>

PUT /api/v1/projects/:id/repair
Rescan all assets in a project for new metadata.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the project to be reencoded.

Validations:

  • Must be a String
>>>

PUT /api/v1/projects/:id/reencode
Reencode all assets in a project.

Metadata

- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
    action.

Params

Param name Description
id
required

ID of the project to be reencoded.

Validations:

  • Must be a String
>>>

PUT /api/v1/projects/:id/rehash
Rehash all files in a project.

Metadata

- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
    action.

Params

Param name Description
id
required

Id of the project to be rehashed.

Validations:

  • Must be a String
>>>

PUT /api/v1/projects/:id/calculate_size
Recalculates the size of the project.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the project.

Validations:

  • Must be a String
>>>

PUT /api/v1/projects/:id/convert_proxy_structure
Convert the proxies of the project to the latest structure version

Metadata

- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
    action.

Params

Param name Description
id
required

ID of the project.

Validations:

  • Must be a String
>>>

GET /api/v1/projects/:id/status_flags
Display a list of all status flags of a project.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the project status flags of which will be displayed.

Validations:

  • Must be a String
>>>

PUT /api/v1/projects/:id/status_flags/:status_flag_id
Add or delete a status flag to/from a project.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the project status flag of which will be added/deleted.

Validations:

  • Must be a String
status_flag_id
required

ID of the status flag to be added/deleted.

Validations:

  • Must be a String
>>>

GET /api/v1/projects_report
Download .xlsx report of project list.

Metadata

- Authentication: The user must be authenticated to perform this action.
>>>

PUT /api/v1/projects/:id/freeze
Freeze a project.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the project to be frozen.

Validations:

  • Must be a String
>>>

DELETE /api/v1/projects/:id/unfreeze
Unfreeze a project.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the project to be unfrozen.

Validations:

  • Must be a String
>>>

DELETE /api/v1/projects/:id/delete_description
Delete a description from the history.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the project.

Validations:

  • Must be a String
description_id
required

ID of the description which should be delete.

Validations:

  • Must be a String
>>>

GET /api/v1/projects/:id
Display a project.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the project to be displayed.

Validations:

  • Must be a String
>>>

GET /api/v1/projects/:id/assets
Display all assets related to the project.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the project assets of which will be displayed.

Validations:

  • Must be a String
dirname
required

The directory from which to return the assets

Validations:

  • Must be a String
storage
optional

The storage from which to return the assets

Validations:

  • Must be a String
>>>

POST /api/v1/projects/:id/addassets
Add multiple assets to a project

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the project to which assets should be added to.

Validations:

  • Must be a String
asset_ids
optional

List of IDs of assets

Validations:

  • Must be an array of any type
folders
optional

List of paths to folders

Validations:

  • Must be an array of any type
type
optional
copy | link | link_to_project

The strategy used to add an asset to a project. Default: link.

Validations:

  • Must be a String
recursive
optional
true | false

Whether to recursively add folders.

Validations:

  • Must be a String
>>>

GET /api/v1/projects/:id/count_assets
Returns the amount of assets inside the given folder

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
storage
required

The storage of the folder

Validations:

  • Must be a String
dirname
required

The dirname of the folder

Validations:

  • Must be a String
>>>

GET /api/v1/projects/:id/changed_asset_metadata
Returns assets which metadata changed since the project was last used.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the project.

Validations:

  • Must be a String
since
optional

Parsable datetime string since when the metadata should be returned

Validations:

  • Must be a String
>>>

GET /api/v1/total_project_size
Display the total size of all projects in bytes.

Metadata

- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
    action.
>>>

PUT /api/v1/projects/:id/quota
Set quota for project.

Metadata

- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
    action.

Params

Param name Description
id
optional

ID of the project.

Validations:

  • Must be a String
quota
optional

Validations:

  • Must be a Integer
>>>

PUT /api/v1/projects/:id/quota_team/:team_id
Set quota team for project.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the project.

Validations:

  • Must be a String
team_id
required

ID of the team to assign as quota team

Validations:

  • Must be a Integer
>>>

DELETE /api/v1/projects/:id/quota_team/:team_id
Resets quota team for project.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the project.

Validations:

  • Must be a String
team_id
required

ID of the quota team to unassign

Validations:

  • Must be a Integer
>>>

POST /api/v1/projects/:id/importsequence
Import Sequence into project.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
optional

ID of the project.

Validations:

  • Must be a String
sequence_id
optional

Id of the sequence.

Validations:

  • Must be a String
format
optional

Format of the exporter.

Validations:

  • Must be a String
>>>

PUT /api/v1/projects/:id/archive
Archive a project using an archiving strategy. Returns the current state of the archiving process.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the project to be archived.

Validations:

  • Must be a String
strategy
required

ID of the archiving strategy to be applied.

Validations:

  • Must be a String
exclude_linked_files
optional
true, false

Indicates whether the Linked-Files directory should be included in the archive.

Validations:

  • Must be a String
>>>

PUT /api/v1/projects/:id/unarchive
Restore an archived project. Returns the current state of the restoring process.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the project to be restored.

Validations:

  • Must be a String
>>>

PUT /api/v1/projects/:id/move_archive
Move a project between archives.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the project to be moved.

Validations:

  • Must be a String
strategy
required

ID of the target archive strategy.

Validations:

  • Must be a String
>>>

PUT /api/v1/projects/:id/cancel_archiving
Stop archiving/unarchiving of project.

Metadata

- Authentication: The user must be authenticated to perform this action.
>>>

PUT /api/v1/projects/:id/copy_to
Copy a project using a copying strategy to a desired storage. Returns the current state of the copying process.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the project to be copied.

Validations:

  • Must be a String
strategy
required

ID of the copying strategy to be applied.

Validations:

  • Must be a String
>>>

PUT /api/v1/projects/:id/backup
Create a *full* backup using a backup strategy. Returns the state of the backup process.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the project to backup.

Validations:

  • Must be a String
strategy
required

ID of the backup strategy to use.

Validations:

  • Must be a String
>>>

PUT /api/v1/projects/:id/clear_archive_errors
Clear the archive (error) state of a particular project.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the project

Validations:

  • Must be a String
>>>

PUT /api/v1/projects/clear_all_archive_errors
Clear the archive (error) state of all projects.

Metadata

- Authentication: The user must be authenticated to perform this action.
>>>

POST /api/v1/projects/tier
Move project to tiering storage.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the project

Validations:

  • Must be a String
tiering_storage
required

Name of the tiering storage.

Validations:

  • Must be a String
>>>

PUT /api/v1/projects/:id/rename
Rename a project.

Metadata

- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
    action.

Params

Param name Description
id
required

ID of the project to be renamed.

Validations:

  • Must be a String
name
required

New name of the project.

Validations:

  • Must be a String
>>>

PUT /api/v1/projects/:id/flag_as_project
Convert a library project back into a online project.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the project to be flagged.

Validations:

  • Must be a String
project
optional , nil allowed

Validations:

  • Must be a Hash
project[name]
optional

Name of the project.

Validations:

  • Must be a String
project[templatename]
optional

The name of the project’s template.

Validations:

  • Must be a String
>>>

PUT /api/v1/projects/:id/create_folder
Create a new folder in the Project

Params

Param name Description
id
required

ID of the Project.

Validations:

  • Must be a String
storage
optional

The storage of the parent folder

Validations:

  • Must be a String
dirname
required

The dirname of the parent folder

Validations:

  • Must be a String
name
required

Name of the new folder to be created

Validations:

  • Must be a String
>>>

PUT /api/v1/projects/:id/move_contents
Move contents of the Project between folders

Params

Param name Description
id
required

ID of the Project.

Validations:

  • Must be a String
target_folder
required

Target folder for the assets and folders

Validations:

  • Must be a Hash
target_folder[storage]
optional

Storage/media name of the folder

Validations:

  • Must be a String
target_folder[dirname]
required

Container relative path to the folder

Validations:

  • Must be a String
folders
optional

Array of Hashes for folders to be moved

Validations:

  • Must be an Array of nested elements
folders[container_id]
required

Container’ ID of the folder

Validations:

  • Must be a String
folders[storage]
optional

Storage/media name of the folder

Validations:

  • Must be a String
folders[dirname]
required

Container relative path to the folder

Validations:

  • Must be a String
asset_ids
optional

Array of asset ids to be moved

Validations:

  • Must be an array of any type
mode
optional

‘overwrite’ to replace existing folders or assets

Validations:

  • Must be a String
>>>

PUT /api/v1/projects/:id/rename_folder
Rename a folder of a Project

Params

Param name Description
id
required

ID of the Project.

Validations:

  • Must be a String
folder
required

Folder to be renamed

Validations:

  • Must be a Hash
folder[storage]
optional

Storage/media name of the folder

Validations:

  • Must be a String
folder[dirname]
required

Container relative path to the folder

Validations:

  • Must be a String
name
required

New name of the folder

Validations:

  • Must be a String
>>>

POST /api/v1/projects/:id/inject_uploads
Inject uploaded files into Project.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the project to be flagged.

Validations:

  • Must be a String
prefix
required

Folder structure to store the files in

Validations:

  • Must be a String
storage
optional

Storage volume to store the files in

Validations:

  • Must be a String
uids
required

TUS upload ids

Validations:

  • Must be an array of any type
>>>

GET /api/v1/projects/:id/editing_proxy_summary
Gather information about editing proxies for assets in a folder

Params

Param name Description
storage
optional

The storage of the folder

Validations:

  • Must be a String
dirname
optional

The dirname of the folder

Validations:

  • Must be a String
>>>

GET /api/v1/projects/:id/skies_checkout_summary
Information about editing proxies and highres edits available for Skies checkout.