- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the project to serve as a base for finding related teams. Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the project Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the project. Validations:
|
|
team_id
required |
ID of the team. Validations:
|
|
write
optional |
Indicates whether the access to the project should be read/write or read-only. Default: false Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the project. Validations:
|
|
team_id
required |
ID of the team. Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the project. Validations:
|
|
own_teams
required |
Apply update to users (own teams) or normal teams. Validations:
|
|
revoke
optional |
Revoke all access rights to the project Validations:
|
|
write
optional |
Grant write access to the project instead of read-only access. Required unless revoke is true. Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
team_id
required |
ID of the team. Validations:
|
|
revoke
optional |
Revoke the team’s access rights to all projects. Validations:
|
|
write
optional |
Grant the team write access to all projects instead of read-only access. Required unless revoke is true. Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the project metadata of which will be updated. Validations:
|
|
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:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the project metadata of which will be displayed. Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
selected_attributes
optional |
When provided only the selected attributes of the projects will be returned. Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
project
optional , nil allowed |
Validations:
|
|
project[name]
required |
Name of the project. Validations:
|
|
project[templatename]
required |
The name of the project’s template. Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
project
optional , nil allowed |
Validations:
|
|
project[name]
optional |
Name of the project. Validations:
|
|
project[templatename]
optional |
The name of the project’s template. Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the project to be updated. Validations:
|
|
project
optional , nil allowed |
Validations:
|
|
project[name]
optional |
Name of the project. Validations:
|
|
project[templatename]
optional |
The name of the project’s template. Validations:
|
- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
action.
| Param name | Description |
|---|---|
|
id
required |
ID of the project to be deleted. Validations:
|
- 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.
| Param name | Description |
|---|---|
|
id
required |
ID of the project the template is going to be added to. Validations:
|
|
templatename
required |
Name of the template to be added to the project. Validations:
|
- 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.
| Param name | Description |
|---|---|
|
id
required |
ID of the project to be mounted. Validations:
|
- 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.
| Param name | Description |
|---|---|
|
id
required |
ID of the project a subproject is going to be added to (parent). Validations:
|
|
subproject_id
required |
ID of the project to be added as a subproject (child). Validations:
|
- 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.
| Param name | Description |
|---|---|
|
id
required |
ID of the project to be umounted. Validations:
|
- 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.
| Param name | Description |
|---|---|
|
id
required |
ID of the project a subproject is going to be umounted from (parent). Validations:
|
|
subproject_id
required |
ID of the subproject to be removed (child). Validations:
|
- 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.
| Param name | Description |
|---|---|
|
id
required |
ID of the mounted project. Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the project to be reindex-ed. Validations:
|
|
priority
optional |
Priority of the index operation. Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the project to be reencoded. Validations:
|
|
priority
optional |
Priority of the index operation. Validations:
|
- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
action.
| Param name | Description |
|---|---|
|
id
required |
ID of the project to be reencoded. Validations:
|
|
priority
optional |
Priority of the index operation. Validations:
|
- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
action.
| Param name | Description |
|---|---|
|
id
required |
Id of the project to be rehashed. Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the project. Validations:
|
- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
action.
| Param name | Description |
|---|---|
|
id
required |
ID of the project. Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the project for which status flags will be displayed. Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the project status flag of which will be added/deleted. Validations:
|
|
status_flag_id
required |
ID of the status flag to be added/deleted. Validations:
|
- Authentication: The user must be authenticated to perform this action.
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the project to be frozen. Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the project to be unfrozen. Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the project. Validations:
|
|
description_id
required |
ID of the description which should be delete. Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the project to be displayed. Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the project assets of which will be displayed. Validations:
|
|
dirname
required |
The directory from which to return the assets Validations:
|
|
storage
optional |
The storage from which to return the assets Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the project to which assets should be added to. Validations:
|
|
asset_ids
optional |
List of IDs of assets Validations:
|
|
folders
optional |
List of paths to folders Validations:
|
|
type
optional |
Validations:
|
|
recursive
optional |
Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
storage
required |
The storage of the folder Validations:
|
|
dirname
required |
The dirname of the folder Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the project. Validations:
|
|
since
optional |
Parsable datetime string since when the metadata should be returned Validations:
|
- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
action.
- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
action.
| Param name | Description |
|---|---|
|
id
optional |
ID of the project. Validations:
|
|
quota
optional |
Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the project. Validations:
|
|
team_id
required |
ID of the team to assign as quota team Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the project. Validations:
|
|
team_id
required |
ID of the quota team to unassign Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the project to be archived. Validations:
|
|
strategy
required |
ID of the archiving strategy to be applied. Validations:
|
|
exclude_linked_files
optional |
Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the project to be restored. Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the project to be moved. Validations:
|
|
strategy
required |
ID of the target archive strategy. Validations:
|
- Authentication: The user must be authenticated to perform this action.
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the project to be copied. Validations:
|
|
strategy
required |
ID of the copying strategy to be applied. Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the project to backup. Validations:
|
|
strategy
required |
ID of the backup strategy to use. Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the project Validations:
|
- Authentication: The user must be authenticated to perform this action.
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the project Validations:
|
|
tiering_storage
required |
Name of the tiering storage. Validations:
|
- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
action.
| Param name | Description |
|---|---|
|
id
required |
ID of the project to be renamed. Validations:
|
|
name
required |
New name of the project. Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the project to be flagged. Validations:
|
|
project
optional , nil allowed |
Validations:
|
|
project[name]
optional |
Name of the project. Validations:
|
|
project[templatename]
optional |
The name of the project’s template. Validations:
|
| Param name | Description |
|---|---|
|
id
required |
ID of the Project. Validations:
|
|
storage
optional |
The storage of the parent folder Validations:
|
|
dirname
required |
The dirname of the parent folder Validations:
|
|
name
required |
Name of the new folder to be created Validations:
|
| Param name | Description |
|---|---|
|
id
required |
ID of the Project. Validations:
|
|
target_folder
required |
Target folder for the assets and folders Validations:
|
|
target_folder[storage]
optional |
Storage/media name of the folder Validations:
|
|
target_folder[dirname]
required |
Container relative path to the folder Validations:
|
|
folders
optional |
Array of Hashes for folders to be moved Validations:
|
|
folders[container_id]
required |
Container’ ID of the folder Validations:
|
|
folders[storage]
optional |
Storage/media name of the folder Validations:
|
|
folders[dirname]
required |
Container relative path to the folder Validations:
|
|
asset_ids
optional |
Array of asset ids to be moved Validations:
|
|
mode
optional |
‘overwrite’ to replace existing folders or assets Validations:
|
| Param name | Description |
|---|---|
|
id
required |
ID of the Project. Validations:
|
|
folder
required |
Folder to be renamed Validations:
|
|
folder[storage]
optional |
Storage/media name of the folder Validations:
|
|
folder[dirname]
required |
Container relative path to the folder Validations:
|
|
name
required |
New name of the folder Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the project to be flagged. Validations:
|
|
prefix
required |
Folder structure to store the files in Validations:
|
|
storage
optional |
Storage volume to store the files in Validations:
|
|
uids
required |
TUS upload ids Validations:
|
| Param name | Description |
|---|---|
|
storage
optional |
The storage of the folder Validations:
|
|
dirname
optional |
The dirname of the folder Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the project to be transcribed. Validations:
|
- Authentication: The user must be authenticated to perform this action.
| Param name | Description |
|---|---|
|
id
required |
ID of the project to be analyzed. Validations:
|