Protocol Documentation

The context of the API key A context id is generally used to refer to a catalogue (e.g. Metadata Catalogue). It can identify the current user, a space, another user in the system or the site as a whole. * `me`—this represents the currently authenticated user's Private Space, * `group{numeric-identifier}`—this represents a Space. The `{numeric-identifier}` is an internal identifier. If you require an id for a given Space, then use the `context` from the Space's details, * `user{numeric-identifier}`—this represents another user in the system. The `{numeric-identifier}` is an internal identifier. If you require an id for a given user, then use the `context` from the User's details, * `dom0`—this represents the whole site.

The date/time that this object was created

Unique ID of this object.

An arbitrary chosen identifier for the API key

The date/time that this object was last changed

The key token

The context of the API key A context id is generally used to refer to a catalogue (e.g. Metadata Catalogue). It can identify the current user, a space, another user in the system or the site as a whole. * `me`—this represents the currently authenticated user's Private Space, * `group{numeric-identifier}`—this represents a Space. The `{numeric-identifier}` is an internal identifier. If you require an id for a given Space, then use the `context` from the Space's details, * `user{numeric-identifier}`—this represents another user in the system. The `{numeric-identifier}` is an internal identifier. If you require an id for a given user, then use the `context` from the User's details, * `dom0`—this represents the whole site.

The date/time that this object was created

Unique ID of this object.

An arbitrary chosen identifier for the API key

The date/time that this object was last changed

Settings to use when creating the new API key

Settings to use when creating the new API key

Settings to use when creating the new API key

The space for which to create the API key

The ID of the API key to delete

IDs of the API keys to fetch details for

IDs of the API keys to fetch details for

The space for which to get the API keys

ID of the API key to update

API key details to set

An arbitrary chosen identifier for the API key

An arbitrary chosen identifier for the API key

The id of the user. This will be null for non-authenticated users.

The type of the user.

The e-mail address of the account to impersonate

The GUID or ID of the account to impersonate

The user account's username

The user account's password

The user account's username

An API key generated by Chorus.

The new/updated session ID for further use

User details for the logged in user

Provides type content specific details for the item in question

Unique ID of this object.

Settings to use when creating the new folder

ID of the parent folder

ID of the item to delete

The ID of an item

Specify the folder ID from which to fetch file links

Specify the folder ID from which to fetch files

Specify the folder ID from which to fetch folder links

Specify the folder ID from which to fetch folders

Specify the folder or folder link from which to fetch rights

Specify the folder ID to fetch

Specify the item for which to fetch metadata

The IDs of the items

Specify the item for which to fetch rights

ID of the folder or folder link to search within

Search text

rights to create a derivative from the item

delete rights for the item

download rights for the item

edit rights for the item

publish rights for the item

share rights for the item

upload rights for the item

view rights for the item

rights to view the item's attachments

rights to view licences provided/used by this file

rights to view or download the object without watermarking

The URL for the avatar of the context.

ID of the folder that is the home of this context. This will be null if the current user cannot view the folders.

The ID of the context. A context id is generally used to refer to a catalogue (e.g. Metadata Catalogue). It can identify the current user, a space, another user in the system or the site as a whole. * `me`—this represents the currently authenticated user's Private Space, * `group{numeric-identifier}`—this represents a Space. The `{numeric-identifier}` is an internal identifier. If you require an id for a given Space, then use the `context` from the Space's details, * `user{numeric-identifier}`—this represents another user in the system. The `{numeric-identifier}` is an internal identifier. If you require an id for a given user, then use the `context` from the User's details, * `dom0`—this represents the whole site.

The name of the context.

ID of the Space or User that this is the context of. This will be null either if you cannot see the Space or User, or this is a context for the site.

The ID of the parent context.

The type of the context.

An array of contexts for which details should be returned. A context id is generally used to refer to a catalogue (e.g. Metadata Catalogue). It can identify the current user, a space, another user in the system or the site as a whole. * `me`—this represents the currently authenticated user's Private Space, * `group{numeric-identifier}`—this represents a Space. The `{numeric-identifier}` is an internal identifier. If you require an id for a given Space, then use the `context` from the Space's details, * `user{numeric-identifier}`—this represents another user in the system. The `{numeric-identifier}` is an internal identifier. If you require an id for a given user, then use the `context` from the User's details, * `dom0`—this represents the whole site.

The parent context for which to get children A context id is generally used to refer to a catalogue (e.g. Metadata Catalogue). It can identify the current user, a space, another user in the system or the site as a whole. * `me`—this represents the currently authenticated user's Private Space, * `group{numeric-identifier}`—this represents a Space. The `{numeric-identifier}` is an internal identifier. If you require an id for a given Space, then use the `context` from the Space's details, * `user{numeric-identifier}`—this represents another user in the system. The `{numeric-identifier}` is an internal identifier. If you require an id for a given user, then use the `context` from the User's details, * `dom0`—this represents the whole site.

An array of contexts for which details should be returned. A context id is generally used to refer to a catalogue (e.g. Metadata Catalogue). It can identify the current user, a space, another user in the system or the site as a whole. * `me`—this represents the currently authenticated user's Private Space, * `group{numeric-identifier}`—this represents a Space. The `{numeric-identifier}` is an internal identifier. If you require an id for a given Space, then use the `context` from the Space's details, * `user{numeric-identifier}`—this represents another user in the system. The `{numeric-identifier}` is an internal identifier. If you require an id for a given user, then use the `context` from the User's details, * `dom0`—this represents the whole site.

ID of the context for which to get shared links A context id is generally used to refer to a particular root of content. It can identify the current user, a Space or another user in the system. * `me`—this represents the currently authenticated user's Private Space, * `group{numeric-identifier}`—this represents a Space. The `{numeric-identifier}` is an internal identifier. If you require an id for a given Space, then use the `context` from the Space's details, * `user{numeric-identifier}`—this represents another user in the system. The `{numeric-identifier}` is an internal identifier. If you require an id for a given user, then use the `context` from the User's details.

The date encoded as per RFC-3339 (a.k.a ATOM)

this is the date/time represented as the number of seconds since the Unix Epoch (January 1 1970, 00:00:00 UTC)

The version of the title to use as the browser title (this often is longer and more verbose). If no specific browser title has been configured, then this will be the same as the 'title'.

The site's title. This is used for the shortcuts and other places referring to the site.

The current version of Chorus.

Sigma value for Gaussian blur

Details of a crop to apply

If true, this changes the content-type to application/x-force-download and forces browsers to trigger a download.

DPI for output image

Specify a filename to append to the URL (defaults to original file name)

the desired method of resolving aspect ratio differences between the requested input and output

Format code for requested file format

Height of output file in pixels

the page number to download, should be zero-indexed (e.g. the first page is '0'). Except when downloading the original, this will default to '0'

A quality parameter for lossy formats like JPEG - accepted range 60-99, default is 85. Smaller parameters yield smaller filesize but lower fidelity

Rotation angle in degrees

Width of output file in pixels

Height, in pixels, of the area to crop.

Width, in pixels, of the area to crop.

Pixel on the `x` axis in which to start the crop.

Pixel on the `y` axis in which to start the crop.

Audio duration in seconds

Document height

Document page count

Document width

If the file is a derivative, whether the current user can see the original file

The date/time that this object was created

The name of the file

The type of the file

Unique ID of this object.

Whether the file is a derivative or not.

The date/time that this object was last changed

If the file is a derivative, the guid for the original file

Unique ID of the object's owning user or space

The GUID of the folder containing this file

the revision number of the file

populated keys depend on the get options (e.g. withExtraThumbs)

The date/time that this object was created

Unique ID of this object.

The name of the linked file.

The date/time that this object was last changed

The ID of the linked file.

The type of the linked file.

The IDs of the File(s) to attach

The ID of the File to which the attachment should be added

The ID of the file for which to revoke the Direct URLs.

The ID of the File to remove as an attachment

The ID of the File from which the attachment should be removed

The file to update

The ID of the file

The ID of the File for which to list attachments

ID of the file for which to get the Direct URL.

Settings to control how the returned file looks. Supplying no settings will return a link to the original file.

The ID of the file link

The IDs of the file links

The files to get metadata for

The IDs of the files

ID of the file for which to get the Direct URL

Settings to control how the returned file looks. Supplying no settings will return a link to the original file.

Image height in pixels

Image width in pixels

Specific details about an audio file

Specific details about a document

A catch-all details type for generic files

Specific details about an image file

Specific details about a video file

Height in pixels

The URL to access the thumbnail

Width in pixels

Video duration in seconds

Video framerate in frames per second

Video height in pixels

Video width in pixels

The description of the newly created folder.

The name of the newly created folder.

Search options to use (only valid when creating a smart collection).

Search params to use (only valid when creating a smart collection).

The type of folder to create.

The identifier for the containing context

The date/time that this object was created

The description of the folder.

Unique ID of this object.

The date/time that this object was last changed

The ID of the parent of the folder, or null if there is no parent

The type of the folder.

The date/time that this object was created

Unique ID of this object.

The name of the linked folder.

The date/time that this object was last changed

The ID of the linked folder.

Default true: include multiple links to the same files (e.g. when visible via both a collection and the folder) in the search results

Default false: include multiple links to the same folders (e.g. via shares) in the search results

Default false: include folders in the search results

Default false: resolve licences matching the search into the files that consume them. Implies includeFileCopies:false

maximum number of results for the search

condition to check in the search logic

name of the tag to perform the search on

the type of search to perform

value used in the search conditional

The ID of the folder

The ID of the folder to list

The ID of the folder to list

The ID of the folder link

The IDs of the folder links

The IDs of the folders

The folder details to set.

A folder ID for the folder of interest.

The description of the folder.

The name of the folder.

the data type of the metadata field

A description of the field

the display type of the field

whether the field is read only

the search settings for the metadata field

types of file supported by this metadata field

The tag name

whether the field is available in advanced search

whether the field is available in general search

the value details to delete

The file or folder to delete the metadata for

The name of the tag for which to delete the metadata

The id of the field of which to get the details

The id of the field of which to get the details

The item to get metadata fields for

The item to get metadata panel IDs for

The file or folder to get metadata for

The name of the tag for which to retrieve the values

The id of the panel for which to get the details

The id of the panel for which to get the details

The name of the tag for which to retrieve the vocab

The name of the tag for which to retrieve the vocab

The space for which to get the tag vocab

The name of the tag for which to retrieve the vocab

the value details to set

The file or folder to replace the metadata for

The name of the tag for which to update the metadata

the vocab details to set

The name of the tag for which to replace the vocab

the vocab details to set

The name of the tag for which to replace the vocab

the vocab details to set

The space for which to replace the tag vocab

The name of the tag for which to replace the vocab

the value details to set

The file or folder to update the metadata for

The name of the tag for which to update the metadata

the vocab details to set

The name of the tag for which to replace the vocab

the vocab details to set

The name of the tag for which to replace the vocab

the vocab details to set

The space for which to update the tag vocab

The name of the tag for which to replace the vocab

Values of metadata if the type of the metadata if this is a numeric type of field.

Values of metadata if the type of the metadata if this is a string type of field.

A description of the panel

The id of the panel

names of the tags in this metadata panel

the mode of the vocab

The name of the tag

names of the values in the vocab list

Search text

The date/time that this object was created

A description for this Shared Link, which will get passed on to the link.

ID of the special collection that backs this shared link.

Unique ID of this object.

The date/time that this object was last changed

A convenient name for this Shared Link.

URLs for the shared link

The id, or array thereof, of the Shared Links of which to get the details.

The id, or array thereof, of the Shared Links of which to get the details.

a URL to the current avatar

The date/time that this object was created

Description of this Space.

Unique ID of this object.

The date/time that this object was last changed

Name of this Space.

ID of the parent Space, or null if this is a top-level Space.

ID of the requested Space

ID of the requested Space

Number of files that have been cancelled before processing.

The date/time that this object was created

ID of the destination folder for the upload.

Number of files that have been failed to process.

Unique ID of this object.

Indication of whether the upload is still accepting files. This will be `false` after 'finish' has been called, or the upload has been cleaned up by the system.

The date/time that this object was last changed

The URL to which files can be uploaded to using HTTP POST requests. The whole file should be posted raw.

The current status of this upload batch.

Number of files that have been successfully processed.

Total number of files in the upload batch.

IDs of files that have been successfully uploaded.

The ID of the container in which to upload

ID of the Upload to finish.

ID of the Upload for which to get the details.

A description about the user, e.g. their job title or department.

The email address of the user.

No longer supported. Field preserved for backwards compatibility.

The user's name.

The "username" of the user.

A description about the user, e.g. their job title or department.

The email address of the user.

No longer supported. Field preserved for backwards compatibility.

The user's name.

a URL to the current avatar

ID of the folder that contains this user's contents. This will be null if requesting details for a different user to the one currently logged in.

The date/time that this object was created

A description about the user, e.g. their job title or department.

The email address of the user. Will be null if the authenticated user cannot see this detail.

Flag used to decide whether to show the user's 'Home Space' in the UI. This should be used if presenting users with a similar layout to that seen in Chorus. Will be null if requesting the details of another user.

ID of the user's Home Space. Null if the user does not have a Home Space, or if the current user cannot see the Home Space.

Unique ID of this object.

The date/time that this object was last changed

The user's name.

The "username" of the user.

Settings to use when creating the new user

Settings to use when creating the new user

The space in which to create the user

ID of the user to delete

The ID of the user

The IDs of the users

The space for which to get the users

The query to match on.

The type of lookup the query is used for.

User details to set

ID of the user to update