Ci API

API Endpoint

https://api.cimediacloud.com

Ci API enables you to manage your files in Ci or to extend your own application with a media optimized cloud based file system. You can securely store, retrieve and archive files of any size using traditional HTTP transfers or by leveraging our media transport for high speed transfers. Content uploaded to Ci will be validated for integrity so that you can be sure we got every last bit. Ci will also create the proxies that you’ve come to love just like we do when you upload through the award-winning user interface.

Ci API is organized around REST and uses HTTP verbs and response codes that most clients are familiar with.

All requests must be formatted as Content-Type: application/json (except where noted).
All responses are also formatted JSON, encoded in the UTF-8 character encoding (Content-Type: application/json; charset=utf-8).
The Accept header will be ignored for all requests.
All POST and PUT requsts must include the Content-Length header.

Security

Ci API uses the Resource Owner Password Credentials Grant flow of OAuth 2.0 for authentication and allows applications to submit authenticated requests on behalf of individual Ci users.

First, encode your credentials
Then you exchange these encoded credentials along with your client credentials for an OAuth 2.0 Bearer token
Once you’ve done that, you simply include your token with all of your Ci requests

An authorization header containing a valid access token must be included in every Ci API request like follows:

Authorization: Bearer 5262d64b892e8d43410as3d01

The bearer token is your key to accessing all of your resources via Ci API. Keep it safe.

SSL must be used in all Ci API interactions.

IP Restrictions

Ci API access can be limited to specific (trusted) IP addresses or IP ranges to further enforce security and restrict unapproved access. If you are interested in limiting API access to specific IP ranges contact our customer success team.

API Update Guidelines

Our API is constantly being updated with new features and improvements to existing ones. These updates ensure the API evolves with customer and industry demands. Managing this change to ensure we provide a reliable, consistent, and backward compatible API design is a critical challenge for our team. Every new and improved feature is put through a peer review process to ensure:

it will not change an existing resource to the extent it breaks current customer implementations,
that it is consistent with existing resources (therefore predictable and easy to use).

The following guidelines are used in our peer review process to understand what constitutes acceptable change for our API and our customers.

Changes we avoid:

Removing or renaming request or response content fields
Removing or renaming query string parameters
Removing or changing the location of a resource
Changing the API domain

Changes we approve and introduce:

Adding new resources
Adding new, optional request content fields
Adding new, optional query string parameters
Adding new response content fields
Adding new response header information

If, for any reason, we cannot avoid any of the non-backward compatible changes mentioned above, we will implement a deprecation schedule. This schedule will be provided to all customers with the goal of giving them adequate time to accommodate the updates.

Looking further out, as our API evolves and industry standards dictate, we do anticipate the possibility that an entirely new API version will be needed. If and when that happens we will, once again, provide a deprecation schedule for the existing version that will ensure all customers have time to upgrade.

Additional information:

Undocumented resources and properties are considered to be in beta release and are subject to change without notification.

Developer Keys

Please contact our customer success team to sign up for a developer key and begin using our API today.

Change Log

Visit the change log for more information about Ci API changes.

Errors

When an error is encountered you will receive an HTTP status code along with a message and error code in the body of the response. The message is intended to give a user-friendly explanation of the error while the error codes are designed to be machine readable codes that applications can use to better understand the context of the error and react appropriately.

We use the following status codes for errors:

Status Code	Meaning
400	Bad Request – The request contains errors.
401	Unauthorized – The authentication process failed, or the access token is not valid.
403	Forbidden – Access to this resource is restricted for the given caller.
404	Not Found – The specified resource could not be found.
405	Method Not Allowed – An invalid method was used to access a resource.
406	Not Acceptable – An unsupported format was requested.
409	Conflict – The requested operation on the resource cannot be made due the resource state.
500	Internal Server Error – There was a problem with the API host server. Try again later.
503	Service Unavailable – API is temporarily offline for maintenance. Try again later.

Rate Limiting

To reduce overuse and protect our platform, we have a rate limiting system in place that will provide details about the number of requests you have made in a specific time period. Clients will receive a HTTP 429 Too Many Requests error if they are in excess of the policy. If you receive a 429 HTTP response we recommend delaying your next API request by the amount of time (in seconds) sent in the Retry-After header.

The default rate limit policy is 3,000 calls per 15 minute period, however, if you need a different policy please work with our Customer Success team. All API Responses will contain the following headers:

Header	Meaning
X-RateLimit-Limit	The maximum allowed number of requests in the policy’s given period of time
X-RateLimit-Remaining	The remaining requests in the policy’s given period of time
X-RateLimit-Reset	The time at which the current rate limit 5-minute window resets in UTC epoch seconds (it resets at the next minute)
Retry-After	The delay, in seconds, the client should follow before retrying

Authentication ¶

There are a few different ways to get an OAuth2 token from Ci. The first option listed, using Ci user credentials, will be the most common.

Using Ci User Credentials

Generates a valid access token which can be used in subsequent calls to Ci API. This resource uses Basic Authorization. Follow these steps to retrieve an access token:

Concatenate your Ci username, a colon character “:”, and your Ci password into a single string
Base64 encode the string from Step 1
Include the resulting encoded string from Step 2 in an Authorization header as follows

Authorization: Basic [encoded string]

Using a Refresh Token

Refresh tokens are long-lived (14 days) authentication tokens that can be used to replace expired access tokens without providing user credentials. Refresh tokens are issued when an access token is requested using Ci user credentials (additionally, they are issued when requesting a new access token with a refresh token).

When requesting an access token using a refresh token you must use a grant type of ‘refresh_token’ and provide the refresh token in the request body. There is no need to include the Ci user credentials in the Authorization header.

Using a Delegate Token

Delegate tokens are short-lived authentication tokens that can be used to grant temporary and limited API access to 3rd party clients. For example, rather than upload a cover element file through a Ci enabled application, a delegate token could be used in a Javascript based application so that the file may be uploaded to Ci directly from a browser.

When requesting a delegate token, an access token or a refresh token is required in the Authorization header. Additionally, an asset ID and a scope must be provided in the request body to ensure that the delegate token allows limited access to Ci.

Once you receive a delegate token you can then use it in the Authorization header just like a regular access token.

Generate Access Token ¶

POST https://api.cimediacloud.com/oauth2/token

Requestswith Ci user credentialswith refresh tokenwith delegate token

Headers

Content-Type: application/json
Authorization: Basic [encoded credentials]

Body

{
  "client_id": "yjtgrjdag8is4cxb",
  "client_secret": "q1h0jt4fi0bctwb5",
  "grant_type": "password"
}

Property name	Type	Description
client_id	`string` (required)	Client id used to access Ci API.
client_secret	`string` (required)	Client secret used to access Ci API.
grant_type	`string` (required)	The OAuth2 grant type for authentication.

Responses200400

Headers

Content-Type: application/json

Body

{
  "access_token": "h3s6zk4o93wfjwwp",
  "expires_in": 3600,
  "token_type": "bearer",
  "refresh_token": "q8eml5kormli7aq6"
}

Property name	Type	Description
access_token	`string`	The bearer token that can be used in subsequent requests.
expires_in	`number`	The number of seconds that the token will expire. Currently set to 86400 (24 hours).
token_type	`string`	The type of token. Always returns ‘bearer’.
refresh_token	`string`	The token which can be used to regenerate a new access token without providing authentication details. Refresh tokens expire in 14 days.

Headers

Content-Type: application/json

Body

{
  "error": "invalid_request",
  "error_description": "Parameter grant_type is required"
}

Property name	Type	Description
error	`string`	Machine readable error code
error_description	`string`	Error message

Headers

Content-Type: application/json

Body

{
  "client_id": "yjtgrjdag8is4cxb",
  "client_secret": "q1h0jt4fi0bctwb5",
  "grant_type": "refresh_token",
  "refresh_token": "3g4atvsqc6pfcaht"
}

Property name	Type	Description
client_id	`string` (required)	Client id used to access Ci API.
client_secret	`string` (required)	Client secret used to access Ci API.
grant_type	`string` (required)	The OAuth2 grant type.
refresh_token	`string` (required)	The previously issued refresh token that will be used to get new access token and updated refresh token.

Responses200400

Headers

Content-Type: application/json

Body

{
  "access_token": "h3s6zk4o93wfjwwp",
  "expires_in": 3600,
  "token_type": "bearer",
  "refresh_token": "q8eml5kormli7aq6"
}

Property name	Type	Description
access_token	`string`	The bearer token that can be used in subsequent requests.
expires_in	`number`	The number of seconds that the token will expire. Currently set to 86400 (24 hours).
token_type	`string`	The type of token. Always returns ‘bearer’.
refresh_token	`string`	The token which can be used to regenerate a new access token without providing authentication details. Refresh tokens expire in 14 days.

Headers

Content-Type: application/json

Body

{
  "error": "invalid_request",
  "error_description": "Parameter grant_type is required"
}

Property name	Type	Description
error	`string`	Machine readable error code
error_description	`string`	Error message

Headers

Content-Type: application/json
Authorization: Basic [encoded credentials]

Body

{
  "assetId": "nooumy2aiumufg3w",
  "scope": "UploadCoverElement"
}

Property name	Type	Description
assetId	`string` (required)	The asset id that can be accessed or modified using the requested token.
scope	`string` (required)	The scope of actions that may be performed on the given asset. Currently the only valid value is ‘UploadCoverElement’.

Responses200400

Headers

Content-Type: application/json

Body

{
  "access_token": "h3s6zk4o93wfjwwp",
  "expires_in": 3600,
  "token_type": "bearer"
}

Property name	Type	Description
access_token	`string`	The bearer token that can be used in subsequent requests.
expires_in	`number`	The number of seconds that the token will expire. Currently set to 86400 (24 hours).
token_type	`string`	The type of token. Always returns ‘bearer’.

Headers

Content-Type: application/json

Body

{
  "code": "TokenScopeNotProvided",
  "message": "Token scope not provided"
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Generate Access Token
POST`/oauth2/token`

Description

Generates the OAuth2 token. See the right context panel for examples of each type of authorization request.

Errors

OAuth error responses conform to the OAuth 2.0 Authorization Framework and therefore return two properties: error and error_description. These 2 properties are returned instead of Message and Code like all other resources.

Status Code	error	error_description
400	invalid_request	Parameter grant_type is required.
400	unsupported_grant_type	Grant type is not supported.
400	invalid_request	Parameter client_id is required.
400	invalid_request	Parameter client_secret is required.
400	invalid_request	Parameter refresh_token is required.
400	invalid_request	Missing or invalid authorization header.
400	invalid_request	Refresh token not found.
400	invalid_request	Refresh token has expired.
400	invalid_request	Refresh token has been revoked.
400	invalid_request	Token provided is not a refresh token.
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	TokenScopeNotProvided	Token scope not provided.
400	AssetIdNotProvided	Asset Id was not provided.
401	invalid_client	Invalid client id and client secret combination.
401	invalid_client	Invalid username and password combination.

Networks ¶

Networks are where Workspaces and users are managed. You can think of a Network as the organizational structure within Ci for a company or a division.

List Events ¶

GET https://api.cimediacloud.com/networks/moqxhkej4epvgrwz/events?since=2018-12-01T00:00:00.000Z&type=CreateWorkspace&limit=10&offset=5&orderDirection=asc

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200404

Headers

Content-Type: application/json

Body

{
  "limit": 1,
  "offset": 0,
  "count": 10,
  "order": {
    "by": "Name",
    "direction": "asc"
  },
  "filter": {
    "type": [
      "CreateWorkspace"
    ],
    "since": "2018-12-01T00:00:00.000Z"
  },
  "items": [
    {
      "id": "prffhlw9iptcfqfc",
      "createdOn": "2017-01-02T00:00:00.000Z",
      "createdBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "type": "CreateWorkspace",
      "workspaces": [
        {
          "id": "gb5ehomv0iv71swg",
          "name": "Workspace Name"
        }
      ]
    }
  ]
}

Property name	Type	Description
limit	`number`	The limit used for the query.
offset	`number`	The offset used for the query.
count	`number`	The total count of items available.
order	`object`	Information about the ordering of the results.
order.by	`string`	Indicates the field used to sort the results.
order.direction	`string`	Indicates the direction used to sort the results.
filter	`object`	Information about the filter used for retrieving events.
filter.type	`array`	Indicates the event types used as a filter in the request. Supported types are ‘CreateWorkspace’, ‘RenameWorkspace’, and ‘DeleteWorkspace’. This field is omitted if no type was used to filter events.
filter.since	`string`	Indicates the timestamp used as a filter in the request. This field is omitted if no timestamp was used to filter events.
items	`array`	The set of events returned by the query.
items[].id	`string`	The unique identifier of the event.
items[].createdOn	`string`	The datetime the event occurred.
items[].createdBy	`object`	Information about the event creator.
items[].createdBy.id	`string`	The unique identifier of the user.
items[].createdBy.name	`string`	The full name of the user.
items[].createdBy.email	`string`	The email of the user.
items[].type	`string`	The type of the event. Returned values are ‘CreateWorkspace’, ‘RenameWorkspace’, and ‘DeleteWorkspace’
items[].workspaces	`array`	The set of Workspaces involved in the event.
items[].workspaces[].id	`string`	The unique identifier of the Workspace.
items[].workspaces[].name	`string`	The name of the Workspace.

Headers

Content-Type: application/json

Body

{
  "code": "NetworkNotFound",
  "message": "Network not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

List Events
GET`/networks/{networkId}/events{?since,type,limit,offset,orderDirection}`

URI Parameters

HideShow

networkId

string (required)

The unique identifier of the Network.

since

string (optional)

Filters the events by their creation date. The operation will only return events that occurred on or after the given timestamp. Value must be in IS0 8601 date and time format (e.g.: ‘2018-01-01T00:00:00.000Z’).

type

string (optional)

Comma-separated list of event types to filter by. Omit this parameter to return all supported event types.

Choices: CreateWorkspace RenameWorkspace DeleteWorkspace

limit

number (optional) Default: 50

The number of items to return. The maximum is 50.

offset

number (optional) Default: 0

The item at which to begin the response.

orderDirection

string (optional) Default: asc

The order direction the items should be returned.

Choices: asc desc

Description

Retrieves events that occurred for a given Network. This query supports pagination using limit and offset. Additionally, using the ‘since’ and ‘type’ parameters, it is possible to filter events by date and event type. The results are ordered by date created.

The following event types can be used when filtering for Network events:

CreateWorkspace - Workspace was created.
RenameWorkspace - Workspace was renamed.
DeleteWorkspace - Workspace was deleted.

Errors

Status Code	Error Code	Message
400	InvalidLimitOrOffset	Invalid limit or offset value. Limit must be a number between 1 and 50. Offset must be greater than or equal to 0.
400	InvalidQueryOrderDirection	Invalid order direction. It must be either ‘Asc’ or ‘Desc’.
400	InvalidQueryFilter	Invalid query filter.
404	NetworkNotFound	Network not found.

Workspaces ¶

Workspaces are where assets and people come together to get things done. Assets are uploaded into Workspaces. Folders, MediaBoxes and WorkSessions are created in Workspaces. Users are invited into Workspaces. This paradigm gives you the control you need to make sure that the right people have access to the right assets.

Create Workspace ¶

POST https://api.cimediacloud.com/networks/fa8f4095c9954ba6a9f03f802311db63/workspaces

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "name": "My new Team Workspace",
  "storageAllotted": {
    "value": 50,
    "unit": "GB"
  },
  "manageMembersPrivilege": "WorkspaceAdmin",
  "purgeTrashPrivilege": "NetworkOwner",
  "isArchiveEnabled": true,
  "isAsperaEnabled": false,
  "isSidecarIngestEnabled": false,
  "members": [
    "john@example.com"
  ],
  "note": "A note attached to the new Workspace"
}

Property name	Type	Description
name	`string` (required)	The name of the Workspace.
storageAllotted	`object` (required)	Information about the storage to be allotted to the new Workspace.
storageAllotted.value	`number` (required)	The size value to allocate.
storageAllotted.unit	`string`	The unit of size to allocate. This value can be `bytes`, `kilobytes`, `megabytes`, `gigabytes` or `terabytes`. Alternatively, you can supply their unit symbols: `B`, `KB`, `MB`, `GB`, `TB`. If omitted, defaults to `bytes`. Important: we are using 1024 as the base value for the multiples of the unit byte, so 1 KB = 1024 bytes, 1 MB = 1,048,576 bytes, etc.
manageMembersPrivilege	`string` (required)	The minimum role level that will be allowed to manage the members of the new Workspace. The valid values, ordered from less restrictive to more restrictive, are: `WorkspaceAdmin`, `WorkspaceOwner`, `NetworkAdmin`, `NetworkOwner`.
purgeTrashPrivilege	`string` (required)	The minimum role level that will be allowed to purge the trashed files of the new Workspace. The valid values, ordered from less restrictive to more restrictive, are: `WorkspaceAdmin`, `WorkspaceOwner`, `NetworkAdmin`, `NetworkOwner`.
isArchiveEnabled	`boolean`	Indicates if archiving files should be available for the new Workspace. If omitted, defaults to `false`.
isAsperaEnabled	`boolean`	Indicates if Aspera should be available for the new Workspace. If omitted, defaults to `false`.
isSidecarIngestEnabled	`boolean`	Indicates if the Sidecar Ingest feature is enabled. If omitted, defaults to `false`.
members	`array`	The list of user Ids or email addresses who are invited to collaborate in the new Workspace. The users will be emailed immediately upon creation of the workspace.
note	`string`	Text body for a user generated note for the Workspace.

Responses200400

Headers

Content-Type: application/json

Body

{
  "id": "bu1m7ii2zo8lexkq",
  "name": "My Team Workspace",
  "class": "Team",
  "rootFolderId": "oaeybnyoggs97nzw",
  "createdOn": "2017-01-02T00:00:00.000Z",
  "lastActivityOn": "2017-01-02T00:00:00.000Z",
  "assetCount": 0,
  "isDeleted": false,
  "plan": {
    "name": "Custom Workspace"
  },
  "storage": {
    "allotted": 1099511627776,
    "used": 0,
    "usedByAssets": 0,
    "usedByElements": 0
  },
  "network": {
    "id": "40c2a6b99a474b319dec5ef9c7dbb356",
    "name": "Company Name",
    "class": "Enterprise"
  },
  "owner": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith"
  },
  "createdBy": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith",
    "email": "johnsmith@example.com"
  },
  "entitlements": {
    "isAperaEnabled": true,
    "isArchiveEnabled": true,
    "isSidecarIngestEnabled": true
  },
  "userLastAccessedOn": "2017-01-02T00:00:00.000Z",
  "runtime": {
    "video": 1000024
  },
  "note": {
    "text": "I am a note.",
    "createdOn": "2017-01-02T00:00:00.000Z",
    "createdBy": {
      "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
      "name": "John Smith",
      "email": "johnsmith@example.com"
    },
    "modifiedOn": "2017-01-02T00:00:00.000Z",
    "modifiedBy": {
      "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
      "name": "John Smith",
      "email": "johnsmith@example.com"
    }
  },
  "spaceExternalStorageInfo": {
    "service": "S3",
    "region": "us-east",
    "bucket": "My-Bucket",
    "prefix": "/my-prefix",
    "scope": {
      "workspaceId": "6538b82537f3487687820f764ac9d831",
      "networkId": "ec34f210539447d9bf419ce9f0acdca9",
      "enterpriseNetworkId": "5752bf48ad4f4a37a359a5be801f48eb"
    },
    "importConfigurations": [
      {
        "id": "ab8fcd95c99e4ba6a9f03f802311db74",
        "source": {
          "region": "us-east-1",
          "bucket": "my-bucket",
          "prefix": "/my-prefix"
        },
        "target": {
          "workspace": {
            "id": "gb5ehomv0iv71swg",
            "name": "Workspace Name",
            "class": "Enterprise"
          },
          "folder": {
            "id": "9b639e12a82f4b0483f512b474dc052ci",
            "name": "Folder Name"
          }
        }
      }
    ]
  }
}

Property name	Type	Description
id	`string`	The unique identifier of the workspace.
name	`string`	The name of the workspace.
class	`string`	Indicates if it is a ‘Team’ or ‘Personal’ workspace.
rootFolderId	`string`	The unique identifier of the default folder.
createdOn	`string`	The datetime the workspace was created.
lastActivityOn	`string`	The datetime the last activity was recorded for the workspace.
assetCount	`number`	The total number of assets in the workspace.
isDeleted	`boolean`	Indicates whether the workspace is active or deleted. Note: listing a user’s workspaces will only return active workspaces.
plan	`object`	The subscription plan associated with this workspace.
plan.name	`string`	The display name of the subscription plan associated with the workspace.
storage	`object`	Information about Ci storage statistics for the workspace.
storage.allotted	`number`	The total storage capacity of the workspace, in bytes.
storage.used	`number`	The total storage used by the files (both assets and elements) in the workspace, in bytes.
storage.usedByAssets	`number`	The storage used by the assets in the workspace, in bytes.
storage.usedByElements	`number`	The storage used by the assets’ elements in the workspace, in bytes.
network	`object`	Information about workspace’s parent network.
network.id	`string`	The unique identifier of the Network.
network.name	`string`	The name of the Network.
network.class	`string`	Indicates if the Network is a ‘Personal’ or ‘Enterprise’ Network.
owner	`object`	Information about the owner of the workspace.
owner.id	`string`	The unique identifier of the user.
owner.name	`string`	The full name of the user.
createdBy	`object`	Information about the creator of the workspace.
createdBy.id	`string`	The unique identifier of the user.
createdBy.name	`string`	The full name of the user.
createdBy.email	`string`	The email of the user.
entitlements	`object`	Information about entitlements granted to this workspace.
entitlements.isAperaEnabled	`boolean`	Indicates if Aspera is available for this workspace.
entitlements.isArchiveEnabled	`boolean`	Indicates if archiving files is available for this workspace.
entitlements.isSidecarIngestEnabled	`boolean`	Indicates if the Sidecar Ingest feature is enabled for this workspace.
userLastAccessedOn	`string`	Indicates the last time the user accessed the workspace.
runtime	`object`	Information about the runtime of the asset.
runtime.video	`number`	The duration of all video assets in the workspace, in seconds.
note	`object`	User generated note field for the workspace.
note.text	`string`	The text body of the note.
note.createdOn	`string`	The datetime the note was created.
note.createdBy	`object`	Information about the creator of the note.
note.createdBy.id	`string`	The unique identifier of the user.
note.createdBy.name	`string`	The full name of the user.
note.createdBy.email	`string`	The email of the user.
note.modifiedOn	`string`	The datetime the note was last updated.
note.modifiedBy	`object`	Information about the last person to update the note.
note.modifiedBy.id	`string`	The unique identifier of the user.
note.modifiedBy.name	`string`	The full name of the user.
note.modifiedBy.email	`string`	The email of the user.
spaceExternalStorageInfo	`object`	The workspace’s external storage configuration (if any).
spaceExternalStorageInfo.service	`string`	The External Storage Service Provider Type.
spaceExternalStorageInfo.region	`string`	The Region of the External Storage.
spaceExternalStorageInfo.bucket	`string`	The Bucket of the External Storage.
spaceExternalStorageInfo.prefix	`string`	The Prefix if the External Storage.
spaceExternalStorageInfo.scope	`object`	The scope of the External Storage.
spaceExternalStorageInfo.scope.workspaceId	`string`	The unique identifier of the Workspace.
spaceExternalStorageInfo.scope.networkId	`string`	The unique identifier of the Network.
spaceExternalStorageInfo.scope.enterpriseNetworkId	`string`	The unique identifier of the Enterprise Network.
spaceExternalStorageInfo.importConfigurations	`array`	The list of Import Configurations for the External Storage.

Headers

Content-Type: application/json

Body

{
  "code": "MissingOrInvalidAllottedStorage",
  "message": "Missing or invalid allotted storage."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Create Workspace
POST`/networks/{networkId}/workspaces`

URI Parameters

HideShow

networkId: string (required)
Identifier of the Network.

Description

Creates a new Team Workspace.

Errors

Status Code	Error Code	Message
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	MissingOrInvalidName	Missing or invalid name.
400	MissingOrInvalidAllottedStorage	Missing or invalid allotted storage.
400	MissingOrInvalidRoleForPrivilege	Missing or invalid role for at least one of the required privileges.
400	InsufficientSpaceAvailable	Allotted storage for workspace will exceed the network’s allowed storage.
400	InvalidOperationOnPersonalNetwork	The requested operation cannot be performed on a Personal Network.
404	NetworkNotFound	Network not found.

Workspace ¶

GET https://api.cimediacloud.com/workspaces/moqxhkej4epvgrwz?extraFields=externalStorage

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200404

Headers

Content-Type: application/json

Body

{
  "id": "bu1m7ii2zo8lexkq",
  "name": "My Team Workspace",
  "class": "Team",
  "createdOn": "2017-01-02T00:00:00.000Z",
  "lastActivityOn": "2017-01-02T00:00:00.000Z",
  "assetCount": 105000,
  "isDeleted": false,
  "plan": {
    "id": "team-2",
    "name": "Team - Large"
  },
  "storage": {
    "allotted": 1099511627776,
    "used": 1073741824,
    "usedByAssets": 536870912,
    "usedByElements": 536870912
  },
  "network": {
    "id": "40c2a6b99a474b319dec5ef9c7dbb356",
    "name": "Company Name",
    "class": "Enterprise"
  },
  "owner": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith"
  },
  "createdBy": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith",
    "email": "johnsmith@example.com"
  },
  "entitlements": {
    "isAperaEnabled": true,
    "isSidecarIngestEnabled": true
  },
  "bannerUrl": "https://cimediacloud.com/t5y7s3ero3w2ie7/banner.jpg",
  "logoUrl": "https://cimediacloud.com/t5y7s3ero3w2ie7/logo.jpg",
  "userRole": "WorkspaceOwner",
  "userInviteStatus": "Joined",
  "userLastAccessedOn": "2017-01-02T00:00:00.000Z",
  "runtime": {
    "video": 1000024
  },
  "note": {
    "text": "I am a note.",
    "createdOn": "2017-01-02T00:00:00.000Z",
    "createdBy": {
      "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
      "name": "John Smith",
      "email": "johnsmith@example.com"
    },
    "modifiedOn": "2017-01-02T00:00:00.000Z",
    "modifiedBy": {
      "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
      "name": "John Smith",
      "email": "johnsmith@example.com"
    }
  },
  "stats": {
    "activeCount": 10,
    "activeStorageUsed": 1024,
    "archivedCount": 10,
    "archivedStorageUsed": 1024,
    "recycledCount": 10,
    "recycledStorageUsed": 1024,
    "temporaryRestoredCount": 10,
    "temporaryRestoredStorageUsed": 1024,
    "storageAllotted": 10,
    "storageUsed": 1024,
    "dataTransferAllotted": 1024,
    "dataTransferUsed": 512
  },
  "spaceExternalStorageInfo": {
    "service": "S3",
    "region": "us-east",
    "bucket": "My-Bucket",
    "prefix": "/my-prefix",
    "scope": {
      "workspaceId": "6538b82537f3487687820f764ac9d831",
      "networkId": "ec34f210539447d9bf419ce9f0acdca9",
      "enterpriseNetworkId": "5752bf48ad4f4a37a359a5be801f48eb"
    },
    "importConfigurations": [
      {
        "id": "ab8fcd95c99e4ba6a9f03f802311db74",
        "source": {
          "region": "us-east-1",
          "bucket": "my-bucket",
          "prefix": "/my-prefix"
        },
        "target": {
          "workspace": {
            "id": "gb5ehomv0iv71swg",
            "name": "Workspace Name",
            "class": "Enterprise"
          },
          "folder": {
            "id": "9b639e12a82f4b0483f512b474dc052ci",
            "name": "Folder Name"
          }
        }
      }
    ]
  },
  "rootFolderId": "oaeybnyoggs97nzw",
  "availableRenderTargets": [
    {
      "name": "Best Fit AVC",
      "key": "best-fit-avc",
      "description": "Render to AVC with best match based on source codec and specs"
    }
  ]
}

Property name	Type	Description
id	`string`	The unique identifier of the workspace.
name	`string`	The name of the workspace.
class	`string`	Indicates if it is a ‘Team’ or ‘Personal’ workspace.
createdOn	`string`	The datetime the workspace was created.
lastActivityOn	`string`	The datetime the last activity was recorded for the workspace.
assetCount	`number`	The total number of assets in the workspace.
isDeleted	`boolean`	Indicates whether the workspace is active or deleted. Note: listing a user’s workspaces will only return active workspaces.
plan	`object`	The subscription plan associated with this workspace.
plan.id	`string`	The unique identifier of the subscription plan associated with the workspace.
plan.name	`string`	The display name of the subscription plan associated with the workspace.
storage	`object`	Information about Ci storage statistics for the workspace.
storage.allotted	`number`	The total storage capacity of the workspace, in bytes.
storage.used	`number`	The total storage used by the files (both assets and elements) in the workspace, in bytes.
storage.usedByAssets	`number`	The storage used by the assets in the workspace, in bytes.
storage.usedByElements	`number`	The storage used by the assets’ elements in the workspace, in bytes.
network	`object`	Information about workspace’s parent network.
network.id	`string`	The unique identifier of the Network.
network.name	`string`	The name of the Network.
network.class	`string`	Indicates if the Network is a ‘Personal’ or ‘Enterprise’ Network.
owner	`object`	Information about the owner of the workspace.
owner.id	`string`	The unique identifier of the user.
owner.name	`string`	The full name of the user.
createdBy	`object`	Information about the creator of the workspace.
createdBy.id	`string`	The unique identifier of the user.
createdBy.name	`string`	The full name of the user.
createdBy.email	`string`	The email of the user.
entitlements	`object`	Information about entitlements granted to this workspace.
entitlements.isAperaEnabled	`boolean`	Indicates if Aspera is available for this workspace.
entitlements.isSidecarIngestEnabled	`boolean`	Indicates if the Sidecar Ingest feature is enabled for this workspace.
bannerUrl	`string`	If available, the link to the banner image.
logoUrl	`string`	If available, the link to the logo image.
userRole	`string`	Indicates the role of the user in the Workspace. Supported values are ‘WorkspaceAdmin’ and ‘WorkspaceOwner’.
userInviteStatus	`string`	Indicates the status of the user in the Workspace. Supported values are ‘Invited’, ‘Joined’.
userLastAccessedOn	`string`	Indicates the last time the user accessed the workspace.
runtime	`object`	Information about the runtime of the asset.
runtime.video	`number`	The duration of all video assets in the workspace, in seconds.
note	`object`	User generated note field for the workspace.
note.text	`string`	The text body of the note.
note.createdOn	`string`	The datetime the note was created.
note.createdBy	`object`	Information about the creator of the note.
note.createdBy.id	`string`	The unique identifier of the user.
note.createdBy.name	`string`	The full name of the user.
note.createdBy.email	`string`	The email of the user.
note.modifiedOn	`string`	The datetime the note was last updated.
note.modifiedBy	`object`	Information about the last person to update the note.
note.modifiedBy.id	`string`	The unique identifier of the user.
note.modifiedBy.name	`string`	The full name of the user.
note.modifiedBy.email	`string`	The email of the user.
stats	`object`	Data storage and data transfer stats for the Workspace.
stats.activeCount	`number`	The number of files that are uploaded and not trashed, archived or restored.
stats.activeStorageUsed	`number`	The total size of files (in bytes) that are uploaded and not trashed, archived or restored.
stats.archivedCount	`number`	The number of files that are archived.
stats.archivedStorageUsed	`number`	The total size of files (in bytes) that are archived.
stats.recycledCount	`number`	The number of files that are in the trash.
stats.recycledStorageUsed	`number`	The total size of files (in bytes) that are in the trash.
stats.temporaryRestoredCount	`number`	The number of files (in bytes) that are in temporarily restored.
stats.temporaryRestoredStorageUsed	`number`	The total size of files (in bytes) that are in temporarily restored.
stats.storageAllotted	`number`	The total storage allotted for this Workspace.
stats.storageUsed	`number`	The total storage used (in bytes) for this Workspace (excluding deleted or archived files, note: this number does include temporarily restored files).
stats.dataTransferAllotted	`number`	The total data transfer (upload and download) allotted for this Workspace (in bytes).
stats.dataTransferUsed	`number`	The total data transfer (upload and download) used for this Workspace (in bytes).
spaceExternalStorageInfo	`object`	The workspace’s external storage configuration (if any).
spaceExternalStorageInfo.service	`string`	The External Storage Service Provider Type.
spaceExternalStorageInfo.region	`string`	The Region of the External Storage.
spaceExternalStorageInfo.bucket	`string`	The Bucket of the External Storage.
spaceExternalStorageInfo.prefix	`string`	The Prefix if the External Storage.
spaceExternalStorageInfo.scope	`object`	The scope of the External Storage.
spaceExternalStorageInfo.scope.workspaceId	`string`	The unique identifier of the Workspace.
spaceExternalStorageInfo.scope.networkId	`string`	The unique identifier of the Network.
spaceExternalStorageInfo.scope.enterpriseNetworkId	`string`	The unique identifier of the Enterprise Network.
spaceExternalStorageInfo.importConfigurations	`array`	The list of Import Configurations for the External Storage.
rootFolderId	`string`	The unique identifier of the default folder.
availableRenderTargets	`array`	Available custom transcode render profiles. These profiles are part of a Network that customer service can setup.
availableRenderTargets[].name	`string`	The target profile name.
availableRenderTargets[].key	`string`	The target profile key used when creating render jobs.
availableRenderTargets[].description	`string`	The description of the render target.

Headers

Content-Type: application/json

Body

{
  "code": "WorkspaceNotFound",
  "message": "Workspace not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Get Workspace Details
GET`/workspaces/{workspaceId}{?extraFields}`

URI Parameters

HideShow

workspaceId: string (required)
The unique identifier of the workspace.
extraFields: string (optional)
A comma separated list of extra fields to return in the response. If this value is empty, the extra fields will not be included in the response.

Description

Retrieves the information of the given workspace.

Errors

Status Code	Error Code	Message
404	WorkspaceNotFound	Workspace not found.

PUT https://api.cimediacloud.com/workspaces/ab8fcd95c99e4ba6a9f03f802311db74

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "name": "A new name for my Team Workspace",
  "storageAllotted": {
    "value": 50,
    "unit": "GB"
  },
  "manageMembersPrivilege": "WorkspaceAdmin",
  "purgeTrashPrivilege": "NetworkOwner",
  "isArchiveEnabled": true,
  "isAsperaEnabled": false,
  "isSidecarIngestEnabled": false,
  "note": "A note attached to the Workspace"
}

Property name	Type	Description
name	`string`	The name of the Workspace.
storageAllotted	`object`	Information about the storage to be allotted to the Workspace.
storageAllotted.value	`number` (required)	The size value to allocate.
storageAllotted.unit	`string`	The unit of size to allocate. This value can be `bytes`, `kilobytes`, `megabytes`, `gigabytes` or `terabytes`. Alternatively, you can supply their unit symbols: `B`, `KB`, `MB`, `GB`, `TB`. If omitted, defaults to `bytes`. Important: we are using 1024 as the base value for the multiples of the unit byte, so 1 KB = 1024 bytes, 1 MB = 1,048,576 bytes, etc.
manageMembersPrivilege	`string`	The minimum role level that will be allowed to manage the members of the Workspace. The valid values, ordered from less restrictive to more restrictive, are: `WorkspaceAdmin`, `WorkspaceOwner`, `NetworkAdmin`, `NetworkOwner`.
purgeTrashPrivilege	`string`	The minimum role level that will be allowed to purge the trashed files of the Workspace. The valid values, ordered from less restrictive to more restrictive, are: `WorkspaceAdmin`, `WorkspaceOwner`, `NetworkAdmin`, `NetworkOwner`.
isArchiveEnabled	`boolean`	Indicates if archiving files should be available for the Workspace.
isAsperaEnabled	`boolean`	Indicates if Aspera should be available for the Workspace.
isSidecarIngestEnabled	`boolean`	Indicates if the Sidecar Ingest feature is enabled. If omitted, defaults to `false`.
note	`string`	Text body for a user generated note for the Workspace.

Responses200400

Headers

Content-Type: application/json

Body

{
  "id": "bu1m7ii2zo8lexkq",
  "name": "My Team Workspace",
  "class": "Team",
  "rootFolderId": "oaeybnyoggs97nzw",
  "createdOn": "2017-01-02T00:00:00.000Z",
  "lastActivityOn": "2017-01-02T00:00:00.000Z",
  "assetCount": 0,
  "isDeleted": false,
  "plan": {
    "name": "Custom Workspace"
  },
  "storage": {
    "allotted": 1099511627776,
    "used": 0,
    "usedByAssets": 0,
    "usedByElements": 0
  },
  "network": {
    "id": "40c2a6b99a474b319dec5ef9c7dbb356",
    "name": "Company Name",
    "class": "Enterprise"
  },
  "owner": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith"
  },
  "createdBy": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith",
    "email": "johnsmith@example.com"
  },
  "entitlements": {
    "isAperaEnabled": true,
    "isArchiveEnabled": true,
    "isSidecarIngestEnabled": true
  },
  "userLastAccessedOn": "2017-01-02T00:00:00.000Z",
  "runtime": {
    "video": 1000024
  },
  "note": {
    "text": "I am a note.",
    "createdOn": "2017-01-02T00:00:00.000Z",
    "createdBy": {
      "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
      "name": "John Smith",
      "email": "johnsmith@example.com"
    },
    "modifiedOn": "2017-01-02T00:00:00.000Z",
    "modifiedBy": {
      "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
      "name": "John Smith",
      "email": "johnsmith@example.com"
    }
  },
  "spaceExternalStorageInfo": {
    "service": "S3",
    "region": "us-east",
    "bucket": "My-Bucket",
    "prefix": "/my-prefix",
    "scope": {
      "workspaceId": "6538b82537f3487687820f764ac9d831",
      "networkId": "ec34f210539447d9bf419ce9f0acdca9",
      "enterpriseNetworkId": "5752bf48ad4f4a37a359a5be801f48eb"
    },
    "importConfigurations": [
      {
        "id": "ab8fcd95c99e4ba6a9f03f802311db74",
        "source": {
          "region": "us-east-1",
          "bucket": "my-bucket",
          "prefix": "/my-prefix"
        },
        "target": {
          "workspace": {
            "id": "gb5ehomv0iv71swg",
            "name": "Workspace Name",
            "class": "Enterprise"
          },
          "folder": {
            "id": "9b639e12a82f4b0483f512b474dc052ci",
            "name": "Folder Name"
          }
        }
      }
    ]
  }
}

Property name	Type	Description
id	`string`	The unique identifier of the workspace.
name	`string`	The name of the workspace.
class	`string`	Indicates if it is a ‘Team’ or ‘Personal’ workspace.
rootFolderId	`string`	The unique identifier of the default folder.
createdOn	`string`	The datetime the workspace was created.
lastActivityOn	`string`	The datetime the last activity was recorded for the workspace.
assetCount	`number`	The total number of assets in the workspace.
isDeleted	`boolean`	Indicates whether the workspace is active or deleted. Note: listing a user’s workspaces will only return active workspaces.
plan	`object`	The subscription plan associated with this workspace.
plan.name	`string`	The display name of the subscription plan associated with the workspace.
storage	`object`	Information about Ci storage statistics for the workspace.
storage.allotted	`number`	The total storage capacity of the workspace, in bytes.
storage.used	`number`	The total storage used by the files (both assets and elements) in the workspace, in bytes.
storage.usedByAssets	`number`	The storage used by the assets in the workspace, in bytes.
storage.usedByElements	`number`	The storage used by the assets’ elements in the workspace, in bytes.
network	`object`	Information about workspace’s parent network.
network.id	`string`	The unique identifier of the Network.
network.name	`string`	The name of the Network.
network.class	`string`	Indicates if the Network is a ‘Personal’ or ‘Enterprise’ Network.
owner	`object`	Information about the owner of the workspace.
owner.id	`string`	The unique identifier of the user.
owner.name	`string`	The full name of the user.
createdBy	`object`	Information about the creator of the workspace.
createdBy.id	`string`	The unique identifier of the user.
createdBy.name	`string`	The full name of the user.
createdBy.email	`string`	The email of the user.
entitlements	`object`	Information about entitlements granted to this workspace.
entitlements.isAperaEnabled	`boolean`	Indicates if Aspera is available for this workspace.
entitlements.isArchiveEnabled	`boolean`	Indicates if archiving files is available for this workspace.
entitlements.isSidecarIngestEnabled	`boolean`	Indicates if the Sidecar Ingest feature is enabled for this workspace.
userLastAccessedOn	`string`	Indicates the last time the user accessed the workspace.
runtime	`object`	Information about the runtime of the asset.
runtime.video	`number`	The duration of all video assets in the workspace, in seconds.
note	`object`	User generated note field for the workspace.
note.text	`string`	The text body of the note.
note.createdOn	`string`	The datetime the note was created.
note.createdBy	`object`	Information about the creator of the note.
note.createdBy.id	`string`	The unique identifier of the user.
note.createdBy.name	`string`	The full name of the user.
note.createdBy.email	`string`	The email of the user.
note.modifiedOn	`string`	The datetime the note was last updated.
note.modifiedBy	`object`	Information about the last person to update the note.
note.modifiedBy.id	`string`	The unique identifier of the user.
note.modifiedBy.name	`string`	The full name of the user.
note.modifiedBy.email	`string`	The email of the user.
spaceExternalStorageInfo	`object`	The workspace’s external storage configuration (if any).
spaceExternalStorageInfo.service	`string`	The External Storage Service Provider Type.
spaceExternalStorageInfo.region	`string`	The Region of the External Storage.
spaceExternalStorageInfo.bucket	`string`	The Bucket of the External Storage.
spaceExternalStorageInfo.prefix	`string`	The Prefix if the External Storage.
spaceExternalStorageInfo.scope	`object`	The scope of the External Storage.
spaceExternalStorageInfo.scope.workspaceId	`string`	The unique identifier of the Workspace.
spaceExternalStorageInfo.scope.networkId	`string`	The unique identifier of the Network.
spaceExternalStorageInfo.scope.enterpriseNetworkId	`string`	The unique identifier of the Enterprise Network.
spaceExternalStorageInfo.importConfigurations	`array`	The list of Import Configurations for the External Storage.

Headers

Content-Type: application/json

Body

{
  "code": "WorkspaceNotFound",
  "message": "Workspace not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Update Workspace
PUT`/workspaces/{workspaceId}`

URI Parameters

HideShow

workspaceId: string (required)
Identifier of the Workspace.

Description

Updates an existing Workspace.

Errors

Status Code	Error Code	Message
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	MissingOrInvalidName	Missing or invalid name.
400	InvalidAllottedStorage	Invalid allotted storage.
400	InvalidRoleForPrivilege	Invalid role for one of the provided privileges.
400	AllottedStorageLessThanUsed	The requested allotted storage cannot be less than the current used storage.
400	InsufficientSpaceAvailable	Allotted storage for workspace will exceed the network’s allowed storage.
400	InvalidOperationOnPersonalNetwork	The requested operation cannot be performed on a Personal Network.
400	InvalidOperationOnWorkspace	The requested operation can only be performed on a Team Workspace.
403	InsufficientPermissions	Insufficient permissions for update Workspace name.
403	InsufficientPermissions	Insufficient permissions for update Workspace note.
403	InsufficientPermissions	Insufficient permissions for update Workspace settings.
404	WorkspaceNotFound	Workspace not found.

DELETE https://api.cimediacloud.com/workspaces/ab8fcd95c99e4ba6a9f03f802311db74

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200404

Headers

Content-Type: application/json

Headers

Content-Type: application/json

Body

{
  "code": "WorkspaceNotFound",
  "message": "Workspace not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Delete Workspace
DELETE`/workspaces/{workspaceId}`

URI Parameters

HideShow

workspaceId: string (required)
The unique identifier of the workspace.

Description

Deletes the specified Workspace and all its contents. The user needs to be a network administrator to perform this operation.

Errors

Status Code	Error Code	Message
404	WorkspaceNotFound	Workspace not found.
403	InsufficientPermissionsForDeleteWorkspace	Insufficient permissions for deleting the Workspace.

List User Workspaces ¶

GET https://api.cimediacloud.com/workspaces?limit=1&offset=0&orderBy=name&orderDirection=asc&fields=assetCount,storage&extraFields=externalStorage

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200400

Headers

Content-Type: application/json

Body

{
  "limit": 1,
  "offset": 0,
  "count": 10,
  "order": {
    "by": "Name",
    "direction": "asc"
  },
  "items": [
    {
      "id": "bu1m7ii2zo8lexkq",
      "name": "My Team Workspace",
      "class": "Team",
      "createdOn": "2017-01-02T00:00:00.000Z",
      "lastActivityOn": "2017-01-02T00:00:00.000Z",
      "assetCount": 105000,
      "isDeleted": false,
      "plan": {
        "id": "team-2",
        "name": "Team - Large"
      },
      "storage": {
        "allotted": 1099511627776,
        "used": 1073741824,
        "usedByAssets": 536870912,
        "usedByElements": 536870912
      },
      "network": {
        "id": "40c2a6b99a474b319dec5ef9c7dbb356",
        "name": "Company Name",
        "class": "Enterprise"
      },
      "owner": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith"
      },
      "createdBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "entitlements": {
        "isAperaEnabled": true,
        "isSidecarIngestEnabled": true
      },
      "bannerUrl": "https://cimediacloud.com/t5y7s3ero3w2ie7/banner.jpg",
      "logoUrl": "https://cimediacloud.com/t5y7s3ero3w2ie7/logo.jpg",
      "userRole": "WorkspaceOwner",
      "userInviteStatus": "Joined",
      "userLastAccessedOn": "2017-01-02T00:00:00.000Z",
      "runtime": {
        "video": 1000024
      },
      "note": {
        "text": "I am a note.",
        "createdOn": "2017-01-02T00:00:00.000Z",
        "createdBy": {
          "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
          "name": "John Smith",
          "email": "johnsmith@example.com"
        },
        "modifiedOn": "2017-01-02T00:00:00.000Z",
        "modifiedBy": {
          "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
          "name": "John Smith",
          "email": "johnsmith@example.com"
        }
      },
      "stats": {
        "activeCount": 10,
        "activeStorageUsed": 1024,
        "archivedCount": 10,
        "archivedStorageUsed": 1024,
        "recycledCount": 10,
        "recycledStorageUsed": 1024,
        "temporaryRestoredCount": 10,
        "temporaryRestoredStorageUsed": 1024,
        "storageAllotted": 10,
        "storageUsed": 1024,
        "dataTransferAllotted": 1024,
        "dataTransferUsed": 512
      },
      "spaceExternalStorageInfo": {
        "service": "S3",
        "region": "us-east",
        "bucket": "My-Bucket",
        "prefix": "/my-prefix",
        "scope": {
          "workspaceId": "6538b82537f3487687820f764ac9d831",
          "networkId": "ec34f210539447d9bf419ce9f0acdca9",
          "enterpriseNetworkId": "5752bf48ad4f4a37a359a5be801f48eb"
        },
        "importConfigurations": [
          {
            "id": "ab8fcd95c99e4ba6a9f03f802311db74",
            "source": {
              "region": "us-east-1",
              "bucket": "my-bucket",
              "prefix": "/my-prefix"
            },
            "target": {
              "workspace": {
                "id": "gb5ehomv0iv71swg",
                "name": "Workspace Name",
                "class": "Enterprise"
              },
              "folder": {
                "id": "9b639e12a82f4b0483f512b474dc052ci",
                "name": "Folder Name"
              }
            }
          }
        ]
      }
    }
  ]
}

Property name	Type	Description
limit	`number`	The limit used for the query.
offset	`number`	The offset used for the query.
count	`number`	The total count of items available.
order	`object`	Information about the ordering of the results.
order.by	`string`	Indicates the field used to sort the results.
order.direction	`string`	Indicates the direction used to sort the results.
items	`array`	The workspaces returned.
items[].id	`string`	The unique identifier of the workspace.
items[].name	`string`	The name of the workspace.
items[].class	`string`	Indicates if it is a ‘Team’ or ‘Personal’ workspace.
items[].createdOn	`string`	The datetime the workspace was created.
items[].lastActivityOn	`string`	The datetime the last activity was recorded for the workspace.
items[].assetCount	`number`	The total number of assets in the workspace.
items[].isDeleted	`boolean`	Indicates whether the workspace is active or deleted. Note: listing a user’s workspaces will only return active workspaces.
items[].plan	`object`	The subscription plan associated with this workspace.
items[].plan.id	`string`	The unique identifier of the subscription plan associated with the workspace.
items[].plan.name	`string`	The display name of the subscription plan associated with the workspace.
items[].storage	`object`	Information about Ci storage statistics for the workspace.
items[].storage.allotted	`number`	The total storage capacity of the workspace, in bytes.
items[].storage.used	`number`	The total storage used by the files (both assets and elements) in the workspace, in bytes.
items[].storage.usedByAssets	`number`	The storage used by the assets in the workspace, in bytes.
items[].storage.usedByElements	`number`	The storage used by the assets’ elements in the workspace, in bytes.
items[].network	`object`	Information about workspace’s parent network.
items[].network.id	`string`	The unique identifier of the Network.
items[].network.name	`string`	The name of the Network.
items[].network.class	`string`	Indicates if the Network is a ‘Personal’ or ‘Enterprise’ Network.
items[].owner	`object`	Information about the owner of the workspace.
items[].owner.id	`string`	The unique identifier of the user.
items[].owner.name	`string`	The full name of the user.
items[].createdBy	`object`	Information about the creator of the workspace.
items[].createdBy.id	`string`	The unique identifier of the user.
items[].createdBy.name	`string`	The full name of the user.
items[].createdBy.email	`string`	The email of the user.
items[].entitlements	`object`	Information about entitlements granted to this workspace.
items[].entitlements.isAperaEnabled	`boolean`	Indicates if Aspera is available for this workspace.
items[].entitlements.isSidecarIngestEnabled	`boolean`	Indicates if the Sidecar Ingest feature is enabled for this workspace.
items[].bannerUrl	`string`	If available, the link to the banner image.
items[].logoUrl	`string`	If available, the link to the logo image.
items[].userRole	`string`	Indicates the role of the user in the Workspace. Supported values are ‘WorkspaceAdmin’ and ‘WorkspaceOwner’.
items[].userInviteStatus	`string`	Indicates the status of the user in the Workspace. Supported values are ‘Invited’, ‘Joined’.
items[].userLastAccessedOn	`string`	Indicates the last time the user accessed the workspace.
items[].runtime	`object`	Information about the runtime of the asset.
items[].runtime.video	`number`	The duration of all video assets in the workspace, in seconds.
items[].note	`object`	User generated note field for the workspace.
items[].note.text	`string`	The text body of the note.
items[].note.createdOn	`string`	The datetime the note was created.
items[].note.createdBy	`object`	Information about the creator of the note.
items[].note.createdBy.id	`string`	The unique identifier of the user.
items[].note.createdBy.name	`string`	The full name of the user.
items[].note.createdBy.email	`string`	The email of the user.
items[].note.modifiedOn	`string`	The datetime the note was last updated.
items[].note.modifiedBy	`object`	Information about the last person to update the note.
items[].note.modifiedBy.id	`string`	The unique identifier of the user.
items[].note.modifiedBy.name	`string`	The full name of the user.
items[].note.modifiedBy.email	`string`	The email of the user.
items[].stats	`object`	Data storage and data transfer stats for the Workspace.
items[].stats.activeCount	`number`	The number of files that are uploaded and not trashed, archived or restored.
items[].stats.activeStorageUsed	`number`	The total size of files (in bytes) that are uploaded and not trashed, archived or restored.
items[].stats.archivedCount	`number`	The number of files that are archived.
items[].stats.archivedStorageUsed	`number`	The total size of files (in bytes) that are archived.
items[].stats.recycledCount	`number`	The number of files that are in the trash.
items[].stats.recycledStorageUsed	`number`	The total size of files (in bytes) that are in the trash.
items[].stats.temporaryRestoredCount	`number`	The number of files (in bytes) that are in temporarily restored.
items[].stats.temporaryRestoredStorageUsed	`number`	The total size of files (in bytes) that are in temporarily restored.
items[].stats.storageAllotted	`number`	The total storage allotted for this Workspace.
items[].stats.storageUsed	`number`	The total storage used (in bytes) for this Workspace (excluding deleted or archived files, note: this number does include temporarily restored files).
items[].stats.dataTransferAllotted	`number`	The total data transfer (upload and download) allotted for this Workspace (in bytes).
items[].stats.dataTransferUsed	`number`	The total data transfer (upload and download) used for this Workspace (in bytes).
items[].spaceExternalStorageInfo	`object`	The workspace’s external storage configuration (if any).
items[].spaceExternalStorageInfo.service	`string`	The External Storage Service Provider Type.
items[].spaceExternalStorageInfo.region	`string`	The Region of the External Storage.
items[].spaceExternalStorageInfo.bucket	`string`	The Bucket of the External Storage.
items[].spaceExternalStorageInfo.prefix	`string`	The Prefix if the External Storage.
items[].spaceExternalStorageInfo.scope	`object`	The scope of the External Storage.
items[].spaceExternalStorageInfo.scope.workspaceId	`string`	The unique identifier of the Workspace.
items[].spaceExternalStorageInfo.scope.networkId	`string`	The unique identifier of the Network.
items[].spaceExternalStorageInfo.scope.enterpriseNetworkId	`string`	The unique identifier of the Enterprise Network.
items[].spaceExternalStorageInfo.importConfigurations	`array`	The list of Import Configurations for the External Storage.

Headers

Content-Type: application/json

Body

{
  "code": "InvalidLimitOrOffset",
  "message": "Invalid limit or offset value."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

List User Workspaces
GET`/workspaces{?limit,offset,orderBy,orderDirection,fields,extraFields}`

URI Parameters

HideShow

limit

number (optional) Default: 50

The number of workspaces to return. The maximum is 500.

offset

number (optional) Default: 0

The item at which to begin the response.

orderBy

string (optional) Default: name

The field to sort the items by.

Choices: createdOn name networkName lastActivityOn

orderDirection

string (optional) Default: asc

The order direction the items should be returned.

Choices: asc desc

fields

string (optional)

A comma separated list of fields to return in the response. If this value is empty all fields will be returned. Id and Name are always returned.

extraFields

string (optional)

A comma separated list of extra fields to return in the response. If this value is empty, the extra fields will not be included in the response.

Description

Retrieves all workspaces the calling user has access to.

It is suggested to use the fields parameter to specify that only required fields are returned. Doing this can give significant performance gains. Only first level field names are accepted for inclusion (therefore you cannot choose specific sub-fields to include, you must choose to include the entire parent field).

Errors

Status Code	Error Code	Message
400	InvalidLimitOrOffset	Invalid limit or offset value. Limit must be a number between 1 and 500. Offset must be greater than or equal to 0.
400	InvalidQueryOrderField	Invalid order field. It must be either ‘CreatedOn’, ‘Name’, ‘NetworkName’ or ‘LastActivityOn’.
400	InvalidQueryOrderDirection	Invalid order direction. It must be either ‘Asc’ or ‘Desc’.

List Workspaces Contents ¶

GET https://api.cimediacloud.com/workspaces/moqxhkej4epvgrwz/contents?kind=all&type=all&limit=1&offset=0&orderBy=name&orderDirection=asc&fields=name,thumbnails&extraFields=commentStats

Requestsexample with asset in responseexample with folder in response

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200404

Headers

Content-Type: application/json

Body

{
  "limit": 1,
  "offset": 0,
  "count": 10,
  "order": {
    "by": "Name",
    "direction": "asc"
  },
  "kind": [
    "All"
  ],
  "type": [
    "All"
  ],
  "items": [
    {
      "id": "bcdc34b53e2c4c18ac41ca288e28d11f",
      "name": "Movie.mov",
      "size": 107856722,
      "type": "Video",
      "format": "mov",
      "folder": {
        "id": "9b639e12a82f4b0483f512b474dc052ci",
        "name": "Folder Name"
      },
      "status": "Complete",
      "description": "Final cut",
      "thumbnails": [
        {
          "type": "large",
          "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/thumb.jpg",
          "size": 1024,
          "width": 200,
          "height": 300,
          "source": {
            "id": "elementId1",
            "kind": "element"
          },
          "isExternal": false
        }
      ],
      "proxies": [
        {
          "type": "video-3g",
          "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/proxy.jpg",
          "size": 1024,
          "width": 200,
          "height": 300,
          "videoBitRate": 1650000,
          "audioBitRate": 128000,
          "isExternal": false
        }
      ],
      "md5Checksum": "tk2ma0zrhrp5irco",
      "createdOn": "2017-01-02T00:00:00.000Z",
      "createdBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "modifiedOn": "2017-01-02T00:00:00.000Z",
      "lastActivityOn": "2017-01-03T00:00:00.000Z",
      "acquisitionSource": {
        "name": "Workspace"
      },
      "archiveStatus": "Not archived",
      "archiveType": "Standard",
      "restoreStatus": "Not restored",
      "restoreExpirationDate": "2017-01-02T00:00:00.000Z",
      "restoreRequestDate": "2017-01-02T00:00:00.000Z",
      "lastRestoreDate": "2017-01-02T00:00:00.000Z",
      "restoredBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "archiveDate": "2017-01-02T00:00:00.000Z",
      "archivedBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "uploadCompleteDate": "2017-01-02T00:00:00.000Z",
      "isTrashed": false,
      "uploadTransferType": "SinglepartHttp",
      "runtime": 1024,
      "totalFolderCount": 1,
      "network": {
        "id": "40c2a6b99a474b319dec5ef9c7dbb356",
        "name": "Company Name",
        "class": "Enterprise"
      },
      "metadata": [
        {
          "name": "resolution",
          "value": "1080p",
          "readOnly": false
        }
      ],
      "technicalMetadata": {
        "type": "Video",
        "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/metadata.jpg",
        "size": 1024,
        "image": {
          "width": 100,
          "height": 300,
          "xResolution": 100,
          "yResolution": 100,
          "resolutionUnit": "cm",
          "cameraMake": "Nikon",
          "cameraModel": "D300",
          "groupingInfo": "6445055e520106d9d01769fffefd058901000100000000000000",
          "umidBasic": "060a2b340101010501010143130000006445055e520106cbd01769fffefd0589",
          "materialNumber": "6445055e520106cbd01769fffefd0589",
          "recordedDate": "2023-07-27T01:39:24Z",
          "locationCity": "New York",
          "locationState": "NY",
          "locationCountry": "USA",
          "exif": {
            "imageWidth": "3888",
            "imageHeight": "2592",
            "artist": "Michael W. Steidl.",
            "copyright": "(c) 2011 IPTC - Rights reserved."
          },
          "iptc": {
            "codedCharacterSet": "UTF8",
            "headline": "Bikefestival Vienna",
            "credit": "IPTC/Michael W. Steidl",
            "keywords": "Vienna Air King,cycling,mountain bike"
          },
          "xmp": {
            "serialNumber": "0380227035",
            "creatorRegion": "Roshire",
            "lens": "EF70-300mm f/4-5.6L IS USM",
            "creatorCountry": "United Kingdom"
          }
        },
        "avContainer": {
          "bitRate": 11934620,
          "duration": 100,
          "start": 0,
          "recordedDate": "2022-11-21T06:42:41Z",
          "deviceManufacturer": "Sony",
          "timeCode": "00:00:00:00",
          "derivedTimeCode": "00:00:00:00",
          "streams": [
            {
              "index": 0,
              "type": "Video",
              "bitRate": 11934620,
              "bitDepth": 8,
              "bitRateMode": "CBR",
              "codec": "h264",
              "codecName": "ProRes",
              "codecProfile": "422 HQ",
              "codecSettings": "Little / Signed",
              "fourCC": "avc1",
              "width": 1280,
              "height": 720,
              "totalFrames": 1024,
              "duration": 100,
              "frameRateNumerator": 360,
              "frameRateDenominator": 12,
              "videoPARWidth": 1,
              "videoPARHeight": 1,
              "videoDARWidth": 19,
              "videoDARHeight": 24,
              "start": 0,
              "timeCode": "00:00:00:00",
              "videoColorSpace": "bt709",
              "videoScanOrder": "TFF",
              "videoScanType": "Interlaced",
              "videoColorPrimaries": "DCI P3",
              "videoChromaSubsampling": "4:2:2",
              "videoScanTypeStoreMethod": "Interleaved fields",
              "audioSampleRate": 32000,
              "audioChannelCount": 2,
              "audioLayout": "Stereo",
              "audioAnalysis": "Stereo",
              "rotate": 0
            }
          ]
        },
        "dolbyContainer": {
          "duration": 9.6,
          "fileSize": 80294994,
          "overallBitRateMode": "CBR",
          "overallBitRate": 66912495,
          "totalChannels": 58,
          "bedChannels": 10,
          "numberOfBeds": 1,
          "bitDepth": 24,
          "samplingRate": 48000,
          "downmix51X": "Direct Render",
          "trimModesSummary": "automatic + manual_0",
          "trimChannel20Mode": "manual_0",
          "trimChannel51Mode": "manual_0",
          "trimChannel71Mode": "automatic",
          "trimChannel212Mode": "manual_0",
          "trimChannel512Mode": "automatic",
          "trimChannel712Mode": "manual_0",
          "trimChannel214Mode": "manual_0",
          "trimChannel514Mode": "manual_0",
          "trimChannel714Mode": "manual_0",
          "associatedVideoFrameRate": 23.976,
          "start": "01:00:00:00",
          "fFoA": "01:00:00:00",
          "end": "01:03:30:13",
          "metadataFormat": "ADM, Version 0",
          "admProfile": "Dolby Atmos Master, Version 1",
          "numberOfProgrammes": 1,
          "numberOfObjectChannels": 48,
          "numberOfPackFormats": 49,
          "numberOfChannelFormats": 58,
          "binauralRenderModesSummary": "Off + Near + Mid + Far",
          "binauralRenderModesOffCount": 9,
          "binauralRenderModesNearCount": 8,
          "binauralRenderModesMidCount": 13,
          "binauralRenderModesFarCount": 1,
          "truePeakLevels": -3.14,
          "loudness": -16.67
        }
      },
      "hlsPlaylistUrl": "https://cimediacloud.com/t5y7s3ero3w2ie7/hls",
      "acquisitionContext": {
        "name": "Movie1.mov",
        "path": "original/source/path"
      },
      "isExternal": false,
      "workspace": {
        "id": "gb5ehomv0iv71swg",
        "name": "Workspace Name",
        "class": "Enterprise"
      },
      "kind": "Asset"
    }
  ]
}

Property name	Type	Description
limit	`number`	The limit used for the query.
offset	`number`	The offset used for the query.
count	`number`	The total count of items available.
order	`object`	Information about the ordering of the results.
order.by	`string`	Indicates the field used to sort the results.
order.direction	`string`	Indicates the direction used to sort the results.
kind	`array`	Indicates the kind filter used in the request. Returned values are ‘All’, ‘Asset’, and ‘Folder’.
type	`array`	Indicates the type filter used in the request. Returned values are ‘image’, ‘video’, ‘audio’, ‘document’, ‘timedtext’, or ‘other’.
items	`array`	The items returned. Can be both assets and folders.
items[].id	`string`	The unique identifier of the asset.
items[].name	`string`	The name of the asset, including its extension. Its maximum length is 512 characters.
items[].size	`number`	The size of the source file, in bytes.
items[].type	`string`	The type of the asset. Valid values are `Audio`, `Video`, `Image`, `Document`, or `Other`.
items[].format	`string`	The asset’s file format.
items[].folder	`object`	Information about the asset’s parent folder.
items[].folder.id	`string`	The unique identifier of the folder.
items[].folder.name	`string`	The name of folder.
items[].status	`string`	The status of the asset. Valid values are ‘Created’, ‘Complete’, ‘Deleted’, ‘Executable Detected’, ‘Failed’, ‘Limited’, ‘Processing’, ‘Uploading’, ‘Virus Detected’, ‘Waiting’. See this section for more information.
items[].description	`string`	A comment or note associated to the asset. Its maximum length is 1000 characters.
items[].thumbnails	`array`	The set of thumbnails for the asset.
items[].thumbnails[].type	`string`	The type of thumbnail returned. Valid values are ‘small’, ‘medium’ and ‘large’.
items[].thumbnails[].location	`string`	The url of the thumbnail.
items[].thumbnails[].size	`number`	The size of the thumbnail, in bytes.
items[].thumbnails[].width	`number`	The width of the thumbnail.
items[].thumbnails[].height	`number`	The height of the thumbnail.
items[].thumbnails[].source	`object`	Information about the source of thumbnails.
items[].thumbnails[].source.id	`string`	Unique identifier of the thumbnail’s source.
items[].thumbnails[].source.kind	`string`	The kind of entity of the thumbnail’s source.
items[].thumbnails[].isExternal	`boolean`	Indicates if the thumbnail is stored in an external source.
items[].proxies	`array`	The set of proxies for the asset.
items[].proxies[].type	`string`	The type of proxy returned. Valid values are ‘standard-audio’, ‘dolby-audio’, ‘video-3g’, ‘video-sd’, ‘video-sdplus’, ‘video-hd’, ‘video-2k’, ‘video-2kplus’, ‘document-pdf’.
items[].proxies[].location	`string`	The url of the proxy.
items[].proxies[].size	`number`	The size of the proxy, in bytes.
items[].proxies[].width	`number`	The width of the proxy.
items[].proxies[].height	`number`	The height of the proxy.
items[].proxies[].videoBitRate	`number`	The video bitrate of the proxy.
items[].proxies[].audioBitRate	`number`	The audio bitrate of the proxy.
items[].proxies[].isExternal	`boolean`	Indicates if the proxy is stored in an external source.
items[].md5Checksum	`string`	The calculated md5 checksum for the asset.
items[].createdOn	`string`	The datetime the asset record was created.
items[].createdBy	`object`	Information about the creator of the asset
items[].createdBy.id	`string`	The unique identifier of the user.
items[].createdBy.name	`string`	The full name of the user.
items[].createdBy.email	`string`	The email of the user.
items[].modifiedOn	`string`	The datetime the asset record was last modified.
items[].lastActivityOn	`string`	The datetime of the last activity of the asset record.
items[].acquisitionSource	`object`	Information about the asset’s source client application.
items[].acquisitionSource.name	`string`	The name of the client application that uploaded the asset.
items[].archiveStatus	`string`	The archive status of the asset. Valid values are ‘Not archived’, ‘Archive in progress’, ‘Archive failed’, ‘Archived’, ‘Cancel archive in progress’.
items[].archiveType	`string`	If available, the kind of archive used for storing the asset. Valid values are `Standard` and `Deep`.
items[].restoreStatus	`string`	The restore status of the asset. This is applicable to assets that have been archived. Valid values are ‘Not restored’, ‘Restore in progress’, ‘Restore failed’, ‘Restored’.
items[].restoreExpirationDate	`string`	If available, the datetime the restored copy of the asset’s source file will no longer be available.
items[].restoreRequestDate	`string`	If available, the datetime the asset’s source file was requested to be restored.
items[].lastRestoreDate	`string`	If available, the datetime the asset’s source file was last restored.
items[].restoredBy	`object`	If available, information about the user who restored the asset.
items[].restoredBy.id	`string`	The unique identifier of the user.
items[].restoredBy.name	`string`	The full name of the user.
items[].restoredBy.email	`string`	The email of the user.
items[].archiveDate	`string`	If available, the datetime the asset’s source file was last archived.
items[].archivedBy	`object`	If available, information about the user who archived the asset.
items[].archivedBy.id	`string`	The unique identifier of the user.
items[].archivedBy.name	`string`	The full name of the user.
items[].archivedBy.email	`string`	The email of the user.
items[].uploadCompleteDate	`string`	The datetime the asset upload was completed.
items[].isTrashed	`boolean`	Indicates if an asset is in the trash bin.
items[].uploadTransferType	`string`	Indicates how the asset was uploaded. Valid values are ‘SinglepartHttp’, ‘MultipartHttp’, ‘Aspera’, ‘Copy’, ‘FTP’, ‘WorkspaceSend’.
items[].runtime	`number`	The duration of the media asset, in seconds.
items[].totalFolderCount	`number`	The amount of folders where the asset exists.
items[].network	`object`	Information about the asset’s network.
items[].network.id	`string`	The unique identifier of the Network.
items[].network.name	`string`	The name of the Network.
items[].network.class	`string`	Indicates if the Network is a ‘Personal’ or ‘Enterprise’ Network.
items[].metadata	`array`	An array of key-value pairs of user-generated and basic technical metadata.
items[].metadata[].name	`string`	The name of the metadata item.
items[].metadata[].value	`string`	the value of the metadata item.
items[].metadata[].readOnly	`boolean`	Flag to set a read-only metadata.
items[].technicalMetadata	`object`	An object that contains all the technical metadata available.
items[].technicalMetadata.type	`string`	The type of the asset. Valid values are either ‘Audio’, ‘Video’ or ‘Image’.
items[].technicalMetadata.location	`string`	Url of the source technical metadata file. Note: the content and structure of the technical metadata file is subject to change at any time.
items[].technicalMetadata.size	`number`	The size of the technical metadata file, in bytes.
items[].technicalMetadata.image	`object`	If the asset’s type is ‘Image’, this property contains the extended image technical metadata.
items[].technicalMetadata.image.width	`number`	The width of the image, in pixels.
items[].technicalMetadata.image.height	`number`	The height of the image, in pixels.
items[].technicalMetadata.image.xResolution	`number`	The number of pixels per resolutionUnit in the width direction.
items[].technicalMetadata.image.yResolution	`number`	The number of pixels per resolutionUnit in the height direction.
items[].technicalMetadata.image.resolutionUnit	`string`	The unit of measurement for xResolution and yResolution. Can be ‘inches’, ‘cm’ or ‘none’.
items[].technicalMetadata.image.cameraMake	`string`	Camera manufacturer name.
items[].technicalMetadata.image.cameraModel	`string`	Camera model name.
items[].technicalMetadata.image.groupingInfo	`string`	If available, the grouping info of the image. String of hexadecimal value (52 characteres) for the byte array object. Byte array order is Litte Endian.
items[].technicalMetadata.image.umidBasic	`string`	If available, the umid basic info of the image. String of hexadecimal value (64 characteres) for the byte array object.
items[].technicalMetadata.image.materialNumber	`string`	If available, the material number of the image. String of hexadecimal value (32 characteres) for the byte array object.
items[].technicalMetadata.image.recordedDate	`string`	The date and Time at which the image was captured.
items[].technicalMetadata.image.locationCity	`string`	Name of the city where the image was created.
items[].technicalMetadata.image.locationState	`string`	Name of the state where the image was created.
items[].technicalMetadata.image.locationCountry	`string`	Name of the country where the image was created.
items[].technicalMetadata.image.exif	`object`	The avalaible EXIF (Exchangeable Image File) metadata.
items[].technicalMetadata.image.exif.imageWidth	`string`	The image width in pixels.
items[].technicalMetadata.image.exif.imageHeight	`string`	The image height in pixels.
items[].technicalMetadata.image.exif.artist	`string`	The image artist info.
items[].technicalMetadata.image.exif.copyright	`string`	The image copyright.
items[].technicalMetadata.image.iptc	`object`	The available IPTC (International Press Telecommunications Council) available.
items[].technicalMetadata.image.iptc.codedCharacterSet	`string`	Determines how the internal IPTC string values are interpreted.
items[].technicalMetadata.image.iptc.headline	`string`	Brief synopsis or summary of the contents of the photograph.
items[].technicalMetadata.image.iptc.credit	`string`	How the image should be credited when published, as specified by the supplier of the image.
items[].technicalMetadata.image.iptc.keywords	`string`	Descriptive words added to the image to enable search and retrieval.
items[].technicalMetadata.image.xmp	`object`	The available XMP (Extensible Metadata Platform) metadata.
items[].technicalMetadata.image.xmp.serialNumber	`string`	Camera Serial Number.
items[].technicalMetadata.image.xmp.creatorRegion	`string`	State / Province for the address of the person that created this image.
items[].technicalMetadata.image.xmp.lens	`string`	Attempts to identify the camera lens used.
items[].technicalMetadata.image.xmp.creatorCountry	`string`	Country name for the address of the person that created this image.
items[].technicalMetadata.avContainer	`object`	If asset type is ‘Audio’ or ‘Video’, this property contains the extended audio / video technical metadata.
items[].technicalMetadata.avContainer.bitRate	`number`	The overall bitrate in the container.
items[].technicalMetadata.avContainer.duration	`number`	The runtime of the media in the container, in seconds.
items[].technicalMetadata.avContainer.start	`number`	The start time in the container, in seconds.
items[].technicalMetadata.avContainer.recordedDate	`string`	The date and Time at which the video was captured.
items[].technicalMetadata.avContainer.deviceManufacturer	`string`	The name of the device Manufacturer.
items[].technicalMetadata.avContainer.timeCode	`string`	The SMPTE timecode in the container.
items[].technicalMetadata.avContainer.derivedTimeCode	`string`	The standardized timecode derived by evaluating stream metadata and converting to drop frame format, if using drop frame rate.
items[].technicalMetadata.avContainer.streams	`array`	Set of audio, video, or data streams contained in the asset.
items[].technicalMetadata.avContainer.streams[].index	`number`	The index of the stream in the container.
items[].technicalMetadata.avContainer.streams[].type	`string`	The type of the stream. Valid values are `Audio`, `Video` or `Data`.
items[].technicalMetadata.avContainer.streams[].bitRate	`number`	If available, the overall bitrate in the stream.
items[].technicalMetadata.avContainer.streams[].bitDepth	`number`	If available, for an `Audio` stream, the bit depth of the stream.
items[].technicalMetadata.avContainer.streams[].bitRateMode	`string`	If available, the bit rate mode of the stream.
items[].technicalMetadata.avContainer.streams[].codec	`string`	If available, the codec used in the stream. For example, `h264`.
items[].technicalMetadata.avContainer.streams[].codecName	`string`	If available, the MediaInfo generated format commercial name for the stream.
items[].technicalMetadata.avContainer.streams[].codecProfile	`string`	If available, the MediaInfo generated format profile for the stream.
items[].technicalMetadata.avContainer.streams[].codecSettings	`string`	If avalable, the MediaInfo generated format settings for the stream.
items[].technicalMetadata.avContainer.streams[].fourCC	`string`	If available, four-character code for the codec used in the stream. For example, `avc1`, `apch`.
items[].technicalMetadata.avContainer.streams[].width	`number`	If available, for a `Video` stream, the width in pixels of the video.
items[].technicalMetadata.avContainer.streams[].height	`number`	If available, for a `Video` stream, the height in pixels of the video.
items[].technicalMetadata.avContainer.streams[].totalFrames	`number`	If available, total number of frames within the `Video` stream.
items[].technicalMetadata.avContainer.streams[].duration	`number`	If available, the runtime of the media in seconds.
items[].technicalMetadata.avContainer.streams[].frameRateNumerator	`number`	If available, the numerator of the frame rate. For example, if the frame rate is 24, the frame rate numerator is 24.
items[].technicalMetadata.avContainer.streams[].frameRateDenominator	`number`	If available, the numerator of the frame rate. For example, if the frame rate is 24, the frame rate denominator is 1.
items[].technicalMetadata.avContainer.streams[].videoPARWidth	`number`	If available, the width part of the pixel aspect ratio.
items[].technicalMetadata.avContainer.streams[].videoPARHeight	`number`	If available, the height part of the pixel aspect ratio.
items[].technicalMetadata.avContainer.streams[].videoDARWidth	`number`	If available, the width part of the display aspect ratio.
items[].technicalMetadata.avContainer.streams[].videoDARHeight	`number`	If available, the height part of the display aspect ratio.
items[].technicalMetadata.avContainer.streams[].start	`number`	If available, the start time in the stream, in seconds.
items[].technicalMetadata.avContainer.streams[].timeCode	`string`	If available, the SMPTE timecode in the stream.
items[].technicalMetadata.avContainer.streams[].videoColorSpace	`string`	If available, for a `Video` stream, the video’s color space / color primaries.
items[].technicalMetadata.avContainer.streams[].videoScanOrder	`string`	If available, for a `Video` stream, the video’s scan order.
items[].technicalMetadata.avContainer.streams[].videoScanType	`string`	If available, for a `Video` stream, the video’s scan type.
items[].technicalMetadata.avContainer.streams[].videoColorPrimaries	`string`	If available, for a `Video` stream, the video’s color primaries.
items[].technicalMetadata.avContainer.streams[].videoChromaSubsampling	`string`	If available, for a `Video` stream, the video’s crhoma subsampling.
items[].technicalMetadata.avContainer.streams[].videoScanTypeStoreMethod	`string`	If available, for a `Video` stream, the video’s scan type store method.
items[].technicalMetadata.avContainer.streams[].audioSampleRate	`number`	If available, for an `Audio` stream, is the sample rate in Hz.
items[].technicalMetadata.avContainer.streams[].audioChannelCount	`number`	If available, for an `Audio` stream, is the number of channels within the stream.
items[].technicalMetadata.avContainer.streams[].audioLayout	`string`	If available, for an `Audio` stream, is the audio channel layout description. For example, `5.1`.
items[].technicalMetadata.avContainer.streams[].audioAnalysis	`string`	If available, for an `Audio` stream, it is further analysis to determine if a stream is true stereo or dual-mono.
items[].technicalMetadata.avContainer.streams[].rotate	`number`	If available, the amount of rotation, in degrees, that should be applied during playback of the video.
items[].technicalMetadata.dolbyContainer	`object`	If asset type is ‘Audio’ and the asset has Dolby Atmos metadata, this property contains the extended Dolby Atmos audio technical metadata.
items[].technicalMetadata.dolbyContainer.duration	`number`	Media duration (in seconds).
items[].technicalMetadata.dolbyContainer.fileSize	`number`	Media size (in bytes).
items[].technicalMetadata.dolbyContainer.overallBitRateMode	`string`	The overall bitrate mode for the Atmos content.
items[].technicalMetadata.dolbyContainer.overallBitRate	`number`	Media bitrate (in bits per second).
items[].technicalMetadata.dolbyContainer.totalChannels	`number`	Number of channels. `Bed channels` plus `Object channels` equals `Total channels`.
items[].technicalMetadata.dolbyContainer.bedChannels	`number`	Number of channel-based premix or stem that includes multichannel panning.
items[].technicalMetadata.dolbyContainer.numberOfBeds	`number`	A bed can be thought of as a traditional channel-based stem with the rules and expectations of stem configurations (such as 2.0, 5.1, and 7.1).
items[].technicalMetadata.dolbyContainer.bitDepth	`number`	Number of bits of information in each sample, generally 16, 24, or 32-bit.
items[].technicalMetadata.dolbyContainer.samplingRate	`number`	Audio sample-rate, generally 44100 or 48000 Hz.
items[].technicalMetadata.dolbyContainer.downmix51X	`string`	Global downmix metadata for monitoring, re-rendering, and encoding.
items[].technicalMetadata.dolbyContainer.trimModesSummary	`string`	A summary of the underlying trim modes.
items[].technicalMetadata.dolbyContainer.trimChannel20Mode	`string`	The type of trim mode supported for 2.0 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel51Mode	`string`	The type of trim mode supported for 5.1 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel71Mode	`string`	The type of trim mode supported for 7.1 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel212Mode	`string`	The type of trim mode supported for 2.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel512Mode	`string`	The type of trim mode supported for 5.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel712Mode	`string`	The type of trim mode supported for 7.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel214Mode	`string`	The type of trim mode supported for 2.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel514Mode	`string`	The type of trim mode supported for 5.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel714Mode	`string`	The type of trim mode supported for 7.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.associatedVideoFrameRate	`number`	Number of frames per second.
items[].technicalMetadata.dolbyContainer.start	`string`	Start SMPTE timecode based on the video frame rate.
items[].technicalMetadata.dolbyContainer.fFoA	`string`	FFoA (First Frame of Action) SMPTE timecode based on the video frame rate.
items[].technicalMetadata.dolbyContainer.end	`string`	End SMPTE timecode based on the video frame rate.
items[].technicalMetadata.dolbyContainer.metadataFormat	`string`	Format of the metadata in the Atmos content.
items[].technicalMetadata.dolbyContainer.admProfile	`string`	ADM (Audio Definition Model) Profile used in the Atmos content.
items[].technicalMetadata.dolbyContainer.numberOfProgrammes	`number`	Number of programmes in the Atmos content.
items[].technicalMetadata.dolbyContainer.numberOfObjectChannels	`number`	Number of objects in the Atmos Master.
items[].technicalMetadata.dolbyContainer.numberOfPackFormats	`number`	Number of Atmos Pack Formats in the Atmos content.
items[].technicalMetadata.dolbyContainer.numberOfChannelFormats	`number`	Number of channel formats in the Atmos content.
items[].technicalMetadata.dolbyContainer.binauralRenderModesSummary	`string`	Summary of all the binaural render modes used in the Atmos content. Supported strings are a unique combination of: “Off”, “Near”, “Mid”, “Far”.
items[].technicalMetadata.dolbyContainer.binauralRenderModesOffCount	`number`	Number of channels that use the “Off” setting for binaural rendering.
items[].technicalMetadata.dolbyContainer.binauralRenderModesNearCount	`number`	Number of channels that use the “Near” setting for binaural rendering.
items[].technicalMetadata.dolbyContainer.binauralRenderModesMidCount	`number`	Number of channels that use the “Mid” setting for binaural rendering.
items[].technicalMetadata.dolbyContainer.binauralRenderModesFarCount	`number`	Number of channels that use the “Far” setting for binaural rendering.
items[].technicalMetadata.dolbyContainer.truePeakLevels	`number`	The peak event in the audio waveform. Units are dBTP for true peak.
items[].technicalMetadata.dolbyContainer.loudness	`number`	Integrated loudness LKFS (or LUFS).
items[].hlsPlaylistUrl	`string`	A link to the HLS playlist generated from the source file.
items[].acquisitionContext	`object`	The file acquisition information.
items[].acquisitionContext.name	`string`	The original source file name, captured on acquisition.
items[].acquisitionContext.path	`string`	The original source file path, captured on acquisition.
items[].isExternal	`boolean`	Indicates if the file is stored in an external source.
items[].workspace	`object`	Information about the asset’s workspace.
items[].workspace.id	`string`	The unique identifier of the Workspace.
items[].workspace.name	`string`	The name of the Workspace.
items[].workspace.class	`string`	Indicates if the Workspace is a ‘Personal’ or ‘Team’ Workspace.
items[].kind	`string`	The type of item returned. Will always be ‘Asset’ for assets.

Headers

Content-Type: application/json

Body

{
  "code": "WorkspaceNotFound",
  "message": "Workspace not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200404

Headers

Content-Type: application/json

Body

{
  "limit": 1,
  "offset": 0,
  "count": 10,
  "order": {
    "by": "Name",
    "direction": "asc"
  },
  "kind": [
    "All"
  ],
  "type": [
    "All"
  ],
  "items": [
    {
      "id": "9b639e12a82f4b0483f512b474dc052ci",
      "name": "My Folder",
      "createdOn": "2017-01-02T00:00:00.000Z",
      "createdBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "lastActivityOn": "2017-01-03T00:00:00.000Z",
      "network": {
        "id": "40c2a6b99a474b319dec5ef9c7dbb356",
        "name": "Company Name",
        "class": "Enterprise"
      },
      "metadata": [
        {
          "name": "intendedFor",
          "value": "landscapeImages"
        }
      ],
      "stats": {
        "childFolderCount": 2
      },
      "parentId": "nqyptt047b7qc9y3",
      "workspace": {
        "id": "gb5ehomv0iv71swg",
        "name": "Workspace Name",
        "class": "Enterprise"
      },
      "parentFolder": {
        "id": "9b639e12a82f4b0483f512b474dc052ci",
        "name": "Folder Name"
      },
      "isTrashed": false,
      "kind": "Folder"
    }
  ]
}

Property name	Type	Description
limit	`number`	The limit used for the query.
offset	`number`	The offset used for the query.
count	`number`	The total count of items available.
order	`object`	Information about the ordering of the results.
order.by	`string`	Indicates the field used to sort the results.
order.direction	`string`	Indicates the direction used to sort the results.
kind	`array`	Indicates the kind filter used in the request. Returned values are ‘All’, ‘Asset’, and ‘Folder’.
type	`array`	Indicates the type filter used in the request. Returned values are ‘image’, ‘video’, ‘audio’, ‘document’, ‘timedtext’, or ‘other’.
items	`array`	The items returned. Can be both assets and folders.
items[].id	`string`	The unique identifier of folder.
items[].name	`string`	The name of the folder.
items[].createdOn	`string`	The datetime the folder was created.
items[].createdBy	`object`	Information about the creator of the folder.
items[].createdBy.id	`string`	The unique identifier of the user.
items[].createdBy.name	`string`	The full name of the user.
items[].createdBy.email	`string`	The email of the user.
items[].lastActivityOn	`string`	The datetime of the last activity of the folder.
items[].network	`object`	Information about the folder’s parent network.
items[].network.id	`string`	The unique identifier of the Network.
items[].network.name	`string`	The name of the Network.
items[].network.class	`string`	Indicates if the Network is a ‘Personal’ or ‘Enterprise’ Network.
items[].metadata	`array`	An array of key-value pairs of user-generated metadata.
items[].metadata[].name	`string`	The name of the metadata item.
items[].metadata[].value	`string`	the value of the metadata item.
items[].stats	`object`	Statistics about the folder.
items[].stats.childFolderCount	`number`	The number of child folders for the given folder.
items[].parentId	`string`	The unique identifier of the parent folder, if it is a child folder, or the workspace id, if it is the Workspace’s root folder.
items[].workspace	`object`	Information about the folder’s parent workspace.
items[].workspace.id	`string`	The unique identifier of the Workspace.
items[].workspace.name	`string`	The name of the Workspace.
items[].workspace.class	`string`	Indicates if the Workspace is a ‘Personal’ or ‘Team’ Workspace.
items[].parentFolder	`object`	Information about the folder’s parent folder. If the folder is the root folder of a Workspace this property will not be available.
items[].parentFolder.id	`string`	The unique identifier of the folder.
items[].parentFolder.name	`string`	The name of folder.
items[].isTrashed	`boolean`	Indicates if a folder is in the trash bin.
items[].kind	`string`	The type of item returned. Will always be ‘Folder’ for folders.

Headers

Content-Type: application/json

Body

{
  "code": "WorkspaceNotFound",
  "message": "Workspace not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

List Workspace Contents
GET`/workspaces/{workspaceId}/contents{?kind,type,limit,offset,orderBy,orderDirection,fields,extraFields}`

URI Parameters

HideShow

workspaceId

string (required)

The unique identifier of the workspace.

kind

string (optional) Default: all

Determines which kind of items will be returned.

Choices: folder asset all

type

string (optional) Default: all

Determines which type of items will be returned.

Choices: image video audio document timedtext other all

limit

number (optional) Default: 50

The number of items to return. The maximum is 100.

offset

number (optional) Default: 0

The item at which to begin the response.

orderBy

string (optional) Default: name

The field to sort the items by.

Choices: createdOn createdBy name type size status

orderDirection

string (optional) Default: asc

The order direction the items should be returned.

Choices: asc desc

fields

string (optional)

A comma separated list of fields to return in the response. If this value is empty all fields will be returned. Id and Name are always returned.

extraFields

string (optional)

A comma separated list of extra fields to return in the response. If this value is empty, the extra fields will not be included in the response.

Description

Retrieves all subfolders and all assets of the given workspace, regardless of the folder hierarchy. This query supports pagination using limit and offset. Additionally, using the ‘kind’ parameter, it is possible to choose which kind of items to return (subfolders, assets or both). If both are returned, the items are grouped by kind (subfolders first, then assets). The ‘type’ parameter filters the assets based on their format. The available options are ‘image’, ‘video’, ‘audio’, ‘document’, ‘timedtext’, and ‘other’. By specifying a type, the request will only return assets of that particular format. For example, setting ‘type=image’ will return only image files. If any ‘type’ value is provided no folders will be returned.

By default, some fields are not included in the API response for performance reasons. You can include them with the extraFields parameter. Currently, the only extra field we support is commentStats which will return the number of comments for a file and if the current user has any unread comments.

Errors

Status Code	Error Code	Message
400	InvalidLimitOrOffset	Invalid limit or offset value. Limit must be a number between 1 and 100. Offset must be greater than or equal to 0.
400	InvalidQueryOrderField	Invalid order field. It must be either ‘CreatedOn’, ‘Name’, ‘Status’, ‘Type’, ‘Size’ or ‘CreatedBy’.
400	InvalidQueryOrderDirection	Invalid order direction. It must be either ‘Asc’ or ‘Desc’.
400	InvalidQueryKindFilter	Invalid kind filter. It must be either ‘All’, ‘Asset’ or ‘Folder’.
404	WorkspaceNotFound	Workspace not found.

List Trash Bin Contents ¶

GET https://api.cimediacloud.com/workspaces/moqxhkej4epvgrwz/trashbin?kind=all&limit=1&offset=0&orderBy=name&orderDirection=asc&fields=name,thumbnails

Requestsexample with asset in responseexample with folder in response

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200404

Headers

Content-Type: application/json

Body

{
  "limit": 1,
  "offset": 0,
  "count": 10,
  "order": {
    "by": "Name",
    "direction": "asc"
  },
  "kind": [
    "All"
  ],
  "items": [
    {
      "id": "bcdc34b53e2c4c18ac41ca288e28d11f",
      "name": "Movie.mov",
      "size": 107856722,
      "type": "Video",
      "format": "mov",
      "folder": {
        "id": "9b639e12a82f4b0483f512b474dc052ci",
        "name": "Folder Name"
      },
      "status": "Complete",
      "description": "Final cut",
      "thumbnails": [
        {
          "type": "large",
          "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/thumb.jpg",
          "size": 1024,
          "width": 200,
          "height": 300,
          "source": {
            "id": "elementId1",
            "kind": "element"
          },
          "isExternal": false
        }
      ],
      "proxies": [
        {
          "type": "video-3g",
          "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/proxy.jpg",
          "size": 1024,
          "width": 200,
          "height": 300,
          "videoBitRate": 1650000,
          "audioBitRate": 128000,
          "isExternal": false
        }
      ],
      "md5Checksum": "tk2ma0zrhrp5irco",
      "createdOn": "2017-01-02T00:00:00.000Z",
      "createdBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "modifiedOn": "2017-01-02T00:00:00.000Z",
      "lastActivityOn": "2017-01-03T00:00:00.000Z",
      "acquisitionSource": {
        "name": "Workspace"
      },
      "archiveStatus": "Not archived",
      "archiveType": "Standard",
      "restoreStatus": "Not restored",
      "restoreExpirationDate": "2017-01-02T00:00:00.000Z",
      "restoreRequestDate": "2017-01-02T00:00:00.000Z",
      "lastRestoreDate": "2017-01-02T00:00:00.000Z",
      "restoredBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "archiveDate": "2017-01-02T00:00:00.000Z",
      "archivedBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "uploadCompleteDate": "2017-01-02T00:00:00.000Z",
      "isTrashed": false,
      "uploadTransferType": "SinglepartHttp",
      "runtime": 1024,
      "totalFolderCount": 1,
      "network": {
        "id": "40c2a6b99a474b319dec5ef9c7dbb356",
        "name": "Company Name",
        "class": "Enterprise"
      },
      "metadata": [
        {
          "name": "resolution",
          "value": "1080p",
          "readOnly": false
        }
      ],
      "technicalMetadata": {
        "type": "Video",
        "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/metadata.jpg",
        "size": 1024,
        "image": {
          "width": 100,
          "height": 300,
          "xResolution": 100,
          "yResolution": 100,
          "resolutionUnit": "cm",
          "cameraMake": "Nikon",
          "cameraModel": "D300",
          "groupingInfo": "6445055e520106d9d01769fffefd058901000100000000000000",
          "umidBasic": "060a2b340101010501010143130000006445055e520106cbd01769fffefd0589",
          "materialNumber": "6445055e520106cbd01769fffefd0589",
          "recordedDate": "2023-07-27T01:39:24Z",
          "locationCity": "New York",
          "locationState": "NY",
          "locationCountry": "USA",
          "exif": {
            "imageWidth": "3888",
            "imageHeight": "2592",
            "artist": "Michael W. Steidl.",
            "copyright": "(c) 2011 IPTC - Rights reserved."
          },
          "iptc": {
            "codedCharacterSet": "UTF8",
            "headline": "Bikefestival Vienna",
            "credit": "IPTC/Michael W. Steidl",
            "keywords": "Vienna Air King,cycling,mountain bike"
          },
          "xmp": {
            "serialNumber": "0380227035",
            "creatorRegion": "Roshire",
            "lens": "EF70-300mm f/4-5.6L IS USM",
            "creatorCountry": "United Kingdom"
          }
        },
        "avContainer": {
          "bitRate": 11934620,
          "duration": 100,
          "start": 0,
          "recordedDate": "2022-11-21T06:42:41Z",
          "deviceManufacturer": "Sony",
          "timeCode": "00:00:00:00",
          "derivedTimeCode": "00:00:00:00",
          "streams": [
            {
              "index": 0,
              "type": "Video",
              "bitRate": 11934620,
              "bitDepth": 8,
              "bitRateMode": "CBR",
              "codec": "h264",
              "codecName": "ProRes",
              "codecProfile": "422 HQ",
              "codecSettings": "Little / Signed",
              "fourCC": "avc1",
              "width": 1280,
              "height": 720,
              "totalFrames": 1024,
              "duration": 100,
              "frameRateNumerator": 360,
              "frameRateDenominator": 12,
              "videoPARWidth": 1,
              "videoPARHeight": 1,
              "videoDARWidth": 19,
              "videoDARHeight": 24,
              "start": 0,
              "timeCode": "00:00:00:00",
              "videoColorSpace": "bt709",
              "videoScanOrder": "TFF",
              "videoScanType": "Interlaced",
              "videoColorPrimaries": "DCI P3",
              "videoChromaSubsampling": "4:2:2",
              "videoScanTypeStoreMethod": "Interleaved fields",
              "audioSampleRate": 32000,
              "audioChannelCount": 2,
              "audioLayout": "Stereo",
              "audioAnalysis": "Stereo",
              "rotate": 0
            }
          ]
        },
        "dolbyContainer": {
          "duration": 9.6,
          "fileSize": 80294994,
          "overallBitRateMode": "CBR",
          "overallBitRate": 66912495,
          "totalChannels": 58,
          "bedChannels": 10,
          "numberOfBeds": 1,
          "bitDepth": 24,
          "samplingRate": 48000,
          "downmix51X": "Direct Render",
          "trimModesSummary": "automatic + manual_0",
          "trimChannel20Mode": "manual_0",
          "trimChannel51Mode": "manual_0",
          "trimChannel71Mode": "automatic",
          "trimChannel212Mode": "manual_0",
          "trimChannel512Mode": "automatic",
          "trimChannel712Mode": "manual_0",
          "trimChannel214Mode": "manual_0",
          "trimChannel514Mode": "manual_0",
          "trimChannel714Mode": "manual_0",
          "associatedVideoFrameRate": 23.976,
          "start": "01:00:00:00",
          "fFoA": "01:00:00:00",
          "end": "01:03:30:13",
          "metadataFormat": "ADM, Version 0",
          "admProfile": "Dolby Atmos Master, Version 1",
          "numberOfProgrammes": 1,
          "numberOfObjectChannels": 48,
          "numberOfPackFormats": 49,
          "numberOfChannelFormats": 58,
          "binauralRenderModesSummary": "Off + Near + Mid + Far",
          "binauralRenderModesOffCount": 9,
          "binauralRenderModesNearCount": 8,
          "binauralRenderModesMidCount": 13,
          "binauralRenderModesFarCount": 1,
          "truePeakLevels": -3.14,
          "loudness": -16.67
        }
      },
      "hlsPlaylistUrl": "https://cimediacloud.com/t5y7s3ero3w2ie7/hls",
      "acquisitionContext": {
        "name": "Movie1.mov",
        "path": "original/source/path"
      },
      "isExternal": false,
      "workspace": {
        "id": "gb5ehomv0iv71swg",
        "name": "Workspace Name",
        "class": "Enterprise"
      },
      "kind": "Asset"
    }
  ]
}

Property name	Type	Description
limit	`number`	The limit used for the query.
offset	`number`	The offset used for the query.
count	`number`	The total count of items available.
order	`object`	Information about the ordering of the results.
order.by	`string`	Indicates the field used to sort the results.
order.direction	`string`	Indicates the direction used to sort the results.
kind	`array`	Indicates the kind filter used in the request. Returned values are ‘All’, ‘Asset’, and ‘Folder’.
items	`array`	The items returned. Can be both assets and folders.
items[].id	`string`	The unique identifier of the asset.
items[].name	`string`	The name of the asset, including its extension. Its maximum length is 512 characters.
items[].size	`number`	The size of the source file, in bytes.
items[].type	`string`	The type of the asset. Valid values are `Audio`, `Video`, `Image`, `Document`, or `Other`.
items[].format	`string`	The asset’s file format.
items[].folder	`object`	Information about the asset’s parent folder.
items[].folder.id	`string`	The unique identifier of the folder.
items[].folder.name	`string`	The name of folder.
items[].status	`string`	The status of the asset. Valid values are ‘Created’, ‘Complete’, ‘Deleted’, ‘Executable Detected’, ‘Failed’, ‘Limited’, ‘Processing’, ‘Uploading’, ‘Virus Detected’, ‘Waiting’. See this section for more information.
items[].description	`string`	A comment or note associated to the asset. Its maximum length is 1000 characters.
items[].thumbnails	`array`	The set of thumbnails for the asset.
items[].thumbnails[].type	`string`	The type of thumbnail returned. Valid values are ‘small’, ‘medium’ and ‘large’.
items[].thumbnails[].location	`string`	The url of the thumbnail.
items[].thumbnails[].size	`number`	The size of the thumbnail, in bytes.
items[].thumbnails[].width	`number`	The width of the thumbnail.
items[].thumbnails[].height	`number`	The height of the thumbnail.
items[].thumbnails[].source	`object`	Information about the source of thumbnails.
items[].thumbnails[].source.id	`string`	Unique identifier of the thumbnail’s source.
items[].thumbnails[].source.kind	`string`	The kind of entity of the thumbnail’s source.
items[].thumbnails[].isExternal	`boolean`	Indicates if the thumbnail is stored in an external source.
items[].proxies	`array`	The set of proxies for the asset.
items[].proxies[].type	`string`	The type of proxy returned. Valid values are ‘standard-audio’, ‘dolby-audio’, ‘video-3g’, ‘video-sd’, ‘video-sdplus’, ‘video-hd’, ‘video-2k’, ‘video-2kplus’, ‘document-pdf’.
items[].proxies[].location	`string`	The url of the proxy.
items[].proxies[].size	`number`	The size of the proxy, in bytes.
items[].proxies[].width	`number`	The width of the proxy.
items[].proxies[].height	`number`	The height of the proxy.
items[].proxies[].videoBitRate	`number`	The video bitrate of the proxy.
items[].proxies[].audioBitRate	`number`	The audio bitrate of the proxy.
items[].proxies[].isExternal	`boolean`	Indicates if the proxy is stored in an external source.
items[].md5Checksum	`string`	The calculated md5 checksum for the asset.
items[].createdOn	`string`	The datetime the asset record was created.
items[].createdBy	`object`	Information about the creator of the asset
items[].createdBy.id	`string`	The unique identifier of the user.
items[].createdBy.name	`string`	The full name of the user.
items[].createdBy.email	`string`	The email of the user.
items[].modifiedOn	`string`	The datetime the asset record was last modified.
items[].lastActivityOn	`string`	The datetime of the last activity of the asset record.
items[].acquisitionSource	`object`	Information about the asset’s source client application.
items[].acquisitionSource.name	`string`	The name of the client application that uploaded the asset.
items[].archiveStatus	`string`	The archive status of the asset. Valid values are ‘Not archived’, ‘Archive in progress’, ‘Archive failed’, ‘Archived’, ‘Cancel archive in progress’.
items[].archiveType	`string`	If available, the kind of archive used for storing the asset. Valid values are `Standard` and `Deep`.
items[].restoreStatus	`string`	The restore status of the asset. This is applicable to assets that have been archived. Valid values are ‘Not restored’, ‘Restore in progress’, ‘Restore failed’, ‘Restored’.
items[].restoreExpirationDate	`string`	If available, the datetime the restored copy of the asset’s source file will no longer be available.
items[].restoreRequestDate	`string`	If available, the datetime the asset’s source file was requested to be restored.
items[].lastRestoreDate	`string`	If available, the datetime the asset’s source file was last restored.
items[].restoredBy	`object`	If available, information about the user who restored the asset.
items[].restoredBy.id	`string`	The unique identifier of the user.
items[].restoredBy.name	`string`	The full name of the user.
items[].restoredBy.email	`string`	The email of the user.
items[].archiveDate	`string`	If available, the datetime the asset’s source file was last archived.
items[].archivedBy	`object`	If available, information about the user who archived the asset.
items[].archivedBy.id	`string`	The unique identifier of the user.
items[].archivedBy.name	`string`	The full name of the user.
items[].archivedBy.email	`string`	The email of the user.
items[].uploadCompleteDate	`string`	The datetime the asset upload was completed.
items[].isTrashed	`boolean`	Indicates if an asset is in the trash bin.
items[].uploadTransferType	`string`	Indicates how the asset was uploaded. Valid values are ‘SinglepartHttp’, ‘MultipartHttp’, ‘Aspera’, ‘Copy’, ‘FTP’, ‘WorkspaceSend’.
items[].runtime	`number`	The duration of the media asset, in seconds.
items[].totalFolderCount	`number`	The amount of folders where the asset exists.
items[].network	`object`	Information about the asset’s network.
items[].network.id	`string`	The unique identifier of the Network.
items[].network.name	`string`	The name of the Network.
items[].network.class	`string`	Indicates if the Network is a ‘Personal’ or ‘Enterprise’ Network.
items[].metadata	`array`	An array of key-value pairs of user-generated and basic technical metadata.
items[].metadata[].name	`string`	The name of the metadata item.
items[].metadata[].value	`string`	the value of the metadata item.
items[].metadata[].readOnly	`boolean`	Flag to set a read-only metadata.
items[].technicalMetadata	`object`	An object that contains all the technical metadata available.
items[].technicalMetadata.type	`string`	The type of the asset. Valid values are either ‘Audio’, ‘Video’ or ‘Image’.
items[].technicalMetadata.location	`string`	Url of the source technical metadata file. Note: the content and structure of the technical metadata file is subject to change at any time.
items[].technicalMetadata.size	`number`	The size of the technical metadata file, in bytes.
items[].technicalMetadata.image	`object`	If the asset’s type is ‘Image’, this property contains the extended image technical metadata.
items[].technicalMetadata.image.width	`number`	The width of the image, in pixels.
items[].technicalMetadata.image.height	`number`	The height of the image, in pixels.
items[].technicalMetadata.image.xResolution	`number`	The number of pixels per resolutionUnit in the width direction.
items[].technicalMetadata.image.yResolution	`number`	The number of pixels per resolutionUnit in the height direction.
items[].technicalMetadata.image.resolutionUnit	`string`	The unit of measurement for xResolution and yResolution. Can be ‘inches’, ‘cm’ or ‘none’.
items[].technicalMetadata.image.cameraMake	`string`	Camera manufacturer name.
items[].technicalMetadata.image.cameraModel	`string`	Camera model name.
items[].technicalMetadata.image.groupingInfo	`string`	If available, the grouping info of the image. String of hexadecimal value (52 characteres) for the byte array object. Byte array order is Litte Endian.
items[].technicalMetadata.image.umidBasic	`string`	If available, the umid basic info of the image. String of hexadecimal value (64 characteres) for the byte array object.
items[].technicalMetadata.image.materialNumber	`string`	If available, the material number of the image. String of hexadecimal value (32 characteres) for the byte array object.
items[].technicalMetadata.image.recordedDate	`string`	The date and Time at which the image was captured.
items[].technicalMetadata.image.locationCity	`string`	Name of the city where the image was created.
items[].technicalMetadata.image.locationState	`string`	Name of the state where the image was created.
items[].technicalMetadata.image.locationCountry	`string`	Name of the country where the image was created.
items[].technicalMetadata.image.exif	`object`	The avalaible EXIF (Exchangeable Image File) metadata.
items[].technicalMetadata.image.exif.imageWidth	`string`	The image width in pixels.
items[].technicalMetadata.image.exif.imageHeight	`string`	The image height in pixels.
items[].technicalMetadata.image.exif.artist	`string`	The image artist info.
items[].technicalMetadata.image.exif.copyright	`string`	The image copyright.
items[].technicalMetadata.image.iptc	`object`	The available IPTC (International Press Telecommunications Council) available.
items[].technicalMetadata.image.iptc.codedCharacterSet	`string`	Determines how the internal IPTC string values are interpreted.
items[].technicalMetadata.image.iptc.headline	`string`	Brief synopsis or summary of the contents of the photograph.
items[].technicalMetadata.image.iptc.credit	`string`	How the image should be credited when published, as specified by the supplier of the image.
items[].technicalMetadata.image.iptc.keywords	`string`	Descriptive words added to the image to enable search and retrieval.
items[].technicalMetadata.image.xmp	`object`	The available XMP (Extensible Metadata Platform) metadata.
items[].technicalMetadata.image.xmp.serialNumber	`string`	Camera Serial Number.
items[].technicalMetadata.image.xmp.creatorRegion	`string`	State / Province for the address of the person that created this image.
items[].technicalMetadata.image.xmp.lens	`string`	Attempts to identify the camera lens used.
items[].technicalMetadata.image.xmp.creatorCountry	`string`	Country name for the address of the person that created this image.
items[].technicalMetadata.avContainer	`object`	If asset type is ‘Audio’ or ‘Video’, this property contains the extended audio / video technical metadata.
items[].technicalMetadata.avContainer.bitRate	`number`	The overall bitrate in the container.
items[].technicalMetadata.avContainer.duration	`number`	The runtime of the media in the container, in seconds.
items[].technicalMetadata.avContainer.start	`number`	The start time in the container, in seconds.
items[].technicalMetadata.avContainer.recordedDate	`string`	The date and Time at which the video was captured.
items[].technicalMetadata.avContainer.deviceManufacturer	`string`	The name of the device Manufacturer.
items[].technicalMetadata.avContainer.timeCode	`string`	The SMPTE timecode in the container.
items[].technicalMetadata.avContainer.derivedTimeCode	`string`	The standardized timecode derived by evaluating stream metadata and converting to drop frame format, if using drop frame rate.
items[].technicalMetadata.avContainer.streams	`array`	Set of audio, video, or data streams contained in the asset.
items[].technicalMetadata.avContainer.streams[].index	`number`	The index of the stream in the container.
items[].technicalMetadata.avContainer.streams[].type	`string`	The type of the stream. Valid values are `Audio`, `Video` or `Data`.
items[].technicalMetadata.avContainer.streams[].bitRate	`number`	If available, the overall bitrate in the stream.
items[].technicalMetadata.avContainer.streams[].bitDepth	`number`	If available, for an `Audio` stream, the bit depth of the stream.
items[].technicalMetadata.avContainer.streams[].bitRateMode	`string`	If available, the bit rate mode of the stream.
items[].technicalMetadata.avContainer.streams[].codec	`string`	If available, the codec used in the stream. For example, `h264`.
items[].technicalMetadata.avContainer.streams[].codecName	`string`	If available, the MediaInfo generated format commercial name for the stream.
items[].technicalMetadata.avContainer.streams[].codecProfile	`string`	If available, the MediaInfo generated format profile for the stream.
items[].technicalMetadata.avContainer.streams[].codecSettings	`string`	If avalable, the MediaInfo generated format settings for the stream.
items[].technicalMetadata.avContainer.streams[].fourCC	`string`	If available, four-character code for the codec used in the stream. For example, `avc1`, `apch`.
items[].technicalMetadata.avContainer.streams[].width	`number`	If available, for a `Video` stream, the width in pixels of the video.
items[].technicalMetadata.avContainer.streams[].height	`number`	If available, for a `Video` stream, the height in pixels of the video.
items[].technicalMetadata.avContainer.streams[].totalFrames	`number`	If available, total number of frames within the `Video` stream.
items[].technicalMetadata.avContainer.streams[].duration	`number`	If available, the runtime of the media in seconds.
items[].technicalMetadata.avContainer.streams[].frameRateNumerator	`number`	If available, the numerator of the frame rate. For example, if the frame rate is 24, the frame rate numerator is 24.
items[].technicalMetadata.avContainer.streams[].frameRateDenominator	`number`	If available, the numerator of the frame rate. For example, if the frame rate is 24, the frame rate denominator is 1.
items[].technicalMetadata.avContainer.streams[].videoPARWidth	`number`	If available, the width part of the pixel aspect ratio.
items[].technicalMetadata.avContainer.streams[].videoPARHeight	`number`	If available, the height part of the pixel aspect ratio.
items[].technicalMetadata.avContainer.streams[].videoDARWidth	`number`	If available, the width part of the display aspect ratio.
items[].technicalMetadata.avContainer.streams[].videoDARHeight	`number`	If available, the height part of the display aspect ratio.
items[].technicalMetadata.avContainer.streams[].start	`number`	If available, the start time in the stream, in seconds.
items[].technicalMetadata.avContainer.streams[].timeCode	`string`	If available, the SMPTE timecode in the stream.
items[].technicalMetadata.avContainer.streams[].videoColorSpace	`string`	If available, for a `Video` stream, the video’s color space / color primaries.
items[].technicalMetadata.avContainer.streams[].videoScanOrder	`string`	If available, for a `Video` stream, the video’s scan order.
items[].technicalMetadata.avContainer.streams[].videoScanType	`string`	If available, for a `Video` stream, the video’s scan type.
items[].technicalMetadata.avContainer.streams[].videoColorPrimaries	`string`	If available, for a `Video` stream, the video’s color primaries.
items[].technicalMetadata.avContainer.streams[].videoChromaSubsampling	`string`	If available, for a `Video` stream, the video’s crhoma subsampling.
items[].technicalMetadata.avContainer.streams[].videoScanTypeStoreMethod	`string`	If available, for a `Video` stream, the video’s scan type store method.
items[].technicalMetadata.avContainer.streams[].audioSampleRate	`number`	If available, for an `Audio` stream, is the sample rate in Hz.
items[].technicalMetadata.avContainer.streams[].audioChannelCount	`number`	If available, for an `Audio` stream, is the number of channels within the stream.
items[].technicalMetadata.avContainer.streams[].audioLayout	`string`	If available, for an `Audio` stream, is the audio channel layout description. For example, `5.1`.
items[].technicalMetadata.avContainer.streams[].audioAnalysis	`string`	If available, for an `Audio` stream, it is further analysis to determine if a stream is true stereo or dual-mono.
items[].technicalMetadata.avContainer.streams[].rotate	`number`	If available, the amount of rotation, in degrees, that should be applied during playback of the video.
items[].technicalMetadata.dolbyContainer	`object`	If asset type is ‘Audio’ and the asset has Dolby Atmos metadata, this property contains the extended Dolby Atmos audio technical metadata.
items[].technicalMetadata.dolbyContainer.duration	`number`	Media duration (in seconds).
items[].technicalMetadata.dolbyContainer.fileSize	`number`	Media size (in bytes).
items[].technicalMetadata.dolbyContainer.overallBitRateMode	`string`	The overall bitrate mode for the Atmos content.
items[].technicalMetadata.dolbyContainer.overallBitRate	`number`	Media bitrate (in bits per second).
items[].technicalMetadata.dolbyContainer.totalChannels	`number`	Number of channels. `Bed channels` plus `Object channels` equals `Total channels`.
items[].technicalMetadata.dolbyContainer.bedChannels	`number`	Number of channel-based premix or stem that includes multichannel panning.
items[].technicalMetadata.dolbyContainer.numberOfBeds	`number`	A bed can be thought of as a traditional channel-based stem with the rules and expectations of stem configurations (such as 2.0, 5.1, and 7.1).
items[].technicalMetadata.dolbyContainer.bitDepth	`number`	Number of bits of information in each sample, generally 16, 24, or 32-bit.
items[].technicalMetadata.dolbyContainer.samplingRate	`number`	Audio sample-rate, generally 44100 or 48000 Hz.
items[].technicalMetadata.dolbyContainer.downmix51X	`string`	Global downmix metadata for monitoring, re-rendering, and encoding.
items[].technicalMetadata.dolbyContainer.trimModesSummary	`string`	A summary of the underlying trim modes.
items[].technicalMetadata.dolbyContainer.trimChannel20Mode	`string`	The type of trim mode supported for 2.0 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel51Mode	`string`	The type of trim mode supported for 5.1 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel71Mode	`string`	The type of trim mode supported for 7.1 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel212Mode	`string`	The type of trim mode supported for 2.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel512Mode	`string`	The type of trim mode supported for 5.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel712Mode	`string`	The type of trim mode supported for 7.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel214Mode	`string`	The type of trim mode supported for 2.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel514Mode	`string`	The type of trim mode supported for 5.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel714Mode	`string`	The type of trim mode supported for 7.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.associatedVideoFrameRate	`number`	Number of frames per second.
items[].technicalMetadata.dolbyContainer.start	`string`	Start SMPTE timecode based on the video frame rate.
items[].technicalMetadata.dolbyContainer.fFoA	`string`	FFoA (First Frame of Action) SMPTE timecode based on the video frame rate.
items[].technicalMetadata.dolbyContainer.end	`string`	End SMPTE timecode based on the video frame rate.
items[].technicalMetadata.dolbyContainer.metadataFormat	`string`	Format of the metadata in the Atmos content.
items[].technicalMetadata.dolbyContainer.admProfile	`string`	ADM (Audio Definition Model) Profile used in the Atmos content.
items[].technicalMetadata.dolbyContainer.numberOfProgrammes	`number`	Number of programmes in the Atmos content.
items[].technicalMetadata.dolbyContainer.numberOfObjectChannels	`number`	Number of objects in the Atmos Master.
items[].technicalMetadata.dolbyContainer.numberOfPackFormats	`number`	Number of Atmos Pack Formats in the Atmos content.
items[].technicalMetadata.dolbyContainer.numberOfChannelFormats	`number`	Number of channel formats in the Atmos content.
items[].technicalMetadata.dolbyContainer.binauralRenderModesSummary	`string`	Summary of all the binaural render modes used in the Atmos content. Supported strings are a unique combination of: “Off”, “Near”, “Mid”, “Far”.
items[].technicalMetadata.dolbyContainer.binauralRenderModesOffCount	`number`	Number of channels that use the “Off” setting for binaural rendering.
items[].technicalMetadata.dolbyContainer.binauralRenderModesNearCount	`number`	Number of channels that use the “Near” setting for binaural rendering.
items[].technicalMetadata.dolbyContainer.binauralRenderModesMidCount	`number`	Number of channels that use the “Mid” setting for binaural rendering.
items[].technicalMetadata.dolbyContainer.binauralRenderModesFarCount	`number`	Number of channels that use the “Far” setting for binaural rendering.
items[].technicalMetadata.dolbyContainer.truePeakLevels	`number`	The peak event in the audio waveform. Units are dBTP for true peak.
items[].technicalMetadata.dolbyContainer.loudness	`number`	Integrated loudness LKFS (or LUFS).
items[].hlsPlaylistUrl	`string`	A link to the HLS playlist generated from the source file.
items[].acquisitionContext	`object`	The file acquisition information.
items[].acquisitionContext.name	`string`	The original source file name, captured on acquisition.
items[].acquisitionContext.path	`string`	The original source file path, captured on acquisition.
items[].isExternal	`boolean`	Indicates if the file is stored in an external source.
items[].workspace	`object`	Information about the asset’s workspace.
items[].workspace.id	`string`	The unique identifier of the Workspace.
items[].workspace.name	`string`	The name of the Workspace.
items[].workspace.class	`string`	Indicates if the Workspace is a ‘Personal’ or ‘Team’ Workspace.
items[].kind	`string`	The type of item returned. Will always be ‘Asset’ for assets.

Headers

Content-Type: application/json

Body

{
  "code": "WorkspaceNotFound",
  "message": "Workspace not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200404

Headers

Content-Type: application/json

Body

{
  "limit": 1,
  "offset": 0,
  "count": 10,
  "order": {
    "by": "Name",
    "direction": "asc"
  },
  "kind": [
    "All"
  ],
  "items": [
    {
      "id": "9b639e12a82f4b0483f512b474dc052ci",
      "name": "My Folder",
      "createdOn": "2017-01-02T00:00:00.000Z",
      "createdBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "lastActivityOn": "2017-01-03T00:00:00.000Z",
      "network": {
        "id": "40c2a6b99a474b319dec5ef9c7dbb356",
        "name": "Company Name",
        "class": "Enterprise"
      },
      "metadata": [
        {
          "name": "intendedFor",
          "value": "landscapeImages"
        }
      ],
      "stats": {
        "childFolderCount": 2
      },
      "parentId": "nqyptt047b7qc9y3",
      "workspace": {
        "id": "gb5ehomv0iv71swg",
        "name": "Workspace Name",
        "class": "Enterprise"
      },
      "parentFolder": {
        "id": "9b639e12a82f4b0483f512b474dc052ci",
        "name": "Folder Name"
      },
      "isTrashed": false,
      "kind": "Folder"
    }
  ]
}

Property name	Type	Description
limit	`number`	The limit used for the query.
offset	`number`	The offset used for the query.
count	`number`	The total count of items available.
order	`object`	Information about the ordering of the results.
order.by	`string`	Indicates the field used to sort the results.
order.direction	`string`	Indicates the direction used to sort the results.
kind	`array`	Indicates the kind filter used in the request. Returned values are ‘All’, ‘Asset’, and ‘Folder’.
items	`array`	The items returned. Can be both assets and folders.
items[].id	`string`	The unique identifier of folder.
items[].name	`string`	The name of the folder.
items[].createdOn	`string`	The datetime the folder was created.
items[].createdBy	`object`	Information about the creator of the folder.
items[].createdBy.id	`string`	The unique identifier of the user.
items[].createdBy.name	`string`	The full name of the user.
items[].createdBy.email	`string`	The email of the user.
items[].lastActivityOn	`string`	The datetime of the last activity of the folder.
items[].network	`object`	Information about the folder’s parent network.
items[].network.id	`string`	The unique identifier of the Network.
items[].network.name	`string`	The name of the Network.
items[].network.class	`string`	Indicates if the Network is a ‘Personal’ or ‘Enterprise’ Network.
items[].metadata	`array`	An array of key-value pairs of user-generated metadata.
items[].metadata[].name	`string`	The name of the metadata item.
items[].metadata[].value	`string`	the value of the metadata item.
items[].stats	`object`	Statistics about the folder.
items[].stats.childFolderCount	`number`	The number of child folders for the given folder.
items[].parentId	`string`	The unique identifier of the parent folder, if it is a child folder, or the workspace id, if it is the Workspace’s root folder.
items[].workspace	`object`	Information about the folder’s parent workspace.
items[].workspace.id	`string`	The unique identifier of the Workspace.
items[].workspace.name	`string`	The name of the Workspace.
items[].workspace.class	`string`	Indicates if the Workspace is a ‘Personal’ or ‘Team’ Workspace.
items[].parentFolder	`object`	Information about the folder’s parent folder. If the folder is the root folder of a Workspace this property will not be available.
items[].parentFolder.id	`string`	The unique identifier of the folder.
items[].parentFolder.name	`string`	The name of folder.
items[].isTrashed	`boolean`	Indicates if a folder is in the trash bin.
items[].kind	`string`	The type of item returned. Will always be ‘Folder’ for folders.

Headers

Content-Type: application/json

Body

{
  "code": "WorkspaceNotFound",
  "message": "Workspace not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

List Trash Bin Contents
GET`/workspaces/{workspaceId}/trashbin{?kind,limit,offset,orderBy,orderDirection,fields}`

URI Parameters

HideShow

workspaceId

string (required)

The unique identifier of the workspace.

kind

string (optional) Default: all

Determines which kind of items will be returned.

Choices: folder asset all

limit

number (optional) Default: 50

The number of items to return. The maximum is 100.

offset

number (optional) Default: 0

The item at which to begin the response.

orderBy

string (optional) Default: name

The field to sort the items by.

Choices: createdOn createdBy name type size status trashedOn

orderDirection

string (optional) Default: asc

The order direction the items should be returned.

Choices: asc desc

fields

string (optional)

A comma separated list of fields to return in the response. If this value is empty all fields will be returned. Id and Name are always returned.

Description

Retrieves the trashed items of a given workspace. This query supports pagination using limit and offset. Additionally, using the ‘kind’ parameter, it is possible to choose which kind of items to return (subfolders, assets or both). If both are returned, the items are grouped by kind (subfolders first, then assets).

Errors

Status Code	Error Code	Message
400	InvalidLimitOrOffset	Invalid limit or offset value. Limit must be a number between 1 and 100. Offset must be greater than or equal to 0.
400	InvalidQueryOrderField	Invalid order field. It must be either ‘CreatedOn’, ‘Name’, ‘Status’, ‘Type’, ‘Size’, ‘TrashedOn’ or ‘CreatedBy’.
400	InvalidQueryOrderDirection	Invalid order direction. It must be either ‘Asc’ or ‘Desc’.
400	InvalidQueryKindFilter	Invalid kind filter. It must be either ‘All’, ‘Asset’ or ‘Folder’.
404	WorkspaceNotFound	Workspace not found.

Search Workspace Contents ¶

GET https://api.cimediacloud.com/workspaces/moqxhkej4epvgrwz/search?query=movies&kind=all&limit=1&offset=0&orderBy=relevance&orderDirection=asc&fields=name,thumbnails

Requestsexample with asset in responseexample with folder in response

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200404

Headers

Content-Type: application/json

Body

{
  "limit": 1,
  "offset": 0,
  "count": 10,
  "order": {
    "by": "Name",
    "direction": "asc"
  },
  "kind": [
    "All"
  ],
  "items": [
    {
      "id": "bcdc34b53e2c4c18ac41ca288e28d11f",
      "name": "Movie.mov",
      "size": 107856722,
      "type": "Video",
      "format": "mov",
      "folder": {
        "id": "9b639e12a82f4b0483f512b474dc052ci",
        "name": "Folder Name"
      },
      "status": "Complete",
      "description": "Final cut",
      "thumbnails": [
        {
          "type": "large",
          "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/thumb.jpg",
          "size": 1024,
          "width": 200,
          "height": 300,
          "source": {
            "id": "elementId1",
            "kind": "element"
          },
          "isExternal": false
        }
      ],
      "proxies": [
        {
          "type": "video-3g",
          "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/proxy.jpg",
          "size": 1024,
          "width": 200,
          "height": 300,
          "videoBitRate": 1650000,
          "audioBitRate": 128000,
          "isExternal": false
        }
      ],
      "md5Checksum": "tk2ma0zrhrp5irco",
      "createdOn": "2017-01-02T00:00:00.000Z",
      "createdBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "modifiedOn": "2017-01-02T00:00:00.000Z",
      "lastActivityOn": "2017-01-03T00:00:00.000Z",
      "acquisitionSource": {
        "name": "Workspace"
      },
      "archiveStatus": "Not archived",
      "archiveType": "Standard",
      "restoreStatus": "Not restored",
      "restoreExpirationDate": "2017-01-02T00:00:00.000Z",
      "restoreRequestDate": "2017-01-02T00:00:00.000Z",
      "lastRestoreDate": "2017-01-02T00:00:00.000Z",
      "restoredBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "archiveDate": "2017-01-02T00:00:00.000Z",
      "archivedBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "uploadCompleteDate": "2017-01-02T00:00:00.000Z",
      "isTrashed": false,
      "uploadTransferType": "SinglepartHttp",
      "runtime": 1024,
      "totalFolderCount": 1,
      "network": {
        "id": "40c2a6b99a474b319dec5ef9c7dbb356",
        "name": "Company Name",
        "class": "Enterprise"
      },
      "metadata": [
        {
          "name": "resolution",
          "value": "1080p",
          "readOnly": false
        }
      ],
      "technicalMetadata": {
        "type": "Video",
        "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/metadata.jpg",
        "size": 1024,
        "image": {
          "width": 100,
          "height": 300,
          "xResolution": 100,
          "yResolution": 100,
          "resolutionUnit": "cm",
          "cameraMake": "Nikon",
          "cameraModel": "D300",
          "groupingInfo": "6445055e520106d9d01769fffefd058901000100000000000000",
          "umidBasic": "060a2b340101010501010143130000006445055e520106cbd01769fffefd0589",
          "materialNumber": "6445055e520106cbd01769fffefd0589",
          "recordedDate": "2023-07-27T01:39:24Z",
          "locationCity": "New York",
          "locationState": "NY",
          "locationCountry": "USA",
          "exif": {
            "imageWidth": "3888",
            "imageHeight": "2592",
            "artist": "Michael W. Steidl.",
            "copyright": "(c) 2011 IPTC - Rights reserved."
          },
          "iptc": {
            "codedCharacterSet": "UTF8",
            "headline": "Bikefestival Vienna",
            "credit": "IPTC/Michael W. Steidl",
            "keywords": "Vienna Air King,cycling,mountain bike"
          },
          "xmp": {
            "serialNumber": "0380227035",
            "creatorRegion": "Roshire",
            "lens": "EF70-300mm f/4-5.6L IS USM",
            "creatorCountry": "United Kingdom"
          }
        },
        "avContainer": {
          "bitRate": 11934620,
          "duration": 100,
          "start": 0,
          "recordedDate": "2022-11-21T06:42:41Z",
          "deviceManufacturer": "Sony",
          "timeCode": "00:00:00:00",
          "derivedTimeCode": "00:00:00:00",
          "streams": [
            {
              "index": 0,
              "type": "Video",
              "bitRate": 11934620,
              "bitDepth": 8,
              "bitRateMode": "CBR",
              "codec": "h264",
              "codecName": "ProRes",
              "codecProfile": "422 HQ",
              "codecSettings": "Little / Signed",
              "fourCC": "avc1",
              "width": 1280,
              "height": 720,
              "totalFrames": 1024,
              "duration": 100,
              "frameRateNumerator": 360,
              "frameRateDenominator": 12,
              "videoPARWidth": 1,
              "videoPARHeight": 1,
              "videoDARWidth": 19,
              "videoDARHeight": 24,
              "start": 0,
              "timeCode": "00:00:00:00",
              "videoColorSpace": "bt709",
              "videoScanOrder": "TFF",
              "videoScanType": "Interlaced",
              "videoColorPrimaries": "DCI P3",
              "videoChromaSubsampling": "4:2:2",
              "videoScanTypeStoreMethod": "Interleaved fields",
              "audioSampleRate": 32000,
              "audioChannelCount": 2,
              "audioLayout": "Stereo",
              "audioAnalysis": "Stereo",
              "rotate": 0
            }
          ]
        },
        "dolbyContainer": {
          "duration": 9.6,
          "fileSize": 80294994,
          "overallBitRateMode": "CBR",
          "overallBitRate": 66912495,
          "totalChannels": 58,
          "bedChannels": 10,
          "numberOfBeds": 1,
          "bitDepth": 24,
          "samplingRate": 48000,
          "downmix51X": "Direct Render",
          "trimModesSummary": "automatic + manual_0",
          "trimChannel20Mode": "manual_0",
          "trimChannel51Mode": "manual_0",
          "trimChannel71Mode": "automatic",
          "trimChannel212Mode": "manual_0",
          "trimChannel512Mode": "automatic",
          "trimChannel712Mode": "manual_0",
          "trimChannel214Mode": "manual_0",
          "trimChannel514Mode": "manual_0",
          "trimChannel714Mode": "manual_0",
          "associatedVideoFrameRate": 23.976,
          "start": "01:00:00:00",
          "fFoA": "01:00:00:00",
          "end": "01:03:30:13",
          "metadataFormat": "ADM, Version 0",
          "admProfile": "Dolby Atmos Master, Version 1",
          "numberOfProgrammes": 1,
          "numberOfObjectChannels": 48,
          "numberOfPackFormats": 49,
          "numberOfChannelFormats": 58,
          "binauralRenderModesSummary": "Off + Near + Mid + Far",
          "binauralRenderModesOffCount": 9,
          "binauralRenderModesNearCount": 8,
          "binauralRenderModesMidCount": 13,
          "binauralRenderModesFarCount": 1,
          "truePeakLevels": -3.14,
          "loudness": -16.67
        }
      },
      "hlsPlaylistUrl": "https://cimediacloud.com/t5y7s3ero3w2ie7/hls",
      "acquisitionContext": {
        "name": "Movie1.mov",
        "path": "original/source/path"
      },
      "isExternal": false,
      "workspace": {
        "id": "gb5ehomv0iv71swg",
        "name": "Workspace Name",
        "class": "Enterprise"
      },
      "kind": "Asset"
    }
  ]
}

Property name	Type	Description
limit	`number`	The limit used for the query.
offset	`number`	The offset used for the query.
count	`number`	The total count of items available.
order	`object`	Information about the ordering of the results.
order.by	`string`	Indicates the field used to sort the results.
order.direction	`string`	Indicates the direction used to sort the results.
kind	`array`	Indicates the kind filter used in the request. Returned values are ‘All’, ‘Asset’, and ‘Folder’.
items	`array`	The items returned. Can be both assets and folders.
items[].id	`string`	The unique identifier of the asset.
items[].name	`string`	The name of the asset, including its extension. Its maximum length is 512 characters.
items[].size	`number`	The size of the source file, in bytes.
items[].type	`string`	The type of the asset. Valid values are `Audio`, `Video`, `Image`, `Document`, or `Other`.
items[].format	`string`	The asset’s file format.
items[].folder	`object`	Information about the asset’s parent folder.
items[].folder.id	`string`	The unique identifier of the folder.
items[].folder.name	`string`	The name of folder.
items[].status	`string`	The status of the asset. Valid values are ‘Created’, ‘Complete’, ‘Deleted’, ‘Executable Detected’, ‘Failed’, ‘Limited’, ‘Processing’, ‘Uploading’, ‘Virus Detected’, ‘Waiting’. See this section for more information.
items[].description	`string`	A comment or note associated to the asset. Its maximum length is 1000 characters.
items[].thumbnails	`array`	The set of thumbnails for the asset.
items[].thumbnails[].type	`string`	The type of thumbnail returned. Valid values are ‘small’, ‘medium’ and ‘large’.
items[].thumbnails[].location	`string`	The url of the thumbnail.
items[].thumbnails[].size	`number`	The size of the thumbnail, in bytes.
items[].thumbnails[].width	`number`	The width of the thumbnail.
items[].thumbnails[].height	`number`	The height of the thumbnail.
items[].thumbnails[].source	`object`	Information about the source of thumbnails.
items[].thumbnails[].source.id	`string`	Unique identifier of the thumbnail’s source.
items[].thumbnails[].source.kind	`string`	The kind of entity of the thumbnail’s source.
items[].thumbnails[].isExternal	`boolean`	Indicates if the thumbnail is stored in an external source.
items[].proxies	`array`	The set of proxies for the asset.
items[].proxies[].type	`string`	The type of proxy returned. Valid values are ‘standard-audio’, ‘dolby-audio’, ‘video-3g’, ‘video-sd’, ‘video-sdplus’, ‘video-hd’, ‘video-2k’, ‘video-2kplus’, ‘document-pdf’.
items[].proxies[].location	`string`	The url of the proxy.
items[].proxies[].size	`number`	The size of the proxy, in bytes.
items[].proxies[].width	`number`	The width of the proxy.
items[].proxies[].height	`number`	The height of the proxy.
items[].proxies[].videoBitRate	`number`	The video bitrate of the proxy.
items[].proxies[].audioBitRate	`number`	The audio bitrate of the proxy.
items[].proxies[].isExternal	`boolean`	Indicates if the proxy is stored in an external source.
items[].md5Checksum	`string`	The calculated md5 checksum for the asset.
items[].createdOn	`string`	The datetime the asset record was created.
items[].createdBy	`object`	Information about the creator of the asset
items[].createdBy.id	`string`	The unique identifier of the user.
items[].createdBy.name	`string`	The full name of the user.
items[].createdBy.email	`string`	The email of the user.
items[].modifiedOn	`string`	The datetime the asset record was last modified.
items[].lastActivityOn	`string`	The datetime of the last activity of the asset record.
items[].acquisitionSource	`object`	Information about the asset’s source client application.
items[].acquisitionSource.name	`string`	The name of the client application that uploaded the asset.
items[].archiveStatus	`string`	The archive status of the asset. Valid values are ‘Not archived’, ‘Archive in progress’, ‘Archive failed’, ‘Archived’, ‘Cancel archive in progress’.
items[].archiveType	`string`	If available, the kind of archive used for storing the asset. Valid values are `Standard` and `Deep`.
items[].restoreStatus	`string`	The restore status of the asset. This is applicable to assets that have been archived. Valid values are ‘Not restored’, ‘Restore in progress’, ‘Restore failed’, ‘Restored’.
items[].restoreExpirationDate	`string`	If available, the datetime the restored copy of the asset’s source file will no longer be available.
items[].restoreRequestDate	`string`	If available, the datetime the asset’s source file was requested to be restored.
items[].lastRestoreDate	`string`	If available, the datetime the asset’s source file was last restored.
items[].restoredBy	`object`	If available, information about the user who restored the asset.
items[].restoredBy.id	`string`	The unique identifier of the user.
items[].restoredBy.name	`string`	The full name of the user.
items[].restoredBy.email	`string`	The email of the user.
items[].archiveDate	`string`	If available, the datetime the asset’s source file was last archived.
items[].archivedBy	`object`	If available, information about the user who archived the asset.
items[].archivedBy.id	`string`	The unique identifier of the user.
items[].archivedBy.name	`string`	The full name of the user.
items[].archivedBy.email	`string`	The email of the user.
items[].uploadCompleteDate	`string`	The datetime the asset upload was completed.
items[].isTrashed	`boolean`	Indicates if an asset is in the trash bin.
items[].uploadTransferType	`string`	Indicates how the asset was uploaded. Valid values are ‘SinglepartHttp’, ‘MultipartHttp’, ‘Aspera’, ‘Copy’, ‘FTP’, ‘WorkspaceSend’.
items[].runtime	`number`	The duration of the media asset, in seconds.
items[].totalFolderCount	`number`	The amount of folders where the asset exists.
items[].network	`object`	Information about the asset’s network.
items[].network.id	`string`	The unique identifier of the Network.
items[].network.name	`string`	The name of the Network.
items[].network.class	`string`	Indicates if the Network is a ‘Personal’ or ‘Enterprise’ Network.
items[].metadata	`array`	An array of key-value pairs of user-generated and basic technical metadata.
items[].metadata[].name	`string`	The name of the metadata item.
items[].metadata[].value	`string`	the value of the metadata item.
items[].metadata[].readOnly	`boolean`	Flag to set a read-only metadata.
items[].technicalMetadata	`object`	An object that contains all the technical metadata available.
items[].technicalMetadata.type	`string`	The type of the asset. Valid values are either ‘Audio’, ‘Video’ or ‘Image’.
items[].technicalMetadata.location	`string`	Url of the source technical metadata file. Note: the content and structure of the technical metadata file is subject to change at any time.
items[].technicalMetadata.size	`number`	The size of the technical metadata file, in bytes.
items[].technicalMetadata.image	`object`	If the asset’s type is ‘Image’, this property contains the extended image technical metadata.
items[].technicalMetadata.image.width	`number`	The width of the image, in pixels.
items[].technicalMetadata.image.height	`number`	The height of the image, in pixels.
items[].technicalMetadata.image.xResolution	`number`	The number of pixels per resolutionUnit in the width direction.
items[].technicalMetadata.image.yResolution	`number`	The number of pixels per resolutionUnit in the height direction.
items[].technicalMetadata.image.resolutionUnit	`string`	The unit of measurement for xResolution and yResolution. Can be ‘inches’, ‘cm’ or ‘none’.
items[].technicalMetadata.image.cameraMake	`string`	Camera manufacturer name.
items[].technicalMetadata.image.cameraModel	`string`	Camera model name.
items[].technicalMetadata.image.groupingInfo	`string`	If available, the grouping info of the image. String of hexadecimal value (52 characteres) for the byte array object. Byte array order is Litte Endian.
items[].technicalMetadata.image.umidBasic	`string`	If available, the umid basic info of the image. String of hexadecimal value (64 characteres) for the byte array object.
items[].technicalMetadata.image.materialNumber	`string`	If available, the material number of the image. String of hexadecimal value (32 characteres) for the byte array object.
items[].technicalMetadata.image.recordedDate	`string`	The date and Time at which the image was captured.
items[].technicalMetadata.image.locationCity	`string`	Name of the city where the image was created.
items[].technicalMetadata.image.locationState	`string`	Name of the state where the image was created.
items[].technicalMetadata.image.locationCountry	`string`	Name of the country where the image was created.
items[].technicalMetadata.image.exif	`object`	The avalaible EXIF (Exchangeable Image File) metadata.
items[].technicalMetadata.image.exif.imageWidth	`string`	The image width in pixels.
items[].technicalMetadata.image.exif.imageHeight	`string`	The image height in pixels.
items[].technicalMetadata.image.exif.artist	`string`	The image artist info.
items[].technicalMetadata.image.exif.copyright	`string`	The image copyright.
items[].technicalMetadata.image.iptc	`object`	The available IPTC (International Press Telecommunications Council) available.
items[].technicalMetadata.image.iptc.codedCharacterSet	`string`	Determines how the internal IPTC string values are interpreted.
items[].technicalMetadata.image.iptc.headline	`string`	Brief synopsis or summary of the contents of the photograph.
items[].technicalMetadata.image.iptc.credit	`string`	How the image should be credited when published, as specified by the supplier of the image.
items[].technicalMetadata.image.iptc.keywords	`string`	Descriptive words added to the image to enable search and retrieval.
items[].technicalMetadata.image.xmp	`object`	The available XMP (Extensible Metadata Platform) metadata.
items[].technicalMetadata.image.xmp.serialNumber	`string`	Camera Serial Number.
items[].technicalMetadata.image.xmp.creatorRegion	`string`	State / Province for the address of the person that created this image.
items[].technicalMetadata.image.xmp.lens	`string`	Attempts to identify the camera lens used.
items[].technicalMetadata.image.xmp.creatorCountry	`string`	Country name for the address of the person that created this image.
items[].technicalMetadata.avContainer	`object`	If asset type is ‘Audio’ or ‘Video’, this property contains the extended audio / video technical metadata.
items[].technicalMetadata.avContainer.bitRate	`number`	The overall bitrate in the container.
items[].technicalMetadata.avContainer.duration	`number`	The runtime of the media in the container, in seconds.
items[].technicalMetadata.avContainer.start	`number`	The start time in the container, in seconds.
items[].technicalMetadata.avContainer.recordedDate	`string`	The date and Time at which the video was captured.
items[].technicalMetadata.avContainer.deviceManufacturer	`string`	The name of the device Manufacturer.
items[].technicalMetadata.avContainer.timeCode	`string`	The SMPTE timecode in the container.
items[].technicalMetadata.avContainer.derivedTimeCode	`string`	The standardized timecode derived by evaluating stream metadata and converting to drop frame format, if using drop frame rate.
items[].technicalMetadata.avContainer.streams	`array`	Set of audio, video, or data streams contained in the asset.
items[].technicalMetadata.avContainer.streams[].index	`number`	The index of the stream in the container.
items[].technicalMetadata.avContainer.streams[].type	`string`	The type of the stream. Valid values are `Audio`, `Video` or `Data`.
items[].technicalMetadata.avContainer.streams[].bitRate	`number`	If available, the overall bitrate in the stream.
items[].technicalMetadata.avContainer.streams[].bitDepth	`number`	If available, for an `Audio` stream, the bit depth of the stream.
items[].technicalMetadata.avContainer.streams[].bitRateMode	`string`	If available, the bit rate mode of the stream.
items[].technicalMetadata.avContainer.streams[].codec	`string`	If available, the codec used in the stream. For example, `h264`.
items[].technicalMetadata.avContainer.streams[].codecName	`string`	If available, the MediaInfo generated format commercial name for the stream.
items[].technicalMetadata.avContainer.streams[].codecProfile	`string`	If available, the MediaInfo generated format profile for the stream.
items[].technicalMetadata.avContainer.streams[].codecSettings	`string`	If avalable, the MediaInfo generated format settings for the stream.
items[].technicalMetadata.avContainer.streams[].fourCC	`string`	If available, four-character code for the codec used in the stream. For example, `avc1`, `apch`.
items[].technicalMetadata.avContainer.streams[].width	`number`	If available, for a `Video` stream, the width in pixels of the video.
items[].technicalMetadata.avContainer.streams[].height	`number`	If available, for a `Video` stream, the height in pixels of the video.
items[].technicalMetadata.avContainer.streams[].totalFrames	`number`	If available, total number of frames within the `Video` stream.
items[].technicalMetadata.avContainer.streams[].duration	`number`	If available, the runtime of the media in seconds.
items[].technicalMetadata.avContainer.streams[].frameRateNumerator	`number`	If available, the numerator of the frame rate. For example, if the frame rate is 24, the frame rate numerator is 24.
items[].technicalMetadata.avContainer.streams[].frameRateDenominator	`number`	If available, the numerator of the frame rate. For example, if the frame rate is 24, the frame rate denominator is 1.
items[].technicalMetadata.avContainer.streams[].videoPARWidth	`number`	If available, the width part of the pixel aspect ratio.
items[].technicalMetadata.avContainer.streams[].videoPARHeight	`number`	If available, the height part of the pixel aspect ratio.
items[].technicalMetadata.avContainer.streams[].videoDARWidth	`number`	If available, the width part of the display aspect ratio.
items[].technicalMetadata.avContainer.streams[].videoDARHeight	`number`	If available, the height part of the display aspect ratio.
items[].technicalMetadata.avContainer.streams[].start	`number`	If available, the start time in the stream, in seconds.
items[].technicalMetadata.avContainer.streams[].timeCode	`string`	If available, the SMPTE timecode in the stream.
items[].technicalMetadata.avContainer.streams[].videoColorSpace	`string`	If available, for a `Video` stream, the video’s color space / color primaries.
items[].technicalMetadata.avContainer.streams[].videoScanOrder	`string`	If available, for a `Video` stream, the video’s scan order.
items[].technicalMetadata.avContainer.streams[].videoScanType	`string`	If available, for a `Video` stream, the video’s scan type.
items[].technicalMetadata.avContainer.streams[].videoColorPrimaries	`string`	If available, for a `Video` stream, the video’s color primaries.
items[].technicalMetadata.avContainer.streams[].videoChromaSubsampling	`string`	If available, for a `Video` stream, the video’s crhoma subsampling.
items[].technicalMetadata.avContainer.streams[].videoScanTypeStoreMethod	`string`	If available, for a `Video` stream, the video’s scan type store method.
items[].technicalMetadata.avContainer.streams[].audioSampleRate	`number`	If available, for an `Audio` stream, is the sample rate in Hz.
items[].technicalMetadata.avContainer.streams[].audioChannelCount	`number`	If available, for an `Audio` stream, is the number of channels within the stream.
items[].technicalMetadata.avContainer.streams[].audioLayout	`string`	If available, for an `Audio` stream, is the audio channel layout description. For example, `5.1`.
items[].technicalMetadata.avContainer.streams[].audioAnalysis	`string`	If available, for an `Audio` stream, it is further analysis to determine if a stream is true stereo or dual-mono.
items[].technicalMetadata.avContainer.streams[].rotate	`number`	If available, the amount of rotation, in degrees, that should be applied during playback of the video.
items[].technicalMetadata.dolbyContainer	`object`	If asset type is ‘Audio’ and the asset has Dolby Atmos metadata, this property contains the extended Dolby Atmos audio technical metadata.
items[].technicalMetadata.dolbyContainer.duration	`number`	Media duration (in seconds).
items[].technicalMetadata.dolbyContainer.fileSize	`number`	Media size (in bytes).
items[].technicalMetadata.dolbyContainer.overallBitRateMode	`string`	The overall bitrate mode for the Atmos content.
items[].technicalMetadata.dolbyContainer.overallBitRate	`number`	Media bitrate (in bits per second).
items[].technicalMetadata.dolbyContainer.totalChannels	`number`	Number of channels. `Bed channels` plus `Object channels` equals `Total channels`.
items[].technicalMetadata.dolbyContainer.bedChannels	`number`	Number of channel-based premix or stem that includes multichannel panning.
items[].technicalMetadata.dolbyContainer.numberOfBeds	`number`	A bed can be thought of as a traditional channel-based stem with the rules and expectations of stem configurations (such as 2.0, 5.1, and 7.1).
items[].technicalMetadata.dolbyContainer.bitDepth	`number`	Number of bits of information in each sample, generally 16, 24, or 32-bit.
items[].technicalMetadata.dolbyContainer.samplingRate	`number`	Audio sample-rate, generally 44100 or 48000 Hz.
items[].technicalMetadata.dolbyContainer.downmix51X	`string`	Global downmix metadata for monitoring, re-rendering, and encoding.
items[].technicalMetadata.dolbyContainer.trimModesSummary	`string`	A summary of the underlying trim modes.
items[].technicalMetadata.dolbyContainer.trimChannel20Mode	`string`	The type of trim mode supported for 2.0 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel51Mode	`string`	The type of trim mode supported for 5.1 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel71Mode	`string`	The type of trim mode supported for 7.1 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel212Mode	`string`	The type of trim mode supported for 2.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel512Mode	`string`	The type of trim mode supported for 5.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel712Mode	`string`	The type of trim mode supported for 7.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel214Mode	`string`	The type of trim mode supported for 2.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel514Mode	`string`	The type of trim mode supported for 5.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel714Mode	`string`	The type of trim mode supported for 7.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.associatedVideoFrameRate	`number`	Number of frames per second.
items[].technicalMetadata.dolbyContainer.start	`string`	Start SMPTE timecode based on the video frame rate.
items[].technicalMetadata.dolbyContainer.fFoA	`string`	FFoA (First Frame of Action) SMPTE timecode based on the video frame rate.
items[].technicalMetadata.dolbyContainer.end	`string`	End SMPTE timecode based on the video frame rate.
items[].technicalMetadata.dolbyContainer.metadataFormat	`string`	Format of the metadata in the Atmos content.
items[].technicalMetadata.dolbyContainer.admProfile	`string`	ADM (Audio Definition Model) Profile used in the Atmos content.
items[].technicalMetadata.dolbyContainer.numberOfProgrammes	`number`	Number of programmes in the Atmos content.
items[].technicalMetadata.dolbyContainer.numberOfObjectChannels	`number`	Number of objects in the Atmos Master.
items[].technicalMetadata.dolbyContainer.numberOfPackFormats	`number`	Number of Atmos Pack Formats in the Atmos content.
items[].technicalMetadata.dolbyContainer.numberOfChannelFormats	`number`	Number of channel formats in the Atmos content.
items[].technicalMetadata.dolbyContainer.binauralRenderModesSummary	`string`	Summary of all the binaural render modes used in the Atmos content. Supported strings are a unique combination of: “Off”, “Near”, “Mid”, “Far”.
items[].technicalMetadata.dolbyContainer.binauralRenderModesOffCount	`number`	Number of channels that use the “Off” setting for binaural rendering.
items[].technicalMetadata.dolbyContainer.binauralRenderModesNearCount	`number`	Number of channels that use the “Near” setting for binaural rendering.
items[].technicalMetadata.dolbyContainer.binauralRenderModesMidCount	`number`	Number of channels that use the “Mid” setting for binaural rendering.
items[].technicalMetadata.dolbyContainer.binauralRenderModesFarCount	`number`	Number of channels that use the “Far” setting for binaural rendering.
items[].technicalMetadata.dolbyContainer.truePeakLevels	`number`	The peak event in the audio waveform. Units are dBTP for true peak.
items[].technicalMetadata.dolbyContainer.loudness	`number`	Integrated loudness LKFS (or LUFS).
items[].hlsPlaylistUrl	`string`	A link to the HLS playlist generated from the source file.
items[].acquisitionContext	`object`	The file acquisition information.
items[].acquisitionContext.name	`string`	The original source file name, captured on acquisition.
items[].acquisitionContext.path	`string`	The original source file path, captured on acquisition.
items[].isExternal	`boolean`	Indicates if the file is stored in an external source.
items[].workspace	`object`	Information about the asset’s workspace.
items[].workspace.id	`string`	The unique identifier of the Workspace.
items[].workspace.name	`string`	The name of the Workspace.
items[].workspace.class	`string`	Indicates if the Workspace is a ‘Personal’ or ‘Team’ Workspace.
items[].kind	`string`	The type of item returned. Will always be ‘Asset’ for assets.

Headers

Content-Type: application/json

Body

{
  "code": "WorkspaceNotFound",
  "message": "Workspace not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200404

Headers

Content-Type: application/json

Body

{
  "limit": 1,
  "offset": 0,
  "count": 10,
  "order": {
    "by": "Name",
    "direction": "asc"
  },
  "kind": [
    "All"
  ],
  "items": [
    {
      "id": "9b639e12a82f4b0483f512b474dc052ci",
      "name": "My Folder",
      "createdOn": "2017-01-02T00:00:00.000Z",
      "createdBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "lastActivityOn": "2017-01-03T00:00:00.000Z",
      "network": {
        "id": "40c2a6b99a474b319dec5ef9c7dbb356",
        "name": "Company Name",
        "class": "Enterprise"
      },
      "metadata": [
        {
          "name": "intendedFor",
          "value": "landscapeImages"
        }
      ],
      "stats": {
        "childFolderCount": 2
      },
      "parentId": "nqyptt047b7qc9y3",
      "workspace": {
        "id": "gb5ehomv0iv71swg",
        "name": "Workspace Name",
        "class": "Enterprise"
      },
      "parentFolder": {
        "id": "9b639e12a82f4b0483f512b474dc052ci",
        "name": "Folder Name"
      },
      "isTrashed": false,
      "kind": "Folder"
    }
  ]
}

Property name	Type	Description
limit	`number`	The limit used for the query.
offset	`number`	The offset used for the query.
count	`number`	The total count of items available.
order	`object`	Information about the ordering of the results.
order.by	`string`	Indicates the field used to sort the results.
order.direction	`string`	Indicates the direction used to sort the results.
kind	`array`	Indicates the kind filter used in the request. Returned values are ‘All’, ‘Asset’, and ‘Folder’.
items	`array`	The items returned. Can be both assets and folders.
items[].id	`string`	The unique identifier of folder.
items[].name	`string`	The name of the folder.
items[].createdOn	`string`	The datetime the folder was created.
items[].createdBy	`object`	Information about the creator of the folder.
items[].createdBy.id	`string`	The unique identifier of the user.
items[].createdBy.name	`string`	The full name of the user.
items[].createdBy.email	`string`	The email of the user.
items[].lastActivityOn	`string`	The datetime of the last activity of the folder.
items[].network	`object`	Information about the folder’s parent network.
items[].network.id	`string`	The unique identifier of the Network.
items[].network.name	`string`	The name of the Network.
items[].network.class	`string`	Indicates if the Network is a ‘Personal’ or ‘Enterprise’ Network.
items[].metadata	`array`	An array of key-value pairs of user-generated metadata.
items[].metadata[].name	`string`	The name of the metadata item.
items[].metadata[].value	`string`	the value of the metadata item.
items[].stats	`object`	Statistics about the folder.
items[].stats.childFolderCount	`number`	The number of child folders for the given folder.
items[].parentId	`string`	The unique identifier of the parent folder, if it is a child folder, or the workspace id, if it is the Workspace’s root folder.
items[].workspace	`object`	Information about the folder’s parent workspace.
items[].workspace.id	`string`	The unique identifier of the Workspace.
items[].workspace.name	`string`	The name of the Workspace.
items[].workspace.class	`string`	Indicates if the Workspace is a ‘Personal’ or ‘Team’ Workspace.
items[].parentFolder	`object`	Information about the folder’s parent folder. If the folder is the root folder of a Workspace this property will not be available.
items[].parentFolder.id	`string`	The unique identifier of the folder.
items[].parentFolder.name	`string`	The name of folder.
items[].isTrashed	`boolean`	Indicates if a folder is in the trash bin.
items[].kind	`string`	The type of item returned. Will always be ‘Folder’ for folders.

Headers

Content-Type: application/json

Body

{
  "code": "WorkspaceNotFound",
  "message": "Workspace not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Search Workspace Contents
GET`/workspaces/{workspaceId}/search{?query,kind,limit,offset,orderBy,orderDirection,fields}`

URI Parameters

HideShow

workspaceId

string (required)

The unique identifier of the workspace.

query

string (required)

The search query keywords. Its length must be 2 or more characters and can contain multiple keywords which are between 2 to 20 characters each. Keywords must be separated by whitespace. For example, ‘demo jpg’.

kind

string (optional) Default: all

Determines which kind of items will be returned.

Choices: folder asset all

limit

number (optional) Default: 50

The number of items to return. The maximum is 100.

offset

number (optional) Default: 0

The item at which to begin the response.

orderBy

string (optional) Default: relevance

The field to sort the items by.

Choices: createdOn name relevance

orderDirection

string (optional) Default: asc

The order direction the items should be returned.

Choices: asc desc

fields

string (optional)

A comma separated list of fields to return in the response. If this value is empty all fields will be returned. Id and Name are always returned.

Description

Searches for assets and folders inside a given workspace. The search operation is case insensitive and supports partial matching. This means the result set will include any asset or folder that contains any of the search keywords in it’s name. The search can contain multiple keywords as long as each keyword is separated by whitespace and is between 2 and 20 characters in length. The results are sorted by relevance so the items that match the most keywords will be at the top (note: regardless of relevance, folders always appear above assets in search results).

Errors

Status Code	Error Code	Message
400	InvalidLimitOrOffset	Invalid limit or offset value. Limit must be a number between 1 and 100. Offset must be greater than or equal to 0.
400	InvalidQueryOrderField	Invalid order field. It must be either ‘CreatedOn’, ‘Name’, or ‘Relevance’.
400	InvalidQueryOrderDirection	Invalid order direction. It must be either ‘Asc’ or ‘Desc’.
400	InvalidQueryKindFilter	Invalid kind filter. It must be either ‘All’, ‘Asset’ or ‘Folder’.
404	WorkspaceNotFound	Workspace not found.

Purge Trash ¶

POST https://api.cimediacloud.com/workspaces/moqxhkej4epvgrwz/purgetrash

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200404

Headers

Content-Type: application/json

Body

{
  "message": "Trash was purged"
}

Property name	Type	Description
message	`string`	Indicates successful purge.

Headers

Content-Type: application/json

Body

{
  "code": "WorkspaceNotFound",
  "message": "Workspace not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Purge Trash
POST`/workspaces/{workspaceId}/purgetrash`

URI Parameters

HideShow

workspaceId: string (required)
The unique identifier of the workspace.

Description

Deletes all trashed folders and assets for a workspace.

All folders and assets are permanently deleted and cannot be recovered.

Assets affected during this operation may not be updated immediately. This work is performed asynchronously and therefore it can take a few minutes for all updates to appear.

Errors

Status Code	Error Code	Message
404	WorkspaceNotFound	Workspace not found.

List Events ¶

POST https://api.cimediacloud.com/events

RequestsBasic Asset EventBasic Element EventBasic Folder EventRemove/Delete Asset EventPreview/Proxy EventCi Generated Thumbnail EventCopy EventArchive EventRestore EventAsset Metadata EventFolder Metadata EventElement Metadata EventCreate and Open MediaBox EventUpdate MediaBox Event

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "catalogId": "moqxhkej4epvgrwz",
  "workspaceId": "moqxhkej4epvgrwz",
  "since": "2017-01-02T00:00:00.000Z",
  "type": [
    "EventType"
  ],
  "limit": 1,
  "offset": 0,
  "orderDirection": "desc"
}

Property name	Type	Description
catalogId	`string`	The unique identifier of the Catalog.
workspaceId	`string`	The unique identifier of the Workspace.
since	`string`	Filters the events by their creation date. The operation will only return events that occurred on or after the given timestamp. Value must be in IS0 8601 date and time format (e.g.: ‘2020-01-01T00:00:00.000Z’).
type	`array`	List of event types to filter by. Omit this parameter to return all supported event types.
limit	`number`	The number of items to return. The maximum is 50.
offset	`number`	The item at which to begin the response.
orderDirection	`string`	The order direction the items should be returned.

Responses200404

Headers

Content-Type: application/json

Body

{
  "limit": 1,
  "offset": 0,
  "count": 10,
  "order": {
    "by": "Desc",
    "direction": "CreatedOn"
  },
  "filter": {
    "type": [
      "EventName"
    ],
    "since": "2020-01-01T00:00:00.000Z"
  },
  "items": [
    {
      "id": "prffhlw9iptcfqfc",
      "createdOn": "2017-01-02T00:00:00.000Z",
      "createdBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "type": "CreateAsset",
      "assets": [
        {
          "id": "d9bf018c804a4e78b775b8dc2f242071",
          "name": "Movie.mov"
        }
      ],
      "mediaBoxes": [
        {
          "id": "21c41d5dea414d2ba5f113adfe28214e",
          "name": "Videos for distribution"
        }
      ],
      "spaces": [
        {
          "id": "gb5ehomv0iv71swg",
          "name": "Workspace Name"
        }
      ]
    }
  ]
}

Property name	Type	Description
limit	`number`	The limit used for the query.
offset	`number`	The offset used for the query.
count	`number`	The total count of items available.
order	`object`	Information about the ordering of the results
order.by	`string`	The sort order of the results. Valid values are `Asc` and `Desc`.
order.direction	`string`	The field used to sort the results. The only valid value is `CreatedOn`.
filter	`object`	Information about the filter used for retrieving events.
filter.type	`array`	Indicates the event types used as a filter in the request. This field is omitted if no type was used to filter events.
filter.since	`string`	Indicates the timestamp used as a filter in the request. This field is omitted if no timestamp was used to filter events.
items	`array`	The set of events returned by the query.
items[].id	`string`	The unique identifier of the event.
items[].createdOn	`string`	The datetime the event occurred.
items[].createdBy	`object`	Information about the event creator.
items[].createdBy.id	`string`	The unique identifier of the user.
items[].createdBy.name	`string`	The full name of the user.
items[].createdBy.email	`string`	The email of the user.
items[].type	`string`	The type of the event.
items[].assets	`array`	The set of assets involved in the event.
items[].assets[].id	`string`	The unique identifier of the asset.
items[].assets[].name	`string`	The name of asset and its extension.
items[].mediaBoxes	`array`	If the event is for a MediaBox event, the set of MediaBoxes involved in the event.
items[].mediaBoxes[].id	`string`	The unique identifier of the MediaBox.
items[].mediaBoxes[].name	`string`	The name of MediaBox.
items[].spaces	`array`	The set of Spaces (Workspaces or Catalogs) involved in the event.
items[].spaces[].id	`string`	The unique identifier of the Workspace.
items[].spaces[].name	`string`	The name of the Workspace.

Headers

Content-Type: application/json

Body

{
  "code": "WorkspaceNotFound",
  "message": "Workspace not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "catalogId": "moqxhkej4epvgrwz",
  "workspaceId": "moqxhkej4epvgrwz",
  "since": "2017-01-02T00:00:00.000Z",
  "type": [
    "EventType"
  ],
  "limit": 1,
  "offset": 0,
  "orderDirection": "desc"
}

Property name	Type	Description
catalogId	`string`	The unique identifier of the Catalog.
workspaceId	`string`	The unique identifier of the Workspace.
since	`string`	Filters the events by their creation date. The operation will only return events that occurred on or after the given timestamp. Value must be in IS0 8601 date and time format (e.g.: ‘2020-01-01T00:00:00.000Z’).
type	`array`	List of event types to filter by. Omit this parameter to return all supported event types.
limit	`number`	The number of items to return. The maximum is 50.
offset	`number`	The item at which to begin the response.
orderDirection	`string`	The order direction the items should be returned.

Responses200404

Headers

Content-Type: application/json

Body

{
  "limit": 1,
  "offset": 0,
  "count": 10,
  "order": {
    "by": "Desc",
    "direction": "CreatedOn"
  },
  "filter": {
    "type": [
      "EventName"
    ],
    "since": "2020-01-01T00:00:00.000Z"
  },
  "items": [
    {
      "id": "prffhlw9iptcfqfc",
      "createdOn": "2017-01-02T00:00:00.000Z",
      "createdBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "type": "CreateElement",
      "elements": [
        {
          "id": "90d69c891da1457ca3bd3d856ad487c2",
          "name": "stillImage.jpg"
        }
      ],
      "assets": [
        {
          "id": "d9bf018c804a4e78b775b8dc2f242071",
          "name": "Movie.mov"
        }
      ],
      "mediaBoxes": [
        {
          "id": "21c41d5dea414d2ba5f113adfe28214e",
          "name": "Videos for distribution"
        }
      ],
      "spaces": [
        {
          "id": "gb5ehomv0iv71swg",
          "name": "Workspace Name"
        }
      ]
    }
  ]
}

Property name	Type	Description
limit	`number`	The limit used for the query.
offset	`number`	The offset used for the query.
count	`number`	The total count of items available.
order	`object`	Information about the ordering of the results
order.by	`string`	The sort order of the results. Valid values are `Asc` and `Desc`.
order.direction	`string`	The field used to sort the results. The only valid value is `CreatedOn`.
filter	`object`	Information about the filter used for retrieving events.
filter.type	`array`	Indicates the event types used as a filter in the request. This field is omitted if no type was used to filter events.
filter.since	`string`	Indicates the timestamp used as a filter in the request. This field is omitted if no timestamp was used to filter events.
items	`array`	The set of events returned by the query.
items[].id	`string`	The unique identifier of the event.
items[].createdOn	`string`	The datetime the event occurred.
items[].createdBy	`object`	Information about the event creator.
items[].createdBy.id	`string`	The unique identifier of the user.
items[].createdBy.name	`string`	The full name of the user.
items[].createdBy.email	`string`	The email of the user.
items[].type	`string`	The type of the event.
items[].elements	`array`	The set of elements involved in the event.
items[].elements[].id	`string`	The unique identifier of the element.
items[].elements[].name	`string`	The name of the element and its extension.
items[].assets	`array`	The set of assets involved in the event.
items[].assets[].id	`string`	The unique identifier of the asset.
items[].assets[].name	`string`	The name of asset and its extension.
items[].mediaBoxes	`array`	If the event is for a MediaBox event, the set of MediaBoxes involved in the event.
items[].mediaBoxes[].id	`string`	The unique identifier of the MediaBox.
items[].mediaBoxes[].name	`string`	The name of MediaBox.
items[].spaces	`array`	The set of Spaces (Workspaces or Catalogs) involved in the event.
items[].spaces[].id	`string`	The unique identifier of the Workspace.
items[].spaces[].name	`string`	The name of the Workspace.

Headers

Content-Type: application/json

Body

{
  "code": "WorkspaceNotFound",
  "message": "Workspace not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "catalogId": "moqxhkej4epvgrwz",
  "workspaceId": "moqxhkej4epvgrwz",
  "since": "2017-01-02T00:00:00.000Z",
  "type": [
    "EventType"
  ],
  "limit": 1,
  "offset": 0,
  "orderDirection": "desc"
}

Property name	Type	Description
catalogId	`string`	The unique identifier of the Catalog.
workspaceId	`string`	The unique identifier of the Workspace.
since	`string`	Filters the events by their creation date. The operation will only return events that occurred on or after the given timestamp. Value must be in IS0 8601 date and time format (e.g.: ‘2020-01-01T00:00:00.000Z’).
type	`array`	List of event types to filter by. Omit this parameter to return all supported event types.
limit	`number`	The number of items to return. The maximum is 50.
offset	`number`	The item at which to begin the response.
orderDirection	`string`	The order direction the items should be returned.

Responses200404

Headers

Content-Type: application/json

Body

{
  "limit": 1,
  "offset": 0,
  "count": 10,
  "order": {
    "by": "Desc",
    "direction": "CreatedOn"
  },
  "filter": {
    "type": [
      "EventName"
    ],
    "since": "2020-01-01T00:00:00.000Z"
  },
  "items": [
    {
      "id": "prffhlw9iptcfqfc",
      "createdOn": "2017-01-02T00:00:00.000Z",
      "createdBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "type": "CreateElement",
      "folders": [
        {
          "id": "9b639e12a82f4b0483f512b474dc052ci",
          "name": "Folder Name"
        }
      ],
      "mediaBoxes": [
        {
          "id": "21c41d5dea414d2ba5f113adfe28214e",
          "name": "Videos for distribution"
        }
      ],
      "spaces": [
        {
          "id": "gb5ehomv0iv71swg",
          "name": "Workspace Name"
        }
      ]
    }
  ]
}

Property name	Type	Description
limit	`number`	The limit used for the query.
offset	`number`	The offset used for the query.
count	`number`	The total count of items available.
order	`object`	Information about the ordering of the results
order.by	`string`	The sort order of the results. Valid values are `Asc` and `Desc`.
order.direction	`string`	The field used to sort the results. The only valid value is `CreatedOn`.
filter	`object`	Information about the filter used for retrieving events.
filter.type	`array`	Indicates the event types used as a filter in the request. This field is omitted if no type was used to filter events.
filter.since	`string`	Indicates the timestamp used as a filter in the request. This field is omitted if no timestamp was used to filter events.
items	`array`	The set of events returned by the query.
items[].id	`string`	The unique identifier of the event.
items[].createdOn	`string`	The datetime the event occurred.
items[].createdBy	`object`	Information about the event creator.
items[].createdBy.id	`string`	The unique identifier of the user.
items[].createdBy.name	`string`	The full name of the user.
items[].createdBy.email	`string`	The email of the user.
items[].type	`string`	The type of the event.
items[].folders	`array`	The set of folders involved in the event.
items[].folders[].id	`string`	The unique identifier of the folder.
items[].folders[].name	`string`	The name of folder.
items[].mediaBoxes	`array`	If the event is for a MediaBox event, the set of MediaBoxes involved in the event.
items[].mediaBoxes[].id	`string`	The unique identifier of the MediaBox.
items[].mediaBoxes[].name	`string`	The name of MediaBox.
items[].spaces	`array`	The set of Spaces (Workspaces or Catalogs) involved in the event.
items[].spaces[].id	`string`	The unique identifier of the Workspace.
items[].spaces[].name	`string`	The name of the Workspace.

Headers

Content-Type: application/json

Body

{
  "code": "WorkspaceNotFound",
  "message": "Workspace not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "catalogId": "moqxhkej4epvgrwz",
  "workspaceId": "moqxhkej4epvgrwz",
  "since": "2017-01-02T00:00:00.000Z",
  "type": [
    "EventType"
  ],
  "limit": 1,
  "offset": 0,
  "orderDirection": "desc"
}

Property name	Type	Description
catalogId	`string`	The unique identifier of the Catalog.
workspaceId	`string`	The unique identifier of the Workspace.
since	`string`	Filters the events by their creation date. The operation will only return events that occurred on or after the given timestamp. Value must be in IS0 8601 date and time format (e.g.: ‘2020-01-01T00:00:00.000Z’).
type	`array`	List of event types to filter by. Omit this parameter to return all supported event types.
limit	`number`	The number of items to return. The maximum is 50.
offset	`number`	The item at which to begin the response.
orderDirection	`string`	The order direction the items should be returned.

Responses200404

Headers

Content-Type: application/json

Body

{
  "limit": 1,
  "offset": 0,
  "count": 10,
  "order": {
    "by": "Desc",
    "direction": "CreatedOn"
  },
  "filter": {
    "type": [
      "EventName"
    ],
    "since": "2020-01-01T00:00:00.000Z"
  },
  "items": [
    {
      "id": "prffhlw9iptcfqfc",
      "createdOn": "2017-01-02T00:00:00.000Z",
      "createdBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "type": "RemoveAssetFromCatalogFolder",
      "assets": [
        {
          "id": "d9bf018c804a4e78b775b8dc2f242071",
          "name": "Movie.mov"
        }
      ],
      "folders": [
        {
          "id": "9b639e12a82f4b0483f512b474dc052ci",
          "name": "Folder Name"
        }
      ],
      "mediaBoxes": [
        {
          "id": "21c41d5dea414d2ba5f113adfe28214e",
          "name": "Videos for distribution"
        }
      ],
      "spaces": [
        {
          "id": "gb5ehomv0iv71swg",
          "name": "Workspace Name"
        }
      ]
    }
  ]
}

Property name	Type	Description
limit	`number`	The limit used for the query.
offset	`number`	The offset used for the query.
count	`number`	The total count of items available.
order	`object`	Information about the ordering of the results
order.by	`string`	The sort order of the results. Valid values are `Asc` and `Desc`.
order.direction	`string`	The field used to sort the results. The only valid value is `CreatedOn`.
filter	`object`	Information about the filter used for retrieving events.
filter.type	`array`	Indicates the event types used as a filter in the request. This field is omitted if no type was used to filter events.
filter.since	`string`	Indicates the timestamp used as a filter in the request. This field is omitted if no timestamp was used to filter events.
items	`array`	The set of events returned by the query.
items[].id	`string`	The unique identifier of the event.
items[].createdOn	`string`	The datetime the event occurred.
items[].createdBy	`object`	Information about the event creator.
items[].createdBy.id	`string`	The unique identifier of the user.
items[].createdBy.name	`string`	The full name of the user.
items[].createdBy.email	`string`	The email of the user.
items[].type	`string`	The type of the event.
items[].assets	`array`	The set of assets involved in the event.
items[].assets[].id	`string`	The unique identifier of the asset.
items[].assets[].name	`string`	The name of asset and its extension.
items[].folders	`array`	The folders were the removed or deleted asset was located.
items[].folders[].id	`string`	The unique identifier of the folder.
items[].folders[].name	`string`	The name of folder.
items[].mediaBoxes	`array`	If the event is for a MediaBox event, the set of MediaBoxes involved in the event.
items[].mediaBoxes[].id	`string`	The unique identifier of the MediaBox.
items[].mediaBoxes[].name	`string`	The name of MediaBox.
items[].spaces	`array`	The set of Spaces (Workspaces or Catalogs) involved in the event.
items[].spaces[].id	`string`	The unique identifier of the Workspace.
items[].spaces[].name	`string`	The name of the Workspace.

Headers

Content-Type: application/json

Body

{
  "code": "WorkspaceNotFound",
  "message": "Workspace not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "catalogId": "moqxhkej4epvgrwz",
  "workspaceId": "moqxhkej4epvgrwz",
  "since": "2017-01-02T00:00:00.000Z",
  "type": [
    "EventType"
  ],
  "limit": 1,
  "offset": 0,
  "orderDirection": "desc"
}

Property name	Type	Description
catalogId	`string`	The unique identifier of the Catalog.
workspaceId	`string`	The unique identifier of the Workspace.
since	`string`	Filters the events by their creation date. The operation will only return events that occurred on or after the given timestamp. Value must be in IS0 8601 date and time format (e.g.: ‘2020-01-01T00:00:00.000Z’).
type	`array`	List of event types to filter by. Omit this parameter to return all supported event types.
limit	`number`	The number of items to return. The maximum is 50.
offset	`number`	The item at which to begin the response.
orderDirection	`string`	The order direction the items should be returned.

Responses200404

Headers

Content-Type: application/json

Body

{
  "limit": 1,
  "offset": 0,
  "count": 10,
  "order": {
    "by": "Desc",
    "direction": "CreatedOn"
  },
  "filter": {
    "type": [
      "EventName"
    ],
    "since": "2020-01-01T00:00:00.000Z"
  },
  "items": [
    {
      "id": "prffhlw9iptcfqfc",
      "createdOn": "2017-01-02T00:00:00.000Z",
      "createdBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "type": "DownloadProxy",
      "assets": [
        {
          "id": "d9bf018c804a4e78b775b8dc2f242071",
          "name": "Movie.mov",
          "proxyTypes": [
            "video-2k"
          ]
        }
      ],
      "mediaBoxes": [
        {
          "id": "21c41d5dea414d2ba5f113adfe28214e",
          "name": "Videos for distribution"
        }
      ],
      "spaces": [
        {
          "id": "gb5ehomv0iv71swg",
          "name": "Workspace Name"
        }
      ]
    }
  ]
}

Property name	Type	Description
limit	`number`	The limit used for the query.
offset	`number`	The offset used for the query.
count	`number`	The total count of items available.
order	`object`	Information about the ordering of the results
order.by	`string`	The sort order of the results. Valid values are `Asc` and `Desc`.
order.direction	`string`	The field used to sort the results. The only valid value is `CreatedOn`.
filter	`object`	Information about the filter used for retrieving events.
filter.type	`array`	Indicates the event types used as a filter in the request. This field is omitted if no type was used to filter events.
filter.since	`string`	Indicates the timestamp used as a filter in the request. This field is omitted if no timestamp was used to filter events.
items	`array`	The set of events returned by the query.
items[].id	`string`	The unique identifier of the event.
items[].createdOn	`string`	The datetime the event occurred.
items[].createdBy	`object`	Information about the event creator.
items[].createdBy.id	`string`	The unique identifier of the user.
items[].createdBy.name	`string`	The full name of the user.
items[].createdBy.email	`string`	The email of the user.
items[].type	`string`	The type of the event.
items[].assets	`array` (required)	The set of assets involved in the event.
items[].assets[].id	`string` (required)	The unique identifier of the asset.
items[].assets[].name	`string` (required)	The name of asset and its extension.
items[].assets[].proxyTypes	`array` (required)	Indicates the quality level of the proxy that was involved in the event. Valid values are `video-3g`, `video-sd`, `video-hd`, `video-hd+`, `video-2k`, and `video-2k+`.
items[].mediaBoxes	`array`	If the event is for a MediaBox event, the set of MediaBoxes involved in the event.
items[].mediaBoxes[].id	`string`	The unique identifier of the MediaBox.
items[].mediaBoxes[].name	`string`	The name of MediaBox.
items[].spaces	`array`	The set of Spaces (Workspaces or Catalogs) involved in the event.
items[].spaces[].id	`string`	The unique identifier of the Workspace.
items[].spaces[].name	`string`	The name of the Workspace.

Headers

Content-Type: application/json

Body

{
  "code": "WorkspaceNotFound",
  "message": "Workspace not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "catalogId": "moqxhkej4epvgrwz",
  "workspaceId": "moqxhkej4epvgrwz",
  "since": "2017-01-02T00:00:00.000Z",
  "type": [
    "EventType"
  ],
  "limit": 1,
  "offset": 0,
  "orderDirection": "desc"
}

Property name	Type	Description
catalogId	`string`	The unique identifier of the Catalog.
workspaceId	`string`	The unique identifier of the Workspace.
since	`string`	Filters the events by their creation date. The operation will only return events that occurred on or after the given timestamp. Value must be in IS0 8601 date and time format (e.g.: ‘2020-01-01T00:00:00.000Z’).
type	`array`	List of event types to filter by. Omit this parameter to return all supported event types.
limit	`number`	The number of items to return. The maximum is 50.
offset	`number`	The item at which to begin the response.
orderDirection	`string`	The order direction the items should be returned.

Responses200404

Headers

Content-Type: application/json

Body

{
  "limit": 1,
  "offset": 0,
  "count": 10,
  "order": {
    "by": "Desc",
    "direction": "CreatedOn"
  },
  "filter": {
    "type": [
      "EventName"
    ],
    "since": "2020-01-01T00:00:00.000Z"
  },
  "items": [
    {
      "id": "prffhlw9iptcfqfc",
      "createdOn": "2017-01-02T00:00:00.000Z",
      "createdBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "type": "DownloadThumbnail",
      "assets": [
        {
          "id": "d9bf018c804a4e78b775b8dc2f242071",
          "name": "Movie.mov",
          "thumbnailTypes": [
            "video-2k"
          ]
        }
      ],
      "spaces": [
        {
          "id": "gb5ehomv0iv71swg",
          "name": "Workspace Name"
        }
      ]
    }
  ]
}

Property name	Type	Description
limit	`number`	The limit used for the query.
offset	`number`	The offset used for the query.
count	`number`	The total count of items available.
order	`object`	Information about the ordering of the results
order.by	`string`	The sort order of the results. Valid values are `Asc` and `Desc`.
order.direction	`string`	The field used to sort the results. The only valid value is `CreatedOn`.
filter	`object`	Information about the filter used for retrieving events.
filter.type	`array`	Indicates the event types used as a filter in the request. This field is omitted if no type was used to filter events.
filter.since	`string`	Indicates the timestamp used as a filter in the request. This field is omitted if no timestamp was used to filter events.
items	`array`	The set of events returned by the query.
items[].id	`string`	The unique identifier of the event.
items[].createdOn	`string`	The datetime the event occurred.
items[].createdBy	`object`	Information about the event creator.
items[].createdBy.id	`string`	The unique identifier of the user.
items[].createdBy.name	`string`	The full name of the user.
items[].createdBy.email	`string`	The email of the user.
items[].type	`string`	The type of the event.
items[].assets	`array` (required)	The set of assets involved in the event.
items[].assets[].id	`string` (required)	The unique identifier of the asset.
items[].assets[].name	`string` (required)	The name of asset and its extension.
items[].assets[].thumbnailTypes	`array` (required)	Indicates the size of the thumbnail that was involved in the event. Valid values are `small`, `medium`, `large`, and `2000k`.
items[].spaces	`array`	The set of Spaces (Workspaces or Catalogs) involved in the event.
items[].spaces[].id	`string`	The unique identifier of the Workspace.
items[].spaces[].name	`string`	The name of the Workspace.

Headers

Content-Type: application/json

Body

{
  "code": "WorkspaceNotFound",
  "message": "Workspace not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "catalogId": "moqxhkej4epvgrwz",
  "workspaceId": "moqxhkej4epvgrwz",
  "since": "2017-01-02T00:00:00.000Z",
  "type": [
    "EventType"
  ],
  "limit": 1,
  "offset": 0,
  "orderDirection": "desc"
}

Property name	Type	Description
catalogId	`string`	The unique identifier of the Catalog.
workspaceId	`string`	The unique identifier of the Workspace.
since	`string`	Filters the events by their creation date. The operation will only return events that occurred on or after the given timestamp. Value must be in IS0 8601 date and time format (e.g.: ‘2020-01-01T00:00:00.000Z’).
type	`array`	List of event types to filter by. Omit this parameter to return all supported event types.
limit	`number`	The number of items to return. The maximum is 50.
offset	`number`	The item at which to begin the response.
orderDirection	`string`	The order direction the items should be returned.

Responses200404

Headers

Content-Type: application/json

Body

{
  "limit": 1,
  "offset": 0,
  "count": 10,
  "order": {
    "by": "Desc",
    "direction": "CreatedOn"
  },
  "filter": {
    "type": [
      "EventName"
    ],
    "since": "2020-01-01T00:00:00.000Z"
  },
  "items": [
    {
      "id": "prffhlw9iptcfqfc",
      "createdOn": "2017-01-02T00:00:00.000Z",
      "createdBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "type": "CopyAsset",
      "assets": [
        {
          "id": "d9bf018c804a4e78b775b8dc2f242071",
          "name": "Movie.mov",
          "folderIds": [
            "60ba68af38dc43cc986aeca498ec5637"
          ],
          "context": "Source"
        },
        {
          "id": "d9bf018c804a4e78b775b8dc2f242071",
          "name": "Movie.mov",
          "folderIds": [
            "60ba68af38dc43cc986aeca498ec5637"
          ],
          "context": "Target"
        }
      ],
      "folders": [
        {
          "id": "9b639e12a82f4b0483f512b474dc052ci",
          "name": "Folder Name",
          "context": "Source"
        },
        {
          "id": "d45a566763434889b7b8e555176d6a2b",
          "name": "Folder Name",
          "context": "Target"
        }
      ],
      "elements": [
        {
          "id": "90d69c891da1457ca3bd3d856ad487c2",
          "name": "stillImage.jpg",
          "context": "Source"
        },
        {
          "id": "1ba89a93d03e4715868afe733c2f2d58",
          "name": "stillImage.jpg",
          "context": "Target"
        }
      ],
      "mediaBoxes": [
        {
          "id": "21c41d5dea414d2ba5f113adfe28214e",
          "name": "Videos for distribution"
        }
      ],
      "spaces": [
        {
          "id": "gb5ehomv0iv71swg",
          "name": "Workspace Name",
          "context": "Source"
        },
        {
          "id": "df998c289e594a2187717b6836c83a25",
          "name": "Workspace Name",
          "context": "Target"
        }
      ]
    }
  ]
}

Property name	Type	Description
limit	`number`	The limit used for the query.
offset	`number`	The offset used for the query.
count	`number`	The total count of items available.
order	`object`	Information about the ordering of the results
order.by	`string`	The sort order of the results. Valid values are `Asc` and `Desc`.
order.direction	`string`	The field used to sort the results. The only valid value is `CreatedOn`.
filter	`object`	Information about the filter used for retrieving events.
filter.type	`array`	Indicates the event types used as a filter in the request. This field is omitted if no type was used to filter events.
filter.since	`string`	Indicates the timestamp used as a filter in the request. This field is omitted if no timestamp was used to filter events.
items	`array`	The set of events returned by the query.
items[].id	`string`	The unique identifier of the event.
items[].createdOn	`string`	The datetime the event occurred.
items[].createdBy	`object`	Information about the event creator.
items[].createdBy.id	`string`	The unique identifier of the user.
items[].createdBy.name	`string`	The full name of the user.
items[].createdBy.email	`string`	The email of the user.
items[].type	`string`	The type of the event.
items[].assets	`array` (required)	The set of assets involved in the event.
items[].assets[].id	`string` (required)	The unique identifier of the asset.
items[].assets[].name	`string` (required)	The name of asset and its extension.
items[].assets[].folderIds	`array` (required)	The set of folders (for this asset) involved in the event.
items[].assets[].context	`string` (required)	Indicates whether this asset is the `Source` asset or the `Target` asset for the copy event.
items[].folders	`array` (required)	The set of folders involved in the event.
items[].folders[].id	`string` (required)	The unique identifier of the folder.
items[].folders[].name	`string` (required)	The name of folder.
items[].folders[].context	`string` (required)	Indicates whether this folder is the `Source` folder or the `Target` folder for the copy event.
items[].elements	`array` (required)	The set of assets involved in the event.
items[].elements[].id	`string` (required)	The unique identifier of the element.
items[].elements[].name	`string` (required)	The name of the element and its extension.
items[].elements[].context	`string` (required)	Indicates whether this element is the `Source` folder or the `Target` folder for the copy event.
items[].mediaBoxes	`array`	If the event is for a MediaBox event, the set of MediaBoxes involved in the event.
items[].mediaBoxes[].id	`string`	The unique identifier of the MediaBox.
items[].mediaBoxes[].name	`string`	The name of MediaBox.
items[].spaces	`array` (required)	The set of Spaces (Workspaces or Catalogs) involved in the event.
items[].spaces[].id	`string` (required)	The unique identifier of the Workspace.
items[].spaces[].name	`string` (required)	The name of the Workspace.
items[].spaces[].context	`string` (required)	Indicates whether this Space is the `Source` folder or the `Target` folder for the copy event.

Headers

Content-Type: application/json

Body

{
  "code": "WorkspaceNotFound",
  "message": "Workspace not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "catalogId": "moqxhkej4epvgrwz",
  "workspaceId": "moqxhkej4epvgrwz",
  "since": "2017-01-02T00:00:00.000Z",
  "type": [
    "EventType"
  ],
  "limit": 1,
  "offset": 0,
  "orderDirection": "desc"
}

Property name	Type	Description
catalogId	`string`	The unique identifier of the Catalog.
workspaceId	`string`	The unique identifier of the Workspace.
since	`string`	Filters the events by their creation date. The operation will only return events that occurred on or after the given timestamp. Value must be in IS0 8601 date and time format (e.g.: ‘2020-01-01T00:00:00.000Z’).
type	`array`	List of event types to filter by. Omit this parameter to return all supported event types.
limit	`number`	The number of items to return. The maximum is 50.
offset	`number`	The item at which to begin the response.
orderDirection	`string`	The order direction the items should be returned.

Responses200404

Headers

Content-Type: application/json

Body

{
  "limit": 1,
  "offset": 0,
  "count": 10,
  "order": {
    "by": "Desc",
    "direction": "CreatedOn"
  },
  "filter": {
    "type": [
      "EventName"
    ],
    "since": "2020-01-01T00:00:00.000Z"
  },
  "items": [
    {
      "id": "prffhlw9iptcfqfc",
      "createdOn": "2017-01-02T00:00:00.000Z",
      "createdBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "type": "AssetArchiveStatusChange",
      "assets": [
        {
          "id": "d9bf018c804a4e78b775b8dc2f242071",
          "name": "Movie.mov",
          "archiveStatus": "Not archived",
          "previousArchiveStatus": "Archived"
        }
      ],
      "spaces": [
        {
          "id": "gb5ehomv0iv71swg",
          "name": "Workspace Name"
        }
      ]
    }
  ]
}

Property name	Type	Description
limit	`number`	The limit used for the query.
offset	`number`	The offset used for the query.
count	`number`	The total count of items available.
order	`object`	Information about the ordering of the results
order.by	`string`	The sort order of the results. Valid values are `Asc` and `Desc`.
order.direction	`string`	The field used to sort the results. The only valid value is `CreatedOn`.
filter	`object`	Information about the filter used for retrieving events.
filter.type	`array`	Indicates the event types used as a filter in the request. This field is omitted if no type was used to filter events.
filter.since	`string`	Indicates the timestamp used as a filter in the request. This field is omitted if no timestamp was used to filter events.
items	`array`	The set of events returned by the query.
items[].id	`string`	The unique identifier of the event.
items[].createdOn	`string`	The datetime the event occurred.
items[].createdBy	`object`	Information about the event creator.
items[].createdBy.id	`string`	The unique identifier of the user.
items[].createdBy.name	`string`	The full name of the user.
items[].createdBy.email	`string`	The email of the user.
items[].type	`string`	The type of the event.
items[].assets	`array` (required)	The set of assets involved in the event.
items[].assets[].id	`string` (required)	The unique identifier of the asset.
items[].assets[].name	`string` (required)	The name of asset and its extension.
items[].assets[].archiveStatus	`string` (required)	If available, the archive status of the asset. Valid values are `Not archived`, `Archive in progress`, `Archive failed`, `Archived`, `Cancel archive in progress`.
items[].assets[].previousArchiveStatus	`string` (required)	If available, the archive status of the asset prior to the event. Valid values are `Not archived`, `Archive in progress`, `Archive failed`, `Archived`, `Cancel archive in progress`.
items[].spaces	`array` (required)	The set of Spaces (Workspaces or Catalogs) involved in the event.
items[].spaces[].id	`string` (required)	The unique identifier of the Workspace.
items[].spaces[].name	`string` (required)	The name of the Workspace.

Headers

Content-Type: application/json

Body

{
  "code": "WorkspaceNotFound",
  "message": "Workspace not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "catalogId": "moqxhkej4epvgrwz",
  "workspaceId": "moqxhkej4epvgrwz",
  "since": "2017-01-02T00:00:00.000Z",
  "type": [
    "EventType"
  ],
  "limit": 1,
  "offset": 0,
  "orderDirection": "desc"
}

Property name	Type	Description
catalogId	`string`	The unique identifier of the Catalog.
workspaceId	`string`	The unique identifier of the Workspace.
since	`string`	Filters the events by their creation date. The operation will only return events that occurred on or after the given timestamp. Value must be in IS0 8601 date and time format (e.g.: ‘2020-01-01T00:00:00.000Z’).
type	`array`	List of event types to filter by. Omit this parameter to return all supported event types.
limit	`number`	The number of items to return. The maximum is 50.
offset	`number`	The item at which to begin the response.
orderDirection	`string`	The order direction the items should be returned.

Responses200404

Headers

Content-Type: application/json

Body

{
  "limit": 1,
  "offset": 0,
  "count": 10,
  "order": {
    "by": "Desc",
    "direction": "CreatedOn"
  },
  "filter": {
    "type": [
      "EventName"
    ],
    "since": "2020-01-01T00:00:00.000Z"
  },
  "items": [
    {
      "id": "prffhlw9iptcfqfc",
      "createdOn": "2017-01-02T00:00:00.000Z",
      "createdBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "type": "AssetRestoreStatusChange",
      "assets": [
        {
          "id": "d9bf018c804a4e78b775b8dc2f242071",
          "name": "Movie.mov",
          "restoreStatus": "Not restored",
          "previousRestoreStatus": "Restore in progress"
        }
      ],
      "spaces": [
        {
          "id": "gb5ehomv0iv71swg",
          "name": "Workspace Name"
        }
      ]
    }
  ]
}

Property name	Type	Description
limit	`number`	The limit used for the query.
offset	`number`	The offset used for the query.
count	`number`	The total count of items available.
order	`object`	Information about the ordering of the results
order.by	`string`	The sort order of the results. Valid values are `Asc` and `Desc`.
order.direction	`string`	The field used to sort the results. The only valid value is `CreatedOn`.
filter	`object`	Information about the filter used for retrieving events.
filter.type	`array`	Indicates the event types used as a filter in the request. This field is omitted if no type was used to filter events.
filter.since	`string`	Indicates the timestamp used as a filter in the request. This field is omitted if no timestamp was used to filter events.
items	`array`	The set of events returned by the query.
items[].id	`string`	The unique identifier of the event.
items[].createdOn	`string`	The datetime the event occurred.
items[].createdBy	`object`	Information about the event creator.
items[].createdBy.id	`string`	The unique identifier of the user.
items[].createdBy.name	`string`	The full name of the user.
items[].createdBy.email	`string`	The email of the user.
items[].type	`string`	The type of the event.
items[].assets	`array` (required)	The set of assets involved in the event.
items[].assets[].id	`string` (required)	The unique identifier of the asset.
items[].assets[].name	`string` (required)	The name of asset and its extension.
items[].assets[].restoreStatus	`string` (required)	If available, the restore status of the asset. This is applicable to assets that have been archived. Valid values are `Not restored`, `Restore in progress`, `Restore failed`, `Restored`.
items[].assets[].previousRestoreStatus	`string` (required)	If available, the restore status of the asset prior to the event. This is applicable to assets that have been archived. Valid values are `Not restored`, `Restore in progress`, `Restore failed`, `Restored`.
items[].spaces	`array` (required)	The set of Spaces (Workspaces or Catalogs) involved in the event.
items[].spaces[].id	`string` (required)	The unique identifier of the Workspace.
items[].spaces[].name	`string` (required)	The name of the Workspace.

Headers

Content-Type: application/json

Body

{
  "code": "WorkspaceNotFound",
  "message": "Workspace not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "catalogId": "moqxhkej4epvgrwz",
  "workspaceId": "moqxhkej4epvgrwz",
  "since": "2017-01-02T00:00:00.000Z",
  "type": [
    "EventType"
  ],
  "limit": 1,
  "offset": 0,
  "orderDirection": "desc"
}

Property name	Type	Description
catalogId	`string`	The unique identifier of the Catalog.
workspaceId	`string`	The unique identifier of the Workspace.
since	`string`	Filters the events by their creation date. The operation will only return events that occurred on or after the given timestamp. Value must be in IS0 8601 date and time format (e.g.: ‘2020-01-01T00:00:00.000Z’).
type	`array`	List of event types to filter by. Omit this parameter to return all supported event types.
limit	`number`	The number of items to return. The maximum is 50.
offset	`number`	The item at which to begin the response.
orderDirection	`string`	The order direction the items should be returned.

Responses200404

Headers

Content-Type: application/json

Body

{
  "limit": 1,
  "offset": 0,
  "count": 10,
  "order": {
    "by": "Desc",
    "direction": "CreatedOn"
  },
  "filter": {
    "type": [
      "EventName"
    ],
    "since": "2020-01-01T00:00:00.000Z"
  },
  "items": [
    {
      "id": "prffhlw9iptcfqfc",
      "createdOn": "2017-01-02T00:00:00.000Z",
      "createdBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "type": "AssetMetadataChange",
      "assets": [
        {
          "id": "d9bf018c804a4e78b775b8dc2f242071",
          "name": "Movie.mov",
          "metadata": [
            {
              "name": "Location",
              "value": "New York"
            }
          ],
          "previousMetadata": [
            {
              "name": "Location",
              "value": "Los Angeles"
            }
          ]
        }
      ],
      "spaces": [
        {
          "id": "gb5ehomv0iv71swg",
          "name": "Workspace Name"
        }
      ]
    }
  ]
}

Property name	Type	Description
limit	`number`	The limit used for the query.
offset	`number`	The offset used for the query.
count	`number`	The total count of items available.
order	`object`	Information about the ordering of the results
order.by	`string`	The sort order of the results. Valid values are `Asc` and `Desc`.
order.direction	`string`	The field used to sort the results. The only valid value is `CreatedOn`.
filter	`object`	Information about the filter used for retrieving events.
filter.type	`array`	Indicates the event types used as a filter in the request. This field is omitted if no type was used to filter events.
filter.since	`string`	Indicates the timestamp used as a filter in the request. This field is omitted if no timestamp was used to filter events.
items	`array`	The set of events returned by the query.
items[].id	`string`	The unique identifier of the event.
items[].createdOn	`string`	The datetime the event occurred.
items[].createdBy	`object`	Information about the event creator.
items[].createdBy.id	`string`	The unique identifier of the user.
items[].createdBy.name	`string`	The full name of the user.
items[].createdBy.email	`string`	The email of the user.
items[].type	`string`	The type of the event.
items[].assets	`array` (required)	The set of assets involved in the event.
items[].assets[].id	`string` (required)	The unique identifier of the asset.
items[].assets[].name	`string` (required)	The name of asset and its extension.
items[].assets[].metadata	`array` (required)	The updated metadata values for the asset.
items[].assets[].metadata[].name	`string` (required)	The name / key of the metadata field
items[].assets[].metadata[].value	`string` (required)	The value of the metadata field
items[].assets[].previousMetadata	`array` (required)	The previous metadata values for the asset.
items[].assets[].previousMetadata[].name	`string` (required)	The name / key of the metadata field
items[].assets[].previousMetadata[].value	`string` (required)	The value of the metadata field
items[].spaces	`array` (required)	The set of Spaces (Workspaces or Catalogs) involved in the event.
items[].spaces[].id	`string` (required)	The unique identifier of the Workspace.
items[].spaces[].name	`string` (required)	The name of the Workspace.

Headers

Content-Type: application/json

Body

{
  "code": "WorkspaceNotFound",
  "message": "Workspace not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "catalogId": "moqxhkej4epvgrwz",
  "workspaceId": "moqxhkej4epvgrwz",
  "since": "2017-01-02T00:00:00.000Z",
  "type": [
    "EventType"
  ],
  "limit": 1,
  "offset": 0,
  "orderDirection": "desc"
}

Property name	Type	Description
catalogId	`string`	The unique identifier of the Catalog.
workspaceId	`string`	The unique identifier of the Workspace.
since	`string`	Filters the events by their creation date. The operation will only return events that occurred on or after the given timestamp. Value must be in IS0 8601 date and time format (e.g.: ‘2020-01-01T00:00:00.000Z’).
type	`array`	List of event types to filter by. Omit this parameter to return all supported event types.
limit	`number`	The number of items to return. The maximum is 50.
offset	`number`	The item at which to begin the response.
orderDirection	`string`	The order direction the items should be returned.

Responses200404

Headers

Content-Type: application/json

Body

{
  "limit": 1,
  "offset": 0,
  "count": 10,
  "order": {
    "by": "Desc",
    "direction": "CreatedOn"
  },
  "filter": {
    "type": [
      "EventName"
    ],
    "since": "2020-01-01T00:00:00.000Z"
  },
  "items": [
    {
      "id": "prffhlw9iptcfqfc",
      "createdOn": "2017-01-02T00:00:00.000Z",
      "createdBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "type": "FolderMetadataChange",
      "folders": [
        {
          "id": "9b639e12a82f4b0483f512b474dc052ci",
          "name": "Folder Name",
          "metadata": [
            {
              "name": "Location",
              "value": "New York"
            }
          ],
          "previousMetadata": [
            {
              "name": "Location",
              "value": "Los Angeles"
            }
          ]
        }
      ],
      "spaces": [
        {
          "id": "gb5ehomv0iv71swg",
          "name": "Workspace Name"
        }
      ]
    }
  ]
}

Property name	Type	Description
limit	`number`	The limit used for the query.
offset	`number`	The offset used for the query.
count	`number`	The total count of items available.
order	`object`	Information about the ordering of the results
order.by	`string`	The sort order of the results. Valid values are `Asc` and `Desc`.
order.direction	`string`	The field used to sort the results. The only valid value is `CreatedOn`.
filter	`object`	Information about the filter used for retrieving events.
filter.type	`array`	Indicates the event types used as a filter in the request. This field is omitted if no type was used to filter events.
filter.since	`string`	Indicates the timestamp used as a filter in the request. This field is omitted if no timestamp was used to filter events.
items	`array`	The set of events returned by the query.
items[].id	`string`	The unique identifier of the event.
items[].createdOn	`string`	The datetime the event occurred.
items[].createdBy	`object`	Information about the event creator.
items[].createdBy.id	`string`	The unique identifier of the user.
items[].createdBy.name	`string`	The full name of the user.
items[].createdBy.email	`string`	The email of the user.
items[].type	`string`	The type of the event.
items[].folders	`array` (required)	The set of assets involved in the event.
items[].folders[].id	`string` (required)	The unique identifier of the folder.
items[].folders[].name	`string` (required)	The name of folder.
items[].folders[].metadata	`array` (required)	The updated metadata values for the folder.
items[].folders[].metadata[].name	`string` (required)	The name / key of the metadata field
items[].folders[].metadata[].value	`string` (required)	The value of the metadata field
items[].folders[].previousMetadata	`array` (required)	The previous metadata values for the folder.
items[].folders[].previousMetadata[].name	`string` (required)	The name / key of the metadata field
items[].folders[].previousMetadata[].value	`string` (required)	The value of the metadata field
items[].spaces	`array` (required)	The set of Spaces (Workspaces or Catalogs) involved in the event.
items[].spaces[].id	`string` (required)	The unique identifier of the Workspace.
items[].spaces[].name	`string` (required)	The name of the Workspace.

Headers

Content-Type: application/json

Body

{
  "code": "WorkspaceNotFound",
  "message": "Workspace not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "catalogId": "moqxhkej4epvgrwz",
  "workspaceId": "moqxhkej4epvgrwz",
  "since": "2017-01-02T00:00:00.000Z",
  "type": [
    "EventType"
  ],
  "limit": 1,
  "offset": 0,
  "orderDirection": "desc"
}

Property name	Type	Description
catalogId	`string`	The unique identifier of the Catalog.
workspaceId	`string`	The unique identifier of the Workspace.
since	`string`	Filters the events by their creation date. The operation will only return events that occurred on or after the given timestamp. Value must be in IS0 8601 date and time format (e.g.: ‘2020-01-01T00:00:00.000Z’).
type	`array`	List of event types to filter by. Omit this parameter to return all supported event types.
limit	`number`	The number of items to return. The maximum is 50.
offset	`number`	The item at which to begin the response.
orderDirection	`string`	The order direction the items should be returned.

Responses200404

Headers

Content-Type: application/json

Body

{
  "limit": 1,
  "offset": 0,
  "count": 10,
  "order": {
    "by": "Desc",
    "direction": "CreatedOn"
  },
  "filter": {
    "type": [
      "EventName"
    ],
    "since": "2020-01-01T00:00:00.000Z"
  },
  "items": [
    {
      "id": "prffhlw9iptcfqfc",
      "createdOn": "2017-01-02T00:00:00.000Z",
      "createdBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "type": "ElementMetadataChange",
      "elements": [
        {
          "id": "90d69c891da1457ca3bd3d856ad487c2",
          "name": "stillImage.jpg",
          "metadata": [
            {
              "name": "Location",
              "value": "New York"
            }
          ],
          "previousMetadata": [
            {
              "name": "Location",
              "value": "Los Angeles"
            }
          ]
        }
      ],
      "spaces": [
        {
          "id": "gb5ehomv0iv71swg",
          "name": "Workspace Name"
        }
      ]
    }
  ]
}

Property name	Type	Description
limit	`number`	The limit used for the query.
offset	`number`	The offset used for the query.
count	`number`	The total count of items available.
order	`object`	Information about the ordering of the results
order.by	`string`	The sort order of the results. Valid values are `Asc` and `Desc`.
order.direction	`string`	The field used to sort the results. The only valid value is `CreatedOn`.
filter	`object`	Information about the filter used for retrieving events.
filter.type	`array`	Indicates the event types used as a filter in the request. This field is omitted if no type was used to filter events.
filter.since	`string`	Indicates the timestamp used as a filter in the request. This field is omitted if no timestamp was used to filter events.
items	`array`	The set of events returned by the query.
items[].id	`string`	The unique identifier of the event.
items[].createdOn	`string`	The datetime the event occurred.
items[].createdBy	`object`	Information about the event creator.
items[].createdBy.id	`string`	The unique identifier of the user.
items[].createdBy.name	`string`	The full name of the user.
items[].createdBy.email	`string`	The email of the user.
items[].type	`string`	The type of the event.
items[].elements	`array` (required)	The set of assets involved in the event.
items[].elements[].id	`string` (required)	The unique identifier of the element.
items[].elements[].name	`string` (required)	The name of the element and its extension.
items[].elements[].metadata	`array` (required)	The updated metadata values for the folder.
items[].elements[].metadata[].name	`string` (required)	The name / key of the metadata field
items[].elements[].metadata[].value	`string` (required)	The value of the metadata field
items[].elements[].previousMetadata	`array` (required)	The previous metadata values for the folder.
items[].elements[].previousMetadata[].name	`string` (required)	The name / key of the metadata field
items[].elements[].previousMetadata[].value	`string` (required)	The value of the metadata field
items[].spaces	`array` (required)	The set of Spaces (Workspaces or Catalogs) involved in the event.
items[].spaces[].id	`string` (required)	The unique identifier of the Workspace.
items[].spaces[].name	`string` (required)	The name of the Workspace.

Headers

Content-Type: application/json

Body

{
  "code": "WorkspaceNotFound",
  "message": "Workspace not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "catalogId": "moqxhkej4epvgrwz",
  "workspaceId": "moqxhkej4epvgrwz",
  "since": "2017-01-02T00:00:00.000Z",
  "type": [
    "EventType"
  ],
  "limit": 1,
  "offset": 0,
  "orderDirection": "desc"
}

Property name	Type	Description
catalogId	`string`	The unique identifier of the Catalog.
workspaceId	`string`	The unique identifier of the Workspace.
since	`string`	Filters the events by their creation date. The operation will only return events that occurred on or after the given timestamp. Value must be in IS0 8601 date and time format (e.g.: ‘2020-01-01T00:00:00.000Z’).
type	`array`	List of event types to filter by. Omit this parameter to return all supported event types.
limit	`number`	The number of items to return. The maximum is 50.
offset	`number`	The item at which to begin the response.
orderDirection	`string`	The order direction the items should be returned.

Responses200404

Headers

Content-Type: application/json

Body

{
  "limit": 1,
  "offset": 0,
  "count": 10,
  "order": {
    "by": "Desc",
    "direction": "CreatedOn"
  },
  "filter": {
    "type": [
      "EventName"
    ],
    "since": "2020-01-01T00:00:00.000Z"
  },
  "items": [
    {
      "id": "prffhlw9iptcfqfc",
      "createdOn": "2017-01-02T00:00:00.000Z",
      "createdBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "type": "AssetRestoreStatusChange",
      "mediaBoxes": [
        {
          "id": "21c41d5dea414d2ba5f113adfe28214e",
          "name": "Videos for distribution",
          "settings": {
            "expirationDate": "2020-01-01T00:00:00.000Z",
            "isDeleted": false,
            "assetIds": [
              "2890a261ebd54471a599d439beabe6ab"
            ],
            "folderIds": [
              "506b73075c5a4253bc8c32796ce1d7ef"
            ],
            "type": "Secure",
            "recipients": [
              "user@example.com"
            ],
            "watermarkingEnabled": true,
            "allowSourceDownload": true,
            "allowPreviewDownload": true,
            "allowElementDownload": true
          }
        }
      ],
      "spaces": [
        {
          "id": "gb5ehomv0iv71swg",
          "name": "Workspace Name"
        }
      ]
    }
  ]
}

Property name	Type	Description
limit	`number`	The limit used for the query.
offset	`number`	The offset used for the query.
count	`number`	The total count of items available.
order	`object`	Information about the ordering of the results
order.by	`string`	The sort order of the results. Valid values are `Asc` and `Desc`.
order.direction	`string`	The field used to sort the results. The only valid value is `CreatedOn`.
filter	`object`	Information about the filter used for retrieving events.
filter.type	`array`	Indicates the event types used as a filter in the request. This field is omitted if no type was used to filter events.
filter.since	`string`	Indicates the timestamp used as a filter in the request. This field is omitted if no timestamp was used to filter events.
items	`array`	The set of events returned by the query.
items[].id	`string`	The unique identifier of the event.
items[].createdOn	`string`	The datetime the event occurred.
items[].createdBy	`object`	Information about the event creator.
items[].createdBy.id	`string`	The unique identifier of the user.
items[].createdBy.name	`string`	The full name of the user.
items[].createdBy.email	`string`	The email of the user.
items[].type	`string`	The type of the event.
items[].mediaBoxes	`array` (required)	The set of MediaBoxes involved in the event.
items[].mediaBoxes[].id	`string` (required)	The unique identifier of the MediaBox.
items[].mediaBoxes[].name	`string` (required)	The name of MediaBox.
items[].mediaBoxes[].settings	`object` (required)	The current settings of the MediaBox
items[].mediaBoxes[].settings.expirationDate	`string` (required)	The datetime the MediaBox expires. This property will not appear if the MediaBox never expires.
items[].mediaBoxes[].settings.isDeleted	`boolean` (required)	Indicates whether the MediaBox was closed / deleted by a user.
items[].mediaBoxes[].settings.assetIds	`array` (required)	The list of assets selected for the MediaBox. Note: this does not include assets in any folders for the MediaBox.
items[].mediaBoxes[].settings.folderIds	`array` (required)	The list of folders selected for the MediaBox. Note: this does not include any sub-folders for the selected folders.
items[].mediaBoxes[].settings.type	`string` (required)	The security level of the MediaBox. Valid values are `Secure`, `Protected`, and `Public`.
items[].mediaBoxes[].settings.recipients	`array` (required)	The list of recipients selected for the MediaBox.
items[].mediaBoxes[].settings.watermarkingEnabled	`boolean` (required)	Indicates whether watermarking is enabled for the MediaBox.
items[].mediaBoxes[].settings.allowSourceDownload	`boolean` (required)	Indicates whether source file download is enabled for the MediaBox.
items[].mediaBoxes[].settings.allowPreviewDownload	`boolean` (required)	Indicates whether preview/proxy or custom render download is enabled for the MediaBox.
items[].mediaBoxes[].settings.allowElementDownload	`boolean` (required)	Indicates whether element download is enabled for the MediaBox.
items[].spaces	`array` (required)	The set of Spaces (Workspaces or Catalogs) involved in the event.
items[].spaces[].id	`string` (required)	The unique identifier of the Workspace.
items[].spaces[].name	`string` (required)	The name of the Workspace.

Headers

Content-Type: application/json

Body

{
  "code": "WorkspaceNotFound",
  "message": "Workspace not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "catalogId": "moqxhkej4epvgrwz",
  "workspaceId": "moqxhkej4epvgrwz",
  "since": "2017-01-02T00:00:00.000Z",
  "type": [
    "EventType"
  ],
  "limit": 1,
  "offset": 0,
  "orderDirection": "desc"
}

Property name	Type	Description
catalogId	`string`	The unique identifier of the Catalog.
workspaceId	`string`	The unique identifier of the Workspace.
since	`string`	Filters the events by their creation date. The operation will only return events that occurred on or after the given timestamp. Value must be in IS0 8601 date and time format (e.g.: ‘2020-01-01T00:00:00.000Z’).
type	`array`	List of event types to filter by. Omit this parameter to return all supported event types.
limit	`number`	The number of items to return. The maximum is 50.
offset	`number`	The item at which to begin the response.
orderDirection	`string`	The order direction the items should be returned.

Responses200404

Headers

Content-Type: application/json

Body

{
  "limit": 1,
  "offset": 0,
  "count": 10,
  "order": {
    "by": "Desc",
    "direction": "CreatedOn"
  },
  "filter": {
    "type": [
      "EventName"
    ],
    "since": "2020-01-01T00:00:00.000Z"
  },
  "items": [
    {
      "id": "prffhlw9iptcfqfc",
      "createdOn": "2017-01-02T00:00:00.000Z",
      "createdBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "type": "AssetRestoreStatusChange",
      "mediaBoxes": [
        {
          "id": "21c41d5dea414d2ba5f113adfe28214e",
          "name": "Videos for distribution",
          "settings": {
            "expirationDate": "2020-01-01T00:00:00.000Z",
            "isDeleted": false,
            "assetIds": [
              "2890a261ebd54471a599d439beabe6ab"
            ],
            "folderIds": [
              "506b73075c5a4253bc8c32796ce1d7ef"
            ],
            "type": "Secure",
            "recipients": [
              "user@example.com"
            ],
            "watermarkingEnabled": true,
            "allowSourceDownload": true,
            "allowPreviewDownload": true,
            "allowElementDownload": true
          },
          "previousSettings": {
            "expirationDate": "2020-01-01T00:00:00.000Z",
            "isDeleted": false,
            "assetIds": [
              "2890a261ebd54471a599d439beabe6ab"
            ],
            "folderIds": [
              "506b73075c5a4253bc8c32796ce1d7ef"
            ],
            "type": "Secure",
            "recipients": [
              "user@example.com"
            ],
            "watermarkingEnabled": true,
            "allowSourceDownload": true,
            "allowPreviewDownload": true,
            "allowElementDownload": true
          }
        }
      ],
      "spaces": [
        {
          "id": "gb5ehomv0iv71swg",
          "name": "Workspace Name"
        }
      ]
    }
  ]
}

Property name	Type	Description
limit	`number`	The limit used for the query.
offset	`number`	The offset used for the query.
count	`number`	The total count of items available.
order	`object`	Information about the ordering of the results
order.by	`string`	The sort order of the results. Valid values are `Asc` and `Desc`.
order.direction	`string`	The field used to sort the results. The only valid value is `CreatedOn`.
filter	`object`	Information about the filter used for retrieving events.
filter.type	`array`	Indicates the event types used as a filter in the request. This field is omitted if no type was used to filter events.
filter.since	`string`	Indicates the timestamp used as a filter in the request. This field is omitted if no timestamp was used to filter events.
items	`array`	The set of events returned by the query.
items[].id	`string`	The unique identifier of the event.
items[].createdOn	`string`	The datetime the event occurred.
items[].createdBy	`object`	Information about the event creator.
items[].createdBy.id	`string`	The unique identifier of the user.
items[].createdBy.name	`string`	The full name of the user.
items[].createdBy.email	`string`	The email of the user.
items[].type	`string`	The type of the event.
items[].mediaBoxes	`array` (required)	The set of MediaBoxes involved in the event.
items[].mediaBoxes[].id	`string` (required)	The unique identifier of the MediaBox.
items[].mediaBoxes[].name	`string` (required)	The name of MediaBox.
items[].mediaBoxes[].settings	`object` (required)	The current settings of the MediaBox
items[].mediaBoxes[].settings.expirationDate	`string` (required)	The datetime the MediaBox expires. This property will not appear if the MediaBox never expires.
items[].mediaBoxes[].settings.isDeleted	`boolean` (required)	Indicates whether the MediaBox was closed / deleted by a user.
items[].mediaBoxes[].settings.assetIds	`array` (required)	The list of assets selected for the MediaBox. Note: this does not include assets in any folders for the MediaBox.
items[].mediaBoxes[].settings.folderIds	`array` (required)	The list of folders selected for the MediaBox. Note: this does not include any sub-folders for the selected folders.
items[].mediaBoxes[].settings.type	`string` (required)	The security level of the MediaBox. Valid values are `Secure`, `Protected`, and `Public`.
items[].mediaBoxes[].settings.recipients	`array` (required)	The list of recipients selected for the MediaBox.
items[].mediaBoxes[].settings.watermarkingEnabled	`boolean` (required)	Indicates whether watermarking is enabled for the MediaBox.
items[].mediaBoxes[].settings.allowSourceDownload	`boolean` (required)	Indicates whether source file download is enabled for the MediaBox.
items[].mediaBoxes[].settings.allowPreviewDownload	`boolean` (required)	Indicates whether preview/proxy or custom render download is enabled for the MediaBox.
items[].mediaBoxes[].settings.allowElementDownload	`boolean` (required)	Indicates whether element download is enabled for the MediaBox.
items[].mediaBoxes[].previousSettings	`object` (required)	The previous settings of the MediaBox
items[].mediaBoxes[].previousSettings.expirationDate	`string` (required)	The datetime the MediaBox expires. This property will not appear if the MediaBox never expires.
items[].mediaBoxes[].previousSettings.isDeleted	`boolean` (required)	Indicates whether the MediaBox was closed / deleted by a user.
items[].mediaBoxes[].previousSettings.assetIds	`array` (required)	The list of assets selected for the MediaBox. Note: this does not include assets in any folders for the MediaBox.
items[].mediaBoxes[].previousSettings.folderIds	`array` (required)	The list of folders selected for the MediaBox. Note: this does not include any sub-folders for the selected folders.
items[].mediaBoxes[].previousSettings.type	`string` (required)	The security level of the MediaBox. Valid values are `Secure`, `Protected`, and `Public`.
items[].mediaBoxes[].previousSettings.recipients	`array` (required)	The list of recipients selected for the MediaBox.
items[].mediaBoxes[].previousSettings.watermarkingEnabled	`boolean` (required)	Indicates whether watermarking is enabled for the MediaBox.
items[].mediaBoxes[].previousSettings.allowSourceDownload	`boolean` (required)	Indicates whether source file download is enabled for the MediaBox.
items[].mediaBoxes[].previousSettings.allowPreviewDownload	`boolean` (required)	Indicates whether preview/proxy or custom render download is enabled for the MediaBox.
items[].mediaBoxes[].previousSettings.allowElementDownload	`boolean` (required)	Indicates whether element download is enabled for the MediaBox.
items[].spaces	`array` (required)	The set of Spaces (Workspaces or Catalogs) involved in the event.
items[].spaces[].id	`string` (required)	The unique identifier of the Workspace.
items[].spaces[].name	`string` (required)	The name of the Workspace.

Headers

Content-Type: application/json

Body

{
  "code": "WorkspaceNotFound",
  "message": "Workspace not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

List Events
POST`/events`

Description

Retrieves events for a given Catalog or Workspace. This query supports pagination using limit and offset. Additionally, using the since and type parameters, it is possible to filter events by date and event type. The results are ordered by date created.

The following event types can be used when filtering for Workspace or Catalog events.

Asset and Element Events

CreateAsset - Asset is created but not yet uploaded. The response data can be found under the Basic Asset Event example.
CreateElement - Element is created but not yet uploaded. The response data can be found under the Basic Element Event example.
RenameAsset - Asset was renamed. The response data can be found under the Basic Asset Event example.
RenameElement - Element was renamed. The response data can be found under the Basic Element Event example.
DeleteAsset - Asset was deleted. The response data can be found under the Basic Asset Event example.
DeleteElement - Element was deleted. The response data can be found under the Remove/Delete Asset Event example.
RemoveAssetFromCatalogFolder - An asset was removed from a Catalog folder but not deleted from the Catalog. The response data can be found under the Remove/Delete Asset Event example.
TrashAsset - Asset was trashed. The response data can be found under the Basic Asset Event example.
UntrashAsset - Asset was restored from the trash. The response data can be found under the Basic Asset Event example.
UploadAsset - Asset was successfully uploaded. The response data can be found under the Basic Asset Event example.
AssetProcessingFinished - Asset is done processing (please note: the result of that processing activity could have the following asset statuses - Complete, Limited, VirusDetected, ExecutableDetected). The response data can be found under the Basic Asset Event example.
ElementProcessingFinished - Element is done processing. The response data can be found under the Basic Element Event example.
PremiumProxyProcessingFinished - Premium preview / proxy is done processing. The response data can be found under the Preview/Proxy Event example.
MoveAsset - Asset was moved to a different folder. The response data can be found under the Basic Asset Event example.
CopyAsset - Asset was copied. This event will be available when any asset copy occurs, including copy within a Space, copy to another Space, or save from a MediaBox. The response data can be found under the Copy Event example.
CopyAssetsToCatalog - Assets were copied to a Catalog. The response data can be found under the Copy Event example.
CopyAssetsToWorkspace - Assets were copied to a Workspace. The response data can be found under the Copy Event example.
CopyAssetToFileRequest - Asset was copied to a File Request. The response data can be found under the Copy Event example.
CopyElement - Element was copied. This event will be available when any element copy occurs, including copy within a Space or copy to another Space. The response data can be found under the Copy Event example.
AssetArchiveStatusChange - Asset archive status was changed. The response data can be found under the Asset Archive Event example.
AssetRestoreStatusChange - Asset restore status was changed. The response data can be found under the Asset Restore Event example.
AssetMetadataChange - Asset metadata has changed. The response data can be found under the Asset Metadata Event example.
ElementMetadataChange - Element metadata has changed. The response data can be found under the Element Metadata Event example.
DownloadAsset - Asset was downloaded using standard download. The response data can be found under the Basic Asset Event example.
DownloadElement - Element was downloaded using standard download. The response data can be found under the Basic Element Event example.
DownloadPreview - Preview / proxy was downloaded using standard download. The response data can be found under the Preview/Proxy Event example.
DownloadThumbnail - Ci generated thumbnail or frame grab was downloaded using standard download. The response data can be found under the Ci Generated Thumbnail Event example.
DownloadAssetWithAspera - Asset was downloaded using Aspera. The response data can be found under the Basic Asset Event example.
DownloadElementWithAspera - Element was downloaded using Aspera. The response data can be found under the Basic Element Event example.
DownloadPreviewWithAspera - Preview / proxy was downloaded using Aspera. The response data can be found under the Preview/Proxy Event example.
DownloadThumbnailWithAspera - Ci generated thumbnail was downloaded using Aspera.The response data can be found under the Ci Generated Thumbnail Event example.
DownloadAssetFromMediaBox - Asset was downloaded from a MediaBox using standard download. The response data can be found under the Basic Asset Event example.
DownloadAssetFromMediaBoxWithAspera - Asset was downloaded from a MediaBox using Aspera. The response data can be found under the Basic Asset Event example.
DownloadElementFromMediaBox - Element was downloaded from a MediaBox using standard download. The response data can be found under the Basic Element Event example.
DownloadElementFromMediaBoxWithAspera - Element was downloaded from a MediaBox using Aspera. The response data can be found under the Basic Element Event example.
DownloadPreviewFromMediaBox - A preview / proxy was downloaded from a MediaBox using standard download. The response data can be found under the Preview/Proxy Event example.
DownloadPreviewFromMediaBoxWithAspera - A preview / proxy was downloaded from a MediaBox using Aspera. The response data can be found under the Preview/Proxy Event example.
SaveAssetsFromMediabox - Assets where saved from a mediabox to a Workspace or Catalog. Note: this event can contain multiple assets in the response. The response data can be found under the Basic Asset Event example.

Folder Events

CreateFolder - Folder was created. The response data can be found under the Basic Folder Event example.
MoveFolder - Folder was moved to a different folder. The response data can be found under the Basic Folder Event example.
RenameFolder - Folder was renamed. The response data can be found under the Basic Folder Event example.
TrashFolder - Folder was trashed. The response data can be found under the Basic Folder Event example.
UntrashFolder - Folder was restored from the trash. The response data can be found under the Basic Folder Event example.
DeleteFolder - Folder was permanently deleted. The response data can be found under the Basic Folder Event example.
FolderMetadataChange - Folder metadata has changed. The response data can be found under the Folder Metadata Event example.
DownloadFolderWithAspera - Folder was downloaded using Aspera. The response data can be found under the Basic Folder Event example.
DownloadFolderFromMediaBoxWithAspera - Folder was downloaded from a MediaBox using Aspera. The response data can be found under the Basic Folder Event example.

MediaBox Events

CreateMediabox - Mediabox was created. The response data can be found under the Create and Open MediaBox Event example.
OpenMediabox - Mediabox was opened. The response data can be found under the Create and Open MediaBox Event example.
UpdateMediabox - Mediabox was updated in settings or content. The response data can be found under the Update MediaBox Event example.

Errors

Status Code	Error Code	Message
400	InvalidLimitOrOffset	Invalid limit or offset value. Limit must be a number between 1 and 50. Offset must be greater than or equal to 0.
400	InvalidQueryOrderDirection	Invalid order direction. It must be either ‘Asc’ or ‘Desc’.
400	InvalidQueryFilter	Invalid query filter.
404	CatalogNotFound	Catalog not found.
404	WorkspaceNotFound	Workspace not found.

List Workspace Events ¶

GET https://api.cimediacloud.com/workspaces/moqxhkej4epvgrwz/events?since=2017-01-02T00:00:00.000Z&type=CreateAsset&limit=1&offset=0&orderDirection=asc

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200404

Headers

Content-Type: application/json

Body

{
  "limit": 1,
  "offset": 0,
  "count": 10,
  "order": {
    "by": "Name",
    "direction": "asc"
  },
  "filter": {
    "type": [
      "AssetProcessingFinished"
    ],
    "since": "2017-01-02T00:00:00.000Z"
  },
  "items": [
    {
      "id": "prffhlw9iptcfqfc",
      "createdOn": "2017-01-02T00:00:00.000Z",
      "createdBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "type": "CreateAsset",
      "assets": [
        {
          "id": "d9bf018c804a4e78b775b8dc2f242071",
          "name": "Movie.mov"
        }
      ],
      "folders": [
        {
          "id": "9b639e12a82f4b0483f512b474dc052ci",
          "name": "Folder Name"
        }
      ]
    }
  ]
}

Property name	Type	Description
limit	`number`	The limit used for the query.
offset	`number`	The offset used for the query.
count	`number`	The total count of items available.
order	`object`	Information about the ordering of the results.
order.by	`string`	Indicates the field used to sort the results.
order.direction	`string`	Indicates the direction used to sort the results.
filter	`object`	Information about the filter used for retrieving events.
filter.type	`array`	Indicates the event types used as a filter in the request. Supported types are ‘AssetProcessingFinished’, ‘CreateAsset’, ‘RenameAsset’, ‘RenameElement’, ‘DeleteAsset’, ‘TrashAsset’, ‘UploadAsset’ and ‘MoveAsset’, ‘UntrashAsset’, ‘CopyAsset’, ‘AssetArchiveStatusChange’, ‘AssetRestoreStatusChange’, ‘AssetMetadataChange’, ‘CreateFolder’, ‘MoveFolder’, ‘RenameFolder’, ‘TrashFolder’, ‘UntrashFolder’, ‘DeleteFolder’, ‘FolderMetadataChange’. This field is omitted if no type was used to filter events.
filter.since	`string`	Indicates the timestamp used as a filter in the request. This field is omitted if no timestamp was used to filter events.
items	`array`	The set of events returned by the query.
items[].id	`string`	The unique identifier of the event.
items[].createdOn	`string`	The datetime the event occurred.
items[].createdBy	`object`	Information about the event creator.
items[].createdBy.id	`string`	The unique identifier of the user.
items[].createdBy.name	`string`	The full name of the user.
items[].createdBy.email	`string`	The email of the user.
items[].type	`string`	The type of the event.
items[].assets	`array`	The set of assets involved in the event.
items[].assets[].id	`string`	The unique identifier of the asset.
items[].assets[].name	`string`	The name of asset and its extension.
items[].folders	`array`	The set of folders involved in the event.
items[].folders[].id	`string`	The unique identifier of the folder.
items[].folders[].name	`string`	The name of folder.

Headers

Content-Type: application/json

Body

{
  "code": "WorkspaceNotFound",
  "message": "Workspace not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

List Events (Deprecated)
GET`/workspaces/{workspaceId}/events{?since,type,limit,offset,orderDirection}`

URI Parameters

HideShow

workspaceId

string (required)

The unique identifier of the workspace.

since

string (optional)

type

string (optional)

Comma-separated list of event types to filter by. Omit this parameter to return all supported event types.

Choices: AssetProcessingFinished CreateAsset RenameAsset RenameElement DeleteAsset TrashAsset UploadAsset MoveAsset UntrashAsset CopyAsset AssetArchiveStatusChange AssetRestoreStatusChange AssetMetadataChange CreateFolder MoveFolder RenameFolder TrashFolder UntrashFolder DeleteFolder FolderMetadataChange

limit

number (optional) Default: 50

The number of items to return. The maximum is 50.

offset

number (optional) Default: 0

The item at which to begin the response.

orderDirection

string (optional) Default: asc

The order direction the items should be returned.

Choices: asc desc

Description

This endpoint has been DEPRECATED in favor of the Events API above.

Retrieves events that occurred on a given Workspace. This query supports pagination using limit and offset. Additionally, using the ‘since’ and ‘type’ parameters, it is possible to filter events by date and event type. The results are ordered by date created.

The following event types can be used when filtering for Workspace events:

AssetProcessingFinished - Asset is done processing (please note: the result of that processing activity could have the following asset statuses - Complete, Limited, VirusDetected, ExecutableDetected).
CreateAsset - Asset is created but not yet uploaded.
RenameAsset - Asset was renamed.
RenameElement - Element was renamed.
DeleteAsset - Asset is deleted.
TrashAsset - Asset is trashed.
UntrashAsset - Asset was restored from the trash.
UploadAsset - Asset is uploaded successfully.
MoveAsset - Asset was moved to a different folder.
CopyAsset - Asset was copied into the Workspace.
AssetArchiveStatusChange - Asset archive status is changed.
AssetRestoreStatusChange - Asset restore status is changed.
AssetMetadataChange - Asset metadata has changed.
CreateFolder - Folder was created.
MoveFolder - Folder was moved to a different folder.
RenameFolder - Folder was renamed.
TrashFolder - Folder was trashed.
UntrashFolder - Folder was restored from the trash.
DeleteFolder - Folder was permanently deleted.
FolderMetadataChange - Folder metadata has changed.

Errors

Status Code	Error Code	Message
400	InvalidLimitOrOffset	Invalid limit or offset value. Limit must be a number between 1 and 50. Offset must be greater than or equal to 0.
400	InvalidQueryOrderDirection	Invalid order direction. It must be either ‘Asc’ or ‘Desc’.
400	InvalidQueryFilter	Invalid query filter.
404	WorkspaceNotFound	Workspace not found.

Workspace Members ¶

GET https://api.cimediacloud.com/workspaces/ab8fcd95c99e4ba6a9f03f802311db74/members

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200404

Headers

Content-Type: application/json

Body

{
  "count": 1,
  "members": [
    {
      "roleId": "ab8fcd95c99e4ba6a9f03f802311db74",
      "status": "Invited",
      "lastAccessedOn": "2017-01-02T00:00:00.000Z",
      "joinedOn": "2022-01-25T00:00:00.000Z",
      "createdOn": "2017-01-02T00:00:00.000Z",
      "createdBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "isOwner": true
    }
  ]
}

Property name	Type	Description
count	`number`	The number of workspace members.
members	`array`	The list of workspace members.

Headers

Content-Type: application/json

Body

{
  "code": "WorkspaceNotFound",
  "message": "Workspace not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Get Workspace Members
GET`/workspaces/{workspaceId}/members`

URI Parameters

HideShow

workspaceId: string (required)
The unique identifier of the workspace.

Description

Retrieves the list of members of the specified Workspace.

Errors

Status Code	Error Code	Message
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
404	WorkspaceNotFound	Workspace not found.

POST https://api.cimediacloud.com/workspaces/ab8fcd95c99e4ba6a9f03f802311db74/members

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "ids": [
    "d9bf018c804a4e78b775b8dc2f242071",
    "johnsmith@example.com"
  ]
}

Property name	Type	Description
ids	`array` (required)	The list of user IDs or emails to add.

Responses200400

Headers

Content-Type: application/json

Body

{
  "completeCount": 1,
  "errorCount": 0,
  "errors": [
    {
      "id": "abcy3lrs45m0qouy",
      "name": "John Smith",
      "kind": "Member",
      "errorCode": "InvalidUserState",
      "errorMessage": "User has not been registered."
    }
  ],
  "complete": [
    {
      "roleId": "ab8fcd95c99e4ba6a9f03f802311db74",
      "status": "Invited",
      "lastAccessedOn": "2017-01-02T00:00:00.000Z",
      "joinedOn": "2022-01-25T00:00:00.000Z",
      "createdOn": "2017-01-02T00:00:00.000Z",
      "createdBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "isOwner": true
    }
  ]
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors	`array`	The list of failed items.
errors[].id	`string`	The unique identifier of the user.
errors[].name	`string`	The member’s name.
errors[].kind	`string`
errors[].errorCode	`string`	The error code.
errors[].errorMessage	`string`	(string) - The error message.
complete	`array`	The list of successful items.
complete[].roleId	`string`	The unique identifier of the role.
complete[].status	`string`	The status of the member. It can be `Owner`, `Unregistered`, `Invited`, `Joined` or `Removed`.
complete[].lastAccessedOn	`string`	The time the user last accessed the workspace.
complete[].joinedOn	`string`	The time the user joined the workspace.
complete[].createdOn	`string`	The time the member record was created.
complete[].createdBy	`object`	Information about the creator of the workspace.
complete[].createdBy.id	`string`	The unique identifier of the user.
complete[].createdBy.name	`string`	The full name of the user.
complete[].createdBy.email	`string`	The email of the user.
complete[].isOwner	`boolean`	True when the status is `Owner`

Headers

Content-Type: application/json

Body

{
  "code": "WorkspaceNotFound",
  "message": "Workspace not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Add Member to Workspace
POST`/workspaces/{workspaceId}/members`

URI Parameters

HideShow

workspaceId: string (required)
The unique identifier of the workspace.

Description

Adds members to the Workspace.

Errors

Status Code	Error Code	Message
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
404	WorkspaceNotFound	Workspace not found.

Remove Member from a Workspace ¶

POST https://api.cimediacloud.com/workspaces/ab8fcd95c99e4ba6a9f03f802311db74/members/remove

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "ids": [
    "d9bf018c804a4e78b775b8dc2f242071",
    "johnsmith@example.com"
  ]
}

Property name	Type	Description
ids	`array` (required)	The list of user IDs or emails to remove.

Responses200400

Headers

Content-Type: application/json

Body

{
  "completeCount": 1,
  "errorCount": 0,
  "errors": [
    {
      "id": "abcy3lrs45m0qouy",
      "name": "John Smith",
      "kind": "Member",
      "errorCode": "InvalidUserState",
      "errorMessage": "User has not been registered."
    }
  ],
  "complete": [
    {
      "roleId": "ab8fcd95c99e4ba6a9f03f802311db74",
      "status": "Invited",
      "lastAccessedOn": "2017-01-02T00:00:00.000Z",
      "joinedOn": "2022-01-25T00:00:00.000Z",
      "createdOn": "2017-01-02T00:00:00.000Z",
      "createdBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "isOwner": true
    }
  ]
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors	`array`	The list of failed items.
errors[].id	`string`	The unique identifier of the user.
errors[].name	`string`	The member’s name.
errors[].kind	`string`
errors[].errorCode	`string`	The error code.
errors[].errorMessage	`string`	(string) - The error message.
complete	`array`	The list of successful items.
complete[].roleId	`string`	The unique identifier of the role.
complete[].status	`string`	The status of the member. It can be `Owner`, `Unregistered`, `Invited`, `Joined` or `Removed`.
complete[].lastAccessedOn	`string`	The time the user last accessed the workspace.
complete[].joinedOn	`string`	The time the user joined the workspace.
complete[].createdOn	`string`	The time the member record was created.
complete[].createdBy	`object`	Information about the creator of the workspace.
complete[].createdBy.id	`string`	The unique identifier of the user.
complete[].createdBy.name	`string`	The full name of the user.
complete[].createdBy.email	`string`	The email of the user.
complete[].isOwner	`boolean`	True when the status is `Owner`

Headers

Content-Type: application/json

Body

{
  "code": "WorkspaceNotFound",
  "message": "Workspace not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Remove Member from a Workspace
POST`/workspaces/{workspaceId}/members/remove`

URI Parameters

HideShow

workspaceId: string (required)
The unique identifier of the workspace.

Description

Removes members from a Workspace

Errors

Status Code	Error Code	Message
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
404	WorkspaceNotFound	Workspace not found.

Folders ¶

Folders allow you to organize your files in ways that make sense to you. Think of a folder in Ci just like a folder on your operating system. You can have a flat set of folders or create nested folder structures (folders inside of folders) - it’s really up to you.

Folder ¶

POST https://api.cimediacloud.com/folders/

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "name": "Folder Name",
  "workspaceId": "nnyhxwjqaug2yhaq",
  "parentFolderId": "rslrfzbh5pj8l3as"
}

Property name	Type	Description
name	`string` (required)	The desired name of the folder. If the desired folder name is already taken in the provided parent folder, a unique name will be generated using the desired folder name as a base.
workspaceId	`string`	The workspace that will contain the folder. If no value is provided, the folder will be placed in the calling user’s personal workspace.
parentFolderId	`string`	The workspace’s parent folder that will contain the folder. If no value is provided, the folder will be placed in the workspaces’ root folder.

Responses200400

Headers

Content-Type: application/json

Body

{
  "folderId": "034s405gln33zxc6",
  "parentId": "rslrfzbh5pj8l3as",
  "workspaceId": "nnyhxwjqaug2yhaq",
  "name": "Folder Name"
}

Property name	Type	Description
folderId	`string`	The unique identifier of the created folder.
parentId	`string`	The workspace’s parent folder that contains the created folder.
workspaceId	`string`	The workspace that contains the created folder.
name	`string`	The assigned name of the created folder. The assigned name may be different than the provided folder name if the desired folder name was already taken in the provided parent folder.

Headers

Content-Type: application/json

Body

{
  "code": "FolderNotFound",
  "message": "Folder not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Create a Folder
POST`/folders/`

Description

Creates a new folder record.

Errors

Status Code	Error Code	Message
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	MissingOrInvalidName	Missing or invalid name.
400	WorkspaceNotFound	Workspace not found.
400	FolderNotFound	Folder not found.
409	FolderTrashed	Folder is trashed.
409	FolderDeleted	Folder is deleted.
400	FolderNotMemberOfWorkspace	Folder is not a member of the provided workspace.

GET https://api.cimediacloud.com/folders/moqxhkej4epvgrwz

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200404

Headers

Content-Type: application/json

Body

{
  "id": "9b639e12a82f4b0483f512b474dc052ci",
  "name": "My Folder",
  "createdOn": "2017-01-02T00:00:00.000Z",
  "createdBy": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith",
    "email": "johnsmith@example.com"
  },
  "lastActivityOn": "2017-01-03T00:00:00.000Z",
  "network": {
    "id": "40c2a6b99a474b319dec5ef9c7dbb356",
    "name": "Company Name",
    "class": "Enterprise"
  },
  "metadata": [
    {
      "name": "intendedFor",
      "value": "landscapeImages"
    }
  ],
  "stats": {
    "childFolderCount": 2
  },
  "parentId": "nqyptt047b7qc9y3",
  "workspace": {
    "id": "gb5ehomv0iv71swg",
    "name": "Workspace Name",
    "class": "Enterprise"
  },
  "parentFolder": {
    "id": "9b639e12a82f4b0483f512b474dc052ci",
    "name": "Folder Name"
  },
  "isTrashed": false
}

Property name	Type	Description
id	`string`	The unique identifier of folder.
name	`string`	The name of the folder.
createdOn	`string`	The datetime the folder was created.
createdBy	`object`	Information about the creator of the folder.
createdBy.id	`string`	The unique identifier of the user.
createdBy.name	`string`	The full name of the user.
createdBy.email	`string`	The email of the user.
lastActivityOn	`string`	The datetime of the last activity of the folder.
network	`object`	Information about the folder’s parent network.
network.id	`string`	The unique identifier of the Network.
network.name	`string`	The name of the Network.
network.class	`string`	Indicates if the Network is a ‘Personal’ or ‘Enterprise’ Network.
metadata	`array`	An array of key-value pairs of user-generated metadata.
metadata[].name	`string`	The name of the metadata item.
metadata[].value	`string`	the value of the metadata item.
stats	`object`	Statistics about the folder.
stats.childFolderCount	`number`	The number of child folders for the given folder.
parentId	`string`	The unique identifier of the parent folder, if it is a child folder, or the workspace id, if it is the Workspace’s root folder.
workspace	`object`	Information about the folder’s parent workspace.
workspace.id	`string`	The unique identifier of the Workspace.
workspace.name	`string`	The name of the Workspace.
workspace.class	`string`	Indicates if the Workspace is a ‘Personal’ or ‘Team’ Workspace.
parentFolder	`object`	Information about the folder’s parent folder. If the folder is the root folder of a Workspace this property will not be available.
parentFolder.id	`string`	The unique identifier of the folder.
parentFolder.name	`string`	The name of folder.
isTrashed	`boolean`	Indicates if a folder is in the trash bin.

Headers

Content-Type: application/json

Body

{
  "code": "FolderNotFound",
  "message": "Folder not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Get Folder Details
GET`/folders/{folderId}`

URI Parameters

HideShow

folderId: string (required)
The unique identifier of the folder.

Description

Retrieves information about the given folder.

Errors

Status Code	Error Code	Message
404	FolderNotFound	Folder not found.

PUT https://api.cimediacloud.com/folders/moqxhkej4epvgrwz

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "name": "New Name"
}

Property name	Type	Description
name	`string`	The new name of the folder.

Responses200404

Headers

Content-Type: application/json

Body

{
  "id": "9b639e12a82f4b0483f512b474dc052ci",
  "name": "My Folder",
  "createdOn": "2017-01-02T00:00:00.000Z",
  "createdBy": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith",
    "email": "johnsmith@example.com"
  },
  "lastActivityOn": "2017-01-03T00:00:00.000Z",
  "network": {
    "id": "40c2a6b99a474b319dec5ef9c7dbb356",
    "name": "Company Name",
    "class": "Enterprise"
  },
  "metadata": [
    {
      "name": "intendedFor",
      "value": "landscapeImages"
    }
  ],
  "stats": {
    "childFolderCount": 2
  },
  "parentId": "nqyptt047b7qc9y3",
  "workspace": {
    "id": "gb5ehomv0iv71swg",
    "name": "Workspace Name",
    "class": "Enterprise"
  },
  "parentFolder": {
    "id": "9b639e12a82f4b0483f512b474dc052ci",
    "name": "Folder Name"
  },
  "isTrashed": false
}

Property name	Type	Description
id	`string`	The unique identifier of folder.
name	`string`	The name of the folder.
createdOn	`string`	The datetime the folder was created.
createdBy	`object`	Information about the creator of the folder.
createdBy.id	`string`	The unique identifier of the user.
createdBy.name	`string`	The full name of the user.
createdBy.email	`string`	The email of the user.
lastActivityOn	`string`	The datetime of the last activity of the folder.
network	`object`	Information about the folder’s parent network.
network.id	`string`	The unique identifier of the Network.
network.name	`string`	The name of the Network.
network.class	`string`	Indicates if the Network is a ‘Personal’ or ‘Enterprise’ Network.
metadata	`array`	An array of key-value pairs of user-generated metadata.
metadata[].name	`string`	The name of the metadata item.
metadata[].value	`string`	the value of the metadata item.
stats	`object`	Statistics about the folder.
stats.childFolderCount	`number`	The number of child folders for the given folder.
parentId	`string`	The unique identifier of the parent folder, if it is a child folder, or the workspace id, if it is the Workspace’s root folder.
workspace	`object`	Information about the folder’s parent workspace.
workspace.id	`string`	The unique identifier of the Workspace.
workspace.name	`string`	The name of the Workspace.
workspace.class	`string`	Indicates if the Workspace is a ‘Personal’ or ‘Team’ Workspace.
parentFolder	`object`	Information about the folder’s parent folder. If the folder is the root folder of a Workspace this property will not be available.
parentFolder.id	`string`	The unique identifier of the folder.
parentFolder.name	`string`	The name of folder.
isTrashed	`boolean`	Indicates if a folder is in the trash bin.

Headers

Content-Type: application/json

Body

{
  "code": "FolderNotFound",
  "message": "Folder not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Update a Folder
PUT`/folders/{folderId}`

URI Parameters

HideShow

folderId: string (required)
The unique identifier of the folder.

Description

Updates specified properties of a folder. The current version of Ci API only supports renaming a folder.

Errors

Status Code	Error Code	Message
400	MissingOrInvalidName	Missing or invalid name.
404	FolderNotFound	Folder not found.
404	FolderDeleted	Folder is deleted.

DELETE https://api.cimediacloud.com/folders/moqxhkej4epvgrwz

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200404

Headers

Content-Type: application/json

Body

{
  "message": "Folder was deleted"
}

Property name	Type	Description
message	`string`	Indicates the folder was deleted.

Headers

Content-Type: application/json

Body

{
  "code": "FolderNotFound",
  "message": "Folder not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Delete a Folder
DELETE`/folders/{folderId}`

URI Parameters

HideShow

folderId: string (required)
The unique identifier of the folder.

Description

Deletes the specified folder and all of its contents permanently. The storage quota is updated to reflect the newly freed space.

Deleting a folder will delete all contents within the folder recursively (including all subfolders and assets within subfolders).

All folders and assets are permanently deleted and cannot be recovered.

Assets affected during this operation may not be updated immediately. This work is performed asynchronously and therefore it can take a few minutes for all updates to appear.

Errors

Status Code	Error Code	Message
404	FolderNotFound	Folder not found.
404	FolderDeleted	Folder is deleted.
409	InvalidOperationOnRootFolder	Root folder cannot be deleted, trashed, untrashed, or moved.

List Folder Contents ¶

GET https://api.cimediacloud.com/folders/moqxhkej4epvgrwz/contents?kind=all&limit=1&offset=0&orderBy=name&orderDirection=asc&fields=name,thumbnails

Requestsexample with asset in responseexample with folder in response

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200404

Headers

Content-Type: application/json

Body

{
  "limit": 1,
  "offset": 0,
  "count": 10,
  "order": {
    "by": "Name",
    "direction": "asc"
  },
  "kind": [
    "All"
  ],
  "items": [
    {
      "id": "bcdc34b53e2c4c18ac41ca288e28d11f",
      "name": "Movie.mov",
      "size": 107856722,
      "type": "Video",
      "format": "mov",
      "folder": {
        "id": "9b639e12a82f4b0483f512b474dc052ci",
        "name": "Folder Name"
      },
      "status": "Complete",
      "description": "Final cut",
      "thumbnails": [
        {
          "type": "large",
          "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/thumb.jpg",
          "size": 1024,
          "width": 200,
          "height": 300,
          "source": {
            "id": "elementId1",
            "kind": "element"
          },
          "isExternal": false
        }
      ],
      "proxies": [
        {
          "type": "video-3g",
          "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/proxy.jpg",
          "size": 1024,
          "width": 200,
          "height": 300,
          "videoBitRate": 1650000,
          "audioBitRate": 128000,
          "isExternal": false
        }
      ],
      "md5Checksum": "tk2ma0zrhrp5irco",
      "createdOn": "2017-01-02T00:00:00.000Z",
      "createdBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "modifiedOn": "2017-01-02T00:00:00.000Z",
      "lastActivityOn": "2017-01-03T00:00:00.000Z",
      "acquisitionSource": {
        "name": "Workspace"
      },
      "archiveStatus": "Not archived",
      "archiveType": "Standard",
      "restoreStatus": "Not restored",
      "restoreExpirationDate": "2017-01-02T00:00:00.000Z",
      "restoreRequestDate": "2017-01-02T00:00:00.000Z",
      "lastRestoreDate": "2017-01-02T00:00:00.000Z",
      "restoredBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "archiveDate": "2017-01-02T00:00:00.000Z",
      "archivedBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "uploadCompleteDate": "2017-01-02T00:00:00.000Z",
      "isTrashed": false,
      "uploadTransferType": "SinglepartHttp",
      "runtime": 1024,
      "totalFolderCount": 1,
      "network": {
        "id": "40c2a6b99a474b319dec5ef9c7dbb356",
        "name": "Company Name",
        "class": "Enterprise"
      },
      "metadata": [
        {
          "name": "resolution",
          "value": "1080p",
          "readOnly": false
        }
      ],
      "technicalMetadata": {
        "type": "Video",
        "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/metadata.jpg",
        "size": 1024,
        "image": {
          "width": 100,
          "height": 300,
          "xResolution": 100,
          "yResolution": 100,
          "resolutionUnit": "cm",
          "cameraMake": "Nikon",
          "cameraModel": "D300",
          "groupingInfo": "6445055e520106d9d01769fffefd058901000100000000000000",
          "umidBasic": "060a2b340101010501010143130000006445055e520106cbd01769fffefd0589",
          "materialNumber": "6445055e520106cbd01769fffefd0589",
          "recordedDate": "2023-07-27T01:39:24Z",
          "locationCity": "New York",
          "locationState": "NY",
          "locationCountry": "USA",
          "exif": {
            "imageWidth": "3888",
            "imageHeight": "2592",
            "artist": "Michael W. Steidl.",
            "copyright": "(c) 2011 IPTC - Rights reserved."
          },
          "iptc": {
            "codedCharacterSet": "UTF8",
            "headline": "Bikefestival Vienna",
            "credit": "IPTC/Michael W. Steidl",
            "keywords": "Vienna Air King,cycling,mountain bike"
          },
          "xmp": {
            "serialNumber": "0380227035",
            "creatorRegion": "Roshire",
            "lens": "EF70-300mm f/4-5.6L IS USM",
            "creatorCountry": "United Kingdom"
          }
        },
        "avContainer": {
          "bitRate": 11934620,
          "duration": 100,
          "start": 0,
          "recordedDate": "2022-11-21T06:42:41Z",
          "deviceManufacturer": "Sony",
          "timeCode": "00:00:00:00",
          "derivedTimeCode": "00:00:00:00",
          "streams": [
            {
              "index": 0,
              "type": "Video",
              "bitRate": 11934620,
              "bitDepth": 8,
              "bitRateMode": "CBR",
              "codec": "h264",
              "codecName": "ProRes",
              "codecProfile": "422 HQ",
              "codecSettings": "Little / Signed",
              "fourCC": "avc1",
              "width": 1280,
              "height": 720,
              "totalFrames": 1024,
              "duration": 100,
              "frameRateNumerator": 360,
              "frameRateDenominator": 12,
              "videoPARWidth": 1,
              "videoPARHeight": 1,
              "videoDARWidth": 19,
              "videoDARHeight": 24,
              "start": 0,
              "timeCode": "00:00:00:00",
              "videoColorSpace": "bt709",
              "videoScanOrder": "TFF",
              "videoScanType": "Interlaced",
              "videoColorPrimaries": "DCI P3",
              "videoChromaSubsampling": "4:2:2",
              "videoScanTypeStoreMethod": "Interleaved fields",
              "audioSampleRate": 32000,
              "audioChannelCount": 2,
              "audioLayout": "Stereo",
              "audioAnalysis": "Stereo",
              "rotate": 0
            }
          ]
        },
        "dolbyContainer": {
          "duration": 9.6,
          "fileSize": 80294994,
          "overallBitRateMode": "CBR",
          "overallBitRate": 66912495,
          "totalChannels": 58,
          "bedChannels": 10,
          "numberOfBeds": 1,
          "bitDepth": 24,
          "samplingRate": 48000,
          "downmix51X": "Direct Render",
          "trimModesSummary": "automatic + manual_0",
          "trimChannel20Mode": "manual_0",
          "trimChannel51Mode": "manual_0",
          "trimChannel71Mode": "automatic",
          "trimChannel212Mode": "manual_0",
          "trimChannel512Mode": "automatic",
          "trimChannel712Mode": "manual_0",
          "trimChannel214Mode": "manual_0",
          "trimChannel514Mode": "manual_0",
          "trimChannel714Mode": "manual_0",
          "associatedVideoFrameRate": 23.976,
          "start": "01:00:00:00",
          "fFoA": "01:00:00:00",
          "end": "01:03:30:13",
          "metadataFormat": "ADM, Version 0",
          "admProfile": "Dolby Atmos Master, Version 1",
          "numberOfProgrammes": 1,
          "numberOfObjectChannels": 48,
          "numberOfPackFormats": 49,
          "numberOfChannelFormats": 58,
          "binauralRenderModesSummary": "Off + Near + Mid + Far",
          "binauralRenderModesOffCount": 9,
          "binauralRenderModesNearCount": 8,
          "binauralRenderModesMidCount": 13,
          "binauralRenderModesFarCount": 1,
          "truePeakLevels": -3.14,
          "loudness": -16.67
        }
      },
      "hlsPlaylistUrl": "https://cimediacloud.com/t5y7s3ero3w2ie7/hls",
      "acquisitionContext": {
        "name": "Movie1.mov",
        "path": "original/source/path"
      },
      "isExternal": false,
      "workspace": {
        "id": "gb5ehomv0iv71swg",
        "name": "Workspace Name",
        "class": "Enterprise"
      },
      "kind": "Asset"
    }
  ]
}

Property name	Type	Description
limit	`number`	The limit used for the query.
offset	`number`	The offset used for the query.
count	`number`	The total count of items available.
order	`object`	Information about the ordering of the results.
order.by	`string`	Indicates the field used to sort the results.
order.direction	`string`	Indicates the direction used to sort the results.
kind	`array`	Indicates the kind filter used in the request. Returned values are ‘All’, ‘Asset’, and ‘Folder’.
items	`array`	The items returned. Can be both assets and folders.
items[].id	`string`	The unique identifier of the asset.
items[].name	`string`	The name of the asset, including its extension. Its maximum length is 512 characters.
items[].size	`number`	The size of the source file, in bytes.
items[].type	`string`	The type of the asset. Valid values are `Audio`, `Video`, `Image`, `Document`, or `Other`.
items[].format	`string`	The asset’s file format.
items[].folder	`object`	Information about the asset’s parent folder.
items[].folder.id	`string`	The unique identifier of the folder.
items[].folder.name	`string`	The name of folder.
items[].status	`string`	The status of the asset. Valid values are ‘Created’, ‘Complete’, ‘Deleted’, ‘Executable Detected’, ‘Failed’, ‘Limited’, ‘Processing’, ‘Uploading’, ‘Virus Detected’, ‘Waiting’. See this section for more information.
items[].description	`string`	A comment or note associated to the asset. Its maximum length is 1000 characters.
items[].thumbnails	`array`	The set of thumbnails for the asset.
items[].thumbnails[].type	`string`	The type of thumbnail returned. Valid values are ‘small’, ‘medium’ and ‘large’.
items[].thumbnails[].location	`string`	The url of the thumbnail.
items[].thumbnails[].size	`number`	The size of the thumbnail, in bytes.
items[].thumbnails[].width	`number`	The width of the thumbnail.
items[].thumbnails[].height	`number`	The height of the thumbnail.
items[].thumbnails[].source	`object`	Information about the source of thumbnails.
items[].thumbnails[].source.id	`string`	Unique identifier of the thumbnail’s source.
items[].thumbnails[].source.kind	`string`	The kind of entity of the thumbnail’s source.
items[].thumbnails[].isExternal	`boolean`	Indicates if the thumbnail is stored in an external source.
items[].proxies	`array`	The set of proxies for the asset.
items[].proxies[].type	`string`	The type of proxy returned. Valid values are ‘standard-audio’, ‘dolby-audio’, ‘video-3g’, ‘video-sd’, ‘video-sdplus’, ‘video-hd’, ‘video-2k’, ‘video-2kplus’, ‘document-pdf’.
items[].proxies[].location	`string`	The url of the proxy.
items[].proxies[].size	`number`	The size of the proxy, in bytes.
items[].proxies[].width	`number`	The width of the proxy.
items[].proxies[].height	`number`	The height of the proxy.
items[].proxies[].videoBitRate	`number`	The video bitrate of the proxy.
items[].proxies[].audioBitRate	`number`	The audio bitrate of the proxy.
items[].proxies[].isExternal	`boolean`	Indicates if the proxy is stored in an external source.
items[].md5Checksum	`string`	The calculated md5 checksum for the asset.
items[].createdOn	`string`	The datetime the asset record was created.
items[].createdBy	`object`	Information about the creator of the asset
items[].createdBy.id	`string`	The unique identifier of the user.
items[].createdBy.name	`string`	The full name of the user.
items[].createdBy.email	`string`	The email of the user.
items[].modifiedOn	`string`	The datetime the asset record was last modified.
items[].lastActivityOn	`string`	The datetime of the last activity of the asset record.
items[].acquisitionSource	`object`	Information about the asset’s source client application.
items[].acquisitionSource.name	`string`	The name of the client application that uploaded the asset.
items[].archiveStatus	`string`	The archive status of the asset. Valid values are ‘Not archived’, ‘Archive in progress’, ‘Archive failed’, ‘Archived’, ‘Cancel archive in progress’.
items[].archiveType	`string`	If available, the kind of archive used for storing the asset. Valid values are `Standard` and `Deep`.
items[].restoreStatus	`string`	The restore status of the asset. This is applicable to assets that have been archived. Valid values are ‘Not restored’, ‘Restore in progress’, ‘Restore failed’, ‘Restored’.
items[].restoreExpirationDate	`string`	If available, the datetime the restored copy of the asset’s source file will no longer be available.
items[].restoreRequestDate	`string`	If available, the datetime the asset’s source file was requested to be restored.
items[].lastRestoreDate	`string`	If available, the datetime the asset’s source file was last restored.
items[].restoredBy	`object`	If available, information about the user who restored the asset.
items[].restoredBy.id	`string`	The unique identifier of the user.
items[].restoredBy.name	`string`	The full name of the user.
items[].restoredBy.email	`string`	The email of the user.
items[].archiveDate	`string`	If available, the datetime the asset’s source file was last archived.
items[].archivedBy	`object`	If available, information about the user who archived the asset.
items[].archivedBy.id	`string`	The unique identifier of the user.
items[].archivedBy.name	`string`	The full name of the user.
items[].archivedBy.email	`string`	The email of the user.
items[].uploadCompleteDate	`string`	The datetime the asset upload was completed.
items[].isTrashed	`boolean`	Indicates if an asset is in the trash bin.
items[].uploadTransferType	`string`	Indicates how the asset was uploaded. Valid values are ‘SinglepartHttp’, ‘MultipartHttp’, ‘Aspera’, ‘Copy’, ‘FTP’, ‘WorkspaceSend’.
items[].runtime	`number`	The duration of the media asset, in seconds.
items[].totalFolderCount	`number`	The amount of folders where the asset exists.
items[].network	`object`	Information about the asset’s network.
items[].network.id	`string`	The unique identifier of the Network.
items[].network.name	`string`	The name of the Network.
items[].network.class	`string`	Indicates if the Network is a ‘Personal’ or ‘Enterprise’ Network.
items[].metadata	`array`	An array of key-value pairs of user-generated and basic technical metadata.
items[].metadata[].name	`string`	The name of the metadata item.
items[].metadata[].value	`string`	the value of the metadata item.
items[].metadata[].readOnly	`boolean`	Flag to set a read-only metadata.
items[].technicalMetadata	`object`	An object that contains all the technical metadata available.
items[].technicalMetadata.type	`string`	The type of the asset. Valid values are either ‘Audio’, ‘Video’ or ‘Image’.
items[].technicalMetadata.location	`string`	Url of the source technical metadata file. Note: the content and structure of the technical metadata file is subject to change at any time.
items[].technicalMetadata.size	`number`	The size of the technical metadata file, in bytes.
items[].technicalMetadata.image	`object`	If the asset’s type is ‘Image’, this property contains the extended image technical metadata.
items[].technicalMetadata.image.width	`number`	The width of the image, in pixels.
items[].technicalMetadata.image.height	`number`	The height of the image, in pixels.
items[].technicalMetadata.image.xResolution	`number`	The number of pixels per resolutionUnit in the width direction.
items[].technicalMetadata.image.yResolution	`number`	The number of pixels per resolutionUnit in the height direction.
items[].technicalMetadata.image.resolutionUnit	`string`	The unit of measurement for xResolution and yResolution. Can be ‘inches’, ‘cm’ or ‘none’.
items[].technicalMetadata.image.cameraMake	`string`	Camera manufacturer name.
items[].technicalMetadata.image.cameraModel	`string`	Camera model name.
items[].technicalMetadata.image.groupingInfo	`string`	If available, the grouping info of the image. String of hexadecimal value (52 characteres) for the byte array object. Byte array order is Litte Endian.
items[].technicalMetadata.image.umidBasic	`string`	If available, the umid basic info of the image. String of hexadecimal value (64 characteres) for the byte array object.
items[].technicalMetadata.image.materialNumber	`string`	If available, the material number of the image. String of hexadecimal value (32 characteres) for the byte array object.
items[].technicalMetadata.image.recordedDate	`string`	The date and Time at which the image was captured.
items[].technicalMetadata.image.locationCity	`string`	Name of the city where the image was created.
items[].technicalMetadata.image.locationState	`string`	Name of the state where the image was created.
items[].technicalMetadata.image.locationCountry	`string`	Name of the country where the image was created.
items[].technicalMetadata.image.exif	`object`	The avalaible EXIF (Exchangeable Image File) metadata.
items[].technicalMetadata.image.exif.imageWidth	`string`	The image width in pixels.
items[].technicalMetadata.image.exif.imageHeight	`string`	The image height in pixels.
items[].technicalMetadata.image.exif.artist	`string`	The image artist info.
items[].technicalMetadata.image.exif.copyright	`string`	The image copyright.
items[].technicalMetadata.image.iptc	`object`	The available IPTC (International Press Telecommunications Council) available.
items[].technicalMetadata.image.iptc.codedCharacterSet	`string`	Determines how the internal IPTC string values are interpreted.
items[].technicalMetadata.image.iptc.headline	`string`	Brief synopsis or summary of the contents of the photograph.
items[].technicalMetadata.image.iptc.credit	`string`	How the image should be credited when published, as specified by the supplier of the image.
items[].technicalMetadata.image.iptc.keywords	`string`	Descriptive words added to the image to enable search and retrieval.
items[].technicalMetadata.image.xmp	`object`	The available XMP (Extensible Metadata Platform) metadata.
items[].technicalMetadata.image.xmp.serialNumber	`string`	Camera Serial Number.
items[].technicalMetadata.image.xmp.creatorRegion	`string`	State / Province for the address of the person that created this image.
items[].technicalMetadata.image.xmp.lens	`string`	Attempts to identify the camera lens used.
items[].technicalMetadata.image.xmp.creatorCountry	`string`	Country name for the address of the person that created this image.
items[].technicalMetadata.avContainer	`object`	If asset type is ‘Audio’ or ‘Video’, this property contains the extended audio / video technical metadata.
items[].technicalMetadata.avContainer.bitRate	`number`	The overall bitrate in the container.
items[].technicalMetadata.avContainer.duration	`number`	The runtime of the media in the container, in seconds.
items[].technicalMetadata.avContainer.start	`number`	The start time in the container, in seconds.
items[].technicalMetadata.avContainer.recordedDate	`string`	The date and Time at which the video was captured.
items[].technicalMetadata.avContainer.deviceManufacturer	`string`	The name of the device Manufacturer.
items[].technicalMetadata.avContainer.timeCode	`string`	The SMPTE timecode in the container.
items[].technicalMetadata.avContainer.derivedTimeCode	`string`	The standardized timecode derived by evaluating stream metadata and converting to drop frame format, if using drop frame rate.
items[].technicalMetadata.avContainer.streams	`array`	Set of audio, video, or data streams contained in the asset.
items[].technicalMetadata.avContainer.streams[].index	`number`	The index of the stream in the container.
items[].technicalMetadata.avContainer.streams[].type	`string`	The type of the stream. Valid values are `Audio`, `Video` or `Data`.
items[].technicalMetadata.avContainer.streams[].bitRate	`number`	If available, the overall bitrate in the stream.
items[].technicalMetadata.avContainer.streams[].bitDepth	`number`	If available, for an `Audio` stream, the bit depth of the stream.
items[].technicalMetadata.avContainer.streams[].bitRateMode	`string`	If available, the bit rate mode of the stream.
items[].technicalMetadata.avContainer.streams[].codec	`string`	If available, the codec used in the stream. For example, `h264`.
items[].technicalMetadata.avContainer.streams[].codecName	`string`	If available, the MediaInfo generated format commercial name for the stream.
items[].technicalMetadata.avContainer.streams[].codecProfile	`string`	If available, the MediaInfo generated format profile for the stream.
items[].technicalMetadata.avContainer.streams[].codecSettings	`string`	If avalable, the MediaInfo generated format settings for the stream.
items[].technicalMetadata.avContainer.streams[].fourCC	`string`	If available, four-character code for the codec used in the stream. For example, `avc1`, `apch`.
items[].technicalMetadata.avContainer.streams[].width	`number`	If available, for a `Video` stream, the width in pixels of the video.
items[].technicalMetadata.avContainer.streams[].height	`number`	If available, for a `Video` stream, the height in pixels of the video.
items[].technicalMetadata.avContainer.streams[].totalFrames	`number`	If available, total number of frames within the `Video` stream.
items[].technicalMetadata.avContainer.streams[].duration	`number`	If available, the runtime of the media in seconds.
items[].technicalMetadata.avContainer.streams[].frameRateNumerator	`number`	If available, the numerator of the frame rate. For example, if the frame rate is 24, the frame rate numerator is 24.
items[].technicalMetadata.avContainer.streams[].frameRateDenominator	`number`	If available, the numerator of the frame rate. For example, if the frame rate is 24, the frame rate denominator is 1.
items[].technicalMetadata.avContainer.streams[].videoPARWidth	`number`	If available, the width part of the pixel aspect ratio.
items[].technicalMetadata.avContainer.streams[].videoPARHeight	`number`	If available, the height part of the pixel aspect ratio.
items[].technicalMetadata.avContainer.streams[].videoDARWidth	`number`	If available, the width part of the display aspect ratio.
items[].technicalMetadata.avContainer.streams[].videoDARHeight	`number`	If available, the height part of the display aspect ratio.
items[].technicalMetadata.avContainer.streams[].start	`number`	If available, the start time in the stream, in seconds.
items[].technicalMetadata.avContainer.streams[].timeCode	`string`	If available, the SMPTE timecode in the stream.
items[].technicalMetadata.avContainer.streams[].videoColorSpace	`string`	If available, for a `Video` stream, the video’s color space / color primaries.
items[].technicalMetadata.avContainer.streams[].videoScanOrder	`string`	If available, for a `Video` stream, the video’s scan order.
items[].technicalMetadata.avContainer.streams[].videoScanType	`string`	If available, for a `Video` stream, the video’s scan type.
items[].technicalMetadata.avContainer.streams[].videoColorPrimaries	`string`	If available, for a `Video` stream, the video’s color primaries.
items[].technicalMetadata.avContainer.streams[].videoChromaSubsampling	`string`	If available, for a `Video` stream, the video’s crhoma subsampling.
items[].technicalMetadata.avContainer.streams[].videoScanTypeStoreMethod	`string`	If available, for a `Video` stream, the video’s scan type store method.
items[].technicalMetadata.avContainer.streams[].audioSampleRate	`number`	If available, for an `Audio` stream, is the sample rate in Hz.
items[].technicalMetadata.avContainer.streams[].audioChannelCount	`number`	If available, for an `Audio` stream, is the number of channels within the stream.
items[].technicalMetadata.avContainer.streams[].audioLayout	`string`	If available, for an `Audio` stream, is the audio channel layout description. For example, `5.1`.
items[].technicalMetadata.avContainer.streams[].audioAnalysis	`string`	If available, for an `Audio` stream, it is further analysis to determine if a stream is true stereo or dual-mono.
items[].technicalMetadata.avContainer.streams[].rotate	`number`	If available, the amount of rotation, in degrees, that should be applied during playback of the video.
items[].technicalMetadata.dolbyContainer	`object`	If asset type is ‘Audio’ and the asset has Dolby Atmos metadata, this property contains the extended Dolby Atmos audio technical metadata.
items[].technicalMetadata.dolbyContainer.duration	`number`	Media duration (in seconds).
items[].technicalMetadata.dolbyContainer.fileSize	`number`	Media size (in bytes).
items[].technicalMetadata.dolbyContainer.overallBitRateMode	`string`	The overall bitrate mode for the Atmos content.
items[].technicalMetadata.dolbyContainer.overallBitRate	`number`	Media bitrate (in bits per second).
items[].technicalMetadata.dolbyContainer.totalChannels	`number`	Number of channels. `Bed channels` plus `Object channels` equals `Total channels`.
items[].technicalMetadata.dolbyContainer.bedChannels	`number`	Number of channel-based premix or stem that includes multichannel panning.
items[].technicalMetadata.dolbyContainer.numberOfBeds	`number`	A bed can be thought of as a traditional channel-based stem with the rules and expectations of stem configurations (such as 2.0, 5.1, and 7.1).
items[].technicalMetadata.dolbyContainer.bitDepth	`number`	Number of bits of information in each sample, generally 16, 24, or 32-bit.
items[].technicalMetadata.dolbyContainer.samplingRate	`number`	Audio sample-rate, generally 44100 or 48000 Hz.
items[].technicalMetadata.dolbyContainer.downmix51X	`string`	Global downmix metadata for monitoring, re-rendering, and encoding.
items[].technicalMetadata.dolbyContainer.trimModesSummary	`string`	A summary of the underlying trim modes.
items[].technicalMetadata.dolbyContainer.trimChannel20Mode	`string`	The type of trim mode supported for 2.0 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel51Mode	`string`	The type of trim mode supported for 5.1 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel71Mode	`string`	The type of trim mode supported for 7.1 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel212Mode	`string`	The type of trim mode supported for 2.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel512Mode	`string`	The type of trim mode supported for 5.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel712Mode	`string`	The type of trim mode supported for 7.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel214Mode	`string`	The type of trim mode supported for 2.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel514Mode	`string`	The type of trim mode supported for 5.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel714Mode	`string`	The type of trim mode supported for 7.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.associatedVideoFrameRate	`number`	Number of frames per second.
items[].technicalMetadata.dolbyContainer.start	`string`	Start SMPTE timecode based on the video frame rate.
items[].technicalMetadata.dolbyContainer.fFoA	`string`	FFoA (First Frame of Action) SMPTE timecode based on the video frame rate.
items[].technicalMetadata.dolbyContainer.end	`string`	End SMPTE timecode based on the video frame rate.
items[].technicalMetadata.dolbyContainer.metadataFormat	`string`	Format of the metadata in the Atmos content.
items[].technicalMetadata.dolbyContainer.admProfile	`string`	ADM (Audio Definition Model) Profile used in the Atmos content.
items[].technicalMetadata.dolbyContainer.numberOfProgrammes	`number`	Number of programmes in the Atmos content.
items[].technicalMetadata.dolbyContainer.numberOfObjectChannels	`number`	Number of objects in the Atmos Master.
items[].technicalMetadata.dolbyContainer.numberOfPackFormats	`number`	Number of Atmos Pack Formats in the Atmos content.
items[].technicalMetadata.dolbyContainer.numberOfChannelFormats	`number`	Number of channel formats in the Atmos content.
items[].technicalMetadata.dolbyContainer.binauralRenderModesSummary	`string`	Summary of all the binaural render modes used in the Atmos content. Supported strings are a unique combination of: “Off”, “Near”, “Mid”, “Far”.
items[].technicalMetadata.dolbyContainer.binauralRenderModesOffCount	`number`	Number of channels that use the “Off” setting for binaural rendering.
items[].technicalMetadata.dolbyContainer.binauralRenderModesNearCount	`number`	Number of channels that use the “Near” setting for binaural rendering.
items[].technicalMetadata.dolbyContainer.binauralRenderModesMidCount	`number`	Number of channels that use the “Mid” setting for binaural rendering.
items[].technicalMetadata.dolbyContainer.binauralRenderModesFarCount	`number`	Number of channels that use the “Far” setting for binaural rendering.
items[].technicalMetadata.dolbyContainer.truePeakLevels	`number`	The peak event in the audio waveform. Units are dBTP for true peak.
items[].technicalMetadata.dolbyContainer.loudness	`number`	Integrated loudness LKFS (or LUFS).
items[].hlsPlaylistUrl	`string`	A link to the HLS playlist generated from the source file.
items[].acquisitionContext	`object`	The file acquisition information.
items[].acquisitionContext.name	`string`	The original source file name, captured on acquisition.
items[].acquisitionContext.path	`string`	The original source file path, captured on acquisition.
items[].isExternal	`boolean`	Indicates if the file is stored in an external source.
items[].workspace	`object`	Information about the asset’s workspace.
items[].workspace.id	`string`	The unique identifier of the Workspace.
items[].workspace.name	`string`	The name of the Workspace.
items[].workspace.class	`string`	Indicates if the Workspace is a ‘Personal’ or ‘Team’ Workspace.
items[].kind	`string`	The type of item returned. Will always be ‘Asset’ for assets.

Headers

Content-Type: application/json

Body

{
  "code": "WorkspaceNotFound",
  "message": "Workspace not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200404

Headers

Content-Type: application/json

Body

{
  "limit": 1,
  "offset": 0,
  "count": 10,
  "order": {
    "by": "Name",
    "direction": "asc"
  },
  "kind": [
    "All"
  ],
  "items": [
    {
      "id": "9b639e12a82f4b0483f512b474dc052ci",
      "name": "My Folder",
      "createdOn": "2017-01-02T00:00:00.000Z",
      "createdBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "lastActivityOn": "2017-01-03T00:00:00.000Z",
      "network": {
        "id": "40c2a6b99a474b319dec5ef9c7dbb356",
        "name": "Company Name",
        "class": "Enterprise"
      },
      "metadata": [
        {
          "name": "intendedFor",
          "value": "landscapeImages"
        }
      ],
      "stats": {
        "childFolderCount": 2
      },
      "parentId": "nqyptt047b7qc9y3",
      "workspace": {
        "id": "gb5ehomv0iv71swg",
        "name": "Workspace Name",
        "class": "Enterprise"
      },
      "parentFolder": {
        "id": "9b639e12a82f4b0483f512b474dc052ci",
        "name": "Folder Name"
      },
      "isTrashed": false,
      "kind": "Folder"
    }
  ]
}

Property name	Type	Description
limit	`number`	The limit used for the query.
offset	`number`	The offset used for the query.
count	`number`	The total count of items available.
order	`object`	Information about the ordering of the results.
order.by	`string`	Indicates the field used to sort the results.
order.direction	`string`	Indicates the direction used to sort the results.
kind	`array`	Indicates the kind filter used in the request. Returned values are ‘All’, ‘Asset’, and ‘Folder’.
items	`array`	The items returned. Can be both assets and folders.
items[].id	`string`	The unique identifier of folder.
items[].name	`string`	The name of the folder.
items[].createdOn	`string`	The datetime the folder was created.
items[].createdBy	`object`	Information about the creator of the folder.
items[].createdBy.id	`string`	The unique identifier of the user.
items[].createdBy.name	`string`	The full name of the user.
items[].createdBy.email	`string`	The email of the user.
items[].lastActivityOn	`string`	The datetime of the last activity of the folder.
items[].network	`object`	Information about the folder’s parent network.
items[].network.id	`string`	The unique identifier of the Network.
items[].network.name	`string`	The name of the Network.
items[].network.class	`string`	Indicates if the Network is a ‘Personal’ or ‘Enterprise’ Network.
items[].metadata	`array`	An array of key-value pairs of user-generated metadata.
items[].metadata[].name	`string`	The name of the metadata item.
items[].metadata[].value	`string`	the value of the metadata item.
items[].stats	`object`	Statistics about the folder.
items[].stats.childFolderCount	`number`	The number of child folders for the given folder.
items[].parentId	`string`	The unique identifier of the parent folder, if it is a child folder, or the workspace id, if it is the Workspace’s root folder.
items[].workspace	`object`	Information about the folder’s parent workspace.
items[].workspace.id	`string`	The unique identifier of the Workspace.
items[].workspace.name	`string`	The name of the Workspace.
items[].workspace.class	`string`	Indicates if the Workspace is a ‘Personal’ or ‘Team’ Workspace.
items[].parentFolder	`object`	Information about the folder’s parent folder. If the folder is the root folder of a Workspace this property will not be available.
items[].parentFolder.id	`string`	The unique identifier of the folder.
items[].parentFolder.name	`string`	The name of folder.
items[].isTrashed	`boolean`	Indicates if a folder is in the trash bin.
items[].kind	`string`	The type of item returned. Will always be ‘Folder’ for folders.

Headers

Content-Type: application/json

Body

{
  "code": "WorkspaceNotFound",
  "message": "Workspace not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

List Folder Contents
GET`/folders/{folderId}/contents{?kind,limit,offset,orderBy,orderDirection,fields}`

URI Parameters

HideShow

folderId

string (required)

The unique identifier of the folder.

kind

string (optional) Default: all

Determines which kind of items will be returned.

Choices: folder asset all

limit

number (optional) Default: 50

The number of items to return. The maximum is 100.

offset

number (optional) Default: 0

The item at which to begin the response.

orderBy

string (optional) Default: name

The field to sort the items by. Note: ‘size’ only sorts by asset size and not folder size.

Choices: createdOn createdBy name type size status

orderDirection

string (optional) Default: asc

The order direction the items should be returned.

Choices: asc desc

fields

string (optional)

A comma separated list of fields to return in the response. If this value is empty all fields will be returned. Id and Name are always returned.

Description

Retrieves the subfolders and assets of the given folder. This query supports pagination using limit and offset. Additionally, using the ‘kind’ parameter, it is possible to choose which kind of items to return (subfolders, assets or both). If both are returned, the items are grouped by kind (subfolders first, then assets).

Errors

Status Code	Error Code	Message
400	InvalidLimitOrOffset	Invalid limit or offset value. Limit must be a number between 1 and 100. Offset must be greater than or equal to 0.
400	InvalidQueryOrderField	Invalid order field. It must be either ‘CreatedOn’, ‘Name’, ‘Status’, ‘Type’, ‘Size’ or ‘CreatedBy’.
400	InvalidQueryOrderDirection	Invalid order direction. It must be either ‘Asc’ or ‘Desc’.
400	InvalidQueryKindFilter	Invalid kind filter. It must be either ‘All’, ‘Asset’ or ‘Folder’.
404	FolderNotFound	Folder not found.

Get Folder Storage Stats ¶

GET https://api.cimediacloud.com/folders/a0fa81ebedbc47c49de78874f985c08c/stats

Requestsexample with stats in response

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200404

Headers

Content-Type: application/json

Body

{
  "fileTotalCount": 12,
  "fileTotalSize": 125,
  "activeFileCount": 4,
  "activeFileSize": 30,
  "archiveInProgressFileCount": 1,
  "archiveInProgressFileSize": 10,
  "archivedFileCount": 4,
  "archivedFileSize": 30,
  "deepArchivedFileCount": 4,
  "deepArchivedFileSize": 30,
  "restoreInProgressFileCount": 1,
  "restoreInProgressFileSize": 10,
  "restoredFileCount": 2,
  "restoredFileSize": 15,
  "folderCount": 0
}

Property name	Type	Description
fileTotalCount	`number`	The amount of all files within the folder.
fileTotalSize	`number`	The sum of the sizes of all files within the folder in bytes.
activeFileCount	`number`	The amount of active files within the folder.
activeFileSize	`number`	The sum of the sizes of active files within the folder in bytes.
archiveInProgressFileCount	`number`	The amount of archive in progress files within the folder.
archiveInProgressFileSize	`number`	The sum of the sizes of archive in progress files within the folder in bytes.
archivedFileCount	`number`	The amount of archived files within the folder.
archivedFileSize	`number`	The sum of the sizes of archived files within the folder in bytes.
deepArchivedFileCount	`number`	The amount of deep archived files within the folder.
deepArchivedFileSize	`number`	The sum of the sizes of deep archived files within the folder in bytes.
restoreInProgressFileCount	`number`	The amount of restore in progress files within the folder.
restoreInProgressFileSize	`number`	The sum of the sizes of restore in progress files within the folder in bytes.
restoredFileCount	`number`	The amount of restored files within the folder.
restoredFileSize	`number`	The sum of the sizes of restored files within the folder in bytes.
folderCount	`number`	The amount of child folders within the folder.

Headers

Content-Type: application/json

Body

{
  "code": "FolderNotFound",
  "message": "Folder not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Get Folder Storage Stats
GET`/folders/{folderId}/stats`

URI Parameters

HideShow

folderId: string (required)
The unique identifier of the folder.

Description

Retrieves information about the contents of the given folder.

Errors

Status Code	Error Code	Message
404	FolderNotFound	Folder not found.

Move Folders ¶

POST https://api.cimediacloud.com/folders/move

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "folderIds": [
    "6i3x3hp1ni2wo5bd"
  ],
  "targetFolderId": "q3ln0tpox340bbmh"
}

Property name	Type	Description
folderIds	`array`	The unique identifiers for all folders.
targetFolderId	`string`	The unique identifier for the target folder.

Responses200409

Headers

Content-Type: application/json

Body

{
  "completeCount": 1,
  "errorCount": 1,
  "errors": [
    {
      "name": "Item name",
      "kind": "Item",
      "errorCode": "ItemNotFound",
      "errorMessage": "Item not found.",
      "id": "ad9289a2019a4e07a08eca9459ef1091"
    }
  ],
  "complete": [
    {
      "id": "9b639e12a82f4b0483f512b474dc052ci",
      "name": "Folder Name",
      "kind": "Folder"
    }
  ]
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors	`array`	An array containing information about each failed item.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].id	`string`	The unique identifier for the item.
complete	`array`	An array containing information about each completed item.
complete[].id	`string`	The unique identifier of the folder.
complete[].name	`string`	The name of folder.
complete[].kind	`string`	The kind of item returned. Will be ‘Folder’ for folders.

Headers

Content-Type: application/json

Body

{
  "completeCount": 0,
  "errorCount": 1,
  "errors": [
    {
      "name": "Item name",
      "kind": "Item",
      "errorCode": "ItemNotFound",
      "errorMessage": "Item not found.",
      "id": "ad9289a2019a4e07a08eca9459ef1091"
    }
  ]
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors	`array`	An array containing information about each failed item.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].id	`string`	The unique identifier for the item.

Move Folders
POST`/folders/move`

Description

Moves one or more folders into a target folder within the same Workspace.

Errors

Status Code	Error Code	Message	Notes
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	FolderIdNotProvided	Folder Id was not provided.	Either the folders to be moved or the target folder was not provided.
400	FolderNotFound	Folder not found.	Target folder was not found.
400	ExceededMaxFolderCount	Max folder count exceeded. The maximum number of folders is 500.
409	FolderTrashed	Folder is trashed.	Target folder is trashed.
409	FolderDeleted	Folder is deleted.	Target folder is deleted.
409	BulkOperationFailed	The bulk operation failed. See the errors array for more information.	This message appears if there were no successfully moved folders.

Errors represented in errors array

Error Code	Message
CannotChangeWorkspace	Invalid workspace. Folders cannot be moved to a different workspace.
FolderNotFound	Folder not found.
FolderDeleted	Folder is deleted.
FolderTrashed	Folder is trashed.
InvalidFolder	Invalid folder. Folders cannot be moved into their sub-folders.
InvalidFolder	Invalid folder. A folder cannot be moved to itself.
InvalidOperationOnRootFolder	Root folder cannot be deleted, trashed, untrashed, or moved.

Trash a Folder ¶

POST https://api.cimediacloud.com/folders/moqxhkej4epvgrwz/trash

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200404

Headers

Content-Type: application/json

Body

{
  "message": "Folder was trashed"
}

Property name	Type	Description
message	`string`	Indicates the folder was trashed.

Headers

Content-Type: application/json

Body

{
  "code": "FolderNotFound",
  "message": "Folder not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Trash a Folder
POST`/folders/{folderId}/trash`

URI Parameters

HideShow

folderId: string (required)
The unique identifier of the folder.

Description

Sends the folder and all of its contents to the trash bin. Items in the trash bin are not considered available for additional operations, i.e. downloading. However, they are still physically available and can be removed from the trash.

Trashing a folder will trash all contents within the folder recursively (including all subfolders and assets within subfolders).

The sum of the size of all assets in the folder are still counted against your storage quota while they exist in the trash bin.

Assets affected during this operation may not be updated immediately. This work is performed asynchronously and therefore it can take a few minutes for all updates to appear.

Errors

Status Code	Error Code	Message
404	FolderNotFound	Folder not found.
404	FolderDeleted	Folder is deleted.
409	FolderTrashed	Folder is trashed.
409	InvalidOperationOnRootFolder	Root folder cannot be deleted, trashed, untrashed, or moved.

Trash Multiple Folders ¶

POST https://api.cimediacloud.com/folders/trash

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "folderIds": [
    "6i3x3hp1ni2wo5bd"
  ]
}

Property name	Type	Description
folderIds	`array`	The unique identifiers for all folders.

Responses200409

Headers

Content-Type: application/json

Body

{
  "completeCount": 1,
  "errorCount": 1,
  "errors": [
    {
      "name": "Item name",
      "kind": "Item",
      "errorCode": "ItemNotFound",
      "errorMessage": "Item not found.",
      "id": "ad9289a2019a4e07a08eca9459ef1091"
    }
  ],
  "complete": [
    {
      "id": "9b639e12a82f4b0483f512b474dc052ci",
      "name": "Folder Name",
      "kind": "Folder"
    }
  ]
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors	`array`	An array containing information about each failed item.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].id	`string`	The unique identifier for the item.
complete	`array`	An array containing information about each completed item.
complete[].id	`string`	The unique identifier of the folder.
complete[].name	`string`	The name of folder.
complete[].kind	`string`	The kind of item returned. Will be ‘Folder’ for folders.

Headers

Content-Type: application/json

Body

{
  "completeCount": 0,
  "errorCount": 1,
  "errors": [
    {
      "name": "Item name",
      "kind": "Item",
      "errorCode": "ItemNotFound",
      "errorMessage": "Item not found.",
      "id": "ad9289a2019a4e07a08eca9459ef1091"
    }
  ]
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors	`array`	An array containing information about each failed item.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].id	`string`	The unique identifier for the item.

Trash Multiple Folders
POST`/folders/trash`

Description

Sends the folders and all of their contents to the trash bin. Items in the trash bin are not considered available for additional operations, i.e. downloading. However, they are still physically available and can be removed from the trash.

500 is the maximum number of folders that can be trashed in a single operation.

Trashing a folder will trash all contents within the folder recursively (including all subfolders and assets within subfolders).

The sum of the size of all assets in the folder are still counted against your storage quota while they exist in the trash bin.

Assets affected during this operation may not be updated immediately. This work is performed asynchronously and therefore it can take a few minutes for all updates to appear.

Errors

Status Code	Error Code	Message	Notes
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	FolderIdNotProvided	Folder Id not provided.
400	ExceededMaxFolderCount	Max folder count exceeded. The maximum number of folders is 500.
409	BulkOperationFailed	The bulk operation failed. See the errors array for more information.	This message appears if there were no successfully trashed folders.

Errors represented in errors array

Error Code	Message
FolderNotFound	Folder not found.
FolderDeleted	Folder is deleted.
FolderTrashed	Folder is trashed.
InvalidOperationOnRootFolder	Root folder cannot be deleted, trashed, untrashed, or moved.

Untrash a Folder ¶

POST https://api.cimediacloud.com/folders/moqxhkej4epvgrwz/untrash

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200404

Headers

Content-Type: application/json

Body

{
  "message": "Folder was untrashed"
}

Property name	Type	Description
message	`string`	Indicates the folder was untrashed.

Headers

Content-Type: application/json

Body

{
  "code": "FolderNotFound",
  "message": "Folder not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Untrash a Folder
POST`/folders/{folderId}/untrash`

URI Parameters

HideShow

folderId: string (required)
The unique identifier of the folder.

Description

Removes a previously-trashed folder and all its contents from the trash bin.

Untrashing a folder will untrash all contents within the folder recursively (including all subfolders and assets within subfolders).

Additionally, this operation will untrash the folder’s parent folders, if trashed, but will not untrash any parent folder contents.

Assets affected during this operation may not be updated immediately. This work is performed asynchronously and therefore it can take a few minutes for all updates to appear.

Errors

Status Code	Error Code	Message
404	FolderNotFound	Folder not found.
404	FolderDeleted	Folder is deleted.
409	FolderNotTrashed	Folder is already untrashed.
409	InvalidOperationOnRootFolder	Root folder cannot be deleted, trashed, untrashed, or moved.

Untrash Multiple Folders ¶

POST https://api.cimediacloud.com/folders/untrash

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "folderIds": [
    "6i3x3hp1ni2wo5bd"
  ]
}

Property name	Type	Description
folderIds	`array`	The unique identifiers for all folders.

Responses200409

Headers

Content-Type: application/json

Body

{
  "completeCount": 1,
  "errorCount": 1,
  "errors": [
    {
      "name": "Item name",
      "kind": "Item",
      "errorCode": "ItemNotFound",
      "errorMessage": "Item not found.",
      "id": "ad9289a2019a4e07a08eca9459ef1091"
    }
  ],
  "complete": [
    {
      "id": "9b639e12a82f4b0483f512b474dc052ci",
      "name": "Folder Name",
      "kind": "Folder"
    }
  ]
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors	`array`	An array containing information about each failed item.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].id	`string`	The unique identifier for the item.
complete	`array`	An array containing information about each completed item.
complete[].id	`string`	The unique identifier of the folder.
complete[].name	`string`	The name of folder.
complete[].kind	`string`	The kind of item returned. Will be ‘Folder’ for folders.

Headers

Content-Type: application/json

Body

{
  "completeCount": 0,
  "errorCount": 1,
  "errors": [
    {
      "name": "Item name",
      "kind": "Item",
      "errorCode": "ItemNotFound",
      "errorMessage": "Item not found.",
      "id": "ad9289a2019a4e07a08eca9459ef1091"
    }
  ]
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors	`array`	An array containing information about each failed item.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].id	`string`	The unique identifier for the item.

Untrash Multiple Folders
POST`/folders/untrash`

Description

Removes previously-trashed folders and all their contents from the trash bin.

500 is the maximum number of folders that can be untrashed in a single operation.

Untrashing a folder will untrash all contents within the folder recursively (including all subfolders and assets within subfolders).

Additionally, this operation will untrash the folder’s parent folders, if trashed, but will not untrash any parent folder contents.

Assets affected during this operation may not be updated immediately. This work is performed asynchronously and therefore it can take a few minutes for all updates to appear.

Errors

Status Code	Error Code	Message	Notes
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	FolderIdNotProvided	Folder Id not provided.
400	ExceededMaxFolderCount	Max folder count exceeded. The maximum number of folders is 500.
409	BulkOperationFailed	The bulk operation failed. See the errors array for more information.	This message appears if there were no successfully untrashed folders.

Errors represented in errors array

Error Code	Message
FolderNotFound	Folder not found.
FolderDeleted	Folder is deleted.
FolderNotTrashed	Folder is already untrashed.
InvalidOperationOnRootFolder	Root folder cannot be deleted, trashed, untrashed, or moved.

Delete Multiple Folders ¶

POST https://api.cimediacloud.com/folders/delete

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "folderIds": [
    "6i3x3hp1ni2wo5bd"
  ]
}

Property name	Type	Description
folderIds	`array`	The unique identifiers for all folders.

Responses200409

Headers

Content-Type: application/json

Body

{
  "completeCount": 1,
  "errorCount": 1,
  "errors": [
    {
      "name": "Item name",
      "kind": "Item",
      "errorCode": "ItemNotFound",
      "errorMessage": "Item not found.",
      "id": "ad9289a2019a4e07a08eca9459ef1091"
    }
  ],
  "complete": [
    {
      "id": "9b639e12a82f4b0483f512b474dc052ci",
      "name": "Folder Name",
      "kind": "Folder"
    }
  ]
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors	`array`	An array containing information about each failed item.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].id	`string`	The unique identifier for the item.
complete	`array`	An array containing information about each completed item.
complete[].id	`string`	The unique identifier of the folder.
complete[].name	`string`	The name of folder.
complete[].kind	`string`	The kind of item returned. Will be ‘Folder’ for folders.

Headers

Content-Type: application/json

Body

{
  "completeCount": 0,
  "errorCount": 1,
  "errors": [
    {
      "name": "Item name",
      "kind": "Item",
      "errorCode": "ItemNotFound",
      "errorMessage": "Item not found.",
      "id": "ad9289a2019a4e07a08eca9459ef1091"
    }
  ]
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors	`array`	An array containing information about each failed item.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].id	`string`	The unique identifier for the item.

Delete Multiple Folders
POST`/folders/delete`

Description

Deletes the specified folders and all of their contents permanently. The storage quota is updated to reflect the newly freed space.

500 is the maximum number of folders that can be deleted in a single operation.

Deleting a folder will delete all contents within the folder recursively (including all subfolders and assets within subfolders).

All folders and assets are permanently deleted and cannot be recovered.

Assets affected during this operation may not be updated immediately. This work is performed asynchronously and therefore it can take a few minutes for all updates to appear.

Errors

Status Code	Error Code	Message	Notes
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	FolderIdNotProvided	Folder Id not provided.
400	ExceededMaxFolderCount	Max folder count exceeded. The maximum number of folders is 500.
409	BulkOperationFailed	The bulk operation failed. See the errors array for more information.	This message appears if there were no successfully deleted folders.

Errors represented in errors array

Error Code	Message
FolderNotFound	Folder not found.
FolderDeleted	Folder is deleted.
InvalidOperationOnRootFolder	Root folder cannot be deleted, trashed, untrashed, or moved.

Change Metadata ¶

POST https://api.cimediacloud.com/folders/metadata/changes

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "changes": [
    {
      "folderIds": [
        "64887fa702df4b2491a4be085814303c"
      ],
      "set": [
        {
          "name": "Owner",
          "value": "Sony"
        }
      ],
      "unset": [
        {
          "name": "Category"
        }
      ]
    }
  ]
}

Property name	Type	Description
changes	`array`	The groups of changes to process.
changes[].folderIds	`array`	The folders affected by the group.
changes[].set	`array`	The items or add or update.
changes[].set[].name	`string`
changes[].set[].value	`string`
changes[].unset	`array`	The items to remove.
changes[].unset[].name	`string`

Responses200409

Headers

Content-Type: application/json

Body

{
  "completeCount": 1,
  "errorCount": 1,
  "errors": [
    {
      "name": "Item name",
      "kind": "Item",
      "errorCode": "ItemNotFound",
      "errorMessage": "Item not found.",
      "id": "ad9289a2019a4e07a08eca9459ef1091"
    }
  ],
  "complete": [
    {
      "id": "9b639e12a82f4b0483f512b474dc052ci",
      "name": "Folder Name",
      "kind": "Folder"
    }
  ]
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors	`array`	An array containing information about each failed item.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].id	`string`	The unique identifier for the item.
complete	`array`	An array containing information about each completed item.
complete[].id	`string`	The unique identifier of the folder.
complete[].name	`string`	The name of folder.
complete[].kind	`string`	The kind of item returned. Will be ‘Folder’ for folders.

Headers

Content-Type: application/json

Body

{
  "completeCount": 0,
  "errorCount": 1,
  "errors": [
    {
      "name": "Item name",
      "kind": "Item",
      "errorCode": "ItemNotFound",
      "errorMessage": "Item not found.",
      "id": "ad9289a2019a4e07a08eca9459ef1091"
    }
  ]
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors	`array`	An array containing information about each failed item.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].id	`string`	The unique identifier for the item.

Change Metadata
POST`/folders/metadata/changes`

Description

Adds, updates and removes metadata for multiple folders. This resource allows to perform multiple metadata changes to multiple folders in a single request.

Each group of changes define which metadata items are added or updated (if any), which metadata items are removed (if any), and which folders are affected by these changes.

A folder can only be affected by a single group of changes. That is, different groups cannot include the same folder id. Also, a group of changes cannot add (or update) and remove a specific metadata item.

The metadata item’s name is case insensitive.

500 is the maximum number of folders that can be updated in a single operation.

500 is the maximum number of changes that can included in a single operation.

Status Code	Error Code	Message	Notes
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	OverlappingChanges	At least a folder is part of different changesets.
400	ExceededMaxFolderCount	Max folder count exceeded. The maximum number of folders is 500.
400	ExceededMaxChangeCount	Max change count exceeded.
409	BulkOperationFailed	The bulk operation failed. See the errors array for more information.	This message appears if no changes were successfully processed.

Errors represented in errors array

Error Code	Message
FolderIdNotProvided	Folder Id not provided.
FolderNotFound	Folder not found.
FolderDeleted	Folder is deleted.
EmptyChanges	A changeset doesn’t have any change defined.
ConflictingChanges	A changeset has conflicting changes.
InvalidChanges	A changeset has invalid, incomplete changes.

MediaBoxes ¶

MediaBoxes allow users to send one or more files to other users who may not have access to the Workspace where the files are stored.

Create MediaBox ¶

POST https://api.cimediacloud.com/mediaboxes

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "name": "MediaBox Name",
  "assetIds": [
    "da836655e2c04e01930fb4b06b1c4e4c"
  ],
  "folderIds": [
    "74c9cf52d6d145258ad0ce6f2c77a1b5"
  ],
  "type": "Secure",
  "allowSourceDownload": false,
  "allowPreviewDownload": true,
  "allowElementDownload": true,
  "recipients": [
    "johnsmith@example.com"
  ],
  "message": "example message",
  "password": "pr!v@te",
  "expirationDays": 30,
  "expirationDate": "2017-01-02T00:00:00.000Z",
  "sendNotifications": true,
  "notifyOnOpen": true,
  "notifyOnChange": true,
  "commentSettings": {
    "isAllowedCommenting": false,
    "showExternalComments": false
  },
  "watermarking": {
    "text": "Watermark Text",
    "opacity": 0.5,
    "verticalPosition": 0.8,
    "forensic": false,
    "elements": [
      {
        "textType": "Custom",
        "text": "Watermark Text",
        "corner": "TL",
        "horizontal": 19.4,
        "vertical": 8.9,
        "opacity": 0.7,
        "fontColor": "FFFFFF",
        "fontSize": 14,
        "backgroundColor": "000000"
      }
    ]
  },
  "filters": {
    "elements": {
      "types": [
        "Image",
        "Video"
      ],
      "ciGeneratedPreviews": [
        "video-2k",
        "video-hd",
        "dolby-audio"
      ],
      "customRenders": [
        "social-media-1080p",
        "social-media-720p"
      ]
    }
  },
  "metadata": {
    "filter": "All",
    "changes": [
      {
        "set": [
          "Title",
          "Event Name"
        ],
        "unset": [
          "Keywords",
          "Description"
        ],
        "appliesTo": [
          "Asset"
        ]
      }
    ]
  }
}

Property name	Type	Description
name	`string` (required)	The title of the MediaBox.
assetIds	`array`	The asset ids that will be included in the MediaBox. All assets (and folders) must be part of the same Workspace. If `assetIds` is not set, then `folderIds` is required.
folderIds	`array`	The folder ids that will be included in the MediaBox. All folders (and assets) must be part of the same Workspace. If `folderIds` is not set, then `assetIds` is required.
type	`string` (required)	Specifies the type of MediaBox. The value must be ‘Secure’, ‘Protected’, or ‘Public’.
allowSourceDownload	`boolean`	Specifies if the source assets included in the MediaBox shall be downloadable or not. The default is ‘false’.
allowPreviewDownload	`boolean`	Specifies if the preview proxies of the assets included in the MediaBox shall be downloadable or not. The default is ‘false’.
allowElementDownload	`boolean`	Specifies if the elements (custom profiles and uploaded through the Elements API) associated to the assets included in the MediaBox shall be downloadable or not. The default is ‘false’.
recipients	`array`	The list of email addresses who shall receive the MediaBox. If ‘type’ is set to ‘Secure’, this list also restricts who can access the MediaBox. If ‘sendNotifications’ is true these users will receive an email when the MediaBox is created.
message	`string`	Brief note for recipients.
password	`string`	If ‘type’ is set to ‘Protected’, a password is required to open the MediaBox.
expirationDays	`number`	Number of days the MediaBox will be accessible after it is created. Provide this field or expirationDate field but not both. Omit this field and expirationDate field and the MediaBox will never expire.
expirationDate	`string`	Date and time when the MediaBox will expire. Value must be in ISO 8601 date and time format (e.g.: ‘2020-01-01’). Provide this field or expirationDays field but not both. Omit this field and expirationDays field + and the MediaBox will never expire.
sendNotifications	`boolean`	Indicates if an email notification shall be sent to the recipients. The default is ‘false’.
notifyOnOpen	`boolean`	Indicates if an email notification shall be sent to the MediaBox owner when a recipient opens the MediaBox. The default is ‘false’.
notifyOnChange	`boolean`	Indicates if an email notification shall be sent to the calling user if a Team Member edits, closes, or re-opens the MediaBox. The default is ‘false’.
commentSettings	`object`	Settings for commenting on the MediaBox.
commentSettings.isAllowedCommenting	`boolean` (required)	Indicates whether users can write comments in MediaBox assets.
commentSettings.showExternalComments	`boolean` (required)	Indicates whether comments from the Workspace can be viewed.
watermarking	`object`	Watermarking options for content in the MediaBox.
watermarking.text	`string` (required)	The watermark text that will be applied to the MediaBox assets. This can be empty if watermark elements are used instead.
watermarking.opacity	`number` (required)	The opacity level of the watermark text.
watermarking.verticalPosition	`number`	The vertical position of the watermark, defined as a percentage value between 0 and 1.
watermarking.forensic	`boolean`	If true, enables forensic watermarking.
watermarking.elements	`array`	List of watermark elements to apply. Each element represents a line of text.
watermarking.elements[].textType	`string` (required)	The type of the watermark text. The possible values are `Name`, `Email`, `IP`, `Date`, `Time` and `Custom`.
watermarking.elements[].text	`string`	The text to display in the watermark element. This is only required if the text type is `Custom`.
watermarking.elements[].corner	`string`	The corner of the content where the watermark is applied. The possible values are `TL`, `TR`, `BL` and `BR`. Default is `TL` (Top Left).
watermarking.elements[].horizontal	`number`	Horizontal offset for the watermark, defined in pixels.
watermarking.elements[].vertical	`number`	Vertical offset for the watermark, defined in pixels.
watermarking.elements[].opacity	`number`	The opacity level for the watermark element.
watermarking.elements[].fontColor	`string`	The font color for the watermark text in hexadecimal format.
watermarking.elements[].fontSize	`number`	The font size for the watermark text in pixels.
watermarking.elements[].backgroundColor	`string`	The background color behind the watermark text in hexadecimal format.
filters	`object`	Filter configuration for the elements that are returned for MediaBox assets.
filters.elements	`object`	Filters the elements that can be downloaded from the MediaBox assets. If not provided, no elements can be downloaded or previewed.
filters.elements.types	`array`	The types of elements that can be downloaded. The possible values are `Image`, `Video`, `Audio`, `Document`, `TimedText` and `Other`.
filters.elements.ciGeneratedPreviews	`array`	The types of Ci-generated previews that can be downloaded. The possible values are `video-2kplus`, `video-2k`, `video-hd`, `video-sdplus`, `video-sd`, `video-3g`, `dolby-audio`, `dolby-audio-stereo`, `dolby-audio-binaural` and `standard-audio`.
filters.elements.customRenders	`array`	The types of custom renders that can be downloaded. For example, `social-media-1080p`, `social-media-720p`, etc.
metadata	`object`	Optional filters for the metadata fields that are returned for assets and elements in the MediaBox. By default, all metadata fields are returned.
metadata.filter	`string`	The type of filter that will be applied to the metadata returned by the MediaBox assets and/or elements. Can be `All` (returns all metadata for assets and elements), `Template` (returns and applies a predefined set of metadata based on the changeset) or `None` (disables metadata retrieval).
metadata.changes	`array`	List of metadata changes to apply to the MediaBox. This is only applicable when the filter is set to `Template`.

Responses200400

Headers

Content-Type: application/json

Body

{
  "mediaboxId": "2vvcf7zv4hsrpeiq",
  "link": "https://workspace.cimediacloud.com/r/XeI26E"
}

Property name	Type	Description
mediaboxId	`string`	The unique identifier of the created MediaBox.
link	`string`	URL of the created MediaBox.

Headers

Content-Type: application/json

Body

{
  "code": "AssetNotFound",
  "message": "Asset not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Create MediaBox
POST`/mediaboxes`

Description

Creates a new MediaBox for sharing assets.

Errors

Status Code	Error Code	Message
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	MissingOrInvalidName	Missing or invalid name.
400	AssetIdNotProvided	Asset Id not provided.
400	ContentNotProvided	Content not provided.
400	InvalidMediaBoxType	Invalid MediaBox type.
400	InvalidExpiration	Invalid expiration.
400	InvalidPassword	A password is required.
400	InvalidRecipients	Recipients are required.
400	InvalidContent	Content belongs to multiple workspaces or catalogs.
400	AssetNotFound	Asset not found.
400	FolderNotFound	Folder not found.
400	InvalidWatermarking	Opacity must be greater than 0 and less or equal to 1.
400	InvalidWatermarking	Text must not be empty.
400	InvalidWatermarking	Position must be greater or equal to 0 and less or equal to 1.
400	EntitlementRequired	Visual Watermarking is not enabled for this network.
400	EntitlementRequired	MediaBox tracking is not enabled for this network.
400	InvalidFolder	MediaBox cannot contain Catalog folders.
400	InvalidMediaboxFilterOptions	Invalid filter options.
400	MediaBoxCommentSettingsNotAllowed	Comment settings not allowed. Make sure the provided value is in compliance with the MediaBox restrictions.
400	MediaBoxNeverExpiresNotAllowed	Never Expires not allowed. Make sure the provided value is in compliance with the MediaBox restrictions.
400	ForensicWatermarkMediaboxUpdate	Forensic Watermarking mediabox cannot be updated.
400	NonForensicWatermarkMediaboxUpdate	Mediabox cannot be converted to be forensically watermarked.

Update MediaBox ¶

PUT https://api.cimediacloud.com/mediaboxes/47d2300a74e9444abccf1016864cafac

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "name": "MediaBox Name",
  "assetIds": [
    "da836655e2c04e01930fb4b06b1c4e4c"
  ],
  "folderIds": [
    "74c9cf52d6d145258ad0ce6f2c77a1b5"
  ],
  "type": "Secure",
  "allowSourceDownload": true,
  "allowPreviewDownload": true,
  "allowElementDownload": true,
  "recipients": [
    "johnsmith@example.com"
  ],
  "message": "example message",
  "password": "pr!v@te",
  "expirationDays": 30,
  "expirationDate": "2017-01-02T00:00:00.000Z",
  "expirationEnabled": false,
  "sendNotifications": true,
  "notifyOnOpen": true,
  "notifyOnChange": true,
  "watermarking": {
    "text": "Watermark Text",
    "opacity": 0.5,
    "verticalPosition": 0.8,
    "forensic": false,
    "elements": [
      {
        "textType": "Custom",
        "text": "Watermark Text",
        "corner": "TL",
        "horizontal": 19.4,
        "vertical": 8.9,
        "opacity": 0.7,
        "fontColor": "FFFFFF",
        "fontSize": 14,
        "backgroundColor": "000000"
      }
    ]
  },
  "watermarkingEnabled": false,
  "isDeleted": false,
  "commentSettings": {
    "isAllowedCommenting": false,
    "showExternalComments": false
  },
  "filters": {
    "elements": {
      "types": [
        "Image",
        "Video"
      ],
      "ciGeneratedPreviews": [
        "video-2k",
        "video-hd",
        "dolby-audio"
      ],
      "customRenders": [
        "social-media-1080p",
        "social-media-720p"
      ]
    }
  },
  "metadata": {
    "filter": "All",
    "changes": [
      {
        "set": [
          "Title",
          "Event Name"
        ],
        "unset": [
          "Keywords",
          "Description"
        ],
        "appliesTo": [
          "Asset"
        ]
      }
    ]
  }
}

Property name	Type	Description
name	`string`	The title of the MediaBox.
assetIds	`array`	The asset IDs to include in the MediaBox. All assets (and folders) must be part of the same Workspace. If `assetIds` is not set, then `folderIds` is required.
folderIds	`array`	The folder IDs to include in the MediaBox. All folders (and assets) must be part of the same Workspace. If `folderIds` is not set, then `assetIds` is required.
type	`string`	Specifies the type of MediaBox. The value must be ‘Secure’, ‘Protected’, or ‘Public’.
allowSourceDownload	`boolean`	Specifies if the source assets included in the MediaBox shall be downloadable or not. The default is ‘false’.
allowPreviewDownload	`boolean`	Specifies if the preview proxies of the assets included in the MediaBox shall be downloadable or not. The default is ‘false’.
allowElementDownload	`boolean`	Specifies if the elements (custom profiles and uploaded through the Elements API) associated to the assets included in the MediaBox shall be downloadable or not. The default is ‘false’.
recipients	`array`	The list of email addresses who shall receive the MediaBox. If ‘type’ is set to ‘Secure’, this list also restricts who can access the MediaBox.
message	`string`	Brief note for recipients.
password	`string`	If ‘type’ is set to ‘Protected’, a password is required to open the MediaBox.
expirationDays	`number`	Number of days the MediaBox will be accessible after it is created. Provide this field or `expirationDate` but not both.
expirationDate	`string`	Date and time when the MediaBox will expire. Value must be in ISO 8601 date and time format (e.g.: ‘2020-01-01’). Provide this field or `expirationDays` but not both.
expirationEnabled	`boolean`	If set to false, the MediaBox will not expire.
sendNotifications	`boolean`	Indicates if an email notification shall be sent to the recipients.
notifyOnOpen	`boolean`	Indicates if an email notification shall be sent to the MediaBox owner when a recipient opens the MediaBox.
notifyOnChange	`boolean`	Indicates if an email notification shall be sent to the calling user if a Team Member edits, closes, or re-opens the MediaBox.
watermarkingEnabled	`boolean`	If set to false, removes watermarking from the MediaBox.
isDeleted	`boolean`	Toggles the delete flag (open/closed).
commentSettings	`object`	Settings for commenting on the MediaBox.
commentSettings.isAllowedCommenting	`boolean` (required)	Indicates whether users can write comments in MediaBox assets.
commentSettings.showExternalComments	`boolean` (required)	Indicates whether comments from the Workspace can be viewed.
watermarking	`object`	Watermarking options for content in the MediaBox.
watermarking.text	`string` (required)	The watermark text that will be applied to the MediaBox assets. This can be empty if watermark elements are used instead.
watermarking.opacity	`number` (required)	The opacity level of the watermark text.
watermarking.verticalPosition	`number`	The vertical position of the watermark, defined as a percentage value between 0 and 1.
watermarking.forensic	`boolean`	If true, enables forensic watermarking.
watermarking.elements	`array`	List of watermark elements to apply. Each element represents a line of text.
watermarking.elements[].textType	`string` (required)	The type of the watermark text. The possible values are `Name`, `Email`, `IP`, `Date`, `Time` and `Custom`.
watermarking.elements[].text	`string`	The text to display in the watermark element. This is only required if the text type is `Custom`.
watermarking.elements[].corner	`string`	The corner of the content where the watermark is applied. The possible values are `TL`, `TR`, `BL` and `BR`. Default is `TL` (Top Left).
watermarking.elements[].horizontal	`number`	Horizontal offset for the watermark, defined in pixels.
watermarking.elements[].vertical	`number`	Vertical offset for the watermark, defined in pixels.
watermarking.elements[].opacity	`number`	The opacity level for the watermark element.
watermarking.elements[].fontColor	`string`	The font color for the watermark text in hexadecimal format.
watermarking.elements[].fontSize	`number`	The font size for the watermark text in pixels.
watermarking.elements[].backgroundColor	`string`	The background color behind the watermark text in hexadecimal format.
filters	`object`	Filter configuration for the elements that are returned for MediaBox assets.
filters.elements	`object`	Filters the elements that can be downloaded from the MediaBox assets. If not provided, no elements can be downloaded or previewed.
filters.elements.types	`array`	The types of elements that can be downloaded. The possible values are `Image`, `Video`, `Audio`, `Document`, `TimedText` and `Other`.
filters.elements.ciGeneratedPreviews	`array`	The types of Ci-generated previews that can be downloaded. The possible values are `video-2kplus`, `video-2k`, `video-hd`, `video-sdplus`, `video-sd`, `video-3g`, `dolby-audio`, `dolby-audio-stereo`, `dolby-audio-binaural` and `standard-audio`.
filters.elements.customRenders	`array`	The types of custom renders that can be downloaded. For example, `social-media-1080p`, `social-media-720p`, etc.
metadata	`object`	Optional filters for the metadata fields that are returned for assets and elements in the MediaBox. By default, all metadata fields are returned.
metadata.filter	`string`	The type of filter that will be applied to the metadata returned by the MediaBox assets and/or elements. Can be `All` (returns all metadata for assets and elements), `Template` (returns and applies a predefined set of metadata based on the changeset) or `None` (disables metadata retrieval).
metadata.changes	`array`	List of metadata changes to apply to the MediaBox. This is only applicable when the filter is set to `Template`.

Responses200

Headers

Content-Type: application/json

Body

{
  "id": "21db607ed65a4198889f50336ba78755",
  "name": "New Releases",
  "message": "For your eyes only",
  "createdOn": "2017-01-02T00:00:00.000Z",
  "expiresOn": "2017-01-02T00:00:00.000Z",
  "deletedOn": "2017-01-02T00:00:00.000Z",
  "network": {
    "id": "40c2a6b99a474b319dec5ef9c7dbb356",
    "name": "Company Name",
    "class": "Enterprise"
  },
  "workspace": {
    "id": "gb5ehomv0iv71swg",
    "name": "Workspace Name",
    "class": "Enterprise"
  },
  "createdBy": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith",
    "email": "johnsmith@example.com"
  },
  "isDeleted": true,
  "link": "https://cimediacloud.com/mediaboxes/1234",
  "type": "Secure",
  "filters": {
    "elements": {
      "types": [
        "Video"
      ]
    }
  },
  "assets": [
    {
      "id": "d9bf018c804a4e78b775b8dc2f242071",
      "name": "Movie.mov",
      "type": "Video",
      "status": "Complete",
      "createdOn": "2017-01-02T00:00:00.000Z",
      "isViewable": true
    }
  ],
  "folders": [
    {
      "id": "9b639e12a82f4b0483f512b474dc052ci",
      "name": "Folder Name",
      "createdOn": "2017-01-02T00:00:00.000Z"
    }
  ],
  "users": [
    {
      "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
      "name": "John Smith",
      "email": "johnsmith@example.com"
    }
  ],
  "viewCount": 510,
  "watermarking": {
    "text": "{filename} viewing on {datestamp} by {username} (IP:{ip-address})",
    "opacity": 0.8,
    "verticalPosition": 0.46
  },
  "allowSourceDownload": false,
  "allowPreviewDownload": true,
  "allowElementDownload": true,
  "assetCount": 24,
  "folderCount": 3
}

Property name	Type	Description
id	`string`	The unique identifier of the MediaBox.
name	`string`	The name of the MediaBox.
message	`string`	Brief description or comment for the MediaBox participants.
createdOn	`string`	The datetime the MediaBox was created.
expiresOn	`string`	The datetime when the MediaBox will expire.
deletedOn	`string`	If deleted, the datetime when the MediaBox was deleted.
network	`object`	Information about MediaBox’s parent Network.
network.id	`string`	The unique identifier of the Network.
network.name	`string`	The name of the Network.
network.class	`string`	Indicates if the Network is a ‘Personal’ or ‘Enterprise’ Network.
workspace	`object`	Information about MediaBox’s parent Workspace.
workspace.id	`string`	The unique identifier of the Workspace.
workspace.name	`string`	The name of the Workspace.
workspace.class	`string`	Indicates if the Workspace is a ‘Personal’ or ‘Team’ Workspace.
createdBy	`object`	Information about the creator of the MediaBox.
createdBy.id	`string`	The unique identifier of the user.
createdBy.name	`string`	The full name of the user.
createdBy.email	`string`	The email of the user.
isDeleted	`boolean`	Indicates if the MediaBox is deleted.
link	`string`	The URL of the MediaBox.
type	`string`	Indicates if the MediaBox is ‘Secure’, ‘Protected’ or ‘Public’.
filters	`object`	Optional content’s filter for view and download.
filters.elements	`object`	Filters applied to elements.
filters.elements.types	`array`	Element types that will be available for view and download. Valid values: `Image`, `Video`, `Audio`, `Document`, `TimedText` and `Other`.
assets	`array`
assets[].id	`string`	The unique identifier of the asset.
assets[].name	`string`	The name of asset and its extension.
assets[].type	`string`	The type of the asset. Valid values are `Audio`, `Video`, `Image`, `Document`, or `Other`.
assets[].status	`string`	The status of the asset. Valid values are ‘Created’, ‘Complete’, ‘Deleted’, ‘Executable Detected’, ‘Failed’, ‘Limited’, ‘Processing’, ‘Uploading’, ‘Virus Detected’, ‘Waiting’.
assets[].createdOn	`string`	The datetime the asset record was created.
assets[].isViewable	`boolean`	Indicates if the asset is viewable by the user.
folders	`array`
folders[].id	`string`	The unique identifier of the folder.
folders[].name	`string`	The name of folder.
folders[].createdOn	`string`	The datetime the asset record was created.
users	`array`	The list of participants for the MediaBox.
users[].id	`string`	The unique identifier of the user.
users[].name	`string`	The full name of the user.
users[].email	`string`	The email of the user.
viewCount	`number`	Number of views.
watermarking	`object`	Watermarking settings for the MediaBox.
watermarking.text	`string`	Text overlay.
watermarking.opacity	`number`	Text opacity. Acceptable values go from 0 (transparent) to 1 (solid).
watermarking.verticalPosition	`number`	Text position. Acceptable values go from 0 (top) to 1 (bottom).
allowSourceDownload	`boolean`	Specifies if the source assets included in the MediaBox shall be downloadable or not.
allowPreviewDownload	`boolean`	Specifies if the preview proxies of the assets included in the MediaBox shall be downloadable or not.
allowElementDownload	`boolean`	Specifies if the elements (custom profiles and uploaded through the Elements API) associated to the assets included in the MediaBox shall be downloadable or not.
assetCount	`number`	Number of assets in the MediaBox, including assets under all folders.
folderCount	`number`	Number of folders in the MediaBox, including sub-folders.

Update MediaBox
PUT`/mediaboxes/{mediaboxId}`

URI Parameters

HideShow

mediaboxId: string (required)
The ID of the MediaBox to update.

Description

Updates the settings of a MediaBox.

Errors

Status Code	Error Code	Message
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	MissingOrInvalidName	Missing or invalid name.
400	AssetIdNotProvided	Asset Id not provided.
400	ContentNotProvided	Content not provided.
400	InvalidMediaBoxType	Invalid MediaBox type.
400	InvalidExpiration	Invalid expiration.
400	InvalidPassword	A password is required.
400	InvalidRecipients	Recipients are required.
400	InvalidContent	Content belongs to multiple workspaces or catalogs.
400	AssetNotFound	Asset not found.
400	FolderNotFound	Folder not found.
400	InvalidWatermarking	Opacity must be greater than 0 and less or equal to 1.
400	InvalidWatermarking	Text must not be empty.
400	InvalidWatermarking	Position must be greater or equal to 0 and less or equal to 1.
400	EntitlementRequired	Visual Watermarking is not enabled for this network.
400	EntitlementRequired	MediaBox tracking is not enabled for this network.
400	InvalidFolder	MediaBox cannot contain Catalog folders.
400	InvalidMediaboxFilterOptions	Invalid filter options.
400	MediaBoxCommentSettingsNotAllowed	Comment settings not allowed. Make sure the provided value is in compliance with the MediaBox restrictions.
400	MediaBoxNeverExpiresNotAllowed	Never Expires not allowed. Make sure the provided value is in compliance with the MediaBox restrictions.
400	ForensicWatermarkMediaboxUpdate	Forensic Watermarking mediabox can not be updated.
400	NonForensicWatermarkMediaboxUpdate	Mediabox can not be converted to be forensically watermarked.
404	MediaBoxNotFound	MediaBox not found.

List Received MediaBoxes ¶

GET https://api.cimediacloud.com/mediaboxes/received?status=active&type=Secure&query=Releases&limit=1&offset=0&orderBy=name&orderDirection=asc&fields=

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200

Headers

Content-Type: application/json

Body

{
  "limit": 1,
  "offset": 0,
  "count": 10,
  "order": {
    "by": "Name",
    "direction": "asc"
  },
  "items": [
    {
      "id": "21db607ed65a4198889f50336ba78755",
      "name": "New Releases",
      "message": "For your eyes only",
      "createdOn": "2017-01-02T00:00:00.000Z",
      "expiresOn": "2017-01-02T00:00:00.000Z",
      "deletedOn": "2017-01-02T00:00:00.000Z",
      "network": {
        "id": "40c2a6b99a474b319dec5ef9c7dbb356",
        "name": "Company Name",
        "class": "Enterprise"
      },
      "workspace": {
        "id": "gb5ehomv0iv71swg",
        "name": "Workspace Name",
        "class": "Enterprise"
      },
      "createdBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "isDeleted": true,
      "link": "https://cimediacloud.com/mediaboxes/1234",
      "type": "Secure",
      "filters": {
        "elements": {
          "types": [
            "Video"
          ]
        }
      },
      "opened": true
    }
  ],
  "filter": {
    "status": "Active",
    "type": "Secure",
    "query": "Releases"
  }
}

Property name	Type	Description
limit	`number`	The limit used for the query.
offset	`number`	The offset used for the query.
count	`number`	The total count of items available.
order	`object`	Information about the ordering of the results.
order.by	`string`	Indicates the field used to sort the results.
order.direction	`string`	Indicates the direction used to sort the results.
items	`array`	The MediaBoxes returned.
items[].id	`string`	The unique identifier of the MediaBox.
items[].name	`string`	The name of the MediaBox.
items[].message	`string`	Brief description or comment for the MediaBox participants.
items[].createdOn	`string`	The datetime the MediaBox was created.
items[].expiresOn	`string`	The datetime when the MediaBox will expire.
items[].deletedOn	`string`	If deleted, the datetime when the MediaBox was deleted.
items[].network	`object`	Information about MediaBox’s parent Network.
items[].network.id	`string`	The unique identifier of the Network.
items[].network.name	`string`	The name of the Network.
items[].network.class	`string`	Indicates if the Network is a ‘Personal’ or ‘Enterprise’ Network.
items[].workspace	`object`	Information about MediaBox’s parent Workspace.
items[].workspace.id	`string`	The unique identifier of the Workspace.
items[].workspace.name	`string`	The name of the Workspace.
items[].workspace.class	`string`	Indicates if the Workspace is a ‘Personal’ or ‘Team’ Workspace.
items[].createdBy	`object`	Information about the creator of the MediaBox.
items[].createdBy.id	`string`	The unique identifier of the user.
items[].createdBy.name	`string`	The full name of the user.
items[].createdBy.email	`string`	The email of the user.
items[].isDeleted	`boolean`	Indicates if the MediaBox is deleted.
items[].link	`string`	The URL of the MediaBox.
items[].type	`string`	Indicates if the MediaBox is ‘Secure’, ‘Protected’ or ‘Public’.
items[].filters	`object`	Optional content’s filter for view and download.
items[].filters.elements	`object`	Filters applied to elements.
items[].filters.elements.types	`array`	Element types that will be available for view and download. Valid values: `Image`, `Video`, `Audio`, `Document`, `TimedText` and `Other`.
items[].opened	`boolean`	Indicates if the current user has opened the MediaBox.
filter	`object`	Information about the filter used.
filter.status	`string`	The status of the MediaBox (Active or Inactive).
filter.type	`string`	The type of the MediaBox (Secure, Protected or Public).
filter.query	`string`	The search term used to query.

List Received MediaBoxes
GET`/mediaboxes/received{?status,type,query,limit,offset,orderBy,orderDirection,fields}`

URI Parameters

HideShow

status

string (optional) Default: active

Indicates if the MediaBoxes to return shall be not deleted or expired.

Choices: active inactive

type

string (optional)

Indicates what type of MediaBoxes shall be returned.

Choices: Public Protected Secure

query

string (optional)

The term to search for.

limit

number (optional) Default: 50

The number of MediaBoxes to return. The maximum is 50.

offset

number (optional) Default: 0

The item at which to begin the response.

orderBy

string (optional) Default: createdOn

The field to sort the items by.

Choices: createdOn name createdBy expiresOn type networkName spaceName

orderDirection

string (optional) Default: desc

The order direction the items should be returned.

Choices: asc desc

fields

string (optional)

A comma separated list of fields to return in the response. If this value is empty all fields will be returned. Id and Name are always returned.

Description

Lists the all of the MediaBoxes the calling user has been invited to.

Errors

Status Code	Error Code	Message
400	InvalidLimitOrOffset	Invalid limit or offset value. Limit must be a number between 1 and 50. Offset must be greater than or equal to 0.
400	InvalidQueryOrderField	Invalid order field. It must be either ‘CreatedOn’, ‘Name’, ‘CreatedBy’ or ‘ExpiresOn’.
400	InvalidQueryOrderDirection	Invalid order direction. It must be either ‘Asc’ or ‘Desc’.
400	InvalidMediaBoxType	Invalid MediaBox type.

Open MediaBox ¶

POST https://api.cimediacloud.com/mediaboxes/47d2300a74e9444abccf1016864cafac/open

RequestsSecure MediaBoxProtected MediaBoxPublic MediaBox

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200

Headers

Content-Type: application/json

Body

{
  "id": "21db607ed65a4198889f50336ba78755",
  "name": "New Releases",
  "message": "For your eyes only",
  "currentUser": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith",
    "email": "johnsmith@example.com"
  },
  "expiresOn": "2017-01-02T00:00:00.000Z",
  "workspace": {
    "id": "gb5ehomv0iv71swg",
    "name": "Workspace Name",
    "class": "Enterprise"
  },
  "link": "https://cimediacloud.com/r/abcdef",
  "watermarking": {
    "text": "{filename} viewing on {datestamp} by {username} (IP:{ip-address})",
    "opacity": 0.8,
    "verticalPosition": 0.46
  },
  "branding": {
    "logoUrl": "https://example.com/logo.png",
    "bannerUrl": "https://example.com/banner.jpg",
    "loginBannerUrl": "https://example.com/login.jpg",
    "backgroundUrl": "https://example.com/background.jpg",
    "accentColor": "#FF00FF",
    "fallbackText": "Contoso"
  },
  "allowAspera": true,
  "allowSourceDownload": true,
  "allowPreviewDownload": true,
  "allowElementDownload": false,
  "createdOn": "2017-01-01T00:00:00.000Z",
  "createdBy": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith",
    "email": "johnsmith@example.com"
  },
  "assetCount": 24,
  "folderCount": 3
}

Property name	Type	Description
id	`string`	The unique identifier of the MediaBox.
name	`string`	The name of the MediaBox.
message	`string`	Brief description or comment for the MediaBox participants.
currentUser	`object`	The user who opened the MediaBox.
currentUser.id	`string`	The unique identifier of the user.
currentUser.name	`string`	The full name of the user.
currentUser.email	`string`	The email of the user.
expiresOn	`string`	The datetime when the MediaBox will expire.
workspace	`object`	Information about MediaBox’s parent workspace.
workspace.id	`string`	The unique identifier of the Workspace.
workspace.name	`string`	The name of the Workspace.
workspace.class	`string`	Indicates if the Workspace is a ‘Personal’ or ‘Team’ Workspace.
link	`string`	The URL of the MediaBox.
watermarking	`object`	Watermarking settings for the MediaBox.
watermarking.text	`string`	Text overlay.
watermarking.opacity	`number`	Text opacity. Acceptable values go from 0 (transparent) to 1 (solid).
watermarking.verticalPosition	`number`	Text position. Acceptable values go from 0 (top) to 1 (bottom).
branding	`object`	Branding settings and resources.
branding.logoUrl	`string`	The image to use as logo.
branding.bannerUrl	`string`	The image to use as banner.
branding.loginBannerUrl	`string`	The image to use as login banner.
branding.backgroundUrl	`string`	The image to use as background.
branding.accentColor	`string`	The accent color to use in UI elements.
branding.fallbackText	`string`	The text to show in case the logo cannot be displayed.
allowAspera	`boolean`	Indicates if Aspera is allowed for downloads.
allowSourceDownload	`boolean`	Specifies if the source assets included in the MediaBox shall be downloadable or not.
allowPreviewDownload	`boolean`	Specifies if the preview proxies of the assets included in the MediaBox shall be downloadable or not.
allowElementDownload	`boolean`	Specifies if the elements (custom profiles and uploaded through the Elements API) associated to the assets included in the MediaBox shall be downloadable or not.
createdOn	`string`	The datetime the MediaBox was created.
createdBy	`object`	Information about the creator of the MediaBox.
createdBy.id	`string`	The unique identifier of the user.
createdBy.name	`string`	The full name of the user.
createdBy.email	`string`	The email of the user.
assetCount	`number`	Number of assets in the MediaBox, including assets under all folders.
folderCount	`number`	Number of folders in the MediaBox, including sub-folders.

Headers

Content-Type: application/json
Authorization: Basic [encoded username:password]

Responses200

Headers

Content-Type: application/json

Body

{
  "id": "21db607ed65a4198889f50336ba78755",
  "name": "New Releases",
  "message": "For your eyes only",
  "currentUser": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith",
    "email": "johnsmith@example.com"
  },
  "expiresOn": "2017-01-02T00:00:00.000Z",
  "workspace": {
    "id": "gb5ehomv0iv71swg",
    "name": "Workspace Name",
    "class": "Enterprise"
  },
  "link": "https://cimediacloud.com/r/abcdef",
  "watermarking": {
    "text": "{filename} viewing on {datestamp} by {username} (IP:{ip-address})",
    "opacity": 0.8,
    "verticalPosition": 0.46
  },
  "branding": {
    "logoUrl": "https://example.com/logo.png",
    "bannerUrl": "https://example.com/banner.jpg",
    "loginBannerUrl": "https://example.com/login.jpg",
    "backgroundUrl": "https://example.com/background.jpg",
    "accentColor": "#FF00FF",
    "fallbackText": "Contoso"
  },
  "allowAspera": true,
  "allowSourceDownload": true,
  "allowPreviewDownload": true,
  "allowElementDownload": false,
  "createdOn": "2017-01-01T00:00:00.000Z",
  "createdBy": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith",
    "email": "johnsmith@example.com"
  },
  "assetCount": 24,
  "folderCount": 3
}

Property name	Type	Description
id	`string`	The unique identifier of the MediaBox.
name	`string`	The name of the MediaBox.
message	`string`	Brief description or comment for the MediaBox participants.
currentUser	`object`	The user who opened the MediaBox.
currentUser.id	`string`	The unique identifier of the user.
currentUser.name	`string`	The full name of the user.
currentUser.email	`string`	The email of the user.
expiresOn	`string`	The datetime when the MediaBox will expire.
workspace	`object`	Information about MediaBox’s parent workspace.
workspace.id	`string`	The unique identifier of the Workspace.
workspace.name	`string`	The name of the Workspace.
workspace.class	`string`	Indicates if the Workspace is a ‘Personal’ or ‘Team’ Workspace.
link	`string`	The URL of the MediaBox.
watermarking	`object`	Watermarking settings for the MediaBox.
watermarking.text	`string`	Text overlay.
watermarking.opacity	`number`	Text opacity. Acceptable values go from 0 (transparent) to 1 (solid).
watermarking.verticalPosition	`number`	Text position. Acceptable values go from 0 (top) to 1 (bottom).
branding	`object`	Branding settings and resources.
branding.logoUrl	`string`	The image to use as logo.
branding.bannerUrl	`string`	The image to use as banner.
branding.loginBannerUrl	`string`	The image to use as login banner.
branding.backgroundUrl	`string`	The image to use as background.
branding.accentColor	`string`	The accent color to use in UI elements.
branding.fallbackText	`string`	The text to show in case the logo cannot be displayed.
allowAspera	`boolean`	Indicates if Aspera is allowed for downloads.
allowSourceDownload	`boolean`	Specifies if the source assets included in the MediaBox shall be downloadable or not.
allowPreviewDownload	`boolean`	Specifies if the preview proxies of the assets included in the MediaBox shall be downloadable or not.
allowElementDownload	`boolean`	Specifies if the elements (custom profiles and uploaded through the Elements API) associated to the assets included in the MediaBox shall be downloadable or not.
createdOn	`string`	The datetime the MediaBox was created.
createdBy	`object`	Information about the creator of the MediaBox.
createdBy.id	`string`	The unique identifier of the user.
createdBy.name	`string`	The full name of the user.
createdBy.email	`string`	The email of the user.
assetCount	`number`	Number of assets in the MediaBox, including assets under all folders.
folderCount	`number`	Number of folders in the MediaBox, including sub-folders.

Headers

Content-Type: application/json

Responses200

Headers

Content-Type: application/json

Body

{
  "id": "21db607ed65a4198889f50336ba78755",
  "name": "New Releases",
  "message": "For your eyes only",
  "currentUser": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith",
    "email": "johnsmith@example.com"
  },
  "expiresOn": "2017-01-02T00:00:00.000Z",
  "workspace": {
    "id": "gb5ehomv0iv71swg",
    "name": "Workspace Name",
    "class": "Enterprise"
  },
  "link": "https://cimediacloud.com/r/abcdef",
  "watermarking": {
    "text": "{filename} viewing on {datestamp} by {username} (IP:{ip-address})",
    "opacity": 0.8,
    "verticalPosition": 0.46
  },
  "branding": {
    "logoUrl": "https://example.com/logo.png",
    "bannerUrl": "https://example.com/banner.jpg",
    "loginBannerUrl": "https://example.com/login.jpg",
    "backgroundUrl": "https://example.com/background.jpg",
    "accentColor": "#FF00FF",
    "fallbackText": "Contoso"
  },
  "allowAspera": true,
  "allowSourceDownload": true,
  "allowPreviewDownload": true,
  "allowElementDownload": false,
  "createdOn": "2017-01-01T00:00:00.000Z",
  "createdBy": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith",
    "email": "johnsmith@example.com"
  },
  "assetCount": 24,
  "folderCount": 3
}

Property name	Type	Description
id	`string`	The unique identifier of the MediaBox.
name	`string`	The name of the MediaBox.
message	`string`	Brief description or comment for the MediaBox participants.
currentUser	`object`	The user who opened the MediaBox.
currentUser.id	`string`	The unique identifier of the user.
currentUser.name	`string`	The full name of the user.
currentUser.email	`string`	The email of the user.
expiresOn	`string`	The datetime when the MediaBox will expire.
workspace	`object`	Information about MediaBox’s parent workspace.
workspace.id	`string`	The unique identifier of the Workspace.
workspace.name	`string`	The name of the Workspace.
workspace.class	`string`	Indicates if the Workspace is a ‘Personal’ or ‘Team’ Workspace.
link	`string`	The URL of the MediaBox.
watermarking	`object`	Watermarking settings for the MediaBox.
watermarking.text	`string`	Text overlay.
watermarking.opacity	`number`	Text opacity. Acceptable values go from 0 (transparent) to 1 (solid).
watermarking.verticalPosition	`number`	Text position. Acceptable values go from 0 (top) to 1 (bottom).
branding	`object`	Branding settings and resources.
branding.logoUrl	`string`	The image to use as logo.
branding.bannerUrl	`string`	The image to use as banner.
branding.loginBannerUrl	`string`	The image to use as login banner.
branding.backgroundUrl	`string`	The image to use as background.
branding.accentColor	`string`	The accent color to use in UI elements.
branding.fallbackText	`string`	The text to show in case the logo cannot be displayed.
allowAspera	`boolean`	Indicates if Aspera is allowed for downloads.
allowSourceDownload	`boolean`	Specifies if the source assets included in the MediaBox shall be downloadable or not.
allowPreviewDownload	`boolean`	Specifies if the preview proxies of the assets included in the MediaBox shall be downloadable or not.
allowElementDownload	`boolean`	Specifies if the elements (custom profiles and uploaded through the Elements API) associated to the assets included in the MediaBox shall be downloadable or not.
createdOn	`string`	The datetime the MediaBox was created.
createdBy	`object`	Information about the creator of the MediaBox.
createdBy.id	`string`	The unique identifier of the user.
createdBy.name	`string`	The full name of the user.
createdBy.email	`string`	The email of the user.
assetCount	`number`	Number of assets in the MediaBox, including assets under all folders.
folderCount	`number`	Number of folders in the MediaBox, including sub-folders.

Open MediaBox
POST`/mediaboxes/{mediaboxId}/open`

URI Parameters

HideShow

mediaboxId: string (required)
The id of the MediaBox to open.

Description

Opens a MediaBox, revealing its content.

Depending on the security rating of the MediaBox (Secure, Protected, Public), the authorization requirements for opening it changes:

Security Rating	Minimum Authorization Scheme	Remarks
Secure	Bearer	The standard OAuth2 authentication used in Ci API. The authenticated user must be part of the MediaBox’s participants list.
Protected	Basic	Basic authentication. A pair of username-password. The username will be ignored. The provided password must match the MediaBox password.
Public	None	No authentication. Anyone can open it.

Errors

Status Code	Error Code	Message
403	MediaBoxAccessDenied	Access denied.
403	ProtectedMediaBoxAccessDenied	Access denied.
404	MediaBoxNotFound	MediaBox not found.
404	MediaBoxNotAvailable	The MediaBox is no longer available.

MediaBox Contents ¶

GET https://api.cimediacloud.com/mediaboxes/47d2300a74e9444abccf1016864cafac/contents?kind=all&limit=1&offset=0&orderBy=name&orderDirection=asc

RequestsSecure MediaBox with asset in responseProtected MediaBox with folder in responsePublic MediaBox

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200

Headers

Content-Type: application/json

Body

{
  "limit": 1,
  "offset": 0,
  "count": 10,
  "order": {
    "by": "Name",
    "direction": "asc"
  },
  "kind": [
    "All"
  ],
  "items": [
    {
      "id": "d9bf018c804a4e78b775b8dc2f242071",
      "name": "Movie.mov",
      "type": "Video",
      "status": "Complete",
      "createdOn": "2017-01-02T00:00:00.000Z",
      "isViewable": true,
      "size": 107856722,
      "format": "mov",
      "thumbnails": [
        {
          "type": "large",
          "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/thumb.jpg",
          "size": 1024,
          "width": 200,
          "height": 300,
          "source": {
            "id": "elementId1",
            "kind": "element"
          },
          "isExternal": false
        }
      ],
      "proxies": [
        {
          "type": "video-3g",
          "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/proxy.jpg",
          "size": 1024,
          "width": 200,
          "height": 300,
          "videoBitRate": 1650000,
          "audioBitRate": 128000,
          "isExternal": false
        }
      ],
      "hlsPlaylistUrl": "https://example.com/hls.m3u8",
      "archiveStatus": "Not archived",
      "restoreStatus": "Not restored",
      "technicalMetadata": {
        "type": "Video",
        "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/metadata.jpg",
        "size": 1024,
        "image": {
          "width": 100,
          "height": 300,
          "xResolution": 100,
          "yResolution": 100,
          "resolutionUnit": "cm",
          "cameraMake": "Nikon",
          "cameraModel": "D300",
          "groupingInfo": "6445055e520106d9d01769fffefd058901000100000000000000",
          "umidBasic": "060a2b340101010501010143130000006445055e520106cbd01769fffefd0589",
          "materialNumber": "6445055e520106cbd01769fffefd0589",
          "recordedDate": "2023-07-27T01:39:24Z",
          "locationCity": "New York",
          "locationState": "NY",
          "locationCountry": "USA",
          "exif": {
            "imageWidth": "3888",
            "imageHeight": "2592",
            "artist": "Michael W. Steidl.",
            "copyright": "(c) 2011 IPTC - Rights reserved."
          },
          "iptc": {
            "codedCharacterSet": "UTF8",
            "headline": "Bikefestival Vienna",
            "credit": "IPTC/Michael W. Steidl",
            "keywords": "Vienna Air King,cycling,mountain bike"
          },
          "xmp": {
            "serialNumber": "0380227035",
            "creatorRegion": "Roshire",
            "lens": "EF70-300mm f/4-5.6L IS USM",
            "creatorCountry": "United Kingdom"
          }
        },
        "avContainer": {
          "bitRate": 11934620,
          "duration": 100,
          "start": 0,
          "recordedDate": "2022-11-21T06:42:41Z",
          "deviceManufacturer": "Sony",
          "timeCode": "00:00:00:00",
          "derivedTimeCode": "00:00:00:00",
          "streams": [
            {
              "index": 0,
              "type": "Video",
              "bitRate": 11934620,
              "bitDepth": 8,
              "bitRateMode": "CBR",
              "codec": "h264",
              "codecName": "ProRes",
              "codecProfile": "422 HQ",
              "codecSettings": "Little / Signed",
              "fourCC": "avc1",
              "width": 1280,
              "height": 720,
              "totalFrames": 1024,
              "duration": 100,
              "frameRateNumerator": 360,
              "frameRateDenominator": 12,
              "videoPARWidth": 1,
              "videoPARHeight": 1,
              "videoDARWidth": 19,
              "videoDARHeight": 24,
              "start": 0,
              "timeCode": "00:00:00:00",
              "videoColorSpace": "bt709",
              "videoScanOrder": "TFF",
              "videoScanType": "Interlaced",
              "videoColorPrimaries": "DCI P3",
              "videoChromaSubsampling": "4:2:2",
              "videoScanTypeStoreMethod": "Interleaved fields",
              "audioSampleRate": 32000,
              "audioChannelCount": 2,
              "audioLayout": "Stereo",
              "audioAnalysis": "Stereo",
              "rotate": 0
            }
          ]
        },
        "dolbyContainer": {
          "duration": 9.6,
          "fileSize": 80294994,
          "overallBitRateMode": "CBR",
          "overallBitRate": 66912495,
          "totalChannels": 58,
          "bedChannels": 10,
          "numberOfBeds": 1,
          "bitDepth": 24,
          "samplingRate": 48000,
          "downmix51X": "Direct Render",
          "trimModesSummary": "automatic + manual_0",
          "trimChannel20Mode": "manual_0",
          "trimChannel51Mode": "manual_0",
          "trimChannel71Mode": "automatic",
          "trimChannel212Mode": "manual_0",
          "trimChannel512Mode": "automatic",
          "trimChannel712Mode": "manual_0",
          "trimChannel214Mode": "manual_0",
          "trimChannel514Mode": "manual_0",
          "trimChannel714Mode": "manual_0",
          "associatedVideoFrameRate": 23.976,
          "start": "01:00:00:00",
          "fFoA": "01:00:00:00",
          "end": "01:03:30:13",
          "metadataFormat": "ADM, Version 0",
          "admProfile": "Dolby Atmos Master, Version 1",
          "numberOfProgrammes": 1,
          "numberOfObjectChannels": 48,
          "numberOfPackFormats": 49,
          "numberOfChannelFormats": 58,
          "binauralRenderModesSummary": "Off + Near + Mid + Far",
          "binauralRenderModesOffCount": 9,
          "binauralRenderModesNearCount": 8,
          "binauralRenderModesMidCount": 13,
          "binauralRenderModesFarCount": 1,
          "truePeakLevels": -3.14,
          "loudness": -16.67
        }
      },
      "filmstrips": [
        {
          "type": "video-filmstrip-small",
          "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/filmstrip.jpg",
          "size": 1024,
          "frames": 100,
          "frameHeight": 100,
          "frameWidth": 100,
          "width": 100,
          "height": 1000
        }
      ],
      "isAvailable": true,
      "elements": [
        {
          "id": "9buxd3oqybkvqxtv",
          "size": 1024,
          "type": "mov",
          "name": "Element.mov",
          "format": "video-3g",
          "uid": "c97291e9-6892-46b5-a306-66577ea1ae82",
          "relatedMaterials": [
            {
              "uid": "c97291e9-6892-46b5-a306-66577ea1ae82",
              "relationship": "mainStream"
            }
          ],
          "customKeys": [
            "examplekey"
          ],
          "createdOn": "2017-01-02T00:00:00.000Z",
          "isVerifiedAuthentic": true,
          "renderType": "medialog-clip"
        }
      ]
    }
  ]
}

Property name	Type	Description
limit	`number`	The limit used for the query.
offset	`number`	The offset used for the query.
count	`number`	The total count of items available.
order	`object`	Information about the ordering of the results.
order.by	`string`	Indicates the field used to sort the results.
order.direction	`string`	Indicates the direction used to sort the results.
kind	`array`	Indicates the kind filter used in the request. Returned values are ‘All’, ‘Asset’, and ‘Folder’.
items	`array`	The items returned. Can be both assets and folders.
items[].id	`string`	The unique identifier of the asset.
items[].name	`string`	The name of asset and its extension.
items[].type	`string`	The type of the asset. Valid values are `Audio`, `Video`, `Image`, `Document`, or `Other`.
items[].status	`string`	The status of the asset. Valid values are ‘Created’, ‘Complete’, ‘Deleted’, ‘Executable Detected’, ‘Failed’, ‘Limited’, ‘Processing’, ‘Uploading’, ‘Virus Detected’, ‘Waiting’.
items[].createdOn	`string`	The datetime the asset record was created.
items[].isViewable	`boolean`	Indicates if the asset is viewable by the user.
items[].size	`number`	The size of the source file, in bytes.
items[].format	`string`	The asset’s file format.
items[].thumbnails	`array`	The set of thumbnails for the asset.
items[].thumbnails[].type	`string`	The type of thumbnail returned. Valid values are ‘small’, ‘medium’ and ‘large’.
items[].thumbnails[].location	`string`	The url of the thumbnail.
items[].thumbnails[].size	`number`	The size of the thumbnail, in bytes.
items[].thumbnails[].width	`number`	The width of the thumbnail.
items[].thumbnails[].height	`number`	The height of the thumbnail.
items[].thumbnails[].source	`object`	Information about the source of thumbnails.
items[].thumbnails[].source.id	`string`	Unique identifier of the thumbnail’s source.
items[].thumbnails[].source.kind	`string`	The kind of entity of the thumbnail’s source.
items[].thumbnails[].isExternal	`boolean`	Indicates if the thumbnail is stored in an external source.
items[].proxies	`array`	The set of proxies for the asset.
items[].proxies[].type	`string`	The type of proxy returned. Valid values are ‘standard-audio’, ‘dolby-audio’, ‘video-3g’, ‘video-sd’, ‘video-sdplus’, ‘video-hd’, ‘video-2k’, ‘video-2kplus’, ‘document-pdf’.
items[].proxies[].location	`string`	The url of the proxy.
items[].proxies[].size	`number`	The size of the proxy, in bytes.
items[].proxies[].width	`number`	The width of the proxy.
items[].proxies[].height	`number`	The height of the proxy.
items[].proxies[].videoBitRate	`number`	The video bitrate of the proxy.
items[].proxies[].audioBitRate	`number`	The audio bitrate of the proxy.
items[].proxies[].isExternal	`boolean`	Indicates if the proxy is stored in an external source.
items[].hlsPlaylistUrl	`string`	A link to the HLS playlist generated from the source file.
items[].archiveStatus	`string`	The archive status of the asset. Valid values are ‘Not archived’, ‘Archive in progress’, ‘Archive failed’, ‘Archived’, ‘Cancel archive in progress’.
items[].restoreStatus	`string`	The restore status of the asset. This is applicable to assets that have been archived. Valid values are ‘Not restored’, ‘Restore in progress’, ‘Restore failed’, ‘Restored’.
items[].technicalMetadata	`object`	An object that contains all the technical metadata available.
items[].technicalMetadata.type	`string`	The type of the asset. Valid values are either ‘Audio’, ‘Video’ or ‘Image’.
items[].technicalMetadata.location	`string`	Url of the source technical metadata file. Note: the content and structure of the technical metadata file is subject to change at any time.
items[].technicalMetadata.size	`number`	The size of the technical metadata file, in bytes.
items[].technicalMetadata.image	`object`	If the asset’s type is ‘Image’, this property contains the extended image technical metadata.
items[].technicalMetadata.image.width	`number`	The width of the image, in pixels.
items[].technicalMetadata.image.height	`number`	The height of the image, in pixels.
items[].technicalMetadata.image.xResolution	`number`	The number of pixels per resolutionUnit in the width direction.
items[].technicalMetadata.image.yResolution	`number`	The number of pixels per resolutionUnit in the height direction.
items[].technicalMetadata.image.resolutionUnit	`string`	The unit of measurement for xResolution and yResolution. Can be ‘inches’, ‘cm’ or ‘none’.
items[].technicalMetadata.image.cameraMake	`string`	Camera manufacturer name.
items[].technicalMetadata.image.cameraModel	`string`	Camera model name.
items[].technicalMetadata.image.groupingInfo	`string`	If available, the grouping info of the image. String of hexadecimal value (52 characteres) for the byte array object. Byte array order is Litte Endian.
items[].technicalMetadata.image.umidBasic	`string`	If available, the umid basic info of the image. String of hexadecimal value (64 characteres) for the byte array object.
items[].technicalMetadata.image.materialNumber	`string`	If available, the material number of the image. String of hexadecimal value (32 characteres) for the byte array object.
items[].technicalMetadata.image.recordedDate	`string`	The date and Time at which the image was captured.
items[].technicalMetadata.image.locationCity	`string`	Name of the city where the image was created.
items[].technicalMetadata.image.locationState	`string`	Name of the state where the image was created.
items[].technicalMetadata.image.locationCountry	`string`	Name of the country where the image was created.
items[].technicalMetadata.image.exif	`object`	The avalaible EXIF (Exchangeable Image File) metadata.
items[].technicalMetadata.image.exif.imageWidth	`string`	The image width in pixels.
items[].technicalMetadata.image.exif.imageHeight	`string`	The image height in pixels.
items[].technicalMetadata.image.exif.artist	`string`	The image artist info.
items[].technicalMetadata.image.exif.copyright	`string`	The image copyright.
items[].technicalMetadata.image.iptc	`object`	The available IPTC (International Press Telecommunications Council) available.
items[].technicalMetadata.image.iptc.codedCharacterSet	`string`	Determines how the internal IPTC string values are interpreted.
items[].technicalMetadata.image.iptc.headline	`string`	Brief synopsis or summary of the contents of the photograph.
items[].technicalMetadata.image.iptc.credit	`string`	How the image should be credited when published, as specified by the supplier of the image.
items[].technicalMetadata.image.iptc.keywords	`string`	Descriptive words added to the image to enable search and retrieval.
items[].technicalMetadata.image.xmp	`object`	The available XMP (Extensible Metadata Platform) metadata.
items[].technicalMetadata.image.xmp.serialNumber	`string`	Camera Serial Number.
items[].technicalMetadata.image.xmp.creatorRegion	`string`	State / Province for the address of the person that created this image.
items[].technicalMetadata.image.xmp.lens	`string`	Attempts to identify the camera lens used.
items[].technicalMetadata.image.xmp.creatorCountry	`string`	Country name for the address of the person that created this image.
items[].technicalMetadata.avContainer	`object`	If asset type is ‘Audio’ or ‘Video’, this property contains the extended audio / video technical metadata.
items[].technicalMetadata.avContainer.bitRate	`number`	The overall bitrate in the container.
items[].technicalMetadata.avContainer.duration	`number`	The runtime of the media in the container, in seconds.
items[].technicalMetadata.avContainer.start	`number`	The start time in the container, in seconds.
items[].technicalMetadata.avContainer.recordedDate	`string`	The date and Time at which the video was captured.
items[].technicalMetadata.avContainer.deviceManufacturer	`string`	The name of the device Manufacturer.
items[].technicalMetadata.avContainer.timeCode	`string`	The SMPTE timecode in the container.
items[].technicalMetadata.avContainer.derivedTimeCode	`string`	The standardized timecode derived by evaluating stream metadata and converting to drop frame format, if using drop frame rate.
items[].technicalMetadata.avContainer.streams	`array`	Set of audio, video, or data streams contained in the asset.
items[].technicalMetadata.avContainer.streams[].index	`number`	The index of the stream in the container.
items[].technicalMetadata.avContainer.streams[].type	`string`	The type of the stream. Valid values are `Audio`, `Video` or `Data`.
items[].technicalMetadata.avContainer.streams[].bitRate	`number`	If available, the overall bitrate in the stream.
items[].technicalMetadata.avContainer.streams[].bitDepth	`number`	If available, for an `Audio` stream, the bit depth of the stream.
items[].technicalMetadata.avContainer.streams[].bitRateMode	`string`	If available, the bit rate mode of the stream.
items[].technicalMetadata.avContainer.streams[].codec	`string`	If available, the codec used in the stream. For example, `h264`.
items[].technicalMetadata.avContainer.streams[].codecName	`string`	If available, the MediaInfo generated format commercial name for the stream.
items[].technicalMetadata.avContainer.streams[].codecProfile	`string`	If available, the MediaInfo generated format profile for the stream.
items[].technicalMetadata.avContainer.streams[].codecSettings	`string`	If avalable, the MediaInfo generated format settings for the stream.
items[].technicalMetadata.avContainer.streams[].fourCC	`string`	If available, four-character code for the codec used in the stream. For example, `avc1`, `apch`.
items[].technicalMetadata.avContainer.streams[].width	`number`	If available, for a `Video` stream, the width in pixels of the video.
items[].technicalMetadata.avContainer.streams[].height	`number`	If available, for a `Video` stream, the height in pixels of the video.
items[].technicalMetadata.avContainer.streams[].totalFrames	`number`	If available, total number of frames within the `Video` stream.
items[].technicalMetadata.avContainer.streams[].duration	`number`	If available, the runtime of the media in seconds.
items[].technicalMetadata.avContainer.streams[].frameRateNumerator	`number`	If available, the numerator of the frame rate. For example, if the frame rate is 24, the frame rate numerator is 24.
items[].technicalMetadata.avContainer.streams[].frameRateDenominator	`number`	If available, the numerator of the frame rate. For example, if the frame rate is 24, the frame rate denominator is 1.
items[].technicalMetadata.avContainer.streams[].videoPARWidth	`number`	If available, the width part of the pixel aspect ratio.
items[].technicalMetadata.avContainer.streams[].videoPARHeight	`number`	If available, the height part of the pixel aspect ratio.
items[].technicalMetadata.avContainer.streams[].videoDARWidth	`number`	If available, the width part of the display aspect ratio.
items[].technicalMetadata.avContainer.streams[].videoDARHeight	`number`	If available, the height part of the display aspect ratio.
items[].technicalMetadata.avContainer.streams[].start	`number`	If available, the start time in the stream, in seconds.
items[].technicalMetadata.avContainer.streams[].timeCode	`string`	If available, the SMPTE timecode in the stream.
items[].technicalMetadata.avContainer.streams[].videoColorSpace	`string`	If available, for a `Video` stream, the video’s color space / color primaries.
items[].technicalMetadata.avContainer.streams[].videoScanOrder	`string`	If available, for a `Video` stream, the video’s scan order.
items[].technicalMetadata.avContainer.streams[].videoScanType	`string`	If available, for a `Video` stream, the video’s scan type.
items[].technicalMetadata.avContainer.streams[].videoColorPrimaries	`string`	If available, for a `Video` stream, the video’s color primaries.
items[].technicalMetadata.avContainer.streams[].videoChromaSubsampling	`string`	If available, for a `Video` stream, the video’s crhoma subsampling.
items[].technicalMetadata.avContainer.streams[].videoScanTypeStoreMethod	`string`	If available, for a `Video` stream, the video’s scan type store method.
items[].technicalMetadata.avContainer.streams[].audioSampleRate	`number`	If available, for an `Audio` stream, is the sample rate in Hz.
items[].technicalMetadata.avContainer.streams[].audioChannelCount	`number`	If available, for an `Audio` stream, is the number of channels within the stream.
items[].technicalMetadata.avContainer.streams[].audioLayout	`string`	If available, for an `Audio` stream, is the audio channel layout description. For example, `5.1`.
items[].technicalMetadata.avContainer.streams[].audioAnalysis	`string`	If available, for an `Audio` stream, it is further analysis to determine if a stream is true stereo or dual-mono.
items[].technicalMetadata.avContainer.streams[].rotate	`number`	If available, the amount of rotation, in degrees, that should be applied during playback of the video.
items[].technicalMetadata.dolbyContainer	`object`	If asset type is ‘Audio’ and the asset has Dolby Atmos metadata, this property contains the extended Dolby Atmos audio technical metadata.
items[].technicalMetadata.dolbyContainer.duration	`number`	Media duration (in seconds).
items[].technicalMetadata.dolbyContainer.fileSize	`number`	Media size (in bytes).
items[].technicalMetadata.dolbyContainer.overallBitRateMode	`string`	The overall bitrate mode for the Atmos content.
items[].technicalMetadata.dolbyContainer.overallBitRate	`number`	Media bitrate (in bits per second).
items[].technicalMetadata.dolbyContainer.totalChannels	`number`	Number of channels. `Bed channels` plus `Object channels` equals `Total channels`.
items[].technicalMetadata.dolbyContainer.bedChannels	`number`	Number of channel-based premix or stem that includes multichannel panning.
items[].technicalMetadata.dolbyContainer.numberOfBeds	`number`	A bed can be thought of as a traditional channel-based stem with the rules and expectations of stem configurations (such as 2.0, 5.1, and 7.1).
items[].technicalMetadata.dolbyContainer.bitDepth	`number`	Number of bits of information in each sample, generally 16, 24, or 32-bit.
items[].technicalMetadata.dolbyContainer.samplingRate	`number`	Audio sample-rate, generally 44100 or 48000 Hz.
items[].technicalMetadata.dolbyContainer.downmix51X	`string`	Global downmix metadata for monitoring, re-rendering, and encoding.
items[].technicalMetadata.dolbyContainer.trimModesSummary	`string`	A summary of the underlying trim modes.
items[].technicalMetadata.dolbyContainer.trimChannel20Mode	`string`	The type of trim mode supported for 2.0 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel51Mode	`string`	The type of trim mode supported for 5.1 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel71Mode	`string`	The type of trim mode supported for 7.1 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel212Mode	`string`	The type of trim mode supported for 2.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel512Mode	`string`	The type of trim mode supported for 5.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel712Mode	`string`	The type of trim mode supported for 7.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel214Mode	`string`	The type of trim mode supported for 2.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel514Mode	`string`	The type of trim mode supported for 5.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel714Mode	`string`	The type of trim mode supported for 7.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.associatedVideoFrameRate	`number`	Number of frames per second.
items[].technicalMetadata.dolbyContainer.start	`string`	Start SMPTE timecode based on the video frame rate.
items[].technicalMetadata.dolbyContainer.fFoA	`string`	FFoA (First Frame of Action) SMPTE timecode based on the video frame rate.
items[].technicalMetadata.dolbyContainer.end	`string`	End SMPTE timecode based on the video frame rate.
items[].technicalMetadata.dolbyContainer.metadataFormat	`string`	Format of the metadata in the Atmos content.
items[].technicalMetadata.dolbyContainer.admProfile	`string`	ADM (Audio Definition Model) Profile used in the Atmos content.
items[].technicalMetadata.dolbyContainer.numberOfProgrammes	`number`	Number of programmes in the Atmos content.
items[].technicalMetadata.dolbyContainer.numberOfObjectChannels	`number`	Number of objects in the Atmos Master.
items[].technicalMetadata.dolbyContainer.numberOfPackFormats	`number`	Number of Atmos Pack Formats in the Atmos content.
items[].technicalMetadata.dolbyContainer.numberOfChannelFormats	`number`	Number of channel formats in the Atmos content.
items[].technicalMetadata.dolbyContainer.binauralRenderModesSummary	`string`	Summary of all the binaural render modes used in the Atmos content. Supported strings are a unique combination of: “Off”, “Near”, “Mid”, “Far”.
items[].technicalMetadata.dolbyContainer.binauralRenderModesOffCount	`number`	Number of channels that use the “Off” setting for binaural rendering.
items[].technicalMetadata.dolbyContainer.binauralRenderModesNearCount	`number`	Number of channels that use the “Near” setting for binaural rendering.
items[].technicalMetadata.dolbyContainer.binauralRenderModesMidCount	`number`	Number of channels that use the “Mid” setting for binaural rendering.
items[].technicalMetadata.dolbyContainer.binauralRenderModesFarCount	`number`	Number of channels that use the “Far” setting for binaural rendering.
items[].technicalMetadata.dolbyContainer.truePeakLevels	`number`	The peak event in the audio waveform. Units are dBTP for true peak.
items[].technicalMetadata.dolbyContainer.loudness	`number`	Integrated loudness LKFS (or LUFS).
items[].filmstrips	`array`	The set of filmstrips for the asset. Please check the Previews section for more information.
items[].filmstrips[].type	`string`	The type of filmstrip returned.
items[].filmstrips[].location	`string`	The url of the filmstrip.
items[].filmstrips[].size	`number`	The size of the filmstrip, in bytes.
items[].filmstrips[].frames	`number`	Number of frames contained in the filmstrip.
items[].filmstrips[].frameHeight	`number`	The height of each frame.
items[].filmstrips[].frameWidth	`number`	The width of each frame.
items[].filmstrips[].width	`number`	Total width of the filmstrip.
items[].filmstrips[].height	`number`	Total height of the filmstrip.
items[].isAvailable	`boolean`	Indicates if the source file is available.
items[].elements	`array`	The set of elements associated with the asset. It’s returned if the MediaBox is configured to allow elements download.
items[].elements[].id	`string`	The unique identifier of the element.
items[].elements[].size	`number`	The size in bytes of the element.
items[].elements[].type	`string`	The type of the element.
items[].elements[].name	`string`	The name of the element.
items[].elements[].format	`string`	The element’s file format.
items[].elements[].uid	`string`	The custom, unique identifier of the media file or stream.
items[].elements[].relatedMaterials	`array`	The list of related materials.
items[].elements[].relatedMaterials[].uid	`string`	The custom, unique identifier of the media file or stream.
items[].elements[].relatedMaterials[].relationship	`string`	Label of the relationship with the main media file.
items[].elements[].customKeys	`array`	An array of strings that represents custom keys over the element that the user wants to add.
items[].elements[].createdOn	`string`	The datetime the element record was created.
items[].elements[].isVerifiedAuthentic	`boolean`	Indicates if the element was created from a Sony device.
items[].elements[].renderType	`string`	Type of the proxy the element was generated from, if applicable.

Headers

Content-Type: application/json
Authorization: Basic [encoded username:password]

Responses200

Headers

Content-Type: application/json

Body

{
  "limit": 1,
  "offset": 0,
  "count": 10,
  "order": {
    "by": "Name",
    "direction": "asc"
  },
  "kind": [
    "All"
  ],
  "items": [
    {
      "id": "9b639e12a82f4b0483f512b474dc052ci",
      "name": "Folder Name",
      "createdOn": "2017-01-02T00:00:00.000Z"
    }
  ]
}

Property name	Type	Description
limit	`number`	The limit used for the query.
offset	`number`	The offset used for the query.
count	`number`	The total count of items available.
order	`object`	Information about the ordering of the results.
order.by	`string`	Indicates the field used to sort the results.
order.direction	`string`	Indicates the direction used to sort the results.
kind	`array`	Indicates the kind filter used in the request. Returned values are ‘All’, ‘Asset’, and ‘Folder’.
items	`array`	The items returned. Can be both assets and folders.
items[].id	`string`	The unique identifier of the folder.
items[].name	`string`	The name of folder.
items[].createdOn	`string`	The datetime the asset record was created.

Headers

Content-Type: application/json

Responses200

Headers

Content-Type: application/json

Body

{
  "limit": 1,
  "offset": 0,
  "count": 10,
  "order": {
    "by": "Name",
    "direction": "asc"
  },
  "kind": [
    "All"
  ],
  "items": [
    {
      "id": "d9bf018c804a4e78b775b8dc2f242071",
      "name": "Movie.mov",
      "type": "Video",
      "status": "Complete",
      "createdOn": "2017-01-02T00:00:00.000Z",
      "isViewable": true,
      "size": 107856722,
      "format": "mov",
      "thumbnails": [
        {
          "type": "large",
          "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/thumb.jpg",
          "size": 1024,
          "width": 200,
          "height": 300,
          "source": {
            "id": "elementId1",
            "kind": "element"
          },
          "isExternal": false
        }
      ],
      "proxies": [
        {
          "type": "video-3g",
          "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/proxy.jpg",
          "size": 1024,
          "width": 200,
          "height": 300,
          "videoBitRate": 1650000,
          "audioBitRate": 128000,
          "isExternal": false
        }
      ],
      "hlsPlaylistUrl": "https://example.com/hls.m3u8",
      "archiveStatus": "Not archived",
      "restoreStatus": "Not restored",
      "technicalMetadata": {
        "type": "Video",
        "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/metadata.jpg",
        "size": 1024,
        "image": {
          "width": 100,
          "height": 300,
          "xResolution": 100,
          "yResolution": 100,
          "resolutionUnit": "cm",
          "cameraMake": "Nikon",
          "cameraModel": "D300",
          "groupingInfo": "6445055e520106d9d01769fffefd058901000100000000000000",
          "umidBasic": "060a2b340101010501010143130000006445055e520106cbd01769fffefd0589",
          "materialNumber": "6445055e520106cbd01769fffefd0589",
          "recordedDate": "2023-07-27T01:39:24Z",
          "locationCity": "New York",
          "locationState": "NY",
          "locationCountry": "USA",
          "exif": {
            "imageWidth": "3888",
            "imageHeight": "2592",
            "artist": "Michael W. Steidl.",
            "copyright": "(c) 2011 IPTC - Rights reserved."
          },
          "iptc": {
            "codedCharacterSet": "UTF8",
            "headline": "Bikefestival Vienna",
            "credit": "IPTC/Michael W. Steidl",
            "keywords": "Vienna Air King,cycling,mountain bike"
          },
          "xmp": {
            "serialNumber": "0380227035",
            "creatorRegion": "Roshire",
            "lens": "EF70-300mm f/4-5.6L IS USM",
            "creatorCountry": "United Kingdom"
          }
        },
        "avContainer": {
          "bitRate": 11934620,
          "duration": 100,
          "start": 0,
          "recordedDate": "2022-11-21T06:42:41Z",
          "deviceManufacturer": "Sony",
          "timeCode": "00:00:00:00",
          "derivedTimeCode": "00:00:00:00",
          "streams": [
            {
              "index": 0,
              "type": "Video",
              "bitRate": 11934620,
              "bitDepth": 8,
              "bitRateMode": "CBR",
              "codec": "h264",
              "codecName": "ProRes",
              "codecProfile": "422 HQ",
              "codecSettings": "Little / Signed",
              "fourCC": "avc1",
              "width": 1280,
              "height": 720,
              "totalFrames": 1024,
              "duration": 100,
              "frameRateNumerator": 360,
              "frameRateDenominator": 12,
              "videoPARWidth": 1,
              "videoPARHeight": 1,
              "videoDARWidth": 19,
              "videoDARHeight": 24,
              "start": 0,
              "timeCode": "00:00:00:00",
              "videoColorSpace": "bt709",
              "videoScanOrder": "TFF",
              "videoScanType": "Interlaced",
              "videoColorPrimaries": "DCI P3",
              "videoChromaSubsampling": "4:2:2",
              "videoScanTypeStoreMethod": "Interleaved fields",
              "audioSampleRate": 32000,
              "audioChannelCount": 2,
              "audioLayout": "Stereo",
              "audioAnalysis": "Stereo",
              "rotate": 0
            }
          ]
        },
        "dolbyContainer": {
          "duration": 9.6,
          "fileSize": 80294994,
          "overallBitRateMode": "CBR",
          "overallBitRate": 66912495,
          "totalChannels": 58,
          "bedChannels": 10,
          "numberOfBeds": 1,
          "bitDepth": 24,
          "samplingRate": 48000,
          "downmix51X": "Direct Render",
          "trimModesSummary": "automatic + manual_0",
          "trimChannel20Mode": "manual_0",
          "trimChannel51Mode": "manual_0",
          "trimChannel71Mode": "automatic",
          "trimChannel212Mode": "manual_0",
          "trimChannel512Mode": "automatic",
          "trimChannel712Mode": "manual_0",
          "trimChannel214Mode": "manual_0",
          "trimChannel514Mode": "manual_0",
          "trimChannel714Mode": "manual_0",
          "associatedVideoFrameRate": 23.976,
          "start": "01:00:00:00",
          "fFoA": "01:00:00:00",
          "end": "01:03:30:13",
          "metadataFormat": "ADM, Version 0",
          "admProfile": "Dolby Atmos Master, Version 1",
          "numberOfProgrammes": 1,
          "numberOfObjectChannels": 48,
          "numberOfPackFormats": 49,
          "numberOfChannelFormats": 58,
          "binauralRenderModesSummary": "Off + Near + Mid + Far",
          "binauralRenderModesOffCount": 9,
          "binauralRenderModesNearCount": 8,
          "binauralRenderModesMidCount": 13,
          "binauralRenderModesFarCount": 1,
          "truePeakLevels": -3.14,
          "loudness": -16.67
        }
      },
      "filmstrips": [
        {
          "type": "video-filmstrip-small",
          "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/filmstrip.jpg",
          "size": 1024,
          "frames": 100,
          "frameHeight": 100,
          "frameWidth": 100,
          "width": 100,
          "height": 1000
        }
      ],
      "isAvailable": true,
      "elements": [
        {
          "id": "9buxd3oqybkvqxtv",
          "size": 1024,
          "type": "mov",
          "name": "Element.mov",
          "format": "video-3g",
          "uid": "c97291e9-6892-46b5-a306-66577ea1ae82",
          "relatedMaterials": [
            {
              "uid": "c97291e9-6892-46b5-a306-66577ea1ae82",
              "relationship": "mainStream"
            }
          ],
          "customKeys": [
            "examplekey"
          ],
          "createdOn": "2017-01-02T00:00:00.000Z",
          "isVerifiedAuthentic": true,
          "renderType": "medialog-clip"
        }
      ]
    }
  ]
}

Property name	Type	Description
limit	`number`	The limit used for the query.
offset	`number`	The offset used for the query.
count	`number`	The total count of items available.
order	`object`	Information about the ordering of the results.
order.by	`string`	Indicates the field used to sort the results.
order.direction	`string`	Indicates the direction used to sort the results.
kind	`array`	Indicates the kind filter used in the request. Returned values are ‘All’, ‘Asset’, and ‘Folder’.
items	`array`	The items returned. Can be both assets and folders.
items[].id	`string`	The unique identifier of the asset.
items[].name	`string`	The name of asset and its extension.
items[].type	`string`	The type of the asset. Valid values are `Audio`, `Video`, `Image`, `Document`, or `Other`.
items[].status	`string`	The status of the asset. Valid values are ‘Created’, ‘Complete’, ‘Deleted’, ‘Executable Detected’, ‘Failed’, ‘Limited’, ‘Processing’, ‘Uploading’, ‘Virus Detected’, ‘Waiting’.
items[].createdOn	`string`	The datetime the asset record was created.
items[].isViewable	`boolean`	Indicates if the asset is viewable by the user.
items[].size	`number`	The size of the source file, in bytes.
items[].format	`string`	The asset’s file format.
items[].thumbnails	`array`	The set of thumbnails for the asset.
items[].thumbnails[].type	`string`	The type of thumbnail returned. Valid values are ‘small’, ‘medium’ and ‘large’.
items[].thumbnails[].location	`string`	The url of the thumbnail.
items[].thumbnails[].size	`number`	The size of the thumbnail, in bytes.
items[].thumbnails[].width	`number`	The width of the thumbnail.
items[].thumbnails[].height	`number`	The height of the thumbnail.
items[].thumbnails[].source	`object`	Information about the source of thumbnails.
items[].thumbnails[].source.id	`string`	Unique identifier of the thumbnail’s source.
items[].thumbnails[].source.kind	`string`	The kind of entity of the thumbnail’s source.
items[].thumbnails[].isExternal	`boolean`	Indicates if the thumbnail is stored in an external source.
items[].proxies	`array`	The set of proxies for the asset.
items[].proxies[].type	`string`	The type of proxy returned. Valid values are ‘standard-audio’, ‘dolby-audio’, ‘video-3g’, ‘video-sd’, ‘video-sdplus’, ‘video-hd’, ‘video-2k’, ‘video-2kplus’, ‘document-pdf’.
items[].proxies[].location	`string`	The url of the proxy.
items[].proxies[].size	`number`	The size of the proxy, in bytes.
items[].proxies[].width	`number`	The width of the proxy.
items[].proxies[].height	`number`	The height of the proxy.
items[].proxies[].videoBitRate	`number`	The video bitrate of the proxy.
items[].proxies[].audioBitRate	`number`	The audio bitrate of the proxy.
items[].proxies[].isExternal	`boolean`	Indicates if the proxy is stored in an external source.
items[].hlsPlaylistUrl	`string`	A link to the HLS playlist generated from the source file.
items[].archiveStatus	`string`	The archive status of the asset. Valid values are ‘Not archived’, ‘Archive in progress’, ‘Archive failed’, ‘Archived’, ‘Cancel archive in progress’.
items[].restoreStatus	`string`	The restore status of the asset. This is applicable to assets that have been archived. Valid values are ‘Not restored’, ‘Restore in progress’, ‘Restore failed’, ‘Restored’.
items[].technicalMetadata	`object`	An object that contains all the technical metadata available.
items[].technicalMetadata.type	`string`	The type of the asset. Valid values are either ‘Audio’, ‘Video’ or ‘Image’.
items[].technicalMetadata.location	`string`	Url of the source technical metadata file. Note: the content and structure of the technical metadata file is subject to change at any time.
items[].technicalMetadata.size	`number`	The size of the technical metadata file, in bytes.
items[].technicalMetadata.image	`object`	If the asset’s type is ‘Image’, this property contains the extended image technical metadata.
items[].technicalMetadata.image.width	`number`	The width of the image, in pixels.
items[].technicalMetadata.image.height	`number`	The height of the image, in pixels.
items[].technicalMetadata.image.xResolution	`number`	The number of pixels per resolutionUnit in the width direction.
items[].technicalMetadata.image.yResolution	`number`	The number of pixels per resolutionUnit in the height direction.
items[].technicalMetadata.image.resolutionUnit	`string`	The unit of measurement for xResolution and yResolution. Can be ‘inches’, ‘cm’ or ‘none’.
items[].technicalMetadata.image.cameraMake	`string`	Camera manufacturer name.
items[].technicalMetadata.image.cameraModel	`string`	Camera model name.
items[].technicalMetadata.image.groupingInfo	`string`	If available, the grouping info of the image. String of hexadecimal value (52 characteres) for the byte array object. Byte array order is Litte Endian.
items[].technicalMetadata.image.umidBasic	`string`	If available, the umid basic info of the image. String of hexadecimal value (64 characteres) for the byte array object.
items[].technicalMetadata.image.materialNumber	`string`	If available, the material number of the image. String of hexadecimal value (32 characteres) for the byte array object.
items[].technicalMetadata.image.recordedDate	`string`	The date and Time at which the image was captured.
items[].technicalMetadata.image.locationCity	`string`	Name of the city where the image was created.
items[].technicalMetadata.image.locationState	`string`	Name of the state where the image was created.
items[].technicalMetadata.image.locationCountry	`string`	Name of the country where the image was created.
items[].technicalMetadata.image.exif	`object`	The avalaible EXIF (Exchangeable Image File) metadata.
items[].technicalMetadata.image.exif.imageWidth	`string`	The image width in pixels.
items[].technicalMetadata.image.exif.imageHeight	`string`	The image height in pixels.
items[].technicalMetadata.image.exif.artist	`string`	The image artist info.
items[].technicalMetadata.image.exif.copyright	`string`	The image copyright.
items[].technicalMetadata.image.iptc	`object`	The available IPTC (International Press Telecommunications Council) available.
items[].technicalMetadata.image.iptc.codedCharacterSet	`string`	Determines how the internal IPTC string values are interpreted.
items[].technicalMetadata.image.iptc.headline	`string`	Brief synopsis or summary of the contents of the photograph.
items[].technicalMetadata.image.iptc.credit	`string`	How the image should be credited when published, as specified by the supplier of the image.
items[].technicalMetadata.image.iptc.keywords	`string`	Descriptive words added to the image to enable search and retrieval.
items[].technicalMetadata.image.xmp	`object`	The available XMP (Extensible Metadata Platform) metadata.
items[].technicalMetadata.image.xmp.serialNumber	`string`	Camera Serial Number.
items[].technicalMetadata.image.xmp.creatorRegion	`string`	State / Province for the address of the person that created this image.
items[].technicalMetadata.image.xmp.lens	`string`	Attempts to identify the camera lens used.
items[].technicalMetadata.image.xmp.creatorCountry	`string`	Country name for the address of the person that created this image.
items[].technicalMetadata.avContainer	`object`	If asset type is ‘Audio’ or ‘Video’, this property contains the extended audio / video technical metadata.
items[].technicalMetadata.avContainer.bitRate	`number`	The overall bitrate in the container.
items[].technicalMetadata.avContainer.duration	`number`	The runtime of the media in the container, in seconds.
items[].technicalMetadata.avContainer.start	`number`	The start time in the container, in seconds.
items[].technicalMetadata.avContainer.recordedDate	`string`	The date and Time at which the video was captured.
items[].technicalMetadata.avContainer.deviceManufacturer	`string`	The name of the device Manufacturer.
items[].technicalMetadata.avContainer.timeCode	`string`	The SMPTE timecode in the container.
items[].technicalMetadata.avContainer.derivedTimeCode	`string`	The standardized timecode derived by evaluating stream metadata and converting to drop frame format, if using drop frame rate.
items[].technicalMetadata.avContainer.streams	`array`	Set of audio, video, or data streams contained in the asset.
items[].technicalMetadata.avContainer.streams[].index	`number`	The index of the stream in the container.
items[].technicalMetadata.avContainer.streams[].type	`string`	The type of the stream. Valid values are `Audio`, `Video` or `Data`.
items[].technicalMetadata.avContainer.streams[].bitRate	`number`	If available, the overall bitrate in the stream.
items[].technicalMetadata.avContainer.streams[].bitDepth	`number`	If available, for an `Audio` stream, the bit depth of the stream.
items[].technicalMetadata.avContainer.streams[].bitRateMode	`string`	If available, the bit rate mode of the stream.
items[].technicalMetadata.avContainer.streams[].codec	`string`	If available, the codec used in the stream. For example, `h264`.
items[].technicalMetadata.avContainer.streams[].codecName	`string`	If available, the MediaInfo generated format commercial name for the stream.
items[].technicalMetadata.avContainer.streams[].codecProfile	`string`	If available, the MediaInfo generated format profile for the stream.
items[].technicalMetadata.avContainer.streams[].codecSettings	`string`	If avalable, the MediaInfo generated format settings for the stream.
items[].technicalMetadata.avContainer.streams[].fourCC	`string`	If available, four-character code for the codec used in the stream. For example, `avc1`, `apch`.
items[].technicalMetadata.avContainer.streams[].width	`number`	If available, for a `Video` stream, the width in pixels of the video.
items[].technicalMetadata.avContainer.streams[].height	`number`	If available, for a `Video` stream, the height in pixels of the video.
items[].technicalMetadata.avContainer.streams[].totalFrames	`number`	If available, total number of frames within the `Video` stream.
items[].technicalMetadata.avContainer.streams[].duration	`number`	If available, the runtime of the media in seconds.
items[].technicalMetadata.avContainer.streams[].frameRateNumerator	`number`	If available, the numerator of the frame rate. For example, if the frame rate is 24, the frame rate numerator is 24.
items[].technicalMetadata.avContainer.streams[].frameRateDenominator	`number`	If available, the numerator of the frame rate. For example, if the frame rate is 24, the frame rate denominator is 1.
items[].technicalMetadata.avContainer.streams[].videoPARWidth	`number`	If available, the width part of the pixel aspect ratio.
items[].technicalMetadata.avContainer.streams[].videoPARHeight	`number`	If available, the height part of the pixel aspect ratio.
items[].technicalMetadata.avContainer.streams[].videoDARWidth	`number`	If available, the width part of the display aspect ratio.
items[].technicalMetadata.avContainer.streams[].videoDARHeight	`number`	If available, the height part of the display aspect ratio.
items[].technicalMetadata.avContainer.streams[].start	`number`	If available, the start time in the stream, in seconds.
items[].technicalMetadata.avContainer.streams[].timeCode	`string`	If available, the SMPTE timecode in the stream.
items[].technicalMetadata.avContainer.streams[].videoColorSpace	`string`	If available, for a `Video` stream, the video’s color space / color primaries.
items[].technicalMetadata.avContainer.streams[].videoScanOrder	`string`	If available, for a `Video` stream, the video’s scan order.
items[].technicalMetadata.avContainer.streams[].videoScanType	`string`	If available, for a `Video` stream, the video’s scan type.
items[].technicalMetadata.avContainer.streams[].videoColorPrimaries	`string`	If available, for a `Video` stream, the video’s color primaries.
items[].technicalMetadata.avContainer.streams[].videoChromaSubsampling	`string`	If available, for a `Video` stream, the video’s crhoma subsampling.
items[].technicalMetadata.avContainer.streams[].videoScanTypeStoreMethod	`string`	If available, for a `Video` stream, the video’s scan type store method.
items[].technicalMetadata.avContainer.streams[].audioSampleRate	`number`	If available, for an `Audio` stream, is the sample rate in Hz.
items[].technicalMetadata.avContainer.streams[].audioChannelCount	`number`	If available, for an `Audio` stream, is the number of channels within the stream.
items[].technicalMetadata.avContainer.streams[].audioLayout	`string`	If available, for an `Audio` stream, is the audio channel layout description. For example, `5.1`.
items[].technicalMetadata.avContainer.streams[].audioAnalysis	`string`	If available, for an `Audio` stream, it is further analysis to determine if a stream is true stereo or dual-mono.
items[].technicalMetadata.avContainer.streams[].rotate	`number`	If available, the amount of rotation, in degrees, that should be applied during playback of the video.
items[].technicalMetadata.dolbyContainer	`object`	If asset type is ‘Audio’ and the asset has Dolby Atmos metadata, this property contains the extended Dolby Atmos audio technical metadata.
items[].technicalMetadata.dolbyContainer.duration	`number`	Media duration (in seconds).
items[].technicalMetadata.dolbyContainer.fileSize	`number`	Media size (in bytes).
items[].technicalMetadata.dolbyContainer.overallBitRateMode	`string`	The overall bitrate mode for the Atmos content.
items[].technicalMetadata.dolbyContainer.overallBitRate	`number`	Media bitrate (in bits per second).
items[].technicalMetadata.dolbyContainer.totalChannels	`number`	Number of channels. `Bed channels` plus `Object channels` equals `Total channels`.
items[].technicalMetadata.dolbyContainer.bedChannels	`number`	Number of channel-based premix or stem that includes multichannel panning.
items[].technicalMetadata.dolbyContainer.numberOfBeds	`number`	A bed can be thought of as a traditional channel-based stem with the rules and expectations of stem configurations (such as 2.0, 5.1, and 7.1).
items[].technicalMetadata.dolbyContainer.bitDepth	`number`	Number of bits of information in each sample, generally 16, 24, or 32-bit.
items[].technicalMetadata.dolbyContainer.samplingRate	`number`	Audio sample-rate, generally 44100 or 48000 Hz.
items[].technicalMetadata.dolbyContainer.downmix51X	`string`	Global downmix metadata for monitoring, re-rendering, and encoding.
items[].technicalMetadata.dolbyContainer.trimModesSummary	`string`	A summary of the underlying trim modes.
items[].technicalMetadata.dolbyContainer.trimChannel20Mode	`string`	The type of trim mode supported for 2.0 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel51Mode	`string`	The type of trim mode supported for 5.1 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel71Mode	`string`	The type of trim mode supported for 7.1 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel212Mode	`string`	The type of trim mode supported for 2.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel512Mode	`string`	The type of trim mode supported for 5.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel712Mode	`string`	The type of trim mode supported for 7.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel214Mode	`string`	The type of trim mode supported for 2.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel514Mode	`string`	The type of trim mode supported for 5.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel714Mode	`string`	The type of trim mode supported for 7.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.associatedVideoFrameRate	`number`	Number of frames per second.
items[].technicalMetadata.dolbyContainer.start	`string`	Start SMPTE timecode based on the video frame rate.
items[].technicalMetadata.dolbyContainer.fFoA	`string`	FFoA (First Frame of Action) SMPTE timecode based on the video frame rate.
items[].technicalMetadata.dolbyContainer.end	`string`	End SMPTE timecode based on the video frame rate.
items[].technicalMetadata.dolbyContainer.metadataFormat	`string`	Format of the metadata in the Atmos content.
items[].technicalMetadata.dolbyContainer.admProfile	`string`	ADM (Audio Definition Model) Profile used in the Atmos content.
items[].technicalMetadata.dolbyContainer.numberOfProgrammes	`number`	Number of programmes in the Atmos content.
items[].technicalMetadata.dolbyContainer.numberOfObjectChannels	`number`	Number of objects in the Atmos Master.
items[].technicalMetadata.dolbyContainer.numberOfPackFormats	`number`	Number of Atmos Pack Formats in the Atmos content.
items[].technicalMetadata.dolbyContainer.numberOfChannelFormats	`number`	Number of channel formats in the Atmos content.
items[].technicalMetadata.dolbyContainer.binauralRenderModesSummary	`string`	Summary of all the binaural render modes used in the Atmos content. Supported strings are a unique combination of: “Off”, “Near”, “Mid”, “Far”.
items[].technicalMetadata.dolbyContainer.binauralRenderModesOffCount	`number`	Number of channels that use the “Off” setting for binaural rendering.
items[].technicalMetadata.dolbyContainer.binauralRenderModesNearCount	`number`	Number of channels that use the “Near” setting for binaural rendering.
items[].technicalMetadata.dolbyContainer.binauralRenderModesMidCount	`number`	Number of channels that use the “Mid” setting for binaural rendering.
items[].technicalMetadata.dolbyContainer.binauralRenderModesFarCount	`number`	Number of channels that use the “Far” setting for binaural rendering.
items[].technicalMetadata.dolbyContainer.truePeakLevels	`number`	The peak event in the audio waveform. Units are dBTP for true peak.
items[].technicalMetadata.dolbyContainer.loudness	`number`	Integrated loudness LKFS (or LUFS).
items[].filmstrips	`array`	The set of filmstrips for the asset. Please check the Previews section for more information.
items[].filmstrips[].type	`string`	The type of filmstrip returned.
items[].filmstrips[].location	`string`	The url of the filmstrip.
items[].filmstrips[].size	`number`	The size of the filmstrip, in bytes.
items[].filmstrips[].frames	`number`	Number of frames contained in the filmstrip.
items[].filmstrips[].frameHeight	`number`	The height of each frame.
items[].filmstrips[].frameWidth	`number`	The width of each frame.
items[].filmstrips[].width	`number`	Total width of the filmstrip.
items[].filmstrips[].height	`number`	Total height of the filmstrip.
items[].isAvailable	`boolean`	Indicates if the source file is available.
items[].elements	`array`	The set of elements associated with the asset. It’s returned if the MediaBox is configured to allow elements download.
items[].elements[].id	`string`	The unique identifier of the element.
items[].elements[].size	`number`	The size in bytes of the element.
items[].elements[].type	`string`	The type of the element.
items[].elements[].name	`string`	The name of the element.
items[].elements[].format	`string`	The element’s file format.
items[].elements[].uid	`string`	The custom, unique identifier of the media file or stream.
items[].elements[].relatedMaterials	`array`	The list of related materials.
items[].elements[].relatedMaterials[].uid	`string`	The custom, unique identifier of the media file or stream.
items[].elements[].relatedMaterials[].relationship	`string`	Label of the relationship with the main media file.
items[].elements[].customKeys	`array`	An array of strings that represents custom keys over the element that the user wants to add.
items[].elements[].createdOn	`string`	The datetime the element record was created.
items[].elements[].isVerifiedAuthentic	`boolean`	Indicates if the element was created from a Sony device.
items[].elements[].renderType	`string`	Type of the proxy the element was generated from, if applicable.

List MediaBox Contents
GET`/mediaboxes/{mediaboxId}/contents{?kind,limit,offset,orderBy,orderDirection}`

URI Parameters

HideShow

mediaboxId

string (required)

The id of the MediaBox to browse.

kind

string (optional) Default: all

Determines which kind of items will be returned.

Choices: folder asset all

limit

number (optional) Default: 50

The number of items to return. The maximum is 100.

offset

number (optional) Default: 0

The item at which to begin the response.

orderBy

string (optional) Default: name

The field to sort the items by.

Choices: name userDefined

orderDirection

string (optional) Default: asc

The order direction the items should be returned.

Choices: asc desc

Description

Browses the MediaBox’s contents. This query supports pagination using limit and offset. Additionally, using the ‘kind’ parameter, it is possible to choose which kind of items to return (folders, assets or both). If both are returned, the items are grouped by kind (folders first, then assets).

Depending on the security rating of the MediaBox (Secure, Protected, Public), the authorization requirements for opening it changes:

Security Rating	Minimum Authorization Scheme	Remarks
Secure	Bearer	The standard OAuth2 authentication used in Ci API. The authenticated user must be part of the MediaBox’s participants list.
Protected	Basic	Basic authentication. A pair of username-password. The username will be ignored. The provided password must match the MediaBox password.
Public	None	No authentication. Anyone can open it.

Errors

Status Code	Error Code	Message
400	InvalidLimitOrOffset	Invalid limit or offset value. Limit must be a number between 1 and 100. Offset must be greater than or equal to 0.
400	InvalidQueryOrderField	Invalid order field. It must be either ‘Name’ or ‘UserDefined’.
400	InvalidQueryOrderDirection	Invalid order direction. It must be either ‘Asc’ or ‘Desc’.
400	InvalidQueryKindFilter	Invalid kind filter. It must be either ‘All’, ‘Asset’ or ‘Folder’.
403	MediaBoxAccessDenied	Access denied.
403	ProtectedMediaBoxAccessDenied	Access denied.
404	MediaBoxNotFound	MediaBox not found.
404	MediaBoxNotAvailable	The MediaBox is no longer available.

MediaBox Folder Contents ¶

GET https://api.cimediacloud.com/mediaboxes/47d2300a74e9444abccf1016864cafac/folders/8b72915ba95b464ab6a0dece3f5d0ecc/contents?kind=all&limit=1&offset=0&orderBy=name&orderDirection=asc

RequestsSecure MediaBox with asset in responseProtected MediaBox with folder in responsePublic MediaBox

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200

Headers

Content-Type: application/json

Body

{
  "limit": 1,
  "offset": 0,
  "count": 10,
  "order": {
    "by": "Name",
    "direction": "asc"
  },
  "kind": [
    "All"
  ],
  "items": [
    {
      "id": "d9bf018c804a4e78b775b8dc2f242071",
      "name": "Movie.mov",
      "type": "Video",
      "status": "Complete",
      "createdOn": "2017-01-02T00:00:00.000Z",
      "isViewable": true,
      "size": 107856722,
      "format": "mov",
      "thumbnails": [
        {
          "type": "large",
          "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/thumb.jpg",
          "size": 1024,
          "width": 200,
          "height": 300,
          "source": {
            "id": "elementId1",
            "kind": "element"
          },
          "isExternal": false
        }
      ],
      "proxies": [
        {
          "type": "video-3g",
          "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/proxy.jpg",
          "size": 1024,
          "width": 200,
          "height": 300,
          "videoBitRate": 1650000,
          "audioBitRate": 128000,
          "isExternal": false
        }
      ],
      "hlsPlaylistUrl": "https://example.com/hls.m3u8",
      "archiveStatus": "Not archived",
      "restoreStatus": "Not restored",
      "technicalMetadata": {
        "type": "Video",
        "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/metadata.jpg",
        "size": 1024,
        "image": {
          "width": 100,
          "height": 300,
          "xResolution": 100,
          "yResolution": 100,
          "resolutionUnit": "cm",
          "cameraMake": "Nikon",
          "cameraModel": "D300",
          "groupingInfo": "6445055e520106d9d01769fffefd058901000100000000000000",
          "umidBasic": "060a2b340101010501010143130000006445055e520106cbd01769fffefd0589",
          "materialNumber": "6445055e520106cbd01769fffefd0589",
          "recordedDate": "2023-07-27T01:39:24Z",
          "locationCity": "New York",
          "locationState": "NY",
          "locationCountry": "USA",
          "exif": {
            "imageWidth": "3888",
            "imageHeight": "2592",
            "artist": "Michael W. Steidl.",
            "copyright": "(c) 2011 IPTC - Rights reserved."
          },
          "iptc": {
            "codedCharacterSet": "UTF8",
            "headline": "Bikefestival Vienna",
            "credit": "IPTC/Michael W. Steidl",
            "keywords": "Vienna Air King,cycling,mountain bike"
          },
          "xmp": {
            "serialNumber": "0380227035",
            "creatorRegion": "Roshire",
            "lens": "EF70-300mm f/4-5.6L IS USM",
            "creatorCountry": "United Kingdom"
          }
        },
        "avContainer": {
          "bitRate": 11934620,
          "duration": 100,
          "start": 0,
          "recordedDate": "2022-11-21T06:42:41Z",
          "deviceManufacturer": "Sony",
          "timeCode": "00:00:00:00",
          "derivedTimeCode": "00:00:00:00",
          "streams": [
            {
              "index": 0,
              "type": "Video",
              "bitRate": 11934620,
              "bitDepth": 8,
              "bitRateMode": "CBR",
              "codec": "h264",
              "codecName": "ProRes",
              "codecProfile": "422 HQ",
              "codecSettings": "Little / Signed",
              "fourCC": "avc1",
              "width": 1280,
              "height": 720,
              "totalFrames": 1024,
              "duration": 100,
              "frameRateNumerator": 360,
              "frameRateDenominator": 12,
              "videoPARWidth": 1,
              "videoPARHeight": 1,
              "videoDARWidth": 19,
              "videoDARHeight": 24,
              "start": 0,
              "timeCode": "00:00:00:00",
              "videoColorSpace": "bt709",
              "videoScanOrder": "TFF",
              "videoScanType": "Interlaced",
              "videoColorPrimaries": "DCI P3",
              "videoChromaSubsampling": "4:2:2",
              "videoScanTypeStoreMethod": "Interleaved fields",
              "audioSampleRate": 32000,
              "audioChannelCount": 2,
              "audioLayout": "Stereo",
              "audioAnalysis": "Stereo",
              "rotate": 0
            }
          ]
        },
        "dolbyContainer": {
          "duration": 9.6,
          "fileSize": 80294994,
          "overallBitRateMode": "CBR",
          "overallBitRate": 66912495,
          "totalChannels": 58,
          "bedChannels": 10,
          "numberOfBeds": 1,
          "bitDepth": 24,
          "samplingRate": 48000,
          "downmix51X": "Direct Render",
          "trimModesSummary": "automatic + manual_0",
          "trimChannel20Mode": "manual_0",
          "trimChannel51Mode": "manual_0",
          "trimChannel71Mode": "automatic",
          "trimChannel212Mode": "manual_0",
          "trimChannel512Mode": "automatic",
          "trimChannel712Mode": "manual_0",
          "trimChannel214Mode": "manual_0",
          "trimChannel514Mode": "manual_0",
          "trimChannel714Mode": "manual_0",
          "associatedVideoFrameRate": 23.976,
          "start": "01:00:00:00",
          "fFoA": "01:00:00:00",
          "end": "01:03:30:13",
          "metadataFormat": "ADM, Version 0",
          "admProfile": "Dolby Atmos Master, Version 1",
          "numberOfProgrammes": 1,
          "numberOfObjectChannels": 48,
          "numberOfPackFormats": 49,
          "numberOfChannelFormats": 58,
          "binauralRenderModesSummary": "Off + Near + Mid + Far",
          "binauralRenderModesOffCount": 9,
          "binauralRenderModesNearCount": 8,
          "binauralRenderModesMidCount": 13,
          "binauralRenderModesFarCount": 1,
          "truePeakLevels": -3.14,
          "loudness": -16.67
        }
      },
      "filmstrips": [
        {
          "type": "video-filmstrip-small",
          "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/filmstrip.jpg",
          "size": 1024,
          "frames": 100,
          "frameHeight": 100,
          "frameWidth": 100,
          "width": 100,
          "height": 1000
        }
      ],
      "isAvailable": true,
      "elements": [
        {
          "id": "9buxd3oqybkvqxtv",
          "size": 1024,
          "type": "mov",
          "name": "Element.mov",
          "format": "video-3g",
          "uid": "c97291e9-6892-46b5-a306-66577ea1ae82",
          "relatedMaterials": [
            {
              "uid": "c97291e9-6892-46b5-a306-66577ea1ae82",
              "relationship": "mainStream"
            }
          ],
          "customKeys": [
            "examplekey"
          ],
          "createdOn": "2017-01-02T00:00:00.000Z",
          "isVerifiedAuthentic": true,
          "renderType": "medialog-clip"
        }
      ]
    }
  ]
}

Property name	Type	Description
limit	`number`	The limit used for the query.
offset	`number`	The offset used for the query.
count	`number`	The total count of items available.
order	`object`	Information about the ordering of the results.
order.by	`string`	Indicates the field used to sort the results.
order.direction	`string`	Indicates the direction used to sort the results.
kind	`array`	Indicates the kind filter used in the request. Returned values are ‘All’, ‘Asset’, and ‘Folder’.
items	`array`	The items returned. Can be both assets and folders.
items[].id	`string`	The unique identifier of the asset.
items[].name	`string`	The name of asset and its extension.
items[].type	`string`	The type of the asset. Valid values are `Audio`, `Video`, `Image`, `Document`, or `Other`.
items[].status	`string`	The status of the asset. Valid values are ‘Created’, ‘Complete’, ‘Deleted’, ‘Executable Detected’, ‘Failed’, ‘Limited’, ‘Processing’, ‘Uploading’, ‘Virus Detected’, ‘Waiting’.
items[].createdOn	`string`	The datetime the asset record was created.
items[].isViewable	`boolean`	Indicates if the asset is viewable by the user.
items[].size	`number`	The size of the source file, in bytes.
items[].format	`string`	The asset’s file format.
items[].thumbnails	`array`	The set of thumbnails for the asset.
items[].thumbnails[].type	`string`	The type of thumbnail returned. Valid values are ‘small’, ‘medium’ and ‘large’.
items[].thumbnails[].location	`string`	The url of the thumbnail.
items[].thumbnails[].size	`number`	The size of the thumbnail, in bytes.
items[].thumbnails[].width	`number`	The width of the thumbnail.
items[].thumbnails[].height	`number`	The height of the thumbnail.
items[].thumbnails[].source	`object`	Information about the source of thumbnails.
items[].thumbnails[].source.id	`string`	Unique identifier of the thumbnail’s source.
items[].thumbnails[].source.kind	`string`	The kind of entity of the thumbnail’s source.
items[].thumbnails[].isExternal	`boolean`	Indicates if the thumbnail is stored in an external source.
items[].proxies	`array`	The set of proxies for the asset.
items[].proxies[].type	`string`	The type of proxy returned. Valid values are ‘standard-audio’, ‘dolby-audio’, ‘video-3g’, ‘video-sd’, ‘video-sdplus’, ‘video-hd’, ‘video-2k’, ‘video-2kplus’, ‘document-pdf’.
items[].proxies[].location	`string`	The url of the proxy.
items[].proxies[].size	`number`	The size of the proxy, in bytes.
items[].proxies[].width	`number`	The width of the proxy.
items[].proxies[].height	`number`	The height of the proxy.
items[].proxies[].videoBitRate	`number`	The video bitrate of the proxy.
items[].proxies[].audioBitRate	`number`	The audio bitrate of the proxy.
items[].proxies[].isExternal	`boolean`	Indicates if the proxy is stored in an external source.
items[].hlsPlaylistUrl	`string`	A link to the HLS playlist generated from the source file.
items[].archiveStatus	`string`	The archive status of the asset. Valid values are ‘Not archived’, ‘Archive in progress’, ‘Archive failed’, ‘Archived’, ‘Cancel archive in progress’.
items[].restoreStatus	`string`	The restore status of the asset. This is applicable to assets that have been archived. Valid values are ‘Not restored’, ‘Restore in progress’, ‘Restore failed’, ‘Restored’.
items[].technicalMetadata	`object`	An object that contains all the technical metadata available.
items[].technicalMetadata.type	`string`	The type of the asset. Valid values are either ‘Audio’, ‘Video’ or ‘Image’.
items[].technicalMetadata.location	`string`	Url of the source technical metadata file. Note: the content and structure of the technical metadata file is subject to change at any time.
items[].technicalMetadata.size	`number`	The size of the technical metadata file, in bytes.
items[].technicalMetadata.image	`object`	If the asset’s type is ‘Image’, this property contains the extended image technical metadata.
items[].technicalMetadata.image.width	`number`	The width of the image, in pixels.
items[].technicalMetadata.image.height	`number`	The height of the image, in pixels.
items[].technicalMetadata.image.xResolution	`number`	The number of pixels per resolutionUnit in the width direction.
items[].technicalMetadata.image.yResolution	`number`	The number of pixels per resolutionUnit in the height direction.
items[].technicalMetadata.image.resolutionUnit	`string`	The unit of measurement for xResolution and yResolution. Can be ‘inches’, ‘cm’ or ‘none’.
items[].technicalMetadata.image.cameraMake	`string`	Camera manufacturer name.
items[].technicalMetadata.image.cameraModel	`string`	Camera model name.
items[].technicalMetadata.image.groupingInfo	`string`	If available, the grouping info of the image. String of hexadecimal value (52 characteres) for the byte array object. Byte array order is Litte Endian.
items[].technicalMetadata.image.umidBasic	`string`	If available, the umid basic info of the image. String of hexadecimal value (64 characteres) for the byte array object.
items[].technicalMetadata.image.materialNumber	`string`	If available, the material number of the image. String of hexadecimal value (32 characteres) for the byte array object.
items[].technicalMetadata.image.recordedDate	`string`	The date and Time at which the image was captured.
items[].technicalMetadata.image.locationCity	`string`	Name of the city where the image was created.
items[].technicalMetadata.image.locationState	`string`	Name of the state where the image was created.
items[].technicalMetadata.image.locationCountry	`string`	Name of the country where the image was created.
items[].technicalMetadata.image.exif	`object`	The avalaible EXIF (Exchangeable Image File) metadata.
items[].technicalMetadata.image.exif.imageWidth	`string`	The image width in pixels.
items[].technicalMetadata.image.exif.imageHeight	`string`	The image height in pixels.
items[].technicalMetadata.image.exif.artist	`string`	The image artist info.
items[].technicalMetadata.image.exif.copyright	`string`	The image copyright.
items[].technicalMetadata.image.iptc	`object`	The available IPTC (International Press Telecommunications Council) available.
items[].technicalMetadata.image.iptc.codedCharacterSet	`string`	Determines how the internal IPTC string values are interpreted.
items[].technicalMetadata.image.iptc.headline	`string`	Brief synopsis or summary of the contents of the photograph.
items[].technicalMetadata.image.iptc.credit	`string`	How the image should be credited when published, as specified by the supplier of the image.
items[].technicalMetadata.image.iptc.keywords	`string`	Descriptive words added to the image to enable search and retrieval.
items[].technicalMetadata.image.xmp	`object`	The available XMP (Extensible Metadata Platform) metadata.
items[].technicalMetadata.image.xmp.serialNumber	`string`	Camera Serial Number.
items[].technicalMetadata.image.xmp.creatorRegion	`string`	State / Province for the address of the person that created this image.
items[].technicalMetadata.image.xmp.lens	`string`	Attempts to identify the camera lens used.
items[].technicalMetadata.image.xmp.creatorCountry	`string`	Country name for the address of the person that created this image.
items[].technicalMetadata.avContainer	`object`	If asset type is ‘Audio’ or ‘Video’, this property contains the extended audio / video technical metadata.
items[].technicalMetadata.avContainer.bitRate	`number`	The overall bitrate in the container.
items[].technicalMetadata.avContainer.duration	`number`	The runtime of the media in the container, in seconds.
items[].technicalMetadata.avContainer.start	`number`	The start time in the container, in seconds.
items[].technicalMetadata.avContainer.recordedDate	`string`	The date and Time at which the video was captured.
items[].technicalMetadata.avContainer.deviceManufacturer	`string`	The name of the device Manufacturer.
items[].technicalMetadata.avContainer.timeCode	`string`	The SMPTE timecode in the container.
items[].technicalMetadata.avContainer.derivedTimeCode	`string`	The standardized timecode derived by evaluating stream metadata and converting to drop frame format, if using drop frame rate.
items[].technicalMetadata.avContainer.streams	`array`	Set of audio, video, or data streams contained in the asset.
items[].technicalMetadata.avContainer.streams[].index	`number`	The index of the stream in the container.
items[].technicalMetadata.avContainer.streams[].type	`string`	The type of the stream. Valid values are `Audio`, `Video` or `Data`.
items[].technicalMetadata.avContainer.streams[].bitRate	`number`	If available, the overall bitrate in the stream.
items[].technicalMetadata.avContainer.streams[].bitDepth	`number`	If available, for an `Audio` stream, the bit depth of the stream.
items[].technicalMetadata.avContainer.streams[].bitRateMode	`string`	If available, the bit rate mode of the stream.
items[].technicalMetadata.avContainer.streams[].codec	`string`	If available, the codec used in the stream. For example, `h264`.
items[].technicalMetadata.avContainer.streams[].codecName	`string`	If available, the MediaInfo generated format commercial name for the stream.
items[].technicalMetadata.avContainer.streams[].codecProfile	`string`	If available, the MediaInfo generated format profile for the stream.
items[].technicalMetadata.avContainer.streams[].codecSettings	`string`	If avalable, the MediaInfo generated format settings for the stream.
items[].technicalMetadata.avContainer.streams[].fourCC	`string`	If available, four-character code for the codec used in the stream. For example, `avc1`, `apch`.
items[].technicalMetadata.avContainer.streams[].width	`number`	If available, for a `Video` stream, the width in pixels of the video.
items[].technicalMetadata.avContainer.streams[].height	`number`	If available, for a `Video` stream, the height in pixels of the video.
items[].technicalMetadata.avContainer.streams[].totalFrames	`number`	If available, total number of frames within the `Video` stream.
items[].technicalMetadata.avContainer.streams[].duration	`number`	If available, the runtime of the media in seconds.
items[].technicalMetadata.avContainer.streams[].frameRateNumerator	`number`	If available, the numerator of the frame rate. For example, if the frame rate is 24, the frame rate numerator is 24.
items[].technicalMetadata.avContainer.streams[].frameRateDenominator	`number`	If available, the numerator of the frame rate. For example, if the frame rate is 24, the frame rate denominator is 1.
items[].technicalMetadata.avContainer.streams[].videoPARWidth	`number`	If available, the width part of the pixel aspect ratio.
items[].technicalMetadata.avContainer.streams[].videoPARHeight	`number`	If available, the height part of the pixel aspect ratio.
items[].technicalMetadata.avContainer.streams[].videoDARWidth	`number`	If available, the width part of the display aspect ratio.
items[].technicalMetadata.avContainer.streams[].videoDARHeight	`number`	If available, the height part of the display aspect ratio.
items[].technicalMetadata.avContainer.streams[].start	`number`	If available, the start time in the stream, in seconds.
items[].technicalMetadata.avContainer.streams[].timeCode	`string`	If available, the SMPTE timecode in the stream.
items[].technicalMetadata.avContainer.streams[].videoColorSpace	`string`	If available, for a `Video` stream, the video’s color space / color primaries.
items[].technicalMetadata.avContainer.streams[].videoScanOrder	`string`	If available, for a `Video` stream, the video’s scan order.
items[].technicalMetadata.avContainer.streams[].videoScanType	`string`	If available, for a `Video` stream, the video’s scan type.
items[].technicalMetadata.avContainer.streams[].videoColorPrimaries	`string`	If available, for a `Video` stream, the video’s color primaries.
items[].technicalMetadata.avContainer.streams[].videoChromaSubsampling	`string`	If available, for a `Video` stream, the video’s crhoma subsampling.
items[].technicalMetadata.avContainer.streams[].videoScanTypeStoreMethod	`string`	If available, for a `Video` stream, the video’s scan type store method.
items[].technicalMetadata.avContainer.streams[].audioSampleRate	`number`	If available, for an `Audio` stream, is the sample rate in Hz.
items[].technicalMetadata.avContainer.streams[].audioChannelCount	`number`	If available, for an `Audio` stream, is the number of channels within the stream.
items[].technicalMetadata.avContainer.streams[].audioLayout	`string`	If available, for an `Audio` stream, is the audio channel layout description. For example, `5.1`.
items[].technicalMetadata.avContainer.streams[].audioAnalysis	`string`	If available, for an `Audio` stream, it is further analysis to determine if a stream is true stereo or dual-mono.
items[].technicalMetadata.avContainer.streams[].rotate	`number`	If available, the amount of rotation, in degrees, that should be applied during playback of the video.
items[].technicalMetadata.dolbyContainer	`object`	If asset type is ‘Audio’ and the asset has Dolby Atmos metadata, this property contains the extended Dolby Atmos audio technical metadata.
items[].technicalMetadata.dolbyContainer.duration	`number`	Media duration (in seconds).
items[].technicalMetadata.dolbyContainer.fileSize	`number`	Media size (in bytes).
items[].technicalMetadata.dolbyContainer.overallBitRateMode	`string`	The overall bitrate mode for the Atmos content.
items[].technicalMetadata.dolbyContainer.overallBitRate	`number`	Media bitrate (in bits per second).
items[].technicalMetadata.dolbyContainer.totalChannels	`number`	Number of channels. `Bed channels` plus `Object channels` equals `Total channels`.
items[].technicalMetadata.dolbyContainer.bedChannels	`number`	Number of channel-based premix or stem that includes multichannel panning.
items[].technicalMetadata.dolbyContainer.numberOfBeds	`number`	A bed can be thought of as a traditional channel-based stem with the rules and expectations of stem configurations (such as 2.0, 5.1, and 7.1).
items[].technicalMetadata.dolbyContainer.bitDepth	`number`	Number of bits of information in each sample, generally 16, 24, or 32-bit.
items[].technicalMetadata.dolbyContainer.samplingRate	`number`	Audio sample-rate, generally 44100 or 48000 Hz.
items[].technicalMetadata.dolbyContainer.downmix51X	`string`	Global downmix metadata for monitoring, re-rendering, and encoding.
items[].technicalMetadata.dolbyContainer.trimModesSummary	`string`	A summary of the underlying trim modes.
items[].technicalMetadata.dolbyContainer.trimChannel20Mode	`string`	The type of trim mode supported for 2.0 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel51Mode	`string`	The type of trim mode supported for 5.1 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel71Mode	`string`	The type of trim mode supported for 7.1 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel212Mode	`string`	The type of trim mode supported for 2.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel512Mode	`string`	The type of trim mode supported for 5.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel712Mode	`string`	The type of trim mode supported for 7.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel214Mode	`string`	The type of trim mode supported for 2.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel514Mode	`string`	The type of trim mode supported for 5.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel714Mode	`string`	The type of trim mode supported for 7.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.associatedVideoFrameRate	`number`	Number of frames per second.
items[].technicalMetadata.dolbyContainer.start	`string`	Start SMPTE timecode based on the video frame rate.
items[].technicalMetadata.dolbyContainer.fFoA	`string`	FFoA (First Frame of Action) SMPTE timecode based on the video frame rate.
items[].technicalMetadata.dolbyContainer.end	`string`	End SMPTE timecode based on the video frame rate.
items[].technicalMetadata.dolbyContainer.metadataFormat	`string`	Format of the metadata in the Atmos content.
items[].technicalMetadata.dolbyContainer.admProfile	`string`	ADM (Audio Definition Model) Profile used in the Atmos content.
items[].technicalMetadata.dolbyContainer.numberOfProgrammes	`number`	Number of programmes in the Atmos content.
items[].technicalMetadata.dolbyContainer.numberOfObjectChannels	`number`	Number of objects in the Atmos Master.
items[].technicalMetadata.dolbyContainer.numberOfPackFormats	`number`	Number of Atmos Pack Formats in the Atmos content.
items[].technicalMetadata.dolbyContainer.numberOfChannelFormats	`number`	Number of channel formats in the Atmos content.
items[].technicalMetadata.dolbyContainer.binauralRenderModesSummary	`string`	Summary of all the binaural render modes used in the Atmos content. Supported strings are a unique combination of: “Off”, “Near”, “Mid”, “Far”.
items[].technicalMetadata.dolbyContainer.binauralRenderModesOffCount	`number`	Number of channels that use the “Off” setting for binaural rendering.
items[].technicalMetadata.dolbyContainer.binauralRenderModesNearCount	`number`	Number of channels that use the “Near” setting for binaural rendering.
items[].technicalMetadata.dolbyContainer.binauralRenderModesMidCount	`number`	Number of channels that use the “Mid” setting for binaural rendering.
items[].technicalMetadata.dolbyContainer.binauralRenderModesFarCount	`number`	Number of channels that use the “Far” setting for binaural rendering.
items[].technicalMetadata.dolbyContainer.truePeakLevels	`number`	The peak event in the audio waveform. Units are dBTP for true peak.
items[].technicalMetadata.dolbyContainer.loudness	`number`	Integrated loudness LKFS (or LUFS).
items[].filmstrips	`array`	The set of filmstrips for the asset. Please check the Previews section for more information.
items[].filmstrips[].type	`string`	The type of filmstrip returned.
items[].filmstrips[].location	`string`	The url of the filmstrip.
items[].filmstrips[].size	`number`	The size of the filmstrip, in bytes.
items[].filmstrips[].frames	`number`	Number of frames contained in the filmstrip.
items[].filmstrips[].frameHeight	`number`	The height of each frame.
items[].filmstrips[].frameWidth	`number`	The width of each frame.
items[].filmstrips[].width	`number`	Total width of the filmstrip.
items[].filmstrips[].height	`number`	Total height of the filmstrip.
items[].isAvailable	`boolean`	Indicates if the source file is available.
items[].elements	`array`	The set of elements associated with the asset. It’s returned if the MediaBox is configured to allow elements download.
items[].elements[].id	`string`	The unique identifier of the element.
items[].elements[].size	`number`	The size in bytes of the element.
items[].elements[].type	`string`	The type of the element.
items[].elements[].name	`string`	The name of the element.
items[].elements[].format	`string`	The element’s file format.
items[].elements[].uid	`string`	The custom, unique identifier of the media file or stream.
items[].elements[].relatedMaterials	`array`	The list of related materials.
items[].elements[].relatedMaterials[].uid	`string`	The custom, unique identifier of the media file or stream.
items[].elements[].relatedMaterials[].relationship	`string`	Label of the relationship with the main media file.
items[].elements[].customKeys	`array`	An array of strings that represents custom keys over the element that the user wants to add.
items[].elements[].createdOn	`string`	The datetime the element record was created.
items[].elements[].isVerifiedAuthentic	`boolean`	Indicates if the element was created from a Sony device.
items[].elements[].renderType	`string`	Type of the proxy the element was generated from, if applicable.

Headers

Content-Type: application/json
Authorization: Basic [encoded username:password]

Responses200

Headers

Content-Type: application/json

Body

{
  "limit": 1,
  "offset": 0,
  "count": 10,
  "order": {
    "by": "Name",
    "direction": "asc"
  },
  "kind": [
    "All"
  ],
  "items": [
    {
      "id": "9b639e12a82f4b0483f512b474dc052ci",
      "name": "Folder Name",
      "createdOn": "2017-01-02T00:00:00.000Z"
    }
  ]
}

Property name	Type	Description
limit	`number`	The limit used for the query.
offset	`number`	The offset used for the query.
count	`number`	The total count of items available.
order	`object`	Information about the ordering of the results.
order.by	`string`	Indicates the field used to sort the results.
order.direction	`string`	Indicates the direction used to sort the results.
kind	`array`	Indicates the kind filter used in the request. Returned values are ‘All’, ‘Asset’, and ‘Folder’.
items	`array`	The items returned. Can be both assets and folders.
items[].id	`string`	The unique identifier of the folder.
items[].name	`string`	The name of folder.
items[].createdOn	`string`	The datetime the asset record was created.

Headers

Content-Type: application/json

Responses200

Headers

Content-Type: application/json

Body

{
  "limit": 1,
  "offset": 0,
  "count": 10,
  "order": {
    "by": "Name",
    "direction": "asc"
  },
  "kind": [
    "All"
  ],
  "items": [
    {
      "id": "d9bf018c804a4e78b775b8dc2f242071",
      "name": "Movie.mov",
      "type": "Video",
      "status": "Complete",
      "createdOn": "2017-01-02T00:00:00.000Z",
      "isViewable": true,
      "size": 107856722,
      "format": "mov",
      "thumbnails": [
        {
          "type": "large",
          "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/thumb.jpg",
          "size": 1024,
          "width": 200,
          "height": 300,
          "source": {
            "id": "elementId1",
            "kind": "element"
          },
          "isExternal": false
        }
      ],
      "proxies": [
        {
          "type": "video-3g",
          "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/proxy.jpg",
          "size": 1024,
          "width": 200,
          "height": 300,
          "videoBitRate": 1650000,
          "audioBitRate": 128000,
          "isExternal": false
        }
      ],
      "hlsPlaylistUrl": "https://example.com/hls.m3u8",
      "archiveStatus": "Not archived",
      "restoreStatus": "Not restored",
      "technicalMetadata": {
        "type": "Video",
        "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/metadata.jpg",
        "size": 1024,
        "image": {
          "width": 100,
          "height": 300,
          "xResolution": 100,
          "yResolution": 100,
          "resolutionUnit": "cm",
          "cameraMake": "Nikon",
          "cameraModel": "D300",
          "groupingInfo": "6445055e520106d9d01769fffefd058901000100000000000000",
          "umidBasic": "060a2b340101010501010143130000006445055e520106cbd01769fffefd0589",
          "materialNumber": "6445055e520106cbd01769fffefd0589",
          "recordedDate": "2023-07-27T01:39:24Z",
          "locationCity": "New York",
          "locationState": "NY",
          "locationCountry": "USA",
          "exif": {
            "imageWidth": "3888",
            "imageHeight": "2592",
            "artist": "Michael W. Steidl.",
            "copyright": "(c) 2011 IPTC - Rights reserved."
          },
          "iptc": {
            "codedCharacterSet": "UTF8",
            "headline": "Bikefestival Vienna",
            "credit": "IPTC/Michael W. Steidl",
            "keywords": "Vienna Air King,cycling,mountain bike"
          },
          "xmp": {
            "serialNumber": "0380227035",
            "creatorRegion": "Roshire",
            "lens": "EF70-300mm f/4-5.6L IS USM",
            "creatorCountry": "United Kingdom"
          }
        },
        "avContainer": {
          "bitRate": 11934620,
          "duration": 100,
          "start": 0,
          "recordedDate": "2022-11-21T06:42:41Z",
          "deviceManufacturer": "Sony",
          "timeCode": "00:00:00:00",
          "derivedTimeCode": "00:00:00:00",
          "streams": [
            {
              "index": 0,
              "type": "Video",
              "bitRate": 11934620,
              "bitDepth": 8,
              "bitRateMode": "CBR",
              "codec": "h264",
              "codecName": "ProRes",
              "codecProfile": "422 HQ",
              "codecSettings": "Little / Signed",
              "fourCC": "avc1",
              "width": 1280,
              "height": 720,
              "totalFrames": 1024,
              "duration": 100,
              "frameRateNumerator": 360,
              "frameRateDenominator": 12,
              "videoPARWidth": 1,
              "videoPARHeight": 1,
              "videoDARWidth": 19,
              "videoDARHeight": 24,
              "start": 0,
              "timeCode": "00:00:00:00",
              "videoColorSpace": "bt709",
              "videoScanOrder": "TFF",
              "videoScanType": "Interlaced",
              "videoColorPrimaries": "DCI P3",
              "videoChromaSubsampling": "4:2:2",
              "videoScanTypeStoreMethod": "Interleaved fields",
              "audioSampleRate": 32000,
              "audioChannelCount": 2,
              "audioLayout": "Stereo",
              "audioAnalysis": "Stereo",
              "rotate": 0
            }
          ]
        },
        "dolbyContainer": {
          "duration": 9.6,
          "fileSize": 80294994,
          "overallBitRateMode": "CBR",
          "overallBitRate": 66912495,
          "totalChannels": 58,
          "bedChannels": 10,
          "numberOfBeds": 1,
          "bitDepth": 24,
          "samplingRate": 48000,
          "downmix51X": "Direct Render",
          "trimModesSummary": "automatic + manual_0",
          "trimChannel20Mode": "manual_0",
          "trimChannel51Mode": "manual_0",
          "trimChannel71Mode": "automatic",
          "trimChannel212Mode": "manual_0",
          "trimChannel512Mode": "automatic",
          "trimChannel712Mode": "manual_0",
          "trimChannel214Mode": "manual_0",
          "trimChannel514Mode": "manual_0",
          "trimChannel714Mode": "manual_0",
          "associatedVideoFrameRate": 23.976,
          "start": "01:00:00:00",
          "fFoA": "01:00:00:00",
          "end": "01:03:30:13",
          "metadataFormat": "ADM, Version 0",
          "admProfile": "Dolby Atmos Master, Version 1",
          "numberOfProgrammes": 1,
          "numberOfObjectChannels": 48,
          "numberOfPackFormats": 49,
          "numberOfChannelFormats": 58,
          "binauralRenderModesSummary": "Off + Near + Mid + Far",
          "binauralRenderModesOffCount": 9,
          "binauralRenderModesNearCount": 8,
          "binauralRenderModesMidCount": 13,
          "binauralRenderModesFarCount": 1,
          "truePeakLevels": -3.14,
          "loudness": -16.67
        }
      },
      "filmstrips": [
        {
          "type": "video-filmstrip-small",
          "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/filmstrip.jpg",
          "size": 1024,
          "frames": 100,
          "frameHeight": 100,
          "frameWidth": 100,
          "width": 100,
          "height": 1000
        }
      ],
      "isAvailable": true,
      "elements": [
        {
          "id": "9buxd3oqybkvqxtv",
          "size": 1024,
          "type": "mov",
          "name": "Element.mov",
          "format": "video-3g",
          "uid": "c97291e9-6892-46b5-a306-66577ea1ae82",
          "relatedMaterials": [
            {
              "uid": "c97291e9-6892-46b5-a306-66577ea1ae82",
              "relationship": "mainStream"
            }
          ],
          "customKeys": [
            "examplekey"
          ],
          "createdOn": "2017-01-02T00:00:00.000Z",
          "isVerifiedAuthentic": true,
          "renderType": "medialog-clip"
        }
      ]
    }
  ]
}

Property name	Type	Description
limit	`number`	The limit used for the query.
offset	`number`	The offset used for the query.
count	`number`	The total count of items available.
order	`object`	Information about the ordering of the results.
order.by	`string`	Indicates the field used to sort the results.
order.direction	`string`	Indicates the direction used to sort the results.
kind	`array`	Indicates the kind filter used in the request. Returned values are ‘All’, ‘Asset’, and ‘Folder’.
items	`array`	The items returned. Can be both assets and folders.
items[].id	`string`	The unique identifier of the asset.
items[].name	`string`	The name of asset and its extension.
items[].type	`string`	The type of the asset. Valid values are `Audio`, `Video`, `Image`, `Document`, or `Other`.
items[].status	`string`	The status of the asset. Valid values are ‘Created’, ‘Complete’, ‘Deleted’, ‘Executable Detected’, ‘Failed’, ‘Limited’, ‘Processing’, ‘Uploading’, ‘Virus Detected’, ‘Waiting’.
items[].createdOn	`string`	The datetime the asset record was created.
items[].isViewable	`boolean`	Indicates if the asset is viewable by the user.
items[].size	`number`	The size of the source file, in bytes.
items[].format	`string`	The asset’s file format.
items[].thumbnails	`array`	The set of thumbnails for the asset.
items[].thumbnails[].type	`string`	The type of thumbnail returned. Valid values are ‘small’, ‘medium’ and ‘large’.
items[].thumbnails[].location	`string`	The url of the thumbnail.
items[].thumbnails[].size	`number`	The size of the thumbnail, in bytes.
items[].thumbnails[].width	`number`	The width of the thumbnail.
items[].thumbnails[].height	`number`	The height of the thumbnail.
items[].thumbnails[].source	`object`	Information about the source of thumbnails.
items[].thumbnails[].source.id	`string`	Unique identifier of the thumbnail’s source.
items[].thumbnails[].source.kind	`string`	The kind of entity of the thumbnail’s source.
items[].thumbnails[].isExternal	`boolean`	Indicates if the thumbnail is stored in an external source.
items[].proxies	`array`	The set of proxies for the asset.
items[].proxies[].type	`string`	The type of proxy returned. Valid values are ‘standard-audio’, ‘dolby-audio’, ‘video-3g’, ‘video-sd’, ‘video-sdplus’, ‘video-hd’, ‘video-2k’, ‘video-2kplus’, ‘document-pdf’.
items[].proxies[].location	`string`	The url of the proxy.
items[].proxies[].size	`number`	The size of the proxy, in bytes.
items[].proxies[].width	`number`	The width of the proxy.
items[].proxies[].height	`number`	The height of the proxy.
items[].proxies[].videoBitRate	`number`	The video bitrate of the proxy.
items[].proxies[].audioBitRate	`number`	The audio bitrate of the proxy.
items[].proxies[].isExternal	`boolean`	Indicates if the proxy is stored in an external source.
items[].hlsPlaylistUrl	`string`	A link to the HLS playlist generated from the source file.
items[].archiveStatus	`string`	The archive status of the asset. Valid values are ‘Not archived’, ‘Archive in progress’, ‘Archive failed’, ‘Archived’, ‘Cancel archive in progress’.
items[].restoreStatus	`string`	The restore status of the asset. This is applicable to assets that have been archived. Valid values are ‘Not restored’, ‘Restore in progress’, ‘Restore failed’, ‘Restored’.
items[].technicalMetadata	`object`	An object that contains all the technical metadata available.
items[].technicalMetadata.type	`string`	The type of the asset. Valid values are either ‘Audio’, ‘Video’ or ‘Image’.
items[].technicalMetadata.location	`string`	Url of the source technical metadata file. Note: the content and structure of the technical metadata file is subject to change at any time.
items[].technicalMetadata.size	`number`	The size of the technical metadata file, in bytes.
items[].technicalMetadata.image	`object`	If the asset’s type is ‘Image’, this property contains the extended image technical metadata.
items[].technicalMetadata.image.width	`number`	The width of the image, in pixels.
items[].technicalMetadata.image.height	`number`	The height of the image, in pixels.
items[].technicalMetadata.image.xResolution	`number`	The number of pixels per resolutionUnit in the width direction.
items[].technicalMetadata.image.yResolution	`number`	The number of pixels per resolutionUnit in the height direction.
items[].technicalMetadata.image.resolutionUnit	`string`	The unit of measurement for xResolution and yResolution. Can be ‘inches’, ‘cm’ or ‘none’.
items[].technicalMetadata.image.cameraMake	`string`	Camera manufacturer name.
items[].technicalMetadata.image.cameraModel	`string`	Camera model name.
items[].technicalMetadata.image.groupingInfo	`string`	If available, the grouping info of the image. String of hexadecimal value (52 characteres) for the byte array object. Byte array order is Litte Endian.
items[].technicalMetadata.image.umidBasic	`string`	If available, the umid basic info of the image. String of hexadecimal value (64 characteres) for the byte array object.
items[].technicalMetadata.image.materialNumber	`string`	If available, the material number of the image. String of hexadecimal value (32 characteres) for the byte array object.
items[].technicalMetadata.image.recordedDate	`string`	The date and Time at which the image was captured.
items[].technicalMetadata.image.locationCity	`string`	Name of the city where the image was created.
items[].technicalMetadata.image.locationState	`string`	Name of the state where the image was created.
items[].technicalMetadata.image.locationCountry	`string`	Name of the country where the image was created.
items[].technicalMetadata.image.exif	`object`	The avalaible EXIF (Exchangeable Image File) metadata.
items[].technicalMetadata.image.exif.imageWidth	`string`	The image width in pixels.
items[].technicalMetadata.image.exif.imageHeight	`string`	The image height in pixels.
items[].technicalMetadata.image.exif.artist	`string`	The image artist info.
items[].technicalMetadata.image.exif.copyright	`string`	The image copyright.
items[].technicalMetadata.image.iptc	`object`	The available IPTC (International Press Telecommunications Council) available.
items[].technicalMetadata.image.iptc.codedCharacterSet	`string`	Determines how the internal IPTC string values are interpreted.
items[].technicalMetadata.image.iptc.headline	`string`	Brief synopsis or summary of the contents of the photograph.
items[].technicalMetadata.image.iptc.credit	`string`	How the image should be credited when published, as specified by the supplier of the image.
items[].technicalMetadata.image.iptc.keywords	`string`	Descriptive words added to the image to enable search and retrieval.
items[].technicalMetadata.image.xmp	`object`	The available XMP (Extensible Metadata Platform) metadata.
items[].technicalMetadata.image.xmp.serialNumber	`string`	Camera Serial Number.
items[].technicalMetadata.image.xmp.creatorRegion	`string`	State / Province for the address of the person that created this image.
items[].technicalMetadata.image.xmp.lens	`string`	Attempts to identify the camera lens used.
items[].technicalMetadata.image.xmp.creatorCountry	`string`	Country name for the address of the person that created this image.
items[].technicalMetadata.avContainer	`object`	If asset type is ‘Audio’ or ‘Video’, this property contains the extended audio / video technical metadata.
items[].technicalMetadata.avContainer.bitRate	`number`	The overall bitrate in the container.
items[].technicalMetadata.avContainer.duration	`number`	The runtime of the media in the container, in seconds.
items[].technicalMetadata.avContainer.start	`number`	The start time in the container, in seconds.
items[].technicalMetadata.avContainer.recordedDate	`string`	The date and Time at which the video was captured.
items[].technicalMetadata.avContainer.deviceManufacturer	`string`	The name of the device Manufacturer.
items[].technicalMetadata.avContainer.timeCode	`string`	The SMPTE timecode in the container.
items[].technicalMetadata.avContainer.derivedTimeCode	`string`	The standardized timecode derived by evaluating stream metadata and converting to drop frame format, if using drop frame rate.
items[].technicalMetadata.avContainer.streams	`array`	Set of audio, video, or data streams contained in the asset.
items[].technicalMetadata.avContainer.streams[].index	`number`	The index of the stream in the container.
items[].technicalMetadata.avContainer.streams[].type	`string`	The type of the stream. Valid values are `Audio`, `Video` or `Data`.
items[].technicalMetadata.avContainer.streams[].bitRate	`number`	If available, the overall bitrate in the stream.
items[].technicalMetadata.avContainer.streams[].bitDepth	`number`	If available, for an `Audio` stream, the bit depth of the stream.
items[].technicalMetadata.avContainer.streams[].bitRateMode	`string`	If available, the bit rate mode of the stream.
items[].technicalMetadata.avContainer.streams[].codec	`string`	If available, the codec used in the stream. For example, `h264`.
items[].technicalMetadata.avContainer.streams[].codecName	`string`	If available, the MediaInfo generated format commercial name for the stream.
items[].technicalMetadata.avContainer.streams[].codecProfile	`string`	If available, the MediaInfo generated format profile for the stream.
items[].technicalMetadata.avContainer.streams[].codecSettings	`string`	If avalable, the MediaInfo generated format settings for the stream.
items[].technicalMetadata.avContainer.streams[].fourCC	`string`	If available, four-character code for the codec used in the stream. For example, `avc1`, `apch`.
items[].technicalMetadata.avContainer.streams[].width	`number`	If available, for a `Video` stream, the width in pixels of the video.
items[].technicalMetadata.avContainer.streams[].height	`number`	If available, for a `Video` stream, the height in pixels of the video.
items[].technicalMetadata.avContainer.streams[].totalFrames	`number`	If available, total number of frames within the `Video` stream.
items[].technicalMetadata.avContainer.streams[].duration	`number`	If available, the runtime of the media in seconds.
items[].technicalMetadata.avContainer.streams[].frameRateNumerator	`number`	If available, the numerator of the frame rate. For example, if the frame rate is 24, the frame rate numerator is 24.
items[].technicalMetadata.avContainer.streams[].frameRateDenominator	`number`	If available, the numerator of the frame rate. For example, if the frame rate is 24, the frame rate denominator is 1.
items[].technicalMetadata.avContainer.streams[].videoPARWidth	`number`	If available, the width part of the pixel aspect ratio.
items[].technicalMetadata.avContainer.streams[].videoPARHeight	`number`	If available, the height part of the pixel aspect ratio.
items[].technicalMetadata.avContainer.streams[].videoDARWidth	`number`	If available, the width part of the display aspect ratio.
items[].technicalMetadata.avContainer.streams[].videoDARHeight	`number`	If available, the height part of the display aspect ratio.
items[].technicalMetadata.avContainer.streams[].start	`number`	If available, the start time in the stream, in seconds.
items[].technicalMetadata.avContainer.streams[].timeCode	`string`	If available, the SMPTE timecode in the stream.
items[].technicalMetadata.avContainer.streams[].videoColorSpace	`string`	If available, for a `Video` stream, the video’s color space / color primaries.
items[].technicalMetadata.avContainer.streams[].videoScanOrder	`string`	If available, for a `Video` stream, the video’s scan order.
items[].technicalMetadata.avContainer.streams[].videoScanType	`string`	If available, for a `Video` stream, the video’s scan type.
items[].technicalMetadata.avContainer.streams[].videoColorPrimaries	`string`	If available, for a `Video` stream, the video’s color primaries.
items[].technicalMetadata.avContainer.streams[].videoChromaSubsampling	`string`	If available, for a `Video` stream, the video’s crhoma subsampling.
items[].technicalMetadata.avContainer.streams[].videoScanTypeStoreMethod	`string`	If available, for a `Video` stream, the video’s scan type store method.
items[].technicalMetadata.avContainer.streams[].audioSampleRate	`number`	If available, for an `Audio` stream, is the sample rate in Hz.
items[].technicalMetadata.avContainer.streams[].audioChannelCount	`number`	If available, for an `Audio` stream, is the number of channels within the stream.
items[].technicalMetadata.avContainer.streams[].audioLayout	`string`	If available, for an `Audio` stream, is the audio channel layout description. For example, `5.1`.
items[].technicalMetadata.avContainer.streams[].audioAnalysis	`string`	If available, for an `Audio` stream, it is further analysis to determine if a stream is true stereo or dual-mono.
items[].technicalMetadata.avContainer.streams[].rotate	`number`	If available, the amount of rotation, in degrees, that should be applied during playback of the video.
items[].technicalMetadata.dolbyContainer	`object`	If asset type is ‘Audio’ and the asset has Dolby Atmos metadata, this property contains the extended Dolby Atmos audio technical metadata.
items[].technicalMetadata.dolbyContainer.duration	`number`	Media duration (in seconds).
items[].technicalMetadata.dolbyContainer.fileSize	`number`	Media size (in bytes).
items[].technicalMetadata.dolbyContainer.overallBitRateMode	`string`	The overall bitrate mode for the Atmos content.
items[].technicalMetadata.dolbyContainer.overallBitRate	`number`	Media bitrate (in bits per second).
items[].technicalMetadata.dolbyContainer.totalChannels	`number`	Number of channels. `Bed channels` plus `Object channels` equals `Total channels`.
items[].technicalMetadata.dolbyContainer.bedChannels	`number`	Number of channel-based premix or stem that includes multichannel panning.
items[].technicalMetadata.dolbyContainer.numberOfBeds	`number`	A bed can be thought of as a traditional channel-based stem with the rules and expectations of stem configurations (such as 2.0, 5.1, and 7.1).
items[].technicalMetadata.dolbyContainer.bitDepth	`number`	Number of bits of information in each sample, generally 16, 24, or 32-bit.
items[].technicalMetadata.dolbyContainer.samplingRate	`number`	Audio sample-rate, generally 44100 or 48000 Hz.
items[].technicalMetadata.dolbyContainer.downmix51X	`string`	Global downmix metadata for monitoring, re-rendering, and encoding.
items[].technicalMetadata.dolbyContainer.trimModesSummary	`string`	A summary of the underlying trim modes.
items[].technicalMetadata.dolbyContainer.trimChannel20Mode	`string`	The type of trim mode supported for 2.0 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel51Mode	`string`	The type of trim mode supported for 5.1 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel71Mode	`string`	The type of trim mode supported for 7.1 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel212Mode	`string`	The type of trim mode supported for 2.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel512Mode	`string`	The type of trim mode supported for 5.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel712Mode	`string`	The type of trim mode supported for 7.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel214Mode	`string`	The type of trim mode supported for 2.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel514Mode	`string`	The type of trim mode supported for 5.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel714Mode	`string`	The type of trim mode supported for 7.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.associatedVideoFrameRate	`number`	Number of frames per second.
items[].technicalMetadata.dolbyContainer.start	`string`	Start SMPTE timecode based on the video frame rate.
items[].technicalMetadata.dolbyContainer.fFoA	`string`	FFoA (First Frame of Action) SMPTE timecode based on the video frame rate.
items[].technicalMetadata.dolbyContainer.end	`string`	End SMPTE timecode based on the video frame rate.
items[].technicalMetadata.dolbyContainer.metadataFormat	`string`	Format of the metadata in the Atmos content.
items[].technicalMetadata.dolbyContainer.admProfile	`string`	ADM (Audio Definition Model) Profile used in the Atmos content.
items[].technicalMetadata.dolbyContainer.numberOfProgrammes	`number`	Number of programmes in the Atmos content.
items[].technicalMetadata.dolbyContainer.numberOfObjectChannels	`number`	Number of objects in the Atmos Master.
items[].technicalMetadata.dolbyContainer.numberOfPackFormats	`number`	Number of Atmos Pack Formats in the Atmos content.
items[].technicalMetadata.dolbyContainer.numberOfChannelFormats	`number`	Number of channel formats in the Atmos content.
items[].technicalMetadata.dolbyContainer.binauralRenderModesSummary	`string`	Summary of all the binaural render modes used in the Atmos content. Supported strings are a unique combination of: “Off”, “Near”, “Mid”, “Far”.
items[].technicalMetadata.dolbyContainer.binauralRenderModesOffCount	`number`	Number of channels that use the “Off” setting for binaural rendering.
items[].technicalMetadata.dolbyContainer.binauralRenderModesNearCount	`number`	Number of channels that use the “Near” setting for binaural rendering.
items[].technicalMetadata.dolbyContainer.binauralRenderModesMidCount	`number`	Number of channels that use the “Mid” setting for binaural rendering.
items[].technicalMetadata.dolbyContainer.binauralRenderModesFarCount	`number`	Number of channels that use the “Far” setting for binaural rendering.
items[].technicalMetadata.dolbyContainer.truePeakLevels	`number`	The peak event in the audio waveform. Units are dBTP for true peak.
items[].technicalMetadata.dolbyContainer.loudness	`number`	Integrated loudness LKFS (or LUFS).
items[].filmstrips	`array`	The set of filmstrips for the asset. Please check the Previews section for more information.
items[].filmstrips[].type	`string`	The type of filmstrip returned.
items[].filmstrips[].location	`string`	The url of the filmstrip.
items[].filmstrips[].size	`number`	The size of the filmstrip, in bytes.
items[].filmstrips[].frames	`number`	Number of frames contained in the filmstrip.
items[].filmstrips[].frameHeight	`number`	The height of each frame.
items[].filmstrips[].frameWidth	`number`	The width of each frame.
items[].filmstrips[].width	`number`	Total width of the filmstrip.
items[].filmstrips[].height	`number`	Total height of the filmstrip.
items[].isAvailable	`boolean`	Indicates if the source file is available.
items[].elements	`array`	The set of elements associated with the asset. It’s returned if the MediaBox is configured to allow elements download.
items[].elements[].id	`string`	The unique identifier of the element.
items[].elements[].size	`number`	The size in bytes of the element.
items[].elements[].type	`string`	The type of the element.
items[].elements[].name	`string`	The name of the element.
items[].elements[].format	`string`	The element’s file format.
items[].elements[].uid	`string`	The custom, unique identifier of the media file or stream.
items[].elements[].relatedMaterials	`array`	The list of related materials.
items[].elements[].relatedMaterials[].uid	`string`	The custom, unique identifier of the media file or stream.
items[].elements[].relatedMaterials[].relationship	`string`	Label of the relationship with the main media file.
items[].elements[].customKeys	`array`	An array of strings that represents custom keys over the element that the user wants to add.
items[].elements[].createdOn	`string`	The datetime the element record was created.
items[].elements[].isVerifiedAuthentic	`boolean`	Indicates if the element was created from a Sony device.
items[].elements[].renderType	`string`	Type of the proxy the element was generated from, if applicable.

List MediaBox's Folder Contents
GET`/mediaboxes/{mediaboxId}/folders/{folderId}/contents{?kind,limit,offset,orderBy,orderDirection}`

URI Parameters

HideShow

mediaboxId

string (required)

The id of the MediaBox.

folderId

string (required)

The id of the folder to browse.

kind

string (optional) Default: all

Determines which kind of items will be returned.

Choices: folder asset all

limit

number (optional) Default: 50

The number of items to return. The maximum is 100.

offset

number (optional) Default: 0

The item at which to begin the response.

orderBy

string (optional) Default: name

The field to sort the items by.

Choices: name userDefined

orderDirection

string (optional) Default: asc

The order direction the items should be returned.

Choices: asc desc

Description

Browses a MediaBox folder’s contents. This query supports pagination using limit and offset. Additionally, using the ‘kind’ parameter, it is possible to choose which kind of items to return (folders, assets or both). If both are returned, the items are grouped by kind (folders first, then assets).

Depending on the security rating of the MediaBox (Secure, Protected, Public), the authorization requirements for opening it changes:

Security Rating	Minimum Authorization Scheme	Remarks
Secure	Bearer	The standard OAuth2 authentication used in Ci API. The authenticated user must be part of the MediaBox’s participants list.
Protected	Basic	Basic authentication. A pair of username-password. The username will be ignored. The provided password must match the MediaBox password.
Public	None	No authentication. Anyone can open it.

Errors

Status Code	Error Code	Message
400	InvalidLimitOrOffset	Invalid limit or offset value. Limit must be a number between 1 and 100. Offset must be greater than or equal to 0.
400	InvalidQueryOrderField	Invalid order field. It must be either ‘Name’ or ‘UserDefined’.
400	InvalidQueryOrderDirection	Invalid order direction. It must be either ‘Asc’ or ‘Desc’.
400	InvalidQueryKindFilter	Invalid kind filter. It must be either ‘All’, ‘Asset’ or ‘Folder’.
403	MediaBoxAccessDenied	Access denied.
403	ProtectedMediaBoxAccessDenied	Access denied.
404	MediaBoxNotFound	MediaBox not found.
404	MediaBoxNotAvailable	The MediaBox is no longer available.
404	FolderNotFound	Folder not found.

Network Mediabox Defaults ¶

Manage the default settings for MediaBoxes in a network.

GET https://api.cimediacloud.com/networks/da836655e2c04e01930fb4b06b1c4e4c/mediabox-defaults

Responses200404

Headers

Content-Type: application/json

Body

{
  "type": "Secure",
  "expirationDays": 30,
  "message": "Welcome!",
  "allowSourceDownload": false,
  "allowPreviewDownload": true,
  "allowElementDownload": true,
  "sendNotifications": true,
  "notifyOnOpen": true,
  "notifyOnChange": true,
  "commentSettings": {
    "isAllowedCommenting": false,
    "showExternalComments": false
  },
  "watermarking": {
    "text": "Watermark Text",
    "opacity": 0.5,
    "verticalPosition": 0.8,
    "forensic": false,
    "elements": [
      {
        "textType": "Custom",
        "text": "Watermark Text",
        "corner": "TL",
        "horizontal": 19.4,
        "vertical": 8.9,
        "opacity": 0.7,
        "fontColor": "FFFFFF",
        "fontSize": 14,
        "backgroundColor": "000000"
      }
    ]
  },
  "filters": {
    "elements": {
      "types": [
        "Image",
        "Video"
      ],
      "ciGeneratedPreviews": [
        "video-2k",
        "video-hd",
        "dolby-audio"
      ],
      "customRenders": [
        "social-media-1080p",
        "social-media-720p"
      ]
    }
  },
  "allowUserDefaults": true
}

Property name	Type	Description
type	`string`	Specifies the type of Mediabox (`Secure`, `Protected`, `Public`).
expirationDays	`number`	The default number of days before the Mediabox expires.
message	`string`	A default message for the Mediabox.
allowSourceDownload	`boolean`	Indicates if source downloads are allowed.
allowPreviewDownload	`boolean`	Indicates if preview downloads are allowed.
allowElementDownload	`boolean`	Indicates if element downloads are allowed.
sendNotifications	`boolean`	Indicates if notifications should be sent when the Mediabox is created.
notifyOnOpen	`boolean`	Indicates if the owner should be notified when the Mediabox is opened.
notifyOnChange	`boolean`	Indicates if the owner should be notified when the Mediabox is modified.
commentSettings	`object`	Configures the commenting behavior for Mediaboxes.
commentSettings.isAllowedCommenting	`boolean` (required)	Indicates whether users can write comments in MediaBox assets.
commentSettings.showExternalComments	`boolean` (required)	Indicates whether comments from the Workspace can be viewed.
watermarking	`object`	Configures the watermarking settings.
watermarking.text	`string` (required)	The watermark text that will be applied to the MediaBox assets. This can be empty if watermark elements are used instead.
watermarking.opacity	`number` (required)	The opacity level of the watermark text.
watermarking.verticalPosition	`number`	The vertical position of the watermark, defined as a percentage value between 0 and 1.
watermarking.forensic	`boolean`	If true, enables forensic watermarking.
watermarking.elements	`array`	List of watermark elements to apply. Each element represents a line of text.
watermarking.elements[].textType	`string` (required)	The type of the watermark text. The possible values are `Name`, `Email`, `IP`, `Date`, `Time` and `Custom`.
watermarking.elements[].text	`string`	The text to display in the watermark element. This is only required if the text type is `Custom`.
watermarking.elements[].corner	`string`	The corner of the content where the watermark is applied. The possible values are `TL`, `TR`, `BL` and `BR`. Default is `TL` (Top Left).
watermarking.elements[].horizontal	`number`	Horizontal offset for the watermark, defined in pixels.
watermarking.elements[].vertical	`number`	Vertical offset for the watermark, defined in pixels.
watermarking.elements[].opacity	`number`	The opacity level for the watermark element.
watermarking.elements[].fontColor	`string`	The font color for the watermark text in hexadecimal format.
watermarking.elements[].fontSize	`number`	The font size for the watermark text in pixels.
watermarking.elements[].backgroundColor	`string`	The background color behind the watermark text in hexadecimal format.
filters	`object`	Configures filters for downloadable elements.
filters.elements	`object`	Filters the elements that can be downloaded from the MediaBox assets. If not provided, no elements can be downloaded or previewed.
filters.elements.types	`array`	The types of elements that can be downloaded. The possible values are `Image`, `Video`, `Audio`, `Document`, `TimedText` and `Other`.
filters.elements.ciGeneratedPreviews	`array`	The types of Ci-generated previews that can be downloaded. The possible values are `video-2kplus`, `video-2k`, `video-hd`, `video-sdplus`, `video-sd`, `video-3g`, `dolby-audio`, `dolby-audio-stereo`, `dolby-audio-binaural` and `standard-audio`.
filters.elements.customRenders	`array`	The types of custom renders that can be downloaded. For example, `social-media-1080p`, `social-media-720p`, etc.
allowUserDefaults	`boolean`	Indicates if users can save their own defaults.

Headers

Content-Type: application/json

Body

{
  "code": "NetworkNotFound",
  "message": "Network not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Get Network Mediabox Defaults
GET`/networks/{networkId}/mediabox-defaults`

URI Parameters

HideShow

networkId: string (required)
The unique identifier of the network.

Retrieve the Mediabox default settings for a specific network.

PUT https://api.cimediacloud.com/networks/da836655e2c04e01930fb4b06b1c4e4c/mediabox-defaults

Requestsexample 1

Headers

Content-Type: application/json

Body

{
  "type": "Secure",
  "expirationDays": 30,
  "message": "Welcome!",
  "allowSourceDownload": false,
  "allowPreviewDownload": true,
  "allowElementDownload": true,
  "sendNotifications": true,
  "notifyOnOpen": true,
  "notifyOnChange": true,
  "commentSettings": {
    "isAllowedCommenting": false,
    "showExternalComments": false
  },
  "watermarking": {
    "text": "Watermark Text",
    "opacity": 0.5,
    "verticalPosition": 0.8,
    "forensic": false,
    "elements": [
      {
        "textType": "Custom",
        "text": "Watermark Text",
        "corner": "TL",
        "horizontal": 19.4,
        "vertical": 8.9,
        "opacity": 0.7,
        "fontColor": "FFFFFF",
        "fontSize": 14,
        "backgroundColor": "000000"
      }
    ]
  },
  "filters": {
    "elements": {
      "types": [
        "Image",
        "Video"
      ],
      "ciGeneratedPreviews": [
        "video-2k",
        "video-hd",
        "dolby-audio"
      ],
      "customRenders": [
        "social-media-1080p",
        "social-media-720p"
      ]
    }
  },
  "allowUserDefaults": true
}

Property name	Type	Description
type	`string`	Specifies the type of Mediabox (`Secure`, `Protected`, `Public`).
expirationDays	`number`	The default number of days before the Mediabox expires.
message	`string`	A default message for the Mediabox.
allowSourceDownload	`boolean`	Indicates if source downloads are allowed.
allowPreviewDownload	`boolean`	Indicates if preview downloads are allowed.
allowElementDownload	`boolean`	Indicates if element downloads are allowed.
sendNotifications	`boolean`	Indicates if notifications should be sent when the Mediabox is created.
notifyOnOpen	`boolean`	Indicates if the owner should be notified when the Mediabox is opened.
notifyOnChange	`boolean`	Indicates if the owner should be notified when the Mediabox is modified.
commentSettings	`object`	Configures the commenting behavior for Mediaboxes.
commentSettings.isAllowedCommenting	`boolean` (required)	Indicates whether users can write comments in MediaBox assets.
commentSettings.showExternalComments	`boolean` (required)	Indicates whether comments from the Workspace can be viewed.
watermarking	`object`	Configures the watermarking settings.
watermarking.text	`string` (required)	The watermark text that will be applied to the MediaBox assets. This can be empty if watermark elements are used instead.
watermarking.opacity	`number` (required)	The opacity level of the watermark text.
watermarking.verticalPosition	`number`	The vertical position of the watermark, defined as a percentage value between 0 and 1.
watermarking.forensic	`boolean`	If true, enables forensic watermarking.
watermarking.elements	`array`	List of watermark elements to apply. Each element represents a line of text.
watermarking.elements[].textType	`string` (required)	The type of the watermark text. The possible values are `Name`, `Email`, `IP`, `Date`, `Time` and `Custom`.
watermarking.elements[].text	`string`	The text to display in the watermark element. This is only required if the text type is `Custom`.
watermarking.elements[].corner	`string`	The corner of the content where the watermark is applied. The possible values are `TL`, `TR`, `BL` and `BR`. Default is `TL` (Top Left).
watermarking.elements[].horizontal	`number`	Horizontal offset for the watermark, defined in pixels.
watermarking.elements[].vertical	`number`	Vertical offset for the watermark, defined in pixels.
watermarking.elements[].opacity	`number`	The opacity level for the watermark element.
watermarking.elements[].fontColor	`string`	The font color for the watermark text in hexadecimal format.
watermarking.elements[].fontSize	`number`	The font size for the watermark text in pixels.
watermarking.elements[].backgroundColor	`string`	The background color behind the watermark text in hexadecimal format.
filters	`object`	Configures filters for downloadable elements.
filters.elements	`object`	Filters the elements that can be downloaded from the MediaBox assets. If not provided, no elements can be downloaded or previewed.
filters.elements.types	`array`	The types of elements that can be downloaded. The possible values are `Image`, `Video`, `Audio`, `Document`, `TimedText` and `Other`.
filters.elements.ciGeneratedPreviews	`array`	The types of Ci-generated previews that can be downloaded. The possible values are `video-2kplus`, `video-2k`, `video-hd`, `video-sdplus`, `video-sd`, `video-3g`, `dolby-audio`, `dolby-audio-stereo`, `dolby-audio-binaural` and `standard-audio`.
filters.elements.customRenders	`array`	The types of custom renders that can be downloaded. For example, `social-media-1080p`, `social-media-720p`, etc.
allowUserDefaults	`boolean`	Indicates if users can save their own defaults.

Responses200404

Headers

Content-Type: application/json

Body

{
  "type": "Secure",
  "expirationDays": 30,
  "message": "Welcome!",
  "allowSourceDownload": false,
  "allowPreviewDownload": true,
  "allowElementDownload": true,
  "sendNotifications": true,
  "notifyOnOpen": true,
  "notifyOnChange": true,
  "commentSettings": {
    "isAllowedCommenting": false,
    "showExternalComments": false
  },
  "watermarking": {
    "text": "Watermark Text",
    "opacity": 0.5,
    "verticalPosition": 0.8,
    "forensic": false,
    "elements": [
      {
        "textType": "Custom",
        "text": "Watermark Text",
        "corner": "TL",
        "horizontal": 19.4,
        "vertical": 8.9,
        "opacity": 0.7,
        "fontColor": "FFFFFF",
        "fontSize": 14,
        "backgroundColor": "000000"
      }
    ]
  },
  "filters": {
    "elements": {
      "types": [
        "Image",
        "Video"
      ],
      "ciGeneratedPreviews": [
        "video-2k",
        "video-hd",
        "dolby-audio"
      ],
      "customRenders": [
        "social-media-1080p",
        "social-media-720p"
      ]
    }
  },
  "allowUserDefaults": true
}

Property name	Type	Description
type	`string`	Specifies the type of Mediabox (`Secure`, `Protected`, `Public`).
expirationDays	`number`	The default number of days before the Mediabox expires.
message	`string`	A default message for the Mediabox.
allowSourceDownload	`boolean`	Indicates if source downloads are allowed.
allowPreviewDownload	`boolean`	Indicates if preview downloads are allowed.
allowElementDownload	`boolean`	Indicates if element downloads are allowed.
sendNotifications	`boolean`	Indicates if notifications should be sent when the Mediabox is created.
notifyOnOpen	`boolean`	Indicates if the owner should be notified when the Mediabox is opened.
notifyOnChange	`boolean`	Indicates if the owner should be notified when the Mediabox is modified.
commentSettings	`object`	Configures the commenting behavior for Mediaboxes.
commentSettings.isAllowedCommenting	`boolean` (required)	Indicates whether users can write comments in MediaBox assets.
commentSettings.showExternalComments	`boolean` (required)	Indicates whether comments from the Workspace can be viewed.
watermarking	`object`	Configures the watermarking settings.
watermarking.text	`string` (required)	The watermark text that will be applied to the MediaBox assets. This can be empty if watermark elements are used instead.
watermarking.opacity	`number` (required)	The opacity level of the watermark text.
watermarking.verticalPosition	`number`	The vertical position of the watermark, defined as a percentage value between 0 and 1.
watermarking.forensic	`boolean`	If true, enables forensic watermarking.
watermarking.elements	`array`	List of watermark elements to apply. Each element represents a line of text.
watermarking.elements[].textType	`string` (required)	The type of the watermark text. The possible values are `Name`, `Email`, `IP`, `Date`, `Time` and `Custom`.
watermarking.elements[].text	`string`	The text to display in the watermark element. This is only required if the text type is `Custom`.
watermarking.elements[].corner	`string`	The corner of the content where the watermark is applied. The possible values are `TL`, `TR`, `BL` and `BR`. Default is `TL` (Top Left).
watermarking.elements[].horizontal	`number`	Horizontal offset for the watermark, defined in pixels.
watermarking.elements[].vertical	`number`	Vertical offset for the watermark, defined in pixels.
watermarking.elements[].opacity	`number`	The opacity level for the watermark element.
watermarking.elements[].fontColor	`string`	The font color for the watermark text in hexadecimal format.
watermarking.elements[].fontSize	`number`	The font size for the watermark text in pixels.
watermarking.elements[].backgroundColor	`string`	The background color behind the watermark text in hexadecimal format.
filters	`object`	Configures filters for downloadable elements.
filters.elements	`object`	Filters the elements that can be downloaded from the MediaBox assets. If not provided, no elements can be downloaded or previewed.
filters.elements.types	`array`	The types of elements that can be downloaded. The possible values are `Image`, `Video`, `Audio`, `Document`, `TimedText` and `Other`.
filters.elements.ciGeneratedPreviews	`array`	The types of Ci-generated previews that can be downloaded. The possible values are `video-2kplus`, `video-2k`, `video-hd`, `video-sdplus`, `video-sd`, `video-3g`, `dolby-audio`, `dolby-audio-stereo`, `dolby-audio-binaural` and `standard-audio`.
filters.elements.customRenders	`array`	The types of custom renders that can be downloaded. For example, `social-media-1080p`, `social-media-720p`, etc.
allowUserDefaults	`boolean`	Indicates if users can save their own defaults.

Headers

Content-Type: application/json

Body

{
  "code": "NetworkNotFound",
  "message": "Network not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Update Network Mediabox Defaults
PUT`/networks/{networkId}/mediabox-defaults`

URI Parameters

HideShow

networkId: string (required)
The unique identifier of the network.

Update the Mediabox default settings for a specific network.

Workspace Mediabox Defaults ¶

Manage the default settings for MediaBoxes in a workspace.

GET https://api.cimediacloud.com/workspaces/da836655e2c04e01930fb4b06b1c4e4c/mediabox-defaults

Responses200404

Headers

Content-Type: application/json

Body

{
  "type": "Secure",
  "expirationDays": 30,
  "message": "Welcome!",
  "allowSourceDownload": false,
  "allowPreviewDownload": true,
  "allowElementDownload": true,
  "sendNotifications": true,
  "notifyOnOpen": true,
  "notifyOnChange": true,
  "commentSettings": {
    "isAllowedCommenting": false,
    "showExternalComments": false
  },
  "watermarking": {
    "text": "Watermark Text",
    "opacity": 0.5,
    "verticalPosition": 0.8,
    "forensic": false,
    "elements": [
      {
        "textType": "Custom",
        "text": "Watermark Text",
        "corner": "TL",
        "horizontal": 19.4,
        "vertical": 8.9,
        "opacity": 0.7,
        "fontColor": "FFFFFF",
        "fontSize": 14,
        "backgroundColor": "000000"
      }
    ]
  },
  "filters": {
    "elements": {
      "types": [
        "Image",
        "Video"
      ],
      "ciGeneratedPreviews": [
        "video-2k",
        "video-hd",
        "dolby-audio"
      ],
      "customRenders": [
        "social-media-1080p",
        "social-media-720p"
      ]
    }
  },
  "allowUserDefaults": true
}

Property name	Type	Description
type	`string`	Specifies the type of Mediabox (`Secure`, `Protected`, `Public`).
expirationDays	`number`	The default number of days before the Mediabox expires.
message	`string`	A default message for the Mediabox.
allowSourceDownload	`boolean`	Indicates if source downloads are allowed.
allowPreviewDownload	`boolean`	Indicates if preview downloads are allowed.
allowElementDownload	`boolean`	Indicates if element downloads are allowed.
sendNotifications	`boolean`	Indicates if notifications should be sent when the Mediabox is created.
notifyOnOpen	`boolean`	Indicates if the owner should be notified when the Mediabox is opened.
notifyOnChange	`boolean`	Indicates if the owner should be notified when the Mediabox is modified.
commentSettings	`object`	Configures the commenting behavior for Mediaboxes.
commentSettings.isAllowedCommenting	`boolean` (required)	Indicates whether users can write comments in MediaBox assets.
commentSettings.showExternalComments	`boolean` (required)	Indicates whether comments from the Workspace can be viewed.
watermarking	`object`	Configures the watermarking settings.
watermarking.text	`string` (required)	The watermark text that will be applied to the MediaBox assets. This can be empty if watermark elements are used instead.
watermarking.opacity	`number` (required)	The opacity level of the watermark text.
watermarking.verticalPosition	`number`	The vertical position of the watermark, defined as a percentage value between 0 and 1.
watermarking.forensic	`boolean`	If true, enables forensic watermarking.
watermarking.elements	`array`	List of watermark elements to apply. Each element represents a line of text.
watermarking.elements[].textType	`string` (required)	The type of the watermark text. The possible values are `Name`, `Email`, `IP`, `Date`, `Time` and `Custom`.
watermarking.elements[].text	`string`	The text to display in the watermark element. This is only required if the text type is `Custom`.
watermarking.elements[].corner	`string`	The corner of the content where the watermark is applied. The possible values are `TL`, `TR`, `BL` and `BR`. Default is `TL` (Top Left).
watermarking.elements[].horizontal	`number`	Horizontal offset for the watermark, defined in pixels.
watermarking.elements[].vertical	`number`	Vertical offset for the watermark, defined in pixels.
watermarking.elements[].opacity	`number`	The opacity level for the watermark element.
watermarking.elements[].fontColor	`string`	The font color for the watermark text in hexadecimal format.
watermarking.elements[].fontSize	`number`	The font size for the watermark text in pixels.
watermarking.elements[].backgroundColor	`string`	The background color behind the watermark text in hexadecimal format.
filters	`object`	Configures filters for downloadable elements.
filters.elements	`object`	Filters the elements that can be downloaded from the MediaBox assets. If not provided, no elements can be downloaded or previewed.
filters.elements.types	`array`	The types of elements that can be downloaded. The possible values are `Image`, `Video`, `Audio`, `Document`, `TimedText` and `Other`.
filters.elements.ciGeneratedPreviews	`array`	The types of Ci-generated previews that can be downloaded. The possible values are `video-2kplus`, `video-2k`, `video-hd`, `video-sdplus`, `video-sd`, `video-3g`, `dolby-audio`, `dolby-audio-stereo`, `dolby-audio-binaural` and `standard-audio`.
filters.elements.customRenders	`array`	The types of custom renders that can be downloaded. For example, `social-media-1080p`, `social-media-720p`, etc.
allowUserDefaults	`boolean`	Indicates if users can save their own defaults.

Headers

Content-Type: application/json

Body

{
  "code": "WorkspaceNotFound",
  "message": "Workspace not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Get Workspace Mediabox Defaults
GET`/workspaces/{workspaceId}/mediabox-defaults`

URI Parameters

HideShow

workspaceId: string (required)
The unique identifier of the workspace.

Description: This endpoint retrieves the Mediabox default settings for a specific workspace.

If the workspace has its own Mediabox defaults configured, they are returned.
If the workspace does not have its own defaults configured, the Mediabox defaults from the associated network are returned (if available).
If neither workspace nor network defaults are set, the response will contain an empty object or null.

Note: defaults can be unset by sending an empty object in the request body of the Update Workspace Mediabox Defaults endpoint.

PUT https://api.cimediacloud.com/workspaces/da836655e2c04e01930fb4b06b1c4e4c/mediabox-defaults

Requestsexample 1

Headers

Content-Type: application/json

Body

{
  "type": "Secure",
  "expirationDays": 30,
  "message": "Welcome!",
  "allowSourceDownload": false,
  "allowPreviewDownload": true,
  "allowElementDownload": true,
  "sendNotifications": true,
  "notifyOnOpen": true,
  "notifyOnChange": true,
  "commentSettings": {
    "isAllowedCommenting": false,
    "showExternalComments": false
  },
  "watermarking": {
    "text": "Watermark Text",
    "opacity": 0.5,
    "verticalPosition": 0.8,
    "forensic": false,
    "elements": [
      {
        "textType": "Custom",
        "text": "Watermark Text",
        "corner": "TL",
        "horizontal": 19.4,
        "vertical": 8.9,
        "opacity": 0.7,
        "fontColor": "FFFFFF",
        "fontSize": 14,
        "backgroundColor": "000000"
      }
    ]
  },
  "filters": {
    "elements": {
      "types": [
        "Image",
        "Video"
      ],
      "ciGeneratedPreviews": [
        "video-2k",
        "video-hd",
        "dolby-audio"
      ],
      "customRenders": [
        "social-media-1080p",
        "social-media-720p"
      ]
    }
  },
  "allowUserDefaults": true
}

Property name	Type	Description
type	`string`	Specifies the type of Mediabox (`Secure`, `Protected`, `Public`).
expirationDays	`number`	The default number of days before the Mediabox expires.
message	`string`	A default message for the Mediabox.
allowSourceDownload	`boolean`	Indicates if source downloads are allowed.
allowPreviewDownload	`boolean`	Indicates if preview downloads are allowed.
allowElementDownload	`boolean`	Indicates if element downloads are allowed.
sendNotifications	`boolean`	Indicates if notifications should be sent when the Mediabox is created.
notifyOnOpen	`boolean`	Indicates if the owner should be notified when the Mediabox is opened.
notifyOnChange	`boolean`	Indicates if the owner should be notified when the Mediabox is modified.
commentSettings	`object`	Configures the commenting behavior for Mediaboxes.
commentSettings.isAllowedCommenting	`boolean` (required)	Indicates whether users can write comments in MediaBox assets.
commentSettings.showExternalComments	`boolean` (required)	Indicates whether comments from the Workspace can be viewed.
watermarking	`object`	Configures the watermarking settings.
watermarking.text	`string` (required)	The watermark text that will be applied to the MediaBox assets. This can be empty if watermark elements are used instead.
watermarking.opacity	`number` (required)	The opacity level of the watermark text.
watermarking.verticalPosition	`number`	The vertical position of the watermark, defined as a percentage value between 0 and 1.
watermarking.forensic	`boolean`	If true, enables forensic watermarking.
watermarking.elements	`array`	List of watermark elements to apply. Each element represents a line of text.
watermarking.elements[].textType	`string` (required)	The type of the watermark text. The possible values are `Name`, `Email`, `IP`, `Date`, `Time` and `Custom`.
watermarking.elements[].text	`string`	The text to display in the watermark element. This is only required if the text type is `Custom`.
watermarking.elements[].corner	`string`	The corner of the content where the watermark is applied. The possible values are `TL`, `TR`, `BL` and `BR`. Default is `TL` (Top Left).
watermarking.elements[].horizontal	`number`	Horizontal offset for the watermark, defined in pixels.
watermarking.elements[].vertical	`number`	Vertical offset for the watermark, defined in pixels.
watermarking.elements[].opacity	`number`	The opacity level for the watermark element.
watermarking.elements[].fontColor	`string`	The font color for the watermark text in hexadecimal format.
watermarking.elements[].fontSize	`number`	The font size for the watermark text in pixels.
watermarking.elements[].backgroundColor	`string`	The background color behind the watermark text in hexadecimal format.
filters	`object`	Configures filters for downloadable elements.
filters.elements	`object`	Filters the elements that can be downloaded from the MediaBox assets. If not provided, no elements can be downloaded or previewed.
filters.elements.types	`array`	The types of elements that can be downloaded. The possible values are `Image`, `Video`, `Audio`, `Document`, `TimedText` and `Other`.
filters.elements.ciGeneratedPreviews	`array`	The types of Ci-generated previews that can be downloaded. The possible values are `video-2kplus`, `video-2k`, `video-hd`, `video-sdplus`, `video-sd`, `video-3g`, `dolby-audio`, `dolby-audio-stereo`, `dolby-audio-binaural` and `standard-audio`.
filters.elements.customRenders	`array`	The types of custom renders that can be downloaded. For example, `social-media-1080p`, `social-media-720p`, etc.
allowUserDefaults	`boolean`	Indicates if users can save their own defaults.

Responses200404

Headers

Content-Type: application/json

Body

{
  "type": "Secure",
  "expirationDays": 30,
  "message": "Welcome!",
  "allowSourceDownload": false,
  "allowPreviewDownload": true,
  "allowElementDownload": true,
  "sendNotifications": true,
  "notifyOnOpen": true,
  "notifyOnChange": true,
  "commentSettings": {
    "isAllowedCommenting": false,
    "showExternalComments": false
  },
  "watermarking": {
    "text": "Watermark Text",
    "opacity": 0.5,
    "verticalPosition": 0.8,
    "forensic": false,
    "elements": [
      {
        "textType": "Custom",
        "text": "Watermark Text",
        "corner": "TL",
        "horizontal": 19.4,
        "vertical": 8.9,
        "opacity": 0.7,
        "fontColor": "FFFFFF",
        "fontSize": 14,
        "backgroundColor": "000000"
      }
    ]
  },
  "filters": {
    "elements": {
      "types": [
        "Image",
        "Video"
      ],
      "ciGeneratedPreviews": [
        "video-2k",
        "video-hd",
        "dolby-audio"
      ],
      "customRenders": [
        "social-media-1080p",
        "social-media-720p"
      ]
    }
  },
  "allowUserDefaults": true
}

Property name	Type	Description
type	`string`	Specifies the type of Mediabox (`Secure`, `Protected`, `Public`).
expirationDays	`number`	The default number of days before the Mediabox expires.
message	`string`	A default message for the Mediabox.
allowSourceDownload	`boolean`	Indicates if source downloads are allowed.
allowPreviewDownload	`boolean`	Indicates if preview downloads are allowed.
allowElementDownload	`boolean`	Indicates if element downloads are allowed.
sendNotifications	`boolean`	Indicates if notifications should be sent when the Mediabox is created.
notifyOnOpen	`boolean`	Indicates if the owner should be notified when the Mediabox is opened.
notifyOnChange	`boolean`	Indicates if the owner should be notified when the Mediabox is modified.
commentSettings	`object`	Configures the commenting behavior for Mediaboxes.
commentSettings.isAllowedCommenting	`boolean` (required)	Indicates whether users can write comments in MediaBox assets.
commentSettings.showExternalComments	`boolean` (required)	Indicates whether comments from the Workspace can be viewed.
watermarking	`object`	Configures the watermarking settings.
watermarking.text	`string` (required)	The watermark text that will be applied to the MediaBox assets. This can be empty if watermark elements are used instead.
watermarking.opacity	`number` (required)	The opacity level of the watermark text.
watermarking.verticalPosition	`number`	The vertical position of the watermark, defined as a percentage value between 0 and 1.
watermarking.forensic	`boolean`	If true, enables forensic watermarking.
watermarking.elements	`array`	List of watermark elements to apply. Each element represents a line of text.
watermarking.elements[].textType	`string` (required)	The type of the watermark text. The possible values are `Name`, `Email`, `IP`, `Date`, `Time` and `Custom`.
watermarking.elements[].text	`string`	The text to display in the watermark element. This is only required if the text type is `Custom`.
watermarking.elements[].corner	`string`	The corner of the content where the watermark is applied. The possible values are `TL`, `TR`, `BL` and `BR`. Default is `TL` (Top Left).
watermarking.elements[].horizontal	`number`	Horizontal offset for the watermark, defined in pixels.
watermarking.elements[].vertical	`number`	Vertical offset for the watermark, defined in pixels.
watermarking.elements[].opacity	`number`	The opacity level for the watermark element.
watermarking.elements[].fontColor	`string`	The font color for the watermark text in hexadecimal format.
watermarking.elements[].fontSize	`number`	The font size for the watermark text in pixels.
watermarking.elements[].backgroundColor	`string`	The background color behind the watermark text in hexadecimal format.
filters	`object`	Configures filters for downloadable elements.
filters.elements	`object`	Filters the elements that can be downloaded from the MediaBox assets. If not provided, no elements can be downloaded or previewed.
filters.elements.types	`array`	The types of elements that can be downloaded. The possible values are `Image`, `Video`, `Audio`, `Document`, `TimedText` and `Other`.
filters.elements.ciGeneratedPreviews	`array`	The types of Ci-generated previews that can be downloaded. The possible values are `video-2kplus`, `video-2k`, `video-hd`, `video-sdplus`, `video-sd`, `video-3g`, `dolby-audio`, `dolby-audio-stereo`, `dolby-audio-binaural` and `standard-audio`.
filters.elements.customRenders	`array`	The types of custom renders that can be downloaded. For example, `social-media-1080p`, `social-media-720p`, etc.
allowUserDefaults	`boolean`	Indicates if users can save their own defaults.

Headers

Content-Type: application/json

Body

{
  "code": "WorkspaceNotFound",
  "message": "Workspace not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Update Workspace Mediabox Defaults
PUT`/workspaces/{workspaceId}/mediabox-defaults`

URI Parameters

HideShow

workspaceId: string (required)
The unique identifier of the workspace.

Description: This endpoint updates the Mediabox default settings for a specific workspace.

If workspace defaults are explicitly set via this endpoint, they will override any inherited network defaults.
If all workspace default fields are cleared (set to null or removed), the workspace will again inherit from the associated network defaults.

File Requests ¶

Create File Request ¶

POST https://api.cimediacloud.com/file-requests

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "name": "File Request Name",
  "message": "Please upload files from today",
  "workspaceId": "oj7mx3vlb2srei89",
  "folderId": "6ovu49kdb3z32z2w",
  "expirationDate": "2019-01-02T00:00:00.000Z",
  "requireContributorEmail": true,
  "recipients": [
    "johnsmith@example.com"
  ],
  "deliveryReceipts": [
    "johnsmith@example.com"
  ],
  "metadataFields": [
    {
      "name": "Example field",
      "value": "Default value",
      "isRequired": false,
      "isReadOnly": false
    }
  ],
  "highlightAspera": false,
  "allowFolderUploads": false,
  "maximumFileUploads": 5,
  "allowedFileTypes": [
    "Audio",
    "Video"
  ],
  "allowedFileExtensions": [
    ".mp4",
    ".jpg"
  ],
  "allowStandardUpload": true,
  "distributionListIds": [
    "84810060232d491b81e7c10473049ffa"
  ]
}

Property name	Type	Description
name	`string` (required)	The name of the File Request.
message	`string`	Optional message / notes that appear for the File Request recipients.
workspaceId	`string` (required)	The Workspace that will contain received assets from the File Request.
folderId	`string`	The Workspace’s folder that will contain received assets from the File Request. If no value is provided, the assets will be placed in the Workspace’s root folder.
expirationDate	`string`	Date and time when the File Request will expire. Value must be in IS0 8601 date and time format (e.g.: ‘2020-01-01’).
requireContributorEmail	`boolean`	Indicates whether the contributor should be required to provide an email address when contributing files or not. Defaults to false.
recipients	`array`	The list of email addresses who will receive notification of the File Request.
deliveryReceipts	`array`	The list of email address who will receive notification when one or more files are contributed to the File Request. The Pro File Request entitlement is required for this feature.
metadataFields	`array`	Asset metadata fields that will appear in the File Request to allow users to provide additional information about each contributed asset.
metadataFields[].name	`string`	The name of the metadata field.
metadataFields[].value	`string`	The default value of the metadata field
metadataFields[].isRequired	`boolean`	Indicates if the metada field is required. Default is false.
metadataFields[].isReadOnly	`boolean`	Indicates if the contributor can modify the metadata value. Default is false.
highlightAspera	`boolean`	Indicates if Aspera will be the highlighted upload method for the contributor.
allowFolderUploads	`boolean`	Indicates if the contributor can upload folders through Aspera.
maximumFileUploads	`number`	The maximum number of files that can be uploadaded at the same time. Will not have any effect if `allowFolderUploads` is true for the same request.
allowedFileTypes	`array`	The file types that are allowed for the File Request. Valid values are: `Audio`, `Image`, `Video`, `Document`, `TimedText`, `Other`. Will not have any effect if `allowFolderUploads` is true for the same request.
allowedFileExtensions	`array`	The file extensions that are allowed for the File Request. The following values are not allowed: `.com`, `.exe`, `.php`, `.js`, `.jsp`, `.bat`, `.vbs`, `.rb`, `.py`, `.html`, `.swf`, `.dmg`, `.msi`. Will not have any effect if `allowFolderUploads` is enabled for the File Request.
allowStandardUpload	`boolean`	Indicates if standard HTTP upload is allowed / restricted. Default is true.
distributionListIds	`array`	One or more distribution list identifiers that can be used to easily add pre-defined recipients to the File Request.

Responses200400

Headers

Content-Type: application/json

Body

{
  "fileRequestId": "2vvcf7zv4hsrpeiq",
  "link": "https://workspace.cimediacloud.com/file-request/XeI26E"
}

Property name	Type	Description
fileRequestId	`string`	The unique identifier of the created File Request.
link	`string`	URL of the created File Request.

Headers

Content-Type: application/json

Body

{
  "code": "FolderNotFound",
  "message": "Folder not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Create File Request
POST`/file-requests`

Description

Creates a new File Request for receiving assets from external contributors.

allowedFileTypes and allowedFileExtensions cannot be submitted on the same request. You must choose either one or the other.

Errors

Status Code	Error Code	Message
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	MissingOrInvalidName	Missing or invalid name.
400	InvalidExpiration	Invalid expiration.
400	InvalidRecipients	One or more recipients has an invalid email address.
400	InvalidDeliveryReceipts	One or more delivery receipts has an invalid email address.
400	FolderNotFound	Folder not found.
400	FolderNotMemberOfWorkspace	Folder is not a member of the provided workspace.
400	WorkspaceNotFound	Workspace not found.
400	MissingFileRestrictions	Missing “AllowedFileTypes” or “AllowedFileExtensions”.
400	MultipleFileRestrictionsPerRequestNotAllowed	Multiple file restrictions found. Only “AllowedFileTypes” or “AllowedFileExtensions” should be provided.
400	RestrictedFileExtensionFound	Restricted file extension found: .com, .exe, .php, .js, .jsp, .bat, .vbs, .rb, .py, .html, .swf, .dmg and .msi files are not allowed.
400	InvalidFileExtensionFound	Invalid file extension found.
400	DistributionListNotFound	Distribution List not found.
409	FolderTrashed	Folder is trashed.
409	FolderDeleted	Folder is deleted.
409	EntitlementRequired	Pro File Request entitlement is required for the provided settings.

Open File Request ¶

POST https://api.cimediacloud.com/file-requests/WDA6AK0H/open

Responses200404

Headers

Content-Type: application/json

Body

{
  "id": "2e27c3e752b0402192e41659b5eba62a",
  "name": "Video Contest",
  "message": "Please upload files from today",
  "link": "https://cimediacloud.com/file-request/WDA6AK0H",
  "expiresOn": "2021-11-01T00:00:00.000Z",
  "requireContributorEmail": true,
  "createdBy": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith",
    "email": "johnsmith@example.com"
  },
  "asperaEnabled": true,
  "metadataFields": [
    {
      "name": "Example field",
      "value": "Default value",
      "isRequired": true,
      "isReadOnly": false
    }
  ],
  "highlightAspera": true,
  "allowFolderUploads": true,
  "maximumFileUploads": 5,
  "allowedFileExtensions": [
    ".mp4",
    ".jpg"
  ],
  "allowedFileTypes": [
    "Audio",
    "Video"
  ],
  "allowStandardUpload": true,
  "branding": {
    "logoUrl": "https://example.com/logo.png",
    "bannerUrl": "https://example.com/banner.jpg",
    "loginBannerUrl": "https://example.com/login.jpg",
    "backgroundUrl": "https://example.com/background.jpg",
    "accentColor": "#FF00FF",
    "fallbackText": "Contoso"
  },
  "accessToken": "638acdda7d7e4e9c88ac9c37e7e529a7"
}

Property name	Type	Description
id	`string`	The unique identifier of the File Request.
name	`string`	The display title of File Request.
message	`string`	Notes for the File Request recipients.
link	`string`	The access link of the File Request.
expiresOn	`string`	The datetime when the MediaBox will expire.
requireContributorEmail	`boolean`	Indicates whether the contributor should be required to provide an email address when contributing files. Defaults to false.
createdBy	`object`	The user who is requesting the files.
createdBy.id	`string`	The unique identifier of the user.
createdBy.name	`string`	The full name of the user.
createdBy.email	`string`	The email of the user.
asperaEnabled	`boolean`	Indicates if Aspera is available as an upload mechanism in this File Request.
metadataFields	`array`	The set of metadata fields used to provide additional information about each contributed asset.
metadataFields[].name	`string`	The name of the metadata field.
metadataFields[].value	`string`	The default value of the metadata field, if applicable.
metadataFields[].isRequired	`boolean`	Indicates if the metada field is required.
metadataFields[].isReadOnly	`boolean`	Indicates if the contributor can modify the metadata value.
highlightAspera	`boolean`	Indicates if Aspera should be highlighted as an upload method for the contributor.
allowFolderUploads	`boolean`	Indicates if the contributor can upload folders using Aspera.
maximumFileUploads	`number`	The maximum number of files that can be uploadaded at the same time. Does not have any effect if `allowFolderUploads` is `true`.
allowedFileExtensions	`array`	The file extensions that are allowed for the File Request. The following values are not allowed: `.com`, `.exe`, `.php`, `.js`, `.jsp`, `.bat`, `.vbs`, `.rb`, `.py`, `.html`, `.swf`, `.dmg`, `.msi`.
allowedFileTypes	`array`	The file types that are allowed for the File Request. Valid values are: `Audio`, `Image`, `Video`, `Document`, `TimedText`, `Other`
allowStandardUpload	`boolean`	Indicates if standard HTTP upload is allowed / restricted.
branding	`object`	Custom branding settings and resources.
branding.logoUrl	`string`	The image to use as logo.
branding.bannerUrl	`string`	The image to use as banner.
branding.loginBannerUrl	`string`	The image to use as login banner.
branding.backgroundUrl	`string`	The image to use as background.
branding.accentColor	`string`	The accent color to use in UI elements.
branding.fallbackText	`string`	The text to show in case the logo cannot be displayed.
accessToken	`string`	The bearer token needed for uploading files to the File Request.

Headers

Content-Type: application/json

Body

{
  "code": "FileRequestNotFound",
  "message": "File Request not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Open File Request
POST`/file-requests/{accessCode}/open`

URI Parameters

HideShow

accessCode: string (required)
The access code of the File Request

Description

Returns appropriate File Request information that is necessary for uploading content.

Errors

Status Code	Error Code	Message
404	FileRequestNotFound	File Request not found.
404	FileRequestNotAvailable	The File Request is no longer available.
409	InsufficientSpaceAvailable	Space storage has been exceeded.

Update File Request ¶

PUT https://api.cimediacloud.com/file-requests/2vvcf7zv4hsrpeiq

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "name": "File Request Name",
  "isDeleted": true,
  "message": "Please upload files from today",
  "folderId": "6ovu49kdb3z32z2w",
  "expirationDate": "2019-01-02T00:00:00.000Z",
  "requireContributorEmail": true,
  "recipients": [
    "johnsmith@example.com"
  ],
  "deliveryReceipts": [
    "johnsmith@example.com"
  ],
  "metadataFields": [
    {
      "name": "Example field",
      "value": "Default value",
      "isRequired": false,
      "isReadOnly": false
    }
  ],
  "highlightAspera": false,
  "allowFolderUploads": false,
  "maximumFileUploads": 5,
  "allowedFileTypes": [
    "Audio",
    "Video"
  ],
  "allowedFileExtensions": [
    ".mp4",
    ".jpg"
  ],
  "allowStandardUpload": true,
  "distributionListIds": [
    "84810060232d491b81e7c10473049ffa"
  ]
}

Property name	Type	Description
name	`string` (required)	The name of the File Request.
isDeleted	`boolean`	Indicates if the File Request should be closed. Default is false.
message	`string`	Optional message / notes that appear for the File Request recipients.
folderId	`string`	The Workspace’s folder that will contain received assets from the File Request. If no value is provided, the assets will be placed in the Workspace’s root folder.
expirationDate	`string`	Date and time when the File Request will expire. Value must be in IS0 8601 date and time format (e.g.: ‘2020-01-01’).
requireContributorEmail	`boolean`	Indicates whether the contributor should be required to provide an email address when contributing files or not. Defaults to false.
recipients	`array`	The list of email addresses who will receive notification of the File Request.
deliveryReceipts	`array`	The list of email address who will receive notification when one or more files are contributed to the File Request. The Pro File Request entitlement is required for this feature.
metadataFields	`array`	Asset metadata fields that will appear in the File Request to allow users to provide additional information about each contributed asset.
metadataFields[].name	`string`	The name of the metadata field.
metadataFields[].value	`string`	The default value of the metadata field
metadataFields[].isRequired	`boolean`	Indicates if the metada field is required. Default is false.
metadataFields[].isReadOnly	`boolean`	Indicates if the contributor can modify the metadata value. Default is false.
highlightAspera	`boolean`	Indicates if Aspera will be the highlighted upload method for the contributor.
allowFolderUploads	`boolean`	Indicates if the contributor can upload folders through Aspera.
maximumFileUploads	`number`	The maximum number of files that can be uploadaded at the same time. Will not have any effect if `allowFolderUploads` is true for the same request.
allowedFileTypes	`array`	The file types that are allowed for the File Request. Valid values are: `Audio`, `Image`, `Video`, `Document`, `TimedText`, `Other`. Will not have any effect if `allowFolderUploads` is true for the same request.
allowedFileExtensions	`array`	The file extensions that are allowed for the File Request. The following values are not allowed: `.com`, `.exe`, `.php`, `.js`, `.jsp`, `.bat`, `.vbs`, `.rb`, `.py`, `.html`, `.swf`, `.dmg`, `.msi`. Will not have any effect if `allowFolderUploads` is enabled for the File Request.
allowStandardUpload	`boolean`	Indicates if standard HTTP upload is allowed / restricted. Default is true.
distributionListIds	`array`	One or more distribution list identifiers that can be used to easily add pre-defined recipients to the File Request.

Responses200400

Headers

Content-Type: application/json

Body

{
  "fileRequestId": "2vvcf7zv4hsrpeiq",
  "accessCode": "DWVW064O"
}

Property name	Type	Description
fileRequestId	`string`	The unique identifier of the updated File Request.
accessCode	`string`	The access code of the updated File Request

Headers

Content-Type: application/json

Body

{
  "code": "FolderNotFound",
  "message": "Folder not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Update File Request
PUT`/file-requests/{code}`

URI Parameters

HideShow

code: string (required)
The unique identifier (ID) or the access code of the File Request

Description

Updates a File Request that receives assets from external contributors.

This API does not support partial updates. All appropriate fields must be provided for each update.

allowedFileTypes and allowedFileExtensions cannot be submitted on the same request. You must choose either one or the other.

isDeleted is used to trigger closing and reopening logic.

If it is false in this request, and the file is already closed, then triggers re-open logic.
If it is true in this request, and the file is already closed, then triggers closing logic.

Errors

Status Code	Error Code	Message
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	MissingOrInvalidName	Missing or invalid name.
400	InvalidExpiration	Invalid expiration.
400	InvalidRecipients	One or more recipients has an invalid email address.
400	InvalidDeliveryReceipts	One or more delivery receipts has an invalid email address.
400	MissingFileRestrictions	Missing “AllowedFileTypes” or “AllowedFileExtensions”.
400	MultipleFileRestrictionsPerRequestNotAllowed	Multiple file restrictions found. Only “AllowedFileTypes” or “AllowedFileExtensions” should be provided.
400	RestrictedFileExtensionFound	Restricted file extension found: .com, .exe, .php, .js, .jsp, .bat, .vbs, .rb, .py, .html, .swf, .dmg and .msi files are not allowed.
400	InvalidFileExtensionFound	Invalid file extension found.
400	DistributionListNotFound	Distribution List not found.
404	FileRequestNotFound	File Request not found.
404	FileRequestAccessDenied	File Request access denied.

WorkSessions ¶

List WorkSessions ¶

GET https://api.cimediacloud.com/worksessions?limit=1&offset=0&orderBy=name&orderDirection=asc&workspaceId=ab8fcd95c99e4ba6a9f03f802311db74&app=VideoReview&status=Active&origin=Sent

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200400

Headers

Content-Type: application/json

Body

{
  "limit": 1,
  "offset": 0,
  "count": 10,
  "order": {
    "by": "Name",
    "direction": "asc"
  },
  "items": [
    {
      "id": "ab8fcd95c99e4ba6a9f03f802311db74",
      "network": {
        "id": "40c2a6b99a474b319dec5ef9c7dbb356",
        "name": "Company Name",
        "class": "Enterprise"
      },
      "workspace": {
        "id": "gb5ehomv0iv71swg",
        "name": "Workspace Name",
        "class": "Enterprise"
      },
      "appName": "VideoReview",
      "goal": "Annotate all localizable frames",
      "name": "Video - Localization",
      "status": "Active",
      "dueOn": "2022-01-25T00:00:00.000Z",
      "link": "https://workspace.cimediacloud.com/vreview/ab8fcd95c99e4ba6a9f03f802311db74",
      "users": [
        {
          "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
          "name": "John Smith",
          "status": "Joined",
          "lastAccessedOn": "2022-01-25T00:00:00.000Z",
          "joinedOn": "2022-01-25T00:00:00.000Z",
          "invitedOn": "2022-01-25T00:00:00.000Z",
          "createdBy": {
            "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
            "name": "John Smith"
          },
          "notificationSetting": "None"
        }
      ],
      "owner": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith"
      },
      "createdBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith"
      },
      "createdOn": "2017-01-02T00:00:00.000Z",
      "modifiedOn": "2017-01-02T00:00:00.000Z",
      "lastActivityOn": "2017-01-02T00:00:00.000Z",
      "permissions": {
        "allowManageMembers": {
          "onlyOwner": true,
          "sessionMembers": true,
          "spaceMembers": true,
          "everyone": true
        }
      },
      "notifications": {
        "invites": true
      },
      "thumbnails": [
        {
          "type": "large",
          "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/thumb.jpg",
          "size": 1024,
          "width": 200,
          "height": 300
        }
      ],
      "fileCount": 1
    }
  ]
}

Property name	Type	Description
limit	`number`	The limit used for the query.
offset	`number`	The offset used for the query.
count	`number`	The total count of items available.
order	`object`	Information about the ordering of the results.
order.by	`string`	Indicates the field used to sort the results.
order.direction	`string`	Indicates the direction used to sort the results.
items	`array`	The WorkSessions returned.
items[].id	`string`	The unique identifier of the WorkSession.
items[].network	`object`	The Network that the WorkSession is part of.
items[].network.id	`string`	The unique identifier of the Network.
items[].network.name	`string`	The name of the Network.
items[].network.class	`string`	Indicates if the Network is a ‘Personal’ or ‘Enterprise’ Network.
items[].workspace	`object`	The Workspace that the WorkSession is part of.
items[].workspace.id	`string`	The unique identifier of the Workspace.
items[].workspace.name	`string`	The name of the Workspace.
items[].workspace.class	`string`	Indicates if the Workspace is a ‘Personal’ or ‘Team’ Workspace.
items[].appName	`string`	The app that this WorkSession corresponds to. It can be ‘VideoReview’, ‘ImageReview’, ‘RoughCut’ or ‘MediaLog’
items[].goal	`string`	The objective of the WorkSession.
items[].name	`string`	The title of the WorkSession.
items[].status	`string`	The status of the WorkSession. It can be ‘Draft’, ‘Active’, ‘Complete’ or ‘Inactive’.
items[].dueOn	`string`	The due date of the WorkSession.
items[].link	`string`	The link that opens the work session.
items[].users	`array`	The participants of the WorkSession.
items[].users[].id	`string`	The unique identifier of the user.
items[].users[].name	`string`	The full name of the user.
items[].users[].status	`string`	The status of the user within the WorkSession. It can be `Owner`, `Invited` or `Joined`.
items[].users[].lastAccessedOn	`string`	The last time the user accessed the WorkSession.
items[].users[].joinedOn	`string`	The datetime the user joined the WorkSession.
items[].users[].invitedOn	`string`	The datetime when the user was invited to the WorkSession.
items[].users[].createdBy	`object`	The user who invited the WorkSession participant.
items[].users[].createdBy.id	`string`	The unique identifier of the user.
items[].users[].createdBy.name	`string`	The full name of the user.
items[].users[].notificationSetting	`string`	The notification settings of the user within the WorkSession. It can be `None` or `Verbose`.
items[].owner	`object`	The owner of the WorkSession.
items[].owner.id	`string`	The unique identifier of the user.
items[].owner.name	`string`	The full name of the user.
items[].createdBy	`object`	The creator of the WorkSession.
items[].createdBy.id	`string`	The unique identifier of the user.
items[].createdBy.name	`string`	The full name of the user.
items[].createdOn	`string`	The datetime the WorkSession was created.
items[].modifiedOn	`string`	The datetime the WorkSession was last modified.
items[].lastActivityOn	`string`	The datetime the WorkSession recorded the most recent activity.
items[].permissions	`object`	The permission configuration of the WorkSession. Only the owner can change them.
items[].permissions.allowManageMembers	`object`
items[].permissions.allowManageMembers.onlyOwner	`boolean`	If this is true, only the owner of the WorkSession can manage it.
items[].permissions.allowManageMembers.sessionMembers	`boolean`	If this is true, all the members of the WorkSession can manage it.
items[].permissions.allowManageMembers.spaceMembers	`boolean`	If this is true, all the members of the space of the WorkSession can manage it.
items[].permissions.allowManageMembers.everyone	`boolean`	If this is true, all members of the WorkSession and the space of the WorkSession can manage it.
items[].notifications	`object`	The notification settings of the WorkSession.
items[].notifications.invites	`boolean`	Indicates if the invited people are notified of the invitation.
items[].thumbnails	`array`	The set of thumbnails for the WorkSession.
items[].thumbnails[].type	`string`	The type of thumbnail returned. Valid values are ‘small’, ‘medium’ and ‘large’.
items[].thumbnails[].location	`string`	The URL of the thumbnail.
items[].thumbnails[].size	`number`	The size of the thumbnail, in bytes.
items[].thumbnails[].width	`number`	The width of the thumbnail.
items[].thumbnails[].height	`number`	The height of the thumbnail.
items[].fileCount	`number`	The number of files within the WorkSession.

Headers

Content-Type: application/json

Body

{
  "code": "InvalidLimitOrOffset",
  "message": "Invalid limit or offset value."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

List WorkSessions
GET`/worksessions{?limit,offset,orderBy,orderDirection,workspaceId,app,status,origin}`

URI Parameters

HideShow

origin

string (optional)

Not set by default. Allows to filter the WorkSessions to retrieve by the kind of access (being a participant of the WorkSession or being a member of its Workspace) the user has to them. It can be either ‘Sent’ or ‘Received’. If not set, all WorkSessions are retrieved, regardless of the kind of access. If Received is used, only WorkSessions where the user is a direct participant (but not the owner) will be retrieved. If Sent is used, the API will return WorkSessions where the user is the owner, or is a member of their Workspace and the session can be managed by Workspace users.

workspaceId

string (optional)

Not set by default. Indicates the Workspace to filter by. It only applies when origin is not set, or its value is Sent.

app

string (optional)

Not set by default. A comma-separated list of the WorkSession apps to filter by. The supported values are ‘VideoReview’, ‘ImageReview’, ‘RoughCut’ or ‘MediaLog’.

status

string (optional)

Not set by default. The WorkSession status to filter by. The supported values are ‘Draft’, ‘Active’, ‘Complete’ or ‘Inactive’.

limit

number (optional) Default: 100

The number of WorkSessions to return. The maximum is 100.

offset

number (optional) Default: 0

The item at which to begin the response.

orderBy

string (optional) Default: createdOn

The field to sort the items by.

Choices: createdOn name app lastActivityOn dueOn ownerName

orderDirection

string (optional) Default: asc

The order direction the items should be returned.

Choices: asc desc

Description

Retrieves all WorkSessions the calling user has access to.

Errors

Status Code	Error Code	Message
400	InvalidLimitOrOffset	Invalid limit or offset value. Limit must be a number between 1 and 500. Offset must be greater than or equal to 0.
400	InvalidQueryOrderFieldForListWorkSessions	Invalid order field. It must be either ‘CreatedOn’, ‘Name’, ‘App’, ‘CreatedBy’, ‘LastActivityOn’, ‘DueOn’ or ‘OwnerName’.
400	InvalidQueryOrderDirection	Invalid order direction. It must be either ‘Asc’ or ‘Desc’.
400	InvalidWorkSessionStatus	Invalid WorkSession status. It must be either ‘Draft’, ‘Active’, ‘Complete’ or ‘Inactive’.
400	InvalidQueryApp	Invalid app. It must be either ‘VideoReview’, ‘ImageReview’, ‘RoughCut’ or ‘MediaLog’.
400	InvalidWorkSessionOrigin	Invalid WorkSession origin. It must be either ‘Sent’ or ‘Received’.
400	WorkspaceNotFound	Workspace not found.

Create WorkSession ¶

POST https://api.cimediacloud.com/worksessions

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "assetIds": [
    "jy3lrsqqm0qobid1"
  ],
  "appName": "VideoReview",
  "dueDate": "2018-01-02T00:00:00.000Z",
  "goal": "Huddle for final draft",
  "name": "WorkSession name",
  "users": [
    "john@example.com"
  ],
  "status": "Active",
  "notifications": {
    "invites": true
  }
}

Property name	Type	Description
assetIds	`array` (required)	The unique identifiers for all assets to include in the WorkSession. The assets’ status must be `Complete`. Its Type must be `Video` for `VideoReview` or `MediaLog` and `Image` for an `ImageReview`.
appName	`string` (required)	The name of WorkSession App. Accepted values are `VideoReview`, `ImageReview`, and `MediaLog`.
dueDate	`string`	The due date for the WorkSession.
goal	`string`	The goal of the WorkSession.
name	`string` (required)	The name of the WorkSession.
users	`array`	The list of Workspace user Ids or email addresses who are invited to collaborate in this WorkSession. The users will be emailed immediately upon creation of the WorkSession.
status	`string`	The status of the WorkSession. Accepted values are `Draft` and `Active`. Default value is `Draft`.
notifications	`object`	Notification settings for the WorkSession.
notifications.invites	`boolean`	Determines if email notifications are sent to the users assigned to the WorkSession.

Responses200400

Headers

Content-Type: application/json

Body

{
  "workSessionId": "oj7mx3vlb2srei89",
  "link": "https://cimediacloud.com/t5y7s3ero3w2ie7/worksession",
  "errorCount": 1,
  "errors": [
    {
      "name": "Item name",
      "kind": "Item",
      "errorCode": "ItemNotFound",
      "errorMessage": "Item not found.",
      "id": "ad9289a2019a4e07a08eca9459ef1091"
    }
  ]
}

Property name	Type	Description
workSessionId	`string`	The unique identifier for the created WorkSession.
link	`string`	URL of the created WorkSession.
errorCount	`number`	The number of errors that occurred during the request.
errors	`array`	An array containing information about each error that occurred during the request.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].id	`string`	The unique identifier for the item.

Headers

Content-Type: application/json

Body

{
  "code": "InvalidRequest",
  "message": "Invalid request. Check the request body format and verify the right Content-Type header value is being sent."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Create WorkSession
POST`/worksessions`

Description

Create a new WorkSession for use with Workspace Apps.

500 is the maximum number of assets that can be added to a WorkSession.

All assets must be from the same Workspace when creating a WorkSession.

If there are any invalid assets or users the WorkSession will not be created. Inspect the errors array for issues that need to resolved before attempting to create the WorkSession.

Errors

Status Code	Error Code	Message
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	MissingOrInvalidName	Missing or invalid WorkSession app name.
400	AssetIdNotProvided	Asset Id was not provided.
400	InvalidWorkSessionStatus	Invalid WorkSession status.
400	InvalidDueDate	Invalid due date.
400	ExceededMaxAssetCount	Max asset count exceeded. The maximum number of assets is 500.
400	InvalidAssets	Assets belong to multiple workspaces.

Errors represented in errors array

Error Code	Message
AssetNotFound	Asset not found.
AssetDeleted	Asset is deleted.
AssetTrashed	Asset is trashed.
InvalidAssetState	Invalid asset status for WorkSession. Asset status must be Complete.
InvalidAssetType	Asset format is not compatible with WorkSession app.
InvalidUser	User or email provided is invalid.

Assets ¶

Assets represent the content that you want to store and make available to your customers. Basically, they’re your files with a whole bunch of value added to them. As part of turning your file into an asset in Ci, we extract technical metadata from your file and make it available to you. We calculate the MD5 checksum so that you can confirm that the file you stored is identical to the file you sent. We also generate the same set of beautiful proxies and thumbnails that you find in the award-winning Workspace user interface. You can add key/value pairs of metadata to the asset to provide useful information such as where it was shot, who was in it, the time of day - whatever information is important to you. Oh, and since we value security as much as you value your files, we check to make sure your files are healthy and free of viruses.

We do our best to support file formats that we know our customers use. If we run into something that’s new to us, we will quickly add it to our arsenal or, at the very least, let you know why we can’t. Even if we can’t create proxies from your file, we’ll still store it and provide you the same level of access that you expect from any asset in Ci.

Asset Statuses

When the asset record is created in our database it will have a status of ‘Created’. Once uploaded its status will transition to ‘Waiting’ to indicate it is waiting for backend processing jobs to begin (thumbnails, preview proxies, MD5 checksum, extract technical metadata, check for viruses, etc.). Once those jobs begin its status moves to ‘Processing’. When those jobs are complete the status will go to ‘Complete’. If a failure happens during upload the status will go to ‘Failed’. There are a couple additional statuses to consider as well:

Limited - There were problems generating thumbnails and/or preview proxies, The source file is still available for download.
Virus Detected - A virus was found and the file is not downloadable and generally cannot be used in our system.
Executable Detected - An executable file was found and the file is not downloadable and generally cannot be used in our system.
Deleted - The file has been deleted.

Previews

During the ingest process we will automatically create previews of your asset. These supplemental previews give you flexibility to display and stream your content appropriately.

These previews are subject to changes at any time.

Thumbnails

The following types of thumbnails can be returned in the thumbnails array found in any resources that return assets.

Thumbnail Types

Type	Description
‘small’	250x250, jpeg, scale of the original source.
‘medium’	560x560, jpeg, scale of the original source.
‘large’	1000x1000, jpeg, scale of the original source.
‘2000px’	2000x2000, jpeg, scale of the original source.

Thumbnails per Asset Type

Type	Video	Image	Audio
‘small’	Generated	Generated	Generated (if available)
‘medium’	Generated	Generated	Generated (if available)
‘large’	Generated	Generated	Generated (if available)
‘2000px’	Not generated	Generated	Not generated

Proxies

The following types of proxies can be returned in the proxies array found in any resources that return assets.

Proxy Types

Type	Description
‘standard-audio’	192kbps, mp3 format.
‘dolby-audio’	320kbps, mp3 format.
‘video-3g’	480x270, 200kbps, h264 codec, mp4 container.
‘video-sd’	640x360, 560kbps, h264 codec, mp4 container.
‘video-sdplus’	960x540, 1650kbps, h264 codec, mp4 container.
‘video-hd’	1280x720, 3000kbps, h264 codec, mp4 container.
‘video-2k’	1920x1080, 6800kbps, h264 codec, mp4 container.
‘video-2kplus’	1920x1080, 8500kbps, h264 codec, mp4 container.
‘document-pdf’	Adobe pdf format.

Proxies per Asset Type

Type	Video	Image	Audio	Document
‘standard-audio’	Not Available	Not Available	Generated	Not Available
‘dolby-audio’	Not Available	Not Available	Generated	Not Available
‘video-3g’	Generated	Not Available	Not Available	Not Available
‘video-sd’	Generated	Not Available	Not Available	Not Available
‘video-sdplus’	Generated	Not Available	Not Available	Not Available
‘video-hd’	Available on request	Not Available	Not Available	Not Available
‘video-2k’	Available on request	Not Available	Not Available	Not Available
‘video-2kplus’	Available on request	Not Available	Not Available	Not Available
‘document-pdf’	Not Available	Not Available	Not Available	Generated

Filmstrips

The following types of filmstrips can be returned in the filmstrips array found in any resources that return assets.

Filmstrip Types

Type	Description
‘video-filmstrip-small’	200 frames, 60x34 maximum frame resolution.
‘video-filmstrip-scrub’	15 frames, 120x120 maximum frame resolution.

Filmstrips per Asset Type

Type	Video	Image	Audio
‘video-filmstrip-small’	Generated	Not Available	Not Available
‘video-filmstrip-scrub’	Generated	Not Available	Not Available

Waveforms

The following types of waveforms can be returned in the waveforms array found in any resources that return assets.

Waveform Types

Type	Description
‘video-waveform’	2000 maximum samples, amplitudes ranging from -100 to 100.

Waveforms per Asset Type**

Type Video Image Audio

‘video-waveform’ Generated Not Available Not Available

Asset ¶

POST https://api.cimediacloud.com/assets/

Requestssimple examplefull example

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "name": "Movie.mov",
  "size": 1024,
  "workspaceId": "oj7mx3vlb2srei89",
  "folderId": "6ovu49kdb3z32z2w"
}

Property name	Type	Description
name	`string` (required)	The name of the asset, including its extension. Its maximum length is 512 characters.
size	`number` (required)	The size of the asset, in bytes.
workspaceId	`string`	The workspace that will contain the asset. If no value is provided, the asset will be placed in the calling user’s personal workspace.
folderId	`string`	The workspace’s folder that will contain the asset. If no value is provided, the asset will be placed in the workspace’s root folder.

Responses200400

Headers

Content-Type: application/json

Body

{
  "id": "bcdc34b53e2c4c18ac41ca288e28d11f",
  "name": "Movie.mov",
  "size": 107856722,
  "type": "Video",
  "format": "mov",
  "folder": {
    "id": "9b639e12a82f4b0483f512b474dc052ci",
    "name": "Folder Name"
  },
  "status": "Complete",
  "description": "Final cut",
  "thumbnails": [
    {
      "type": "large",
      "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/thumb.jpg",
      "size": 1024,
      "width": 200,
      "height": 300,
      "source": {
        "id": "elementId1",
        "kind": "element"
      },
      "isExternal": false
    }
  ],
  "proxies": [
    {
      "type": "video-3g",
      "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/proxy.jpg",
      "size": 1024,
      "width": 200,
      "height": 300,
      "videoBitRate": 1650000,
      "audioBitRate": 128000,
      "isExternal": false
    }
  ],
  "md5Checksum": "tk2ma0zrhrp5irco",
  "createdOn": "2017-01-02T00:00:00.000Z",
  "createdBy": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith",
    "email": "johnsmith@example.com"
  },
  "modifiedOn": "2017-01-02T00:00:00.000Z",
  "lastActivityOn": "2017-01-03T00:00:00.000Z",
  "acquisitionSource": {
    "name": "Workspace"
  },
  "archiveStatus": "Not archived",
  "archiveType": "Standard",
  "restoreStatus": "Not restored",
  "restoreExpirationDate": "2017-01-02T00:00:00.000Z",
  "restoreRequestDate": "2017-01-02T00:00:00.000Z",
  "lastRestoreDate": "2017-01-02T00:00:00.000Z",
  "restoredBy": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith",
    "email": "johnsmith@example.com"
  },
  "archiveDate": "2017-01-02T00:00:00.000Z",
  "archivedBy": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith",
    "email": "johnsmith@example.com"
  },
  "uploadCompleteDate": "2017-01-02T00:00:00.000Z",
  "isTrashed": false,
  "uploadTransferType": "SinglepartHttp",
  "runtime": 1024,
  "totalFolderCount": 1,
  "network": {
    "id": "40c2a6b99a474b319dec5ef9c7dbb356",
    "name": "Company Name",
    "class": "Enterprise"
  },
  "metadata": [
    {
      "name": "resolution",
      "value": "1080p",
      "readOnly": false
    }
  ],
  "technicalMetadata": {
    "type": "Video",
    "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/metadata.jpg",
    "size": 1024,
    "image": {
      "width": 100,
      "height": 300,
      "xResolution": 100,
      "yResolution": 100,
      "resolutionUnit": "cm",
      "cameraMake": "Nikon",
      "cameraModel": "D300",
      "groupingInfo": "6445055e520106d9d01769fffefd058901000100000000000000",
      "umidBasic": "060a2b340101010501010143130000006445055e520106cbd01769fffefd0589",
      "materialNumber": "6445055e520106cbd01769fffefd0589",
      "recordedDate": "2023-07-27T01:39:24Z",
      "locationCity": "New York",
      "locationState": "NY",
      "locationCountry": "USA",
      "exif": {
        "imageWidth": "3888",
        "imageHeight": "2592",
        "artist": "Michael W. Steidl.",
        "copyright": "(c) 2011 IPTC - Rights reserved."
      },
      "iptc": {
        "codedCharacterSet": "UTF8",
        "headline": "Bikefestival Vienna",
        "credit": "IPTC/Michael W. Steidl",
        "keywords": "Vienna Air King,cycling,mountain bike"
      },
      "xmp": {
        "serialNumber": "0380227035",
        "creatorRegion": "Roshire",
        "lens": "EF70-300mm f/4-5.6L IS USM",
        "creatorCountry": "United Kingdom"
      }
    },
    "avContainer": {
      "bitRate": 11934620,
      "duration": 100,
      "start": 0,
      "recordedDate": "2022-11-21T06:42:41Z",
      "deviceManufacturer": "Sony",
      "timeCode": "00:00:00:00",
      "derivedTimeCode": "00:00:00:00",
      "streams": [
        {
          "index": 0,
          "type": "Video",
          "bitRate": 11934620,
          "bitDepth": 8,
          "bitRateMode": "CBR",
          "codec": "h264",
          "codecName": "ProRes",
          "codecProfile": "422 HQ",
          "codecSettings": "Little / Signed",
          "fourCC": "avc1",
          "width": 1280,
          "height": 720,
          "totalFrames": 1024,
          "duration": 100,
          "frameRateNumerator": 360,
          "frameRateDenominator": 12,
          "videoPARWidth": 1,
          "videoPARHeight": 1,
          "videoDARWidth": 19,
          "videoDARHeight": 24,
          "start": 0,
          "timeCode": "00:00:00:00",
          "videoColorSpace": "bt709",
          "videoScanOrder": "TFF",
          "videoScanType": "Interlaced",
          "videoColorPrimaries": "DCI P3",
          "videoChromaSubsampling": "4:2:2",
          "videoScanTypeStoreMethod": "Interleaved fields",
          "audioSampleRate": 32000,
          "audioChannelCount": 2,
          "audioLayout": "Stereo",
          "audioAnalysis": "Stereo",
          "rotate": 0
        }
      ]
    },
    "dolbyContainer": {
      "duration": 9.6,
      "fileSize": 80294994,
      "overallBitRateMode": "CBR",
      "overallBitRate": 66912495,
      "totalChannels": 58,
      "bedChannels": 10,
      "numberOfBeds": 1,
      "bitDepth": 24,
      "samplingRate": 48000,
      "downmix51X": "Direct Render",
      "trimModesSummary": "automatic + manual_0",
      "trimChannel20Mode": "manual_0",
      "trimChannel51Mode": "manual_0",
      "trimChannel71Mode": "automatic",
      "trimChannel212Mode": "manual_0",
      "trimChannel512Mode": "automatic",
      "trimChannel712Mode": "manual_0",
      "trimChannel214Mode": "manual_0",
      "trimChannel514Mode": "manual_0",
      "trimChannel714Mode": "manual_0",
      "associatedVideoFrameRate": 23.976,
      "start": "01:00:00:00",
      "fFoA": "01:00:00:00",
      "end": "01:03:30:13",
      "metadataFormat": "ADM, Version 0",
      "admProfile": "Dolby Atmos Master, Version 1",
      "numberOfProgrammes": 1,
      "numberOfObjectChannels": 48,
      "numberOfPackFormats": 49,
      "numberOfChannelFormats": 58,
      "binauralRenderModesSummary": "Off + Near + Mid + Far",
      "binauralRenderModesOffCount": 9,
      "binauralRenderModesNearCount": 8,
      "binauralRenderModesMidCount": 13,
      "binauralRenderModesFarCount": 1,
      "truePeakLevels": -3.14,
      "loudness": -16.67
    }
  },
  "hlsPlaylistUrl": "https://cimediacloud.com/t5y7s3ero3w2ie7/hls",
  "acquisitionContext": {
    "name": "Movie1.mov",
    "path": "original/source/path"
  },
  "isExternal": false,
  "workspace": {
    "id": "gb5ehomv0iv71swg",
    "name": "Workspace Name",
    "class": "Enterprise"
  },
  "filmstrips": [
    {
      "type": "video-filmstrip-small",
      "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/filmstrip.jpg",
      "size": 1024,
      "frames": 100,
      "frameHeight": 100,
      "frameWidth": 100,
      "width": 100,
      "height": 1000
    }
  ],
  "waveforms": [
    {
      "type": "video-waveform",
      "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/waveform.jpg",
      "size": 1024,
      "maxAmplitude": 1000,
      "sampleMethod": "SamplesCount",
      "samplesPerSecond": 12,
      "uploadCompleteDate": "2017-01-02T00:00:00.000Z"
    }
  ],
  "isDeleted": false,
  "trashedOn": "2017-01-02T00:00:00.000Z",
  "trashedBy": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith",
    "email": "johnsmith@example.com"
  }
}

Property name	Type	Description
id	`string`	The unique identifier of the asset.
name	`string`	The name of the asset, including its extension. Its maximum length is 512 characters.
size	`number`	The size of the source file, in bytes.
type	`string`	The type of the asset. Valid values are `Audio`, `Video`, `Image`, `Document`, or `Other`.
format	`string`	The asset’s file format.
folder	`object`	Information about the asset’s parent folder.
folder.id	`string`	The unique identifier of the folder.
folder.name	`string`	The name of folder.
status	`string`	The status of the asset. Valid values are ‘Created’, ‘Complete’, ‘Deleted’, ‘Executable Detected’, ‘Failed’, ‘Limited’, ‘Processing’, ‘Uploading’, ‘Virus Detected’, ‘Waiting’. See this section for more information.
description	`string`	A comment or note associated to the asset. Its maximum length is 1000 characters.
thumbnails	`array`	The set of thumbnails for the asset.
thumbnails[].type	`string`	The type of thumbnail returned. Valid values are ‘small’, ‘medium’ and ‘large’.
thumbnails[].location	`string`	The url of the thumbnail.
thumbnails[].size	`number`	The size of the thumbnail, in bytes.
thumbnails[].width	`number`	The width of the thumbnail.
thumbnails[].height	`number`	The height of the thumbnail.
thumbnails[].source	`object`	Information about the source of thumbnails.
thumbnails[].source.id	`string`	Unique identifier of the thumbnail’s source.
thumbnails[].source.kind	`string`	The kind of entity of the thumbnail’s source.
thumbnails[].isExternal	`boolean`	Indicates if the thumbnail is stored in an external source.
proxies	`array`	The set of proxies for the asset.
proxies[].type	`string`	The type of proxy returned. Valid values are ‘standard-audio’, ‘dolby-audio’, ‘video-3g’, ‘video-sd’, ‘video-sdplus’, ‘video-hd’, ‘video-2k’, ‘video-2kplus’, ‘document-pdf’.
proxies[].location	`string`	The url of the proxy.
proxies[].size	`number`	The size of the proxy, in bytes.
proxies[].width	`number`	The width of the proxy.
proxies[].height	`number`	The height of the proxy.
proxies[].videoBitRate	`number`	The video bitrate of the proxy.
proxies[].audioBitRate	`number`	The audio bitrate of the proxy.
proxies[].isExternal	`boolean`	Indicates if the proxy is stored in an external source.
md5Checksum	`string`	The calculated md5 checksum for the asset.
createdOn	`string`	The datetime the asset record was created.
createdBy	`object`	Information about the creator of the asset
createdBy.id	`string`	The unique identifier of the user.
createdBy.name	`string`	The full name of the user.
createdBy.email	`string`	The email of the user.
modifiedOn	`string`	The datetime the asset record was last modified.
lastActivityOn	`string`	The datetime of the last activity of the asset record.
acquisitionSource	`object`	Information about the asset’s source client application.
acquisitionSource.name	`string`	The name of the client application that uploaded the asset.
archiveStatus	`string`	The archive status of the asset. Valid values are ‘Not archived’, ‘Archive in progress’, ‘Archive failed’, ‘Archived’, ‘Cancel archive in progress’.
archiveType	`string`	If available, the kind of archive used for storing the asset. Valid values are `Standard` and `Deep`.
restoreStatus	`string`	The restore status of the asset. This is applicable to assets that have been archived. Valid values are ‘Not restored’, ‘Restore in progress’, ‘Restore failed’, ‘Restored’.
restoreExpirationDate	`string`	If available, the datetime the restored copy of the asset’s source file will no longer be available.
restoreRequestDate	`string`	If available, the datetime the asset’s source file was requested to be restored.
lastRestoreDate	`string`	If available, the datetime the asset’s source file was last restored.
restoredBy	`object`	If available, information about the user who restored the asset.
restoredBy.id	`string`	The unique identifier of the user.
restoredBy.name	`string`	The full name of the user.
restoredBy.email	`string`	The email of the user.
archiveDate	`string`	If available, the datetime the asset’s source file was last archived.
archivedBy	`object`	If available, information about the user who archived the asset.
archivedBy.id	`string`	The unique identifier of the user.
archivedBy.name	`string`	The full name of the user.
archivedBy.email	`string`	The email of the user.
uploadCompleteDate	`string`	The datetime the asset upload was completed.
isTrashed	`boolean`	Indicates if an asset is in the trash bin.
uploadTransferType	`string`	Indicates how the asset was uploaded. Valid values are ‘SinglepartHttp’, ‘MultipartHttp’, ‘Aspera’, ‘Copy’, ‘FTP’, ‘WorkspaceSend’.
runtime	`number`	The duration of the media asset, in seconds.
totalFolderCount	`number`	The amount of folders where the asset exists.
network	`object`	Information about the asset’s network.
network.id	`string`	The unique identifier of the Network.
network.name	`string`	The name of the Network.
network.class	`string`	Indicates if the Network is a ‘Personal’ or ‘Enterprise’ Network.
metadata	`array`	An array of key-value pairs of user-generated and basic technical metadata.
metadata[].name	`string`	The name of the metadata item.
metadata[].value	`string`	the value of the metadata item.
metadata[].readOnly	`boolean`	Flag to set a read-only metadata.
technicalMetadata	`object`	An object that contains all the technical metadata available.
technicalMetadata.type	`string`	The type of the asset. Valid values are either ‘Audio’, ‘Video’ or ‘Image’.
technicalMetadata.location	`string`	Url of the source technical metadata file. Note: the content and structure of the technical metadata file is subject to change at any time.
technicalMetadata.size	`number`	The size of the technical metadata file, in bytes.
technicalMetadata.image	`object`	If the asset’s type is ‘Image’, this property contains the extended image technical metadata.
technicalMetadata.image.width	`number`	The width of the image, in pixels.
technicalMetadata.image.height	`number`	The height of the image, in pixels.
technicalMetadata.image.xResolution	`number`	The number of pixels per resolutionUnit in the width direction.
technicalMetadata.image.yResolution	`number`	The number of pixels per resolutionUnit in the height direction.
technicalMetadata.image.resolutionUnit	`string`	The unit of measurement for xResolution and yResolution. Can be ‘inches’, ‘cm’ or ‘none’.
technicalMetadata.image.cameraMake	`string`	Camera manufacturer name.
technicalMetadata.image.cameraModel	`string`	Camera model name.
technicalMetadata.image.groupingInfo	`string`	If available, the grouping info of the image. String of hexadecimal value (52 characteres) for the byte array object. Byte array order is Litte Endian.
technicalMetadata.image.umidBasic	`string`	If available, the umid basic info of the image. String of hexadecimal value (64 characteres) for the byte array object.
technicalMetadata.image.materialNumber	`string`	If available, the material number of the image. String of hexadecimal value (32 characteres) for the byte array object.
technicalMetadata.image.recordedDate	`string`	The date and Time at which the image was captured.
technicalMetadata.image.locationCity	`string`	Name of the city where the image was created.
technicalMetadata.image.locationState	`string`	Name of the state where the image was created.
technicalMetadata.image.locationCountry	`string`	Name of the country where the image was created.
technicalMetadata.image.exif	`object`	The avalaible EXIF (Exchangeable Image File) metadata.
technicalMetadata.image.exif.imageWidth	`string`	The image width in pixels.
technicalMetadata.image.exif.imageHeight	`string`	The image height in pixels.
technicalMetadata.image.exif.artist	`string`	The image artist info.
technicalMetadata.image.exif.copyright	`string`	The image copyright.
technicalMetadata.image.iptc	`object`	The available IPTC (International Press Telecommunications Council) available.
technicalMetadata.image.iptc.codedCharacterSet	`string`	Determines how the internal IPTC string values are interpreted.
technicalMetadata.image.iptc.headline	`string`	Brief synopsis or summary of the contents of the photograph.
technicalMetadata.image.iptc.credit	`string`	How the image should be credited when published, as specified by the supplier of the image.
technicalMetadata.image.iptc.keywords	`string`	Descriptive words added to the image to enable search and retrieval.
technicalMetadata.image.xmp	`object`	The available XMP (Extensible Metadata Platform) metadata.
technicalMetadata.image.xmp.serialNumber	`string`	Camera Serial Number.
technicalMetadata.image.xmp.creatorRegion	`string`	State / Province for the address of the person that created this image.
technicalMetadata.image.xmp.lens	`string`	Attempts to identify the camera lens used.
technicalMetadata.image.xmp.creatorCountry	`string`	Country name for the address of the person that created this image.
technicalMetadata.avContainer	`object`	If asset type is ‘Audio’ or ‘Video’, this property contains the extended audio / video technical metadata.
technicalMetadata.avContainer.bitRate	`number`	The overall bitrate in the container.
technicalMetadata.avContainer.duration	`number`	The runtime of the media in the container, in seconds.
technicalMetadata.avContainer.start	`number`	The start time in the container, in seconds.
technicalMetadata.avContainer.recordedDate	`string`	The date and Time at which the video was captured.
technicalMetadata.avContainer.deviceManufacturer	`string`	The name of the device Manufacturer.
technicalMetadata.avContainer.timeCode	`string`	The SMPTE timecode in the container.
technicalMetadata.avContainer.derivedTimeCode	`string`	The standardized timecode derived by evaluating stream metadata and converting to drop frame format, if using drop frame rate.
technicalMetadata.avContainer.streams	`array`	Set of audio, video, or data streams contained in the asset.
technicalMetadata.avContainer.streams[].index	`number`	The index of the stream in the container.
technicalMetadata.avContainer.streams[].type	`string`	The type of the stream. Valid values are `Audio`, `Video` or `Data`.
technicalMetadata.avContainer.streams[].bitRate	`number`	If available, the overall bitrate in the stream.
technicalMetadata.avContainer.streams[].bitDepth	`number`	If available, for an `Audio` stream, the bit depth of the stream.
technicalMetadata.avContainer.streams[].bitRateMode	`string`	If available, the bit rate mode of the stream.
technicalMetadata.avContainer.streams[].codec	`string`	If available, the codec used in the stream. For example, `h264`.
technicalMetadata.avContainer.streams[].codecName	`string`	If available, the MediaInfo generated format commercial name for the stream.
technicalMetadata.avContainer.streams[].codecProfile	`string`	If available, the MediaInfo generated format profile for the stream.
technicalMetadata.avContainer.streams[].codecSettings	`string`	If avalable, the MediaInfo generated format settings for the stream.
technicalMetadata.avContainer.streams[].fourCC	`string`	If available, four-character code for the codec used in the stream. For example, `avc1`, `apch`.
technicalMetadata.avContainer.streams[].width	`number`	If available, for a `Video` stream, the width in pixels of the video.
technicalMetadata.avContainer.streams[].height	`number`	If available, for a `Video` stream, the height in pixels of the video.
technicalMetadata.avContainer.streams[].totalFrames	`number`	If available, total number of frames within the `Video` stream.
technicalMetadata.avContainer.streams[].duration	`number`	If available, the runtime of the media in seconds.
technicalMetadata.avContainer.streams[].frameRateNumerator	`number`	If available, the numerator of the frame rate. For example, if the frame rate is 24, the frame rate numerator is 24.
technicalMetadata.avContainer.streams[].frameRateDenominator	`number`	If available, the numerator of the frame rate. For example, if the frame rate is 24, the frame rate denominator is 1.
technicalMetadata.avContainer.streams[].videoPARWidth	`number`	If available, the width part of the pixel aspect ratio.
technicalMetadata.avContainer.streams[].videoPARHeight	`number`	If available, the height part of the pixel aspect ratio.
technicalMetadata.avContainer.streams[].videoDARWidth	`number`	If available, the width part of the display aspect ratio.
technicalMetadata.avContainer.streams[].videoDARHeight	`number`	If available, the height part of the display aspect ratio.
technicalMetadata.avContainer.streams[].start	`number`	If available, the start time in the stream, in seconds.
technicalMetadata.avContainer.streams[].timeCode	`string`	If available, the SMPTE timecode in the stream.
technicalMetadata.avContainer.streams[].videoColorSpace	`string`	If available, for a `Video` stream, the video’s color space / color primaries.
technicalMetadata.avContainer.streams[].videoScanOrder	`string`	If available, for a `Video` stream, the video’s scan order.
technicalMetadata.avContainer.streams[].videoScanType	`string`	If available, for a `Video` stream, the video’s scan type.
technicalMetadata.avContainer.streams[].videoColorPrimaries	`string`	If available, for a `Video` stream, the video’s color primaries.
technicalMetadata.avContainer.streams[].videoChromaSubsampling	`string`	If available, for a `Video` stream, the video’s crhoma subsampling.
technicalMetadata.avContainer.streams[].videoScanTypeStoreMethod	`string`	If available, for a `Video` stream, the video’s scan type store method.
technicalMetadata.avContainer.streams[].audioSampleRate	`number`	If available, for an `Audio` stream, is the sample rate in Hz.
technicalMetadata.avContainer.streams[].audioChannelCount	`number`	If available, for an `Audio` stream, is the number of channels within the stream.
technicalMetadata.avContainer.streams[].audioLayout	`string`	If available, for an `Audio` stream, is the audio channel layout description. For example, `5.1`.
technicalMetadata.avContainer.streams[].audioAnalysis	`string`	If available, for an `Audio` stream, it is further analysis to determine if a stream is true stereo or dual-mono.
technicalMetadata.avContainer.streams[].rotate	`number`	If available, the amount of rotation, in degrees, that should be applied during playback of the video.
technicalMetadata.dolbyContainer	`object`	If asset type is ‘Audio’ and the asset has Dolby Atmos metadata, this property contains the extended Dolby Atmos audio technical metadata.
technicalMetadata.dolbyContainer.duration	`number`	Media duration (in seconds).
technicalMetadata.dolbyContainer.fileSize	`number`	Media size (in bytes).
technicalMetadata.dolbyContainer.overallBitRateMode	`string`	The overall bitrate mode for the Atmos content.
technicalMetadata.dolbyContainer.overallBitRate	`number`	Media bitrate (in bits per second).
technicalMetadata.dolbyContainer.totalChannels	`number`	Number of channels. `Bed channels` plus `Object channels` equals `Total channels`.
technicalMetadata.dolbyContainer.bedChannels	`number`	Number of channel-based premix or stem that includes multichannel panning.
technicalMetadata.dolbyContainer.numberOfBeds	`number`	A bed can be thought of as a traditional channel-based stem with the rules and expectations of stem configurations (such as 2.0, 5.1, and 7.1).
technicalMetadata.dolbyContainer.bitDepth	`number`	Number of bits of information in each sample, generally 16, 24, or 32-bit.
technicalMetadata.dolbyContainer.samplingRate	`number`	Audio sample-rate, generally 44100 or 48000 Hz.
technicalMetadata.dolbyContainer.downmix51X	`string`	Global downmix metadata for monitoring, re-rendering, and encoding.
technicalMetadata.dolbyContainer.trimModesSummary	`string`	A summary of the underlying trim modes.
technicalMetadata.dolbyContainer.trimChannel20Mode	`string`	The type of trim mode supported for 2.0 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
technicalMetadata.dolbyContainer.trimChannel51Mode	`string`	The type of trim mode supported for 5.1 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
technicalMetadata.dolbyContainer.trimChannel71Mode	`string`	The type of trim mode supported for 7.1 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
technicalMetadata.dolbyContainer.trimChannel212Mode	`string`	The type of trim mode supported for 2.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
technicalMetadata.dolbyContainer.trimChannel512Mode	`string`	The type of trim mode supported for 5.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
technicalMetadata.dolbyContainer.trimChannel712Mode	`string`	The type of trim mode supported for 7.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
technicalMetadata.dolbyContainer.trimChannel214Mode	`string`	The type of trim mode supported for 2.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
technicalMetadata.dolbyContainer.trimChannel514Mode	`string`	The type of trim mode supported for 5.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
technicalMetadata.dolbyContainer.trimChannel714Mode	`string`	The type of trim mode supported for 7.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
technicalMetadata.dolbyContainer.associatedVideoFrameRate	`number`	Number of frames per second.
technicalMetadata.dolbyContainer.start	`string`	Start SMPTE timecode based on the video frame rate.
technicalMetadata.dolbyContainer.fFoA	`string`	FFoA (First Frame of Action) SMPTE timecode based on the video frame rate.
technicalMetadata.dolbyContainer.end	`string`	End SMPTE timecode based on the video frame rate.
technicalMetadata.dolbyContainer.metadataFormat	`string`	Format of the metadata in the Atmos content.
technicalMetadata.dolbyContainer.admProfile	`string`	ADM (Audio Definition Model) Profile used in the Atmos content.
technicalMetadata.dolbyContainer.numberOfProgrammes	`number`	Number of programmes in the Atmos content.
technicalMetadata.dolbyContainer.numberOfObjectChannels	`number`	Number of objects in the Atmos Master.
technicalMetadata.dolbyContainer.numberOfPackFormats	`number`	Number of Atmos Pack Formats in the Atmos content.
technicalMetadata.dolbyContainer.numberOfChannelFormats	`number`	Number of channel formats in the Atmos content.
technicalMetadata.dolbyContainer.binauralRenderModesSummary	`string`	Summary of all the binaural render modes used in the Atmos content. Supported strings are a unique combination of: “Off”, “Near”, “Mid”, “Far”.
technicalMetadata.dolbyContainer.binauralRenderModesOffCount	`number`	Number of channels that use the “Off” setting for binaural rendering.
technicalMetadata.dolbyContainer.binauralRenderModesNearCount	`number`	Number of channels that use the “Near” setting for binaural rendering.
technicalMetadata.dolbyContainer.binauralRenderModesMidCount	`number`	Number of channels that use the “Mid” setting for binaural rendering.
technicalMetadata.dolbyContainer.binauralRenderModesFarCount	`number`	Number of channels that use the “Far” setting for binaural rendering.
technicalMetadata.dolbyContainer.truePeakLevels	`number`	The peak event in the audio waveform. Units are dBTP for true peak.
technicalMetadata.dolbyContainer.loudness	`number`	Integrated loudness LKFS (or LUFS).
hlsPlaylistUrl	`string`	A link to the HLS playlist generated from the source file.
acquisitionContext	`object`	The file acquisition information.
acquisitionContext.name	`string`	The original source file name, captured on acquisition.
acquisitionContext.path	`string`	The original source file path, captured on acquisition.
isExternal	`boolean`	Indicates if the file is stored in an external source.
workspace	`object`	Information about the asset’s workspace.
workspace.id	`string`	The unique identifier of the Workspace.
workspace.name	`string`	The name of the Workspace.
workspace.class	`string`	Indicates if the Workspace is a ‘Personal’ or ‘Team’ Workspace.
filmstrips	`array`	The set of filmstrips for the asset. Please check the Previews section for more information.
filmstrips[].type	`string`	The type of filmstrip returned.
filmstrips[].location	`string`	The url of the filmstrip.
filmstrips[].size	`number`	The size of the filmstrip, in bytes.
filmstrips[].frames	`number`	Number of frames contained in the filmstrip.
filmstrips[].frameHeight	`number`	The height of each frame.
filmstrips[].frameWidth	`number`	The width of each frame.
filmstrips[].width	`number`	Total width of the filmstrip.
filmstrips[].height	`number`	Total height of the filmstrip.
waveforms	`array`	The set of waveforms for the asset. Please check the Previews section for more information.
waveforms[].type	`string`	The type of waveform returned.
waveforms[].location	`string`	The url of the waveform.
waveforms[].size	`number`	The size in bytes of the waveform.
waveforms[].maxAmplitude	`number`	Sample values will range from this number to its additive inverse. For example, if this value is 100, then samples within the waveform file will have values between -100 and 100.
waveforms[].sampleMethod	`string`	The type of sample method used to extract samples from the source audio stream. Supported values are ‘SamplesCount’ and ‘SamplesPerSecond’. When ‘SamplesCount’ is returned, then a fixed number of samples was extracted, spanning the duration of the source audio stream. When ‘SamplesPerSecond’ is returned, then a fixed number of samples was extracted per second of audio.
waveforms[].samplesPerSecond	`number`	When the sampleMethod is ‘SamplesPerSecond’, this value indicates the number of samples that were extracted for each second of audio.
waveforms[].uploadCompleteDate	`string`	The datetime the asset upload was completed.
isDeleted	`boolean`	Indicates if an asset is deleted.
trashedOn	`string`	The datetime the asset was trashed.
trashedBy	`object`	Information about the user that trashed the asset.
trashedBy.id	`string`	The unique identifier of the user.
trashedBy.name	`string`	The full name of the user.
trashedBy.email	`string`	The email of the user.

Headers

Content-Type: application/json

Body

{
  "code": "FolderNotFound",
  "message": "Folder not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "name": "Movie.mov",
  "size": 1024,
  "workspaceId": "oj7mx3vlb2srei89",
  "folderId": "6ovu49kdb3z32z2w",
  "description": "sample description",
  "metadata": {
    "key name 1": "value",
    "key name 2": "value"
  },
  "ingestConfiguration": {
    "autoArchive": true,
    "audioMappings": [
      {
        "mappings": [
          {
            "sourceStream": 1,
            "sourceChannel": 2,
            "targetChannel": 3,
            "amplitude": 0.8
          }
        ]
      }
    ]
  }
}

Property name	Type	Description
name	`string` (required)	The name of the asset, including its extension. Its maximum length is 512 characters.
size	`number` (required)	The size of the asset, in bytes.
workspaceId	`string`	The workspace that will contain the asset. If no value is provided, the asset will be placed in the calling user’s personal workspace.
folderId	`string`	The workspace’s folder that will contain the asset. If no value is provided, the asset will be placed in the workspace’s root folder.
description	`string`	A brief note associated to the asset. Its maximum length is 1000 characters.
metadata	`object`	An object containing key-value pairs of user-generated metadata.
metadata.key name 1	`string`	An example key-value.
metadata.key name 2	`string`	An example key-value.
ingestConfiguration	`object`	Settings for customizing the ingest process of the asset.
ingestConfiguration.autoArchive	`boolean`	Indicates if the asset shall be archived right after ingestion.
ingestConfiguration.audioMappings	`array`	A set of objects that specifies ingest customizations that will be used when generating proxies. Currently, we support a single object in this array. If more than 1 object is provided, only the first will be processed and the rest will be ignored.
ingestConfiguration.audioMappings[].mappings	`array`	A set of objects that defines the mapping of a source file’s audio streams to the proxies’ audio streams.
ingestConfiguration.audioMappings[].mappings[].sourceStream	`number`	Index of an audio stream from the source file that will be mapped to each proxy’s audio stream. This index is zero-based.
ingestConfiguration.audioMappings[].mappings[].sourceChannel	`number`	Channel index of the specified source stream that will be mapped to each proxy’s target channels. This index is zero-based and the default is 0.
ingestConfiguration.audioMappings[].mappings[].targetChannel	`number`	Channel index of the proxies’ audio stream. This index is zero-based and the default is 0.
ingestConfiguration.audioMappings[].mappings[].amplitude	`number`	Number between 0 and 1 that determines the amplitude of the proxies’ target channel based on the source channel amplitude. Default is 1.

Responses200400

Headers

Content-Type: application/json

Body

{
  "id": "bcdc34b53e2c4c18ac41ca288e28d11f",
  "name": "Movie.mov",
  "size": 107856722,
  "type": "Video",
  "format": "mov",
  "folder": {
    "id": "9b639e12a82f4b0483f512b474dc052ci",
    "name": "Folder Name"
  },
  "status": "Complete",
  "description": "Final cut",
  "thumbnails": [
    {
      "type": "large",
      "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/thumb.jpg",
      "size": 1024,
      "width": 200,
      "height": 300,
      "source": {
        "id": "elementId1",
        "kind": "element"
      },
      "isExternal": false
    }
  ],
  "proxies": [
    {
      "type": "video-3g",
      "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/proxy.jpg",
      "size": 1024,
      "width": 200,
      "height": 300,
      "videoBitRate": 1650000,
      "audioBitRate": 128000,
      "isExternal": false
    }
  ],
  "md5Checksum": "tk2ma0zrhrp5irco",
  "createdOn": "2017-01-02T00:00:00.000Z",
  "createdBy": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith",
    "email": "johnsmith@example.com"
  },
  "modifiedOn": "2017-01-02T00:00:00.000Z",
  "lastActivityOn": "2017-01-03T00:00:00.000Z",
  "acquisitionSource": {
    "name": "Workspace"
  },
  "archiveStatus": "Not archived",
  "archiveType": "Standard",
  "restoreStatus": "Not restored",
  "restoreExpirationDate": "2017-01-02T00:00:00.000Z",
  "restoreRequestDate": "2017-01-02T00:00:00.000Z",
  "lastRestoreDate": "2017-01-02T00:00:00.000Z",
  "restoredBy": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith",
    "email": "johnsmith@example.com"
  },
  "archiveDate": "2017-01-02T00:00:00.000Z",
  "archivedBy": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith",
    "email": "johnsmith@example.com"
  },
  "uploadCompleteDate": "2017-01-02T00:00:00.000Z",
  "isTrashed": false,
  "uploadTransferType": "SinglepartHttp",
  "runtime": 1024,
  "totalFolderCount": 1,
  "network": {
    "id": "40c2a6b99a474b319dec5ef9c7dbb356",
    "name": "Company Name",
    "class": "Enterprise"
  },
  "metadata": [
    {
      "name": "resolution",
      "value": "1080p",
      "readOnly": false
    }
  ],
  "technicalMetadata": {
    "type": "Video",
    "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/metadata.jpg",
    "size": 1024,
    "image": {
      "width": 100,
      "height": 300,
      "xResolution": 100,
      "yResolution": 100,
      "resolutionUnit": "cm",
      "cameraMake": "Nikon",
      "cameraModel": "D300",
      "groupingInfo": "6445055e520106d9d01769fffefd058901000100000000000000",
      "umidBasic": "060a2b340101010501010143130000006445055e520106cbd01769fffefd0589",
      "materialNumber": "6445055e520106cbd01769fffefd0589",
      "recordedDate": "2023-07-27T01:39:24Z",
      "locationCity": "New York",
      "locationState": "NY",
      "locationCountry": "USA",
      "exif": {
        "imageWidth": "3888",
        "imageHeight": "2592",
        "artist": "Michael W. Steidl.",
        "copyright": "(c) 2011 IPTC - Rights reserved."
      },
      "iptc": {
        "codedCharacterSet": "UTF8",
        "headline": "Bikefestival Vienna",
        "credit": "IPTC/Michael W. Steidl",
        "keywords": "Vienna Air King,cycling,mountain bike"
      },
      "xmp": {
        "serialNumber": "0380227035",
        "creatorRegion": "Roshire",
        "lens": "EF70-300mm f/4-5.6L IS USM",
        "creatorCountry": "United Kingdom"
      }
    },
    "avContainer": {
      "bitRate": 11934620,
      "duration": 100,
      "start": 0,
      "recordedDate": "2022-11-21T06:42:41Z",
      "deviceManufacturer": "Sony",
      "timeCode": "00:00:00:00",
      "derivedTimeCode": "00:00:00:00",
      "streams": [
        {
          "index": 0,
          "type": "Video",
          "bitRate": 11934620,
          "bitDepth": 8,
          "bitRateMode": "CBR",
          "codec": "h264",
          "codecName": "ProRes",
          "codecProfile": "422 HQ",
          "codecSettings": "Little / Signed",
          "fourCC": "avc1",
          "width": 1280,
          "height": 720,
          "totalFrames": 1024,
          "duration": 100,
          "frameRateNumerator": 360,
          "frameRateDenominator": 12,
          "videoPARWidth": 1,
          "videoPARHeight": 1,
          "videoDARWidth": 19,
          "videoDARHeight": 24,
          "start": 0,
          "timeCode": "00:00:00:00",
          "videoColorSpace": "bt709",
          "videoScanOrder": "TFF",
          "videoScanType": "Interlaced",
          "videoColorPrimaries": "DCI P3",
          "videoChromaSubsampling": "4:2:2",
          "videoScanTypeStoreMethod": "Interleaved fields",
          "audioSampleRate": 32000,
          "audioChannelCount": 2,
          "audioLayout": "Stereo",
          "audioAnalysis": "Stereo",
          "rotate": 0
        }
      ]
    },
    "dolbyContainer": {
      "duration": 9.6,
      "fileSize": 80294994,
      "overallBitRateMode": "CBR",
      "overallBitRate": 66912495,
      "totalChannels": 58,
      "bedChannels": 10,
      "numberOfBeds": 1,
      "bitDepth": 24,
      "samplingRate": 48000,
      "downmix51X": "Direct Render",
      "trimModesSummary": "automatic + manual_0",
      "trimChannel20Mode": "manual_0",
      "trimChannel51Mode": "manual_0",
      "trimChannel71Mode": "automatic",
      "trimChannel212Mode": "manual_0",
      "trimChannel512Mode": "automatic",
      "trimChannel712Mode": "manual_0",
      "trimChannel214Mode": "manual_0",
      "trimChannel514Mode": "manual_0",
      "trimChannel714Mode": "manual_0",
      "associatedVideoFrameRate": 23.976,
      "start": "01:00:00:00",
      "fFoA": "01:00:00:00",
      "end": "01:03:30:13",
      "metadataFormat": "ADM, Version 0",
      "admProfile": "Dolby Atmos Master, Version 1",
      "numberOfProgrammes": 1,
      "numberOfObjectChannels": 48,
      "numberOfPackFormats": 49,
      "numberOfChannelFormats": 58,
      "binauralRenderModesSummary": "Off + Near + Mid + Far",
      "binauralRenderModesOffCount": 9,
      "binauralRenderModesNearCount": 8,
      "binauralRenderModesMidCount": 13,
      "binauralRenderModesFarCount": 1,
      "truePeakLevels": -3.14,
      "loudness": -16.67
    }
  },
  "hlsPlaylistUrl": "https://cimediacloud.com/t5y7s3ero3w2ie7/hls",
  "acquisitionContext": {
    "name": "Movie1.mov",
    "path": "original/source/path"
  },
  "isExternal": false,
  "workspace": {
    "id": "gb5ehomv0iv71swg",
    "name": "Workspace Name",
    "class": "Enterprise"
  },
  "filmstrips": [
    {
      "type": "video-filmstrip-small",
      "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/filmstrip.jpg",
      "size": 1024,
      "frames": 100,
      "frameHeight": 100,
      "frameWidth": 100,
      "width": 100,
      "height": 1000
    }
  ],
  "waveforms": [
    {
      "type": "video-waveform",
      "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/waveform.jpg",
      "size": 1024,
      "maxAmplitude": 1000,
      "sampleMethod": "SamplesCount",
      "samplesPerSecond": 12,
      "uploadCompleteDate": "2017-01-02T00:00:00.000Z"
    }
  ],
  "isDeleted": false,
  "trashedOn": "2017-01-02T00:00:00.000Z",
  "trashedBy": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith",
    "email": "johnsmith@example.com"
  }
}

Property name	Type	Description
id	`string`	The unique identifier of the asset.
name	`string`	The name of the asset, including its extension. Its maximum length is 512 characters.
size	`number`	The size of the source file, in bytes.
type	`string`	The type of the asset. Valid values are `Audio`, `Video`, `Image`, `Document`, or `Other`.
format	`string`	The asset’s file format.
folder	`object`	Information about the asset’s parent folder.
folder.id	`string`	The unique identifier of the folder.
folder.name	`string`	The name of folder.
status	`string`	The status of the asset. Valid values are ‘Created’, ‘Complete’, ‘Deleted’, ‘Executable Detected’, ‘Failed’, ‘Limited’, ‘Processing’, ‘Uploading’, ‘Virus Detected’, ‘Waiting’. See this section for more information.
description	`string`	A comment or note associated to the asset. Its maximum length is 1000 characters.
thumbnails	`array`	The set of thumbnails for the asset.
thumbnails[].type	`string`	The type of thumbnail returned. Valid values are ‘small’, ‘medium’ and ‘large’.
thumbnails[].location	`string`	The url of the thumbnail.
thumbnails[].size	`number`	The size of the thumbnail, in bytes.
thumbnails[].width	`number`	The width of the thumbnail.
thumbnails[].height	`number`	The height of the thumbnail.
thumbnails[].source	`object`	Information about the source of thumbnails.
thumbnails[].source.id	`string`	Unique identifier of the thumbnail’s source.
thumbnails[].source.kind	`string`	The kind of entity of the thumbnail’s source.
thumbnails[].isExternal	`boolean`	Indicates if the thumbnail is stored in an external source.
proxies	`array`	The set of proxies for the asset.
proxies[].type	`string`	The type of proxy returned. Valid values are ‘standard-audio’, ‘dolby-audio’, ‘video-3g’, ‘video-sd’, ‘video-sdplus’, ‘video-hd’, ‘video-2k’, ‘video-2kplus’, ‘document-pdf’.
proxies[].location	`string`	The url of the proxy.
proxies[].size	`number`	The size of the proxy, in bytes.
proxies[].width	`number`	The width of the proxy.
proxies[].height	`number`	The height of the proxy.
proxies[].videoBitRate	`number`	The video bitrate of the proxy.
proxies[].audioBitRate	`number`	The audio bitrate of the proxy.
proxies[].isExternal	`boolean`	Indicates if the proxy is stored in an external source.
md5Checksum	`string`	The calculated md5 checksum for the asset.
createdOn	`string`	The datetime the asset record was created.
createdBy	`object`	Information about the creator of the asset
createdBy.id	`string`	The unique identifier of the user.
createdBy.name	`string`	The full name of the user.
createdBy.email	`string`	The email of the user.
modifiedOn	`string`	The datetime the asset record was last modified.
lastActivityOn	`string`	The datetime of the last activity of the asset record.
acquisitionSource	`object`	Information about the asset’s source client application.
acquisitionSource.name	`string`	The name of the client application that uploaded the asset.
archiveStatus	`string`	The archive status of the asset. Valid values are ‘Not archived’, ‘Archive in progress’, ‘Archive failed’, ‘Archived’, ‘Cancel archive in progress’.
archiveType	`string`	If available, the kind of archive used for storing the asset. Valid values are `Standard` and `Deep`.
restoreStatus	`string`	The restore status of the asset. This is applicable to assets that have been archived. Valid values are ‘Not restored’, ‘Restore in progress’, ‘Restore failed’, ‘Restored’.
restoreExpirationDate	`string`	If available, the datetime the restored copy of the asset’s source file will no longer be available.
restoreRequestDate	`string`	If available, the datetime the asset’s source file was requested to be restored.
lastRestoreDate	`string`	If available, the datetime the asset’s source file was last restored.
restoredBy	`object`	If available, information about the user who restored the asset.
restoredBy.id	`string`	The unique identifier of the user.
restoredBy.name	`string`	The full name of the user.
restoredBy.email	`string`	The email of the user.
archiveDate	`string`	If available, the datetime the asset’s source file was last archived.
archivedBy	`object`	If available, information about the user who archived the asset.
archivedBy.id	`string`	The unique identifier of the user.
archivedBy.name	`string`	The full name of the user.
archivedBy.email	`string`	The email of the user.
uploadCompleteDate	`string`	The datetime the asset upload was completed.
isTrashed	`boolean`	Indicates if an asset is in the trash bin.
uploadTransferType	`string`	Indicates how the asset was uploaded. Valid values are ‘SinglepartHttp’, ‘MultipartHttp’, ‘Aspera’, ‘Copy’, ‘FTP’, ‘WorkspaceSend’.
runtime	`number`	The duration of the media asset, in seconds.
totalFolderCount	`number`	The amount of folders where the asset exists.
network	`object`	Information about the asset’s network.
network.id	`string`	The unique identifier of the Network.
network.name	`string`	The name of the Network.
network.class	`string`	Indicates if the Network is a ‘Personal’ or ‘Enterprise’ Network.
metadata	`array`	An array of key-value pairs of user-generated and basic technical metadata.
metadata[].name	`string`	The name of the metadata item.
metadata[].value	`string`	the value of the metadata item.
metadata[].readOnly	`boolean`	Flag to set a read-only metadata.
technicalMetadata	`object`	An object that contains all the technical metadata available.
technicalMetadata.type	`string`	The type of the asset. Valid values are either ‘Audio’, ‘Video’ or ‘Image’.
technicalMetadata.location	`string`	Url of the source technical metadata file. Note: the content and structure of the technical metadata file is subject to change at any time.
technicalMetadata.size	`number`	The size of the technical metadata file, in bytes.
technicalMetadata.image	`object`	If the asset’s type is ‘Image’, this property contains the extended image technical metadata.
technicalMetadata.image.width	`number`	The width of the image, in pixels.
technicalMetadata.image.height	`number`	The height of the image, in pixels.
technicalMetadata.image.xResolution	`number`	The number of pixels per resolutionUnit in the width direction.
technicalMetadata.image.yResolution	`number`	The number of pixels per resolutionUnit in the height direction.
technicalMetadata.image.resolutionUnit	`string`	The unit of measurement for xResolution and yResolution. Can be ‘inches’, ‘cm’ or ‘none’.
technicalMetadata.image.cameraMake	`string`	Camera manufacturer name.
technicalMetadata.image.cameraModel	`string`	Camera model name.
technicalMetadata.image.groupingInfo	`string`	If available, the grouping info of the image. String of hexadecimal value (52 characteres) for the byte array object. Byte array order is Litte Endian.
technicalMetadata.image.umidBasic	`string`	If available, the umid basic info of the image. String of hexadecimal value (64 characteres) for the byte array object.
technicalMetadata.image.materialNumber	`string`	If available, the material number of the image. String of hexadecimal value (32 characteres) for the byte array object.
technicalMetadata.image.recordedDate	`string`	The date and Time at which the image was captured.
technicalMetadata.image.locationCity	`string`	Name of the city where the image was created.
technicalMetadata.image.locationState	`string`	Name of the state where the image was created.
technicalMetadata.image.locationCountry	`string`	Name of the country where the image was created.
technicalMetadata.image.exif	`object`	The avalaible EXIF (Exchangeable Image File) metadata.
technicalMetadata.image.exif.imageWidth	`string`	The image width in pixels.
technicalMetadata.image.exif.imageHeight	`string`	The image height in pixels.
technicalMetadata.image.exif.artist	`string`	The image artist info.
technicalMetadata.image.exif.copyright	`string`	The image copyright.
technicalMetadata.image.iptc	`object`	The available IPTC (International Press Telecommunications Council) available.
technicalMetadata.image.iptc.codedCharacterSet	`string`	Determines how the internal IPTC string values are interpreted.
technicalMetadata.image.iptc.headline	`string`	Brief synopsis or summary of the contents of the photograph.
technicalMetadata.image.iptc.credit	`string`	How the image should be credited when published, as specified by the supplier of the image.
technicalMetadata.image.iptc.keywords	`string`	Descriptive words added to the image to enable search and retrieval.
technicalMetadata.image.xmp	`object`	The available XMP (Extensible Metadata Platform) metadata.
technicalMetadata.image.xmp.serialNumber	`string`	Camera Serial Number.
technicalMetadata.image.xmp.creatorRegion	`string`	State / Province for the address of the person that created this image.
technicalMetadata.image.xmp.lens	`string`	Attempts to identify the camera lens used.
technicalMetadata.image.xmp.creatorCountry	`string`	Country name for the address of the person that created this image.
technicalMetadata.avContainer	`object`	If asset type is ‘Audio’ or ‘Video’, this property contains the extended audio / video technical metadata.
technicalMetadata.avContainer.bitRate	`number`	The overall bitrate in the container.
technicalMetadata.avContainer.duration	`number`	The runtime of the media in the container, in seconds.
technicalMetadata.avContainer.start	`number`	The start time in the container, in seconds.
technicalMetadata.avContainer.recordedDate	`string`	The date and Time at which the video was captured.
technicalMetadata.avContainer.deviceManufacturer	`string`	The name of the device Manufacturer.
technicalMetadata.avContainer.timeCode	`string`	The SMPTE timecode in the container.
technicalMetadata.avContainer.derivedTimeCode	`string`	The standardized timecode derived by evaluating stream metadata and converting to drop frame format, if using drop frame rate.
technicalMetadata.avContainer.streams	`array`	Set of audio, video, or data streams contained in the asset.
technicalMetadata.avContainer.streams[].index	`number`	The index of the stream in the container.
technicalMetadata.avContainer.streams[].type	`string`	The type of the stream. Valid values are `Audio`, `Video` or `Data`.
technicalMetadata.avContainer.streams[].bitRate	`number`	If available, the overall bitrate in the stream.
technicalMetadata.avContainer.streams[].bitDepth	`number`	If available, for an `Audio` stream, the bit depth of the stream.
technicalMetadata.avContainer.streams[].bitRateMode	`string`	If available, the bit rate mode of the stream.
technicalMetadata.avContainer.streams[].codec	`string`	If available, the codec used in the stream. For example, `h264`.
technicalMetadata.avContainer.streams[].codecName	`string`	If available, the MediaInfo generated format commercial name for the stream.
technicalMetadata.avContainer.streams[].codecProfile	`string`	If available, the MediaInfo generated format profile for the stream.
technicalMetadata.avContainer.streams[].codecSettings	`string`	If avalable, the MediaInfo generated format settings for the stream.
technicalMetadata.avContainer.streams[].fourCC	`string`	If available, four-character code for the codec used in the stream. For example, `avc1`, `apch`.
technicalMetadata.avContainer.streams[].width	`number`	If available, for a `Video` stream, the width in pixels of the video.
technicalMetadata.avContainer.streams[].height	`number`	If available, for a `Video` stream, the height in pixels of the video.
technicalMetadata.avContainer.streams[].totalFrames	`number`	If available, total number of frames within the `Video` stream.
technicalMetadata.avContainer.streams[].duration	`number`	If available, the runtime of the media in seconds.
technicalMetadata.avContainer.streams[].frameRateNumerator	`number`	If available, the numerator of the frame rate. For example, if the frame rate is 24, the frame rate numerator is 24.
technicalMetadata.avContainer.streams[].frameRateDenominator	`number`	If available, the numerator of the frame rate. For example, if the frame rate is 24, the frame rate denominator is 1.
technicalMetadata.avContainer.streams[].videoPARWidth	`number`	If available, the width part of the pixel aspect ratio.
technicalMetadata.avContainer.streams[].videoPARHeight	`number`	If available, the height part of the pixel aspect ratio.
technicalMetadata.avContainer.streams[].videoDARWidth	`number`	If available, the width part of the display aspect ratio.
technicalMetadata.avContainer.streams[].videoDARHeight	`number`	If available, the height part of the display aspect ratio.
technicalMetadata.avContainer.streams[].start	`number`	If available, the start time in the stream, in seconds.
technicalMetadata.avContainer.streams[].timeCode	`string`	If available, the SMPTE timecode in the stream.
technicalMetadata.avContainer.streams[].videoColorSpace	`string`	If available, for a `Video` stream, the video’s color space / color primaries.
technicalMetadata.avContainer.streams[].videoScanOrder	`string`	If available, for a `Video` stream, the video’s scan order.
technicalMetadata.avContainer.streams[].videoScanType	`string`	If available, for a `Video` stream, the video’s scan type.
technicalMetadata.avContainer.streams[].videoColorPrimaries	`string`	If available, for a `Video` stream, the video’s color primaries.
technicalMetadata.avContainer.streams[].videoChromaSubsampling	`string`	If available, for a `Video` stream, the video’s crhoma subsampling.
technicalMetadata.avContainer.streams[].videoScanTypeStoreMethod	`string`	If available, for a `Video` stream, the video’s scan type store method.
technicalMetadata.avContainer.streams[].audioSampleRate	`number`	If available, for an `Audio` stream, is the sample rate in Hz.
technicalMetadata.avContainer.streams[].audioChannelCount	`number`	If available, for an `Audio` stream, is the number of channels within the stream.
technicalMetadata.avContainer.streams[].audioLayout	`string`	If available, for an `Audio` stream, is the audio channel layout description. For example, `5.1`.
technicalMetadata.avContainer.streams[].audioAnalysis	`string`	If available, for an `Audio` stream, it is further analysis to determine if a stream is true stereo or dual-mono.
technicalMetadata.avContainer.streams[].rotate	`number`	If available, the amount of rotation, in degrees, that should be applied during playback of the video.
technicalMetadata.dolbyContainer	`object`	If asset type is ‘Audio’ and the asset has Dolby Atmos metadata, this property contains the extended Dolby Atmos audio technical metadata.
technicalMetadata.dolbyContainer.duration	`number`	Media duration (in seconds).
technicalMetadata.dolbyContainer.fileSize	`number`	Media size (in bytes).
technicalMetadata.dolbyContainer.overallBitRateMode	`string`	The overall bitrate mode for the Atmos content.
technicalMetadata.dolbyContainer.overallBitRate	`number`	Media bitrate (in bits per second).
technicalMetadata.dolbyContainer.totalChannels	`number`	Number of channels. `Bed channels` plus `Object channels` equals `Total channels`.
technicalMetadata.dolbyContainer.bedChannels	`number`	Number of channel-based premix or stem that includes multichannel panning.
technicalMetadata.dolbyContainer.numberOfBeds	`number`	A bed can be thought of as a traditional channel-based stem with the rules and expectations of stem configurations (such as 2.0, 5.1, and 7.1).
technicalMetadata.dolbyContainer.bitDepth	`number`	Number of bits of information in each sample, generally 16, 24, or 32-bit.
technicalMetadata.dolbyContainer.samplingRate	`number`	Audio sample-rate, generally 44100 or 48000 Hz.
technicalMetadata.dolbyContainer.downmix51X	`string`	Global downmix metadata for monitoring, re-rendering, and encoding.
technicalMetadata.dolbyContainer.trimModesSummary	`string`	A summary of the underlying trim modes.
technicalMetadata.dolbyContainer.trimChannel20Mode	`string`	The type of trim mode supported for 2.0 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
technicalMetadata.dolbyContainer.trimChannel51Mode	`string`	The type of trim mode supported for 5.1 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
technicalMetadata.dolbyContainer.trimChannel71Mode	`string`	The type of trim mode supported for 7.1 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
technicalMetadata.dolbyContainer.trimChannel212Mode	`string`	The type of trim mode supported for 2.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
technicalMetadata.dolbyContainer.trimChannel512Mode	`string`	The type of trim mode supported for 5.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
technicalMetadata.dolbyContainer.trimChannel712Mode	`string`	The type of trim mode supported for 7.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
technicalMetadata.dolbyContainer.trimChannel214Mode	`string`	The type of trim mode supported for 2.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
technicalMetadata.dolbyContainer.trimChannel514Mode	`string`	The type of trim mode supported for 5.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
technicalMetadata.dolbyContainer.trimChannel714Mode	`string`	The type of trim mode supported for 7.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
technicalMetadata.dolbyContainer.associatedVideoFrameRate	`number`	Number of frames per second.
technicalMetadata.dolbyContainer.start	`string`	Start SMPTE timecode based on the video frame rate.
technicalMetadata.dolbyContainer.fFoA	`string`	FFoA (First Frame of Action) SMPTE timecode based on the video frame rate.
technicalMetadata.dolbyContainer.end	`string`	End SMPTE timecode based on the video frame rate.
technicalMetadata.dolbyContainer.metadataFormat	`string`	Format of the metadata in the Atmos content.
technicalMetadata.dolbyContainer.admProfile	`string`	ADM (Audio Definition Model) Profile used in the Atmos content.
technicalMetadata.dolbyContainer.numberOfProgrammes	`number`	Number of programmes in the Atmos content.
technicalMetadata.dolbyContainer.numberOfObjectChannels	`number`	Number of objects in the Atmos Master.
technicalMetadata.dolbyContainer.numberOfPackFormats	`number`	Number of Atmos Pack Formats in the Atmos content.
technicalMetadata.dolbyContainer.numberOfChannelFormats	`number`	Number of channel formats in the Atmos content.
technicalMetadata.dolbyContainer.binauralRenderModesSummary	`string`	Summary of all the binaural render modes used in the Atmos content. Supported strings are a unique combination of: “Off”, “Near”, “Mid”, “Far”.
technicalMetadata.dolbyContainer.binauralRenderModesOffCount	`number`	Number of channels that use the “Off” setting for binaural rendering.
technicalMetadata.dolbyContainer.binauralRenderModesNearCount	`number`	Number of channels that use the “Near” setting for binaural rendering.
technicalMetadata.dolbyContainer.binauralRenderModesMidCount	`number`	Number of channels that use the “Mid” setting for binaural rendering.
technicalMetadata.dolbyContainer.binauralRenderModesFarCount	`number`	Number of channels that use the “Far” setting for binaural rendering.
technicalMetadata.dolbyContainer.truePeakLevels	`number`	The peak event in the audio waveform. Units are dBTP for true peak.
technicalMetadata.dolbyContainer.loudness	`number`	Integrated loudness LKFS (or LUFS).
hlsPlaylistUrl	`string`	A link to the HLS playlist generated from the source file.
acquisitionContext	`object`	The file acquisition information.
acquisitionContext.name	`string`	The original source file name, captured on acquisition.
acquisitionContext.path	`string`	The original source file path, captured on acquisition.
isExternal	`boolean`	Indicates if the file is stored in an external source.
workspace	`object`	Information about the asset’s workspace.
workspace.id	`string`	The unique identifier of the Workspace.
workspace.name	`string`	The name of the Workspace.
workspace.class	`string`	Indicates if the Workspace is a ‘Personal’ or ‘Team’ Workspace.
filmstrips	`array`	The set of filmstrips for the asset. Please check the Previews section for more information.
filmstrips[].type	`string`	The type of filmstrip returned.
filmstrips[].location	`string`	The url of the filmstrip.
filmstrips[].size	`number`	The size of the filmstrip, in bytes.
filmstrips[].frames	`number`	Number of frames contained in the filmstrip.
filmstrips[].frameHeight	`number`	The height of each frame.
filmstrips[].frameWidth	`number`	The width of each frame.
filmstrips[].width	`number`	Total width of the filmstrip.
filmstrips[].height	`number`	Total height of the filmstrip.
waveforms	`array`	The set of waveforms for the asset. Please check the Previews section for more information.
waveforms[].type	`string`	The type of waveform returned.
waveforms[].location	`string`	The url of the waveform.
waveforms[].size	`number`	The size in bytes of the waveform.
waveforms[].maxAmplitude	`number`	Sample values will range from this number to its additive inverse. For example, if this value is 100, then samples within the waveform file will have values between -100 and 100.
waveforms[].sampleMethod	`string`	The type of sample method used to extract samples from the source audio stream. Supported values are ‘SamplesCount’ and ‘SamplesPerSecond’. When ‘SamplesCount’ is returned, then a fixed number of samples was extracted, spanning the duration of the source audio stream. When ‘SamplesPerSecond’ is returned, then a fixed number of samples was extracted per second of audio.
waveforms[].samplesPerSecond	`number`	When the sampleMethod is ‘SamplesPerSecond’, this value indicates the number of samples that were extracted for each second of audio.
waveforms[].uploadCompleteDate	`string`	The datetime the asset upload was completed.
isDeleted	`boolean`	Indicates if an asset is deleted.
trashedOn	`string`	The datetime the asset was trashed.
trashedBy	`object`	Information about the user that trashed the asset.
trashedBy.id	`string`	The unique identifier of the user.
trashedBy.name	`string`	The full name of the user.
trashedBy.email	`string`	The email of the user.

Headers

Content-Type: application/json

Body

{
  "code": "FolderNotFound",
  "message": "Folder not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Create an Asset
POST`/assets/`

Description

Creates a new asset record without any content. The source file can be uploaded later using http or Aspera upload. This can be useful if you need to migrate a large number of assets into Ci but you may not have all of the source files available yet. You can also use it to create “to-be-made” assets that you are expecting other collaborators to create in the future. And don’t worry, you can always call Get asset details to find out whether an asset record has had its content uploaded.

As security is paramount to all that we do, we don’t allow the following types of files to be uploaded to Ci:

Batch files
COM files
Executable files
HTML files
JavaScript files
JavaServer Pages
MSI files
PHP files
Python files
Ruby files
SWF files
VBScript files

Errors

Status Code	Error Code	Message
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	MissingOrInvalidName	Missing or invalid name. The file name must not be null and its length must be equal to or less than 512 characters.
400	InvalidDescription	Invalid description. The description length must equal to or less than 1000 characters.
400	MissingOrInvalidFileSize	Missing or invalid file size.
400	InvalidFileType	Invalid file type.
400	WorkspaceNotFound	Workspace not found.
400	FolderNotFound	Folder not found.
400	FolderNotMemberOfWorkspace	Folder is not a member of the provided workspace.
400	InvalidIngestConfiguration	Invalid ingest configuration.
409	FolderTrashed	Folder is trashed.
409	FolderDeleted	Folder is deleted.
409	InsufficientSpaceAvailable	Upload will exceed the workspace’s allotted storage.

GET https://api.cimediacloud.com/assets/yiireizq1hcowxua?thumbnailExpirationDate=2030-01-02T00:00:00.000Z&proxyExpirationDate=2030-01-02T00:00:00.000Z&hlsPlaylistExpirationDate=2030-01-02T00:00:00.000Z

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200404

Headers

Content-Type: application/json

Body

{
  "id": "bcdc34b53e2c4c18ac41ca288e28d11f",
  "name": "Movie.mov",
  "size": 107856722,
  "type": "Video",
  "format": "mov",
  "folder": {
    "id": "9b639e12a82f4b0483f512b474dc052ci",
    "name": "Folder Name"
  },
  "status": "Complete",
  "description": "Final cut",
  "thumbnails": [
    {
      "type": "large",
      "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/thumb.jpg",
      "size": 1024,
      "width": 200,
      "height": 300,
      "source": {
        "id": "elementId1",
        "kind": "element"
      },
      "isExternal": false
    }
  ],
  "proxies": [
    {
      "type": "video-3g",
      "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/proxy.jpg",
      "size": 1024,
      "width": 200,
      "height": 300,
      "videoBitRate": 1650000,
      "audioBitRate": 128000,
      "isExternal": false
    }
  ],
  "md5Checksum": "tk2ma0zrhrp5irco",
  "createdOn": "2017-01-02T00:00:00.000Z",
  "createdBy": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith",
    "email": "johnsmith@example.com"
  },
  "modifiedOn": "2017-01-02T00:00:00.000Z",
  "lastActivityOn": "2017-01-03T00:00:00.000Z",
  "acquisitionSource": {
    "name": "Workspace"
  },
  "archiveStatus": "Not archived",
  "archiveType": "Standard",
  "restoreStatus": "Not restored",
  "restoreExpirationDate": "2017-01-02T00:00:00.000Z",
  "restoreRequestDate": "2017-01-02T00:00:00.000Z",
  "lastRestoreDate": "2017-01-02T00:00:00.000Z",
  "restoredBy": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith",
    "email": "johnsmith@example.com"
  },
  "archiveDate": "2017-01-02T00:00:00.000Z",
  "archivedBy": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith",
    "email": "johnsmith@example.com"
  },
  "uploadCompleteDate": "2017-01-02T00:00:00.000Z",
  "isTrashed": false,
  "uploadTransferType": "SinglepartHttp",
  "runtime": 1024,
  "totalFolderCount": 1,
  "network": {
    "id": "40c2a6b99a474b319dec5ef9c7dbb356",
    "name": "Company Name",
    "class": "Enterprise"
  },
  "metadata": [
    {
      "name": "resolution",
      "value": "1080p",
      "readOnly": false
    }
  ],
  "technicalMetadata": {
    "type": "Video",
    "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/metadata.jpg",
    "size": 1024,
    "image": {
      "width": 100,
      "height": 300,
      "xResolution": 100,
      "yResolution": 100,
      "resolutionUnit": "cm",
      "cameraMake": "Nikon",
      "cameraModel": "D300",
      "groupingInfo": "6445055e520106d9d01769fffefd058901000100000000000000",
      "umidBasic": "060a2b340101010501010143130000006445055e520106cbd01769fffefd0589",
      "materialNumber": "6445055e520106cbd01769fffefd0589",
      "recordedDate": "2023-07-27T01:39:24Z",
      "locationCity": "New York",
      "locationState": "NY",
      "locationCountry": "USA",
      "exif": {
        "imageWidth": "3888",
        "imageHeight": "2592",
        "artist": "Michael W. Steidl.",
        "copyright": "(c) 2011 IPTC - Rights reserved."
      },
      "iptc": {
        "codedCharacterSet": "UTF8",
        "headline": "Bikefestival Vienna",
        "credit": "IPTC/Michael W. Steidl",
        "keywords": "Vienna Air King,cycling,mountain bike"
      },
      "xmp": {
        "serialNumber": "0380227035",
        "creatorRegion": "Roshire",
        "lens": "EF70-300mm f/4-5.6L IS USM",
        "creatorCountry": "United Kingdom"
      }
    },
    "avContainer": {
      "bitRate": 11934620,
      "duration": 100,
      "start": 0,
      "recordedDate": "2022-11-21T06:42:41Z",
      "deviceManufacturer": "Sony",
      "timeCode": "00:00:00:00",
      "derivedTimeCode": "00:00:00:00",
      "streams": [
        {
          "index": 0,
          "type": "Video",
          "bitRate": 11934620,
          "bitDepth": 8,
          "bitRateMode": "CBR",
          "codec": "h264",
          "codecName": "ProRes",
          "codecProfile": "422 HQ",
          "codecSettings": "Little / Signed",
          "fourCC": "avc1",
          "width": 1280,
          "height": 720,
          "totalFrames": 1024,
          "duration": 100,
          "frameRateNumerator": 360,
          "frameRateDenominator": 12,
          "videoPARWidth": 1,
          "videoPARHeight": 1,
          "videoDARWidth": 19,
          "videoDARHeight": 24,
          "start": 0,
          "timeCode": "00:00:00:00",
          "videoColorSpace": "bt709",
          "videoScanOrder": "TFF",
          "videoScanType": "Interlaced",
          "videoColorPrimaries": "DCI P3",
          "videoChromaSubsampling": "4:2:2",
          "videoScanTypeStoreMethod": "Interleaved fields",
          "audioSampleRate": 32000,
          "audioChannelCount": 2,
          "audioLayout": "Stereo",
          "audioAnalysis": "Stereo",
          "rotate": 0
        }
      ]
    },
    "dolbyContainer": {
      "duration": 9.6,
      "fileSize": 80294994,
      "overallBitRateMode": "CBR",
      "overallBitRate": 66912495,
      "totalChannels": 58,
      "bedChannels": 10,
      "numberOfBeds": 1,
      "bitDepth": 24,
      "samplingRate": 48000,
      "downmix51X": "Direct Render",
      "trimModesSummary": "automatic + manual_0",
      "trimChannel20Mode": "manual_0",
      "trimChannel51Mode": "manual_0",
      "trimChannel71Mode": "automatic",
      "trimChannel212Mode": "manual_0",
      "trimChannel512Mode": "automatic",
      "trimChannel712Mode": "manual_0",
      "trimChannel214Mode": "manual_0",
      "trimChannel514Mode": "manual_0",
      "trimChannel714Mode": "manual_0",
      "associatedVideoFrameRate": 23.976,
      "start": "01:00:00:00",
      "fFoA": "01:00:00:00",
      "end": "01:03:30:13",
      "metadataFormat": "ADM, Version 0",
      "admProfile": "Dolby Atmos Master, Version 1",
      "numberOfProgrammes": 1,
      "numberOfObjectChannels": 48,
      "numberOfPackFormats": 49,
      "numberOfChannelFormats": 58,
      "binauralRenderModesSummary": "Off + Near + Mid + Far",
      "binauralRenderModesOffCount": 9,
      "binauralRenderModesNearCount": 8,
      "binauralRenderModesMidCount": 13,
      "binauralRenderModesFarCount": 1,
      "truePeakLevels": -3.14,
      "loudness": -16.67
    }
  },
  "hlsPlaylistUrl": "https://cimediacloud.com/t5y7s3ero3w2ie7/hls",
  "acquisitionContext": {
    "name": "Movie1.mov",
    "path": "original/source/path"
  },
  "isExternal": false,
  "workspace": {
    "id": "gb5ehomv0iv71swg",
    "name": "Workspace Name",
    "class": "Enterprise"
  },
  "filmstrips": [
    {
      "type": "video-filmstrip-small",
      "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/filmstrip.jpg",
      "size": 1024,
      "frames": 100,
      "frameHeight": 100,
      "frameWidth": 100,
      "width": 100,
      "height": 1000
    }
  ],
  "waveforms": [
    {
      "type": "video-waveform",
      "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/waveform.jpg",
      "size": 1024,
      "maxAmplitude": 1000,
      "sampleMethod": "SamplesCount",
      "samplesPerSecond": 12,
      "uploadCompleteDate": "2017-01-02T00:00:00.000Z"
    }
  ],
  "isDeleted": false,
  "trashedOn": "2017-01-02T00:00:00.000Z",
  "trashedBy": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith",
    "email": "johnsmith@example.com"
  }
}

Property name	Type	Description
id	`string`	The unique identifier of the asset.
name	`string`	The name of the asset, including its extension. Its maximum length is 512 characters.
size	`number`	The size of the source file, in bytes.
type	`string`	The type of the asset. Valid values are `Audio`, `Video`, `Image`, `Document`, or `Other`.
format	`string`	The asset’s file format.
folder	`object`	Information about the asset’s parent folder.
folder.id	`string`	The unique identifier of the folder.
folder.name	`string`	The name of folder.
status	`string`	The status of the asset. Valid values are ‘Created’, ‘Complete’, ‘Deleted’, ‘Executable Detected’, ‘Failed’, ‘Limited’, ‘Processing’, ‘Uploading’, ‘Virus Detected’, ‘Waiting’. See this section for more information.
description	`string`	A comment or note associated to the asset. Its maximum length is 1000 characters.
thumbnails	`array`	The set of thumbnails for the asset.
thumbnails[].type	`string`	The type of thumbnail returned. Valid values are ‘small’, ‘medium’ and ‘large’.
thumbnails[].location	`string`	The url of the thumbnail.
thumbnails[].size	`number`	The size of the thumbnail, in bytes.
thumbnails[].width	`number`	The width of the thumbnail.
thumbnails[].height	`number`	The height of the thumbnail.
thumbnails[].source	`object`	Information about the source of thumbnails.
thumbnails[].source.id	`string`	Unique identifier of the thumbnail’s source.
thumbnails[].source.kind	`string`	The kind of entity of the thumbnail’s source.
thumbnails[].isExternal	`boolean`	Indicates if the thumbnail is stored in an external source.
proxies	`array`	The set of proxies for the asset.
proxies[].type	`string`	The type of proxy returned. Valid values are ‘standard-audio’, ‘dolby-audio’, ‘video-3g’, ‘video-sd’, ‘video-sdplus’, ‘video-hd’, ‘video-2k’, ‘video-2kplus’, ‘document-pdf’.
proxies[].location	`string`	The url of the proxy.
proxies[].size	`number`	The size of the proxy, in bytes.
proxies[].width	`number`	The width of the proxy.
proxies[].height	`number`	The height of the proxy.
proxies[].videoBitRate	`number`	The video bitrate of the proxy.
proxies[].audioBitRate	`number`	The audio bitrate of the proxy.
proxies[].isExternal	`boolean`	Indicates if the proxy is stored in an external source.
md5Checksum	`string`	The calculated md5 checksum for the asset.
createdOn	`string`	The datetime the asset record was created.
createdBy	`object`	Information about the creator of the asset
createdBy.id	`string`	The unique identifier of the user.
createdBy.name	`string`	The full name of the user.
createdBy.email	`string`	The email of the user.
modifiedOn	`string`	The datetime the asset record was last modified.
lastActivityOn	`string`	The datetime of the last activity of the asset record.
acquisitionSource	`object`	Information about the asset’s source client application.
acquisitionSource.name	`string`	The name of the client application that uploaded the asset.
archiveStatus	`string`	The archive status of the asset. Valid values are ‘Not archived’, ‘Archive in progress’, ‘Archive failed’, ‘Archived’, ‘Cancel archive in progress’.
archiveType	`string`	If available, the kind of archive used for storing the asset. Valid values are `Standard` and `Deep`.
restoreStatus	`string`	The restore status of the asset. This is applicable to assets that have been archived. Valid values are ‘Not restored’, ‘Restore in progress’, ‘Restore failed’, ‘Restored’.
restoreExpirationDate	`string`	If available, the datetime the restored copy of the asset’s source file will no longer be available.
restoreRequestDate	`string`	If available, the datetime the asset’s source file was requested to be restored.
lastRestoreDate	`string`	If available, the datetime the asset’s source file was last restored.
restoredBy	`object`	If available, information about the user who restored the asset.
restoredBy.id	`string`	The unique identifier of the user.
restoredBy.name	`string`	The full name of the user.
restoredBy.email	`string`	The email of the user.
archiveDate	`string`	If available, the datetime the asset’s source file was last archived.
archivedBy	`object`	If available, information about the user who archived the asset.
archivedBy.id	`string`	The unique identifier of the user.
archivedBy.name	`string`	The full name of the user.
archivedBy.email	`string`	The email of the user.
uploadCompleteDate	`string`	The datetime the asset upload was completed.
isTrashed	`boolean`	Indicates if an asset is in the trash bin.
uploadTransferType	`string`	Indicates how the asset was uploaded. Valid values are ‘SinglepartHttp’, ‘MultipartHttp’, ‘Aspera’, ‘Copy’, ‘FTP’, ‘WorkspaceSend’.
runtime	`number`	The duration of the media asset, in seconds.
totalFolderCount	`number`	The amount of folders where the asset exists.
network	`object`	Information about the asset’s network.
network.id	`string`	The unique identifier of the Network.
network.name	`string`	The name of the Network.
network.class	`string`	Indicates if the Network is a ‘Personal’ or ‘Enterprise’ Network.
metadata	`array`	An array of key-value pairs of user-generated and basic technical metadata.
metadata[].name	`string`	The name of the metadata item.
metadata[].value	`string`	the value of the metadata item.
metadata[].readOnly	`boolean`	Flag to set a read-only metadata.
technicalMetadata	`object`	An object that contains all the technical metadata available.
technicalMetadata.type	`string`	The type of the asset. Valid values are either ‘Audio’, ‘Video’ or ‘Image’.
technicalMetadata.location	`string`	Url of the source technical metadata file. Note: the content and structure of the technical metadata file is subject to change at any time.
technicalMetadata.size	`number`	The size of the technical metadata file, in bytes.
technicalMetadata.image	`object`	If the asset’s type is ‘Image’, this property contains the extended image technical metadata.
technicalMetadata.image.width	`number`	The width of the image, in pixels.
technicalMetadata.image.height	`number`	The height of the image, in pixels.
technicalMetadata.image.xResolution	`number`	The number of pixels per resolutionUnit in the width direction.
technicalMetadata.image.yResolution	`number`	The number of pixels per resolutionUnit in the height direction.
technicalMetadata.image.resolutionUnit	`string`	The unit of measurement for xResolution and yResolution. Can be ‘inches’, ‘cm’ or ‘none’.
technicalMetadata.image.cameraMake	`string`	Camera manufacturer name.
technicalMetadata.image.cameraModel	`string`	Camera model name.
technicalMetadata.image.groupingInfo	`string`	If available, the grouping info of the image. String of hexadecimal value (52 characteres) for the byte array object. Byte array order is Litte Endian.
technicalMetadata.image.umidBasic	`string`	If available, the umid basic info of the image. String of hexadecimal value (64 characteres) for the byte array object.
technicalMetadata.image.materialNumber	`string`	If available, the material number of the image. String of hexadecimal value (32 characteres) for the byte array object.
technicalMetadata.image.recordedDate	`string`	The date and Time at which the image was captured.
technicalMetadata.image.locationCity	`string`	Name of the city where the image was created.
technicalMetadata.image.locationState	`string`	Name of the state where the image was created.
technicalMetadata.image.locationCountry	`string`	Name of the country where the image was created.
technicalMetadata.image.exif	`object`	The avalaible EXIF (Exchangeable Image File) metadata.
technicalMetadata.image.exif.imageWidth	`string`	The image width in pixels.
technicalMetadata.image.exif.imageHeight	`string`	The image height in pixels.
technicalMetadata.image.exif.artist	`string`	The image artist info.
technicalMetadata.image.exif.copyright	`string`	The image copyright.
technicalMetadata.image.iptc	`object`	The available IPTC (International Press Telecommunications Council) available.
technicalMetadata.image.iptc.codedCharacterSet	`string`	Determines how the internal IPTC string values are interpreted.
technicalMetadata.image.iptc.headline	`string`	Brief synopsis or summary of the contents of the photograph.
technicalMetadata.image.iptc.credit	`string`	How the image should be credited when published, as specified by the supplier of the image.
technicalMetadata.image.iptc.keywords	`string`	Descriptive words added to the image to enable search and retrieval.
technicalMetadata.image.xmp	`object`	The available XMP (Extensible Metadata Platform) metadata.
technicalMetadata.image.xmp.serialNumber	`string`	Camera Serial Number.
technicalMetadata.image.xmp.creatorRegion	`string`	State / Province for the address of the person that created this image.
technicalMetadata.image.xmp.lens	`string`	Attempts to identify the camera lens used.
technicalMetadata.image.xmp.creatorCountry	`string`	Country name for the address of the person that created this image.
technicalMetadata.avContainer	`object`	If asset type is ‘Audio’ or ‘Video’, this property contains the extended audio / video technical metadata.
technicalMetadata.avContainer.bitRate	`number`	The overall bitrate in the container.
technicalMetadata.avContainer.duration	`number`	The runtime of the media in the container, in seconds.
technicalMetadata.avContainer.start	`number`	The start time in the container, in seconds.
technicalMetadata.avContainer.recordedDate	`string`	The date and Time at which the video was captured.
technicalMetadata.avContainer.deviceManufacturer	`string`	The name of the device Manufacturer.
technicalMetadata.avContainer.timeCode	`string`	The SMPTE timecode in the container.
technicalMetadata.avContainer.derivedTimeCode	`string`	The standardized timecode derived by evaluating stream metadata and converting to drop frame format, if using drop frame rate.
technicalMetadata.avContainer.streams	`array`	Set of audio, video, or data streams contained in the asset.
technicalMetadata.avContainer.streams[].index	`number`	The index of the stream in the container.
technicalMetadata.avContainer.streams[].type	`string`	The type of the stream. Valid values are `Audio`, `Video` or `Data`.
technicalMetadata.avContainer.streams[].bitRate	`number`	If available, the overall bitrate in the stream.
technicalMetadata.avContainer.streams[].bitDepth	`number`	If available, for an `Audio` stream, the bit depth of the stream.
technicalMetadata.avContainer.streams[].bitRateMode	`string`	If available, the bit rate mode of the stream.
technicalMetadata.avContainer.streams[].codec	`string`	If available, the codec used in the stream. For example, `h264`.
technicalMetadata.avContainer.streams[].codecName	`string`	If available, the MediaInfo generated format commercial name for the stream.
technicalMetadata.avContainer.streams[].codecProfile	`string`	If available, the MediaInfo generated format profile for the stream.
technicalMetadata.avContainer.streams[].codecSettings	`string`	If avalable, the MediaInfo generated format settings for the stream.
technicalMetadata.avContainer.streams[].fourCC	`string`	If available, four-character code for the codec used in the stream. For example, `avc1`, `apch`.
technicalMetadata.avContainer.streams[].width	`number`	If available, for a `Video` stream, the width in pixels of the video.
technicalMetadata.avContainer.streams[].height	`number`	If available, for a `Video` stream, the height in pixels of the video.
technicalMetadata.avContainer.streams[].totalFrames	`number`	If available, total number of frames within the `Video` stream.
technicalMetadata.avContainer.streams[].duration	`number`	If available, the runtime of the media in seconds.
technicalMetadata.avContainer.streams[].frameRateNumerator	`number`	If available, the numerator of the frame rate. For example, if the frame rate is 24, the frame rate numerator is 24.
technicalMetadata.avContainer.streams[].frameRateDenominator	`number`	If available, the numerator of the frame rate. For example, if the frame rate is 24, the frame rate denominator is 1.
technicalMetadata.avContainer.streams[].videoPARWidth	`number`	If available, the width part of the pixel aspect ratio.
technicalMetadata.avContainer.streams[].videoPARHeight	`number`	If available, the height part of the pixel aspect ratio.
technicalMetadata.avContainer.streams[].videoDARWidth	`number`	If available, the width part of the display aspect ratio.
technicalMetadata.avContainer.streams[].videoDARHeight	`number`	If available, the height part of the display aspect ratio.
technicalMetadata.avContainer.streams[].start	`number`	If available, the start time in the stream, in seconds.
technicalMetadata.avContainer.streams[].timeCode	`string`	If available, the SMPTE timecode in the stream.
technicalMetadata.avContainer.streams[].videoColorSpace	`string`	If available, for a `Video` stream, the video’s color space / color primaries.
technicalMetadata.avContainer.streams[].videoScanOrder	`string`	If available, for a `Video` stream, the video’s scan order.
technicalMetadata.avContainer.streams[].videoScanType	`string`	If available, for a `Video` stream, the video’s scan type.
technicalMetadata.avContainer.streams[].videoColorPrimaries	`string`	If available, for a `Video` stream, the video’s color primaries.
technicalMetadata.avContainer.streams[].videoChromaSubsampling	`string`	If available, for a `Video` stream, the video’s crhoma subsampling.
technicalMetadata.avContainer.streams[].videoScanTypeStoreMethod	`string`	If available, for a `Video` stream, the video’s scan type store method.
technicalMetadata.avContainer.streams[].audioSampleRate	`number`	If available, for an `Audio` stream, is the sample rate in Hz.
technicalMetadata.avContainer.streams[].audioChannelCount	`number`	If available, for an `Audio` stream, is the number of channels within the stream.
technicalMetadata.avContainer.streams[].audioLayout	`string`	If available, for an `Audio` stream, is the audio channel layout description. For example, `5.1`.
technicalMetadata.avContainer.streams[].audioAnalysis	`string`	If available, for an `Audio` stream, it is further analysis to determine if a stream is true stereo or dual-mono.
technicalMetadata.avContainer.streams[].rotate	`number`	If available, the amount of rotation, in degrees, that should be applied during playback of the video.
technicalMetadata.dolbyContainer	`object`	If asset type is ‘Audio’ and the asset has Dolby Atmos metadata, this property contains the extended Dolby Atmos audio technical metadata.
technicalMetadata.dolbyContainer.duration	`number`	Media duration (in seconds).
technicalMetadata.dolbyContainer.fileSize	`number`	Media size (in bytes).
technicalMetadata.dolbyContainer.overallBitRateMode	`string`	The overall bitrate mode for the Atmos content.
technicalMetadata.dolbyContainer.overallBitRate	`number`	Media bitrate (in bits per second).
technicalMetadata.dolbyContainer.totalChannels	`number`	Number of channels. `Bed channels` plus `Object channels` equals `Total channels`.
technicalMetadata.dolbyContainer.bedChannels	`number`	Number of channel-based premix or stem that includes multichannel panning.
technicalMetadata.dolbyContainer.numberOfBeds	`number`	A bed can be thought of as a traditional channel-based stem with the rules and expectations of stem configurations (such as 2.0, 5.1, and 7.1).
technicalMetadata.dolbyContainer.bitDepth	`number`	Number of bits of information in each sample, generally 16, 24, or 32-bit.
technicalMetadata.dolbyContainer.samplingRate	`number`	Audio sample-rate, generally 44100 or 48000 Hz.
technicalMetadata.dolbyContainer.downmix51X	`string`	Global downmix metadata for monitoring, re-rendering, and encoding.
technicalMetadata.dolbyContainer.trimModesSummary	`string`	A summary of the underlying trim modes.
technicalMetadata.dolbyContainer.trimChannel20Mode	`string`	The type of trim mode supported for 2.0 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
technicalMetadata.dolbyContainer.trimChannel51Mode	`string`	The type of trim mode supported for 5.1 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
technicalMetadata.dolbyContainer.trimChannel71Mode	`string`	The type of trim mode supported for 7.1 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
technicalMetadata.dolbyContainer.trimChannel212Mode	`string`	The type of trim mode supported for 2.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
technicalMetadata.dolbyContainer.trimChannel512Mode	`string`	The type of trim mode supported for 5.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
technicalMetadata.dolbyContainer.trimChannel712Mode	`string`	The type of trim mode supported for 7.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
technicalMetadata.dolbyContainer.trimChannel214Mode	`string`	The type of trim mode supported for 2.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
technicalMetadata.dolbyContainer.trimChannel514Mode	`string`	The type of trim mode supported for 5.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
technicalMetadata.dolbyContainer.trimChannel714Mode	`string`	The type of trim mode supported for 7.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
technicalMetadata.dolbyContainer.associatedVideoFrameRate	`number`	Number of frames per second.
technicalMetadata.dolbyContainer.start	`string`	Start SMPTE timecode based on the video frame rate.
technicalMetadata.dolbyContainer.fFoA	`string`	FFoA (First Frame of Action) SMPTE timecode based on the video frame rate.
technicalMetadata.dolbyContainer.end	`string`	End SMPTE timecode based on the video frame rate.
technicalMetadata.dolbyContainer.metadataFormat	`string`	Format of the metadata in the Atmos content.
technicalMetadata.dolbyContainer.admProfile	`string`	ADM (Audio Definition Model) Profile used in the Atmos content.
technicalMetadata.dolbyContainer.numberOfProgrammes	`number`	Number of programmes in the Atmos content.
technicalMetadata.dolbyContainer.numberOfObjectChannels	`number`	Number of objects in the Atmos Master.
technicalMetadata.dolbyContainer.numberOfPackFormats	`number`	Number of Atmos Pack Formats in the Atmos content.
technicalMetadata.dolbyContainer.numberOfChannelFormats	`number`	Number of channel formats in the Atmos content.
technicalMetadata.dolbyContainer.binauralRenderModesSummary	`string`	Summary of all the binaural render modes used in the Atmos content. Supported strings are a unique combination of: “Off”, “Near”, “Mid”, “Far”.
technicalMetadata.dolbyContainer.binauralRenderModesOffCount	`number`	Number of channels that use the “Off” setting for binaural rendering.
technicalMetadata.dolbyContainer.binauralRenderModesNearCount	`number`	Number of channels that use the “Near” setting for binaural rendering.
technicalMetadata.dolbyContainer.binauralRenderModesMidCount	`number`	Number of channels that use the “Mid” setting for binaural rendering.
technicalMetadata.dolbyContainer.binauralRenderModesFarCount	`number`	Number of channels that use the “Far” setting for binaural rendering.
technicalMetadata.dolbyContainer.truePeakLevels	`number`	The peak event in the audio waveform. Units are dBTP for true peak.
technicalMetadata.dolbyContainer.loudness	`number`	Integrated loudness LKFS (or LUFS).
hlsPlaylistUrl	`string`	A link to the HLS playlist generated from the source file.
acquisitionContext	`object`	The file acquisition information.
acquisitionContext.name	`string`	The original source file name, captured on acquisition.
acquisitionContext.path	`string`	The original source file path, captured on acquisition.
isExternal	`boolean`	Indicates if the file is stored in an external source.
workspace	`object`	Information about the asset’s workspace.
workspace.id	`string`	The unique identifier of the Workspace.
workspace.name	`string`	The name of the Workspace.
workspace.class	`string`	Indicates if the Workspace is a ‘Personal’ or ‘Team’ Workspace.
filmstrips	`array`	The set of filmstrips for the asset. Please check the Previews section for more information.
filmstrips[].type	`string`	The type of filmstrip returned.
filmstrips[].location	`string`	The url of the filmstrip.
filmstrips[].size	`number`	The size of the filmstrip, in bytes.
filmstrips[].frames	`number`	Number of frames contained in the filmstrip.
filmstrips[].frameHeight	`number`	The height of each frame.
filmstrips[].frameWidth	`number`	The width of each frame.
filmstrips[].width	`number`	Total width of the filmstrip.
filmstrips[].height	`number`	Total height of the filmstrip.
waveforms	`array`	The set of waveforms for the asset. Please check the Previews section for more information.
waveforms[].type	`string`	The type of waveform returned.
waveforms[].location	`string`	The url of the waveform.
waveforms[].size	`number`	The size in bytes of the waveform.
waveforms[].maxAmplitude	`number`	Sample values will range from this number to its additive inverse. For example, if this value is 100, then samples within the waveform file will have values between -100 and 100.
waveforms[].sampleMethod	`string`	The type of sample method used to extract samples from the source audio stream. Supported values are ‘SamplesCount’ and ‘SamplesPerSecond’. When ‘SamplesCount’ is returned, then a fixed number of samples was extracted, spanning the duration of the source audio stream. When ‘SamplesPerSecond’ is returned, then a fixed number of samples was extracted per second of audio.
waveforms[].samplesPerSecond	`number`	When the sampleMethod is ‘SamplesPerSecond’, this value indicates the number of samples that were extracted for each second of audio.
waveforms[].uploadCompleteDate	`string`	The datetime the asset upload was completed.
isDeleted	`boolean`	Indicates if an asset is deleted.
trashedOn	`string`	The datetime the asset was trashed.
trashedBy	`object`	Information about the user that trashed the asset.
trashedBy.id	`string`	The unique identifier of the user.
trashedBy.name	`string`	The full name of the user.
trashedBy.email	`string`	The email of the user.

Headers

Content-Type: application/json

Body

{
  "code": "AssetNotFound",
  "message": "Asset not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Get Asset Details
GET`/assets/{assetId}{?thumbnailExpirationDate,proxyExpirationDate,hlsPlaylistExpirationDate}`

URI Parameters

HideShow

assetId: string (required)
The unique identifier of the asset.
thumbnailExpirationDate: string (optional)
The date and time for thumbnail URL expiration in IS0 8601 date and time format (e.g.: ‘2020-01-01’). Value must be less than ‘2038-01-01’ and greater than the current date and time. If not provided, default of 2 years is used.
proxyExpirationDate: string (optional)
The date and time for proxy URL expiration in IS0 8601 date and time format (e.g.: ‘2020-01-01’). Value must be less than ‘2038-01-01’ and greater than the current date and time. If not provided, default of 12 hours is used.
hlsPlaylistExpirationDate: string (optional)
The date and time for HLS playlist URL expiration in IS0 8601 date and time format (e.g.: ‘2020-01-01’). Value must be less than ‘2038-01-01’ and greater than the current date and time. If not provided, default of 12 hours is used.

Description

Retrieves asset information for the specified asset.

Use custom url expiration parameters for the following use cases:

Caching thumbnail urls for long periods of time.
Limiting the amount of time a proxy or HLS playlist is available for viewing.

Errors

Status Code	Error Code	Message
404	AssetNotFound	Asset not found.
400	InvalidExpiration	Invalid expiration.

PUT https://api.cimediacloud.com/assets/yiireizq1hcowxua

Requestssimple examplefull example

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "name": "Movie.mov",
  "description": "sample description"
}

Property name	Type	Description
name	`string`	The name of the asset, including its extension. Its maximum length is 512 characters.
description	`string`	A brief note associated to the asset. Its maximum length is 1000 characters.

Responses200400

Headers

Content-Type: application/json

Body

{
  "id": "bcdc34b53e2c4c18ac41ca288e28d11f",
  "name": "Movie.mov",
  "size": 107856722,
  "type": "Video",
  "format": "mov",
  "folder": {
    "id": "9b639e12a82f4b0483f512b474dc052ci",
    "name": "Folder Name"
  },
  "status": "Complete",
  "description": "Final cut",
  "thumbnails": [
    {
      "type": "large",
      "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/thumb.jpg",
      "size": 1024,
      "width": 200,
      "height": 300,
      "source": {
        "id": "elementId1",
        "kind": "element"
      },
      "isExternal": false
    }
  ],
  "proxies": [
    {
      "type": "video-3g",
      "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/proxy.jpg",
      "size": 1024,
      "width": 200,
      "height": 300,
      "videoBitRate": 1650000,
      "audioBitRate": 128000,
      "isExternal": false
    }
  ],
  "md5Checksum": "tk2ma0zrhrp5irco",
  "createdOn": "2017-01-02T00:00:00.000Z",
  "createdBy": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith",
    "email": "johnsmith@example.com"
  },
  "modifiedOn": "2017-01-02T00:00:00.000Z",
  "lastActivityOn": "2017-01-03T00:00:00.000Z",
  "acquisitionSource": {
    "name": "Workspace"
  },
  "archiveStatus": "Not archived",
  "archiveType": "Standard",
  "restoreStatus": "Not restored",
  "restoreExpirationDate": "2017-01-02T00:00:00.000Z",
  "restoreRequestDate": "2017-01-02T00:00:00.000Z",
  "lastRestoreDate": "2017-01-02T00:00:00.000Z",
  "restoredBy": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith",
    "email": "johnsmith@example.com"
  },
  "archiveDate": "2017-01-02T00:00:00.000Z",
  "archivedBy": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith",
    "email": "johnsmith@example.com"
  },
  "uploadCompleteDate": "2017-01-02T00:00:00.000Z",
  "isTrashed": false,
  "uploadTransferType": "SinglepartHttp",
  "runtime": 1024,
  "totalFolderCount": 1,
  "network": {
    "id": "40c2a6b99a474b319dec5ef9c7dbb356",
    "name": "Company Name",
    "class": "Enterprise"
  },
  "metadata": [
    {
      "name": "resolution",
      "value": "1080p",
      "readOnly": false
    }
  ],
  "technicalMetadata": {
    "type": "Video",
    "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/metadata.jpg",
    "size": 1024,
    "image": {
      "width": 100,
      "height": 300,
      "xResolution": 100,
      "yResolution": 100,
      "resolutionUnit": "cm",
      "cameraMake": "Nikon",
      "cameraModel": "D300",
      "groupingInfo": "6445055e520106d9d01769fffefd058901000100000000000000",
      "umidBasic": "060a2b340101010501010143130000006445055e520106cbd01769fffefd0589",
      "materialNumber": "6445055e520106cbd01769fffefd0589",
      "recordedDate": "2023-07-27T01:39:24Z",
      "locationCity": "New York",
      "locationState": "NY",
      "locationCountry": "USA",
      "exif": {
        "imageWidth": "3888",
        "imageHeight": "2592",
        "artist": "Michael W. Steidl.",
        "copyright": "(c) 2011 IPTC - Rights reserved."
      },
      "iptc": {
        "codedCharacterSet": "UTF8",
        "headline": "Bikefestival Vienna",
        "credit": "IPTC/Michael W. Steidl",
        "keywords": "Vienna Air King,cycling,mountain bike"
      },
      "xmp": {
        "serialNumber": "0380227035",
        "creatorRegion": "Roshire",
        "lens": "EF70-300mm f/4-5.6L IS USM",
        "creatorCountry": "United Kingdom"
      }
    },
    "avContainer": {
      "bitRate": 11934620,
      "duration": 100,
      "start": 0,
      "recordedDate": "2022-11-21T06:42:41Z",
      "deviceManufacturer": "Sony",
      "timeCode": "00:00:00:00",
      "derivedTimeCode": "00:00:00:00",
      "streams": [
        {
          "index": 0,
          "type": "Video",
          "bitRate": 11934620,
          "bitDepth": 8,
          "bitRateMode": "CBR",
          "codec": "h264",
          "codecName": "ProRes",
          "codecProfile": "422 HQ",
          "codecSettings": "Little / Signed",
          "fourCC": "avc1",
          "width": 1280,
          "height": 720,
          "totalFrames": 1024,
          "duration": 100,
          "frameRateNumerator": 360,
          "frameRateDenominator": 12,
          "videoPARWidth": 1,
          "videoPARHeight": 1,
          "videoDARWidth": 19,
          "videoDARHeight": 24,
          "start": 0,
          "timeCode": "00:00:00:00",
          "videoColorSpace": "bt709",
          "videoScanOrder": "TFF",
          "videoScanType": "Interlaced",
          "videoColorPrimaries": "DCI P3",
          "videoChromaSubsampling": "4:2:2",
          "videoScanTypeStoreMethod": "Interleaved fields",
          "audioSampleRate": 32000,
          "audioChannelCount": 2,
          "audioLayout": "Stereo",
          "audioAnalysis": "Stereo",
          "rotate": 0
        }
      ]
    },
    "dolbyContainer": {
      "duration": 9.6,
      "fileSize": 80294994,
      "overallBitRateMode": "CBR",
      "overallBitRate": 66912495,
      "totalChannels": 58,
      "bedChannels": 10,
      "numberOfBeds": 1,
      "bitDepth": 24,
      "samplingRate": 48000,
      "downmix51X": "Direct Render",
      "trimModesSummary": "automatic + manual_0",
      "trimChannel20Mode": "manual_0",
      "trimChannel51Mode": "manual_0",
      "trimChannel71Mode": "automatic",
      "trimChannel212Mode": "manual_0",
      "trimChannel512Mode": "automatic",
      "trimChannel712Mode": "manual_0",
      "trimChannel214Mode": "manual_0",
      "trimChannel514Mode": "manual_0",
      "trimChannel714Mode": "manual_0",
      "associatedVideoFrameRate": 23.976,
      "start": "01:00:00:00",
      "fFoA": "01:00:00:00",
      "end": "01:03:30:13",
      "metadataFormat": "ADM, Version 0",
      "admProfile": "Dolby Atmos Master, Version 1",
      "numberOfProgrammes": 1,
      "numberOfObjectChannels": 48,
      "numberOfPackFormats": 49,
      "numberOfChannelFormats": 58,
      "binauralRenderModesSummary": "Off + Near + Mid + Far",
      "binauralRenderModesOffCount": 9,
      "binauralRenderModesNearCount": 8,
      "binauralRenderModesMidCount": 13,
      "binauralRenderModesFarCount": 1,
      "truePeakLevels": -3.14,
      "loudness": -16.67
    }
  },
  "hlsPlaylistUrl": "https://cimediacloud.com/t5y7s3ero3w2ie7/hls",
  "acquisitionContext": {
    "name": "Movie1.mov",
    "path": "original/source/path"
  },
  "isExternal": false,
  "workspace": {
    "id": "gb5ehomv0iv71swg",
    "name": "Workspace Name",
    "class": "Enterprise"
  },
  "filmstrips": [
    {
      "type": "video-filmstrip-small",
      "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/filmstrip.jpg",
      "size": 1024,
      "frames": 100,
      "frameHeight": 100,
      "frameWidth": 100,
      "width": 100,
      "height": 1000
    }
  ],
  "waveforms": [
    {
      "type": "video-waveform",
      "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/waveform.jpg",
      "size": 1024,
      "maxAmplitude": 1000,
      "sampleMethod": "SamplesCount",
      "samplesPerSecond": 12,
      "uploadCompleteDate": "2017-01-02T00:00:00.000Z"
    }
  ],
  "isDeleted": false,
  "trashedOn": "2017-01-02T00:00:00.000Z",
  "trashedBy": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith",
    "email": "johnsmith@example.com"
  }
}

Property name	Type	Description
id	`string`	The unique identifier of the asset.
name	`string`	The name of the asset, including its extension. Its maximum length is 512 characters.
size	`number`	The size of the source file, in bytes.
type	`string`	The type of the asset. Valid values are `Audio`, `Video`, `Image`, `Document`, or `Other`.
format	`string`	The asset’s file format.
folder	`object`	Information about the asset’s parent folder.
folder.id	`string`	The unique identifier of the folder.
folder.name	`string`	The name of folder.
status	`string`	The status of the asset. Valid values are ‘Created’, ‘Complete’, ‘Deleted’, ‘Executable Detected’, ‘Failed’, ‘Limited’, ‘Processing’, ‘Uploading’, ‘Virus Detected’, ‘Waiting’. See this section for more information.
description	`string`	A comment or note associated to the asset. Its maximum length is 1000 characters.
thumbnails	`array`	The set of thumbnails for the asset.
thumbnails[].type	`string`	The type of thumbnail returned. Valid values are ‘small’, ‘medium’ and ‘large’.
thumbnails[].location	`string`	The url of the thumbnail.
thumbnails[].size	`number`	The size of the thumbnail, in bytes.
thumbnails[].width	`number`	The width of the thumbnail.
thumbnails[].height	`number`	The height of the thumbnail.
thumbnails[].source	`object`	Information about the source of thumbnails.
thumbnails[].source.id	`string`	Unique identifier of the thumbnail’s source.
thumbnails[].source.kind	`string`	The kind of entity of the thumbnail’s source.
thumbnails[].isExternal	`boolean`	Indicates if the thumbnail is stored in an external source.
proxies	`array`	The set of proxies for the asset.
proxies[].type	`string`	The type of proxy returned. Valid values are ‘standard-audio’, ‘dolby-audio’, ‘video-3g’, ‘video-sd’, ‘video-sdplus’, ‘video-hd’, ‘video-2k’, ‘video-2kplus’, ‘document-pdf’.
proxies[].location	`string`	The url of the proxy.
proxies[].size	`number`	The size of the proxy, in bytes.
proxies[].width	`number`	The width of the proxy.
proxies[].height	`number`	The height of the proxy.
proxies[].videoBitRate	`number`	The video bitrate of the proxy.
proxies[].audioBitRate	`number`	The audio bitrate of the proxy.
proxies[].isExternal	`boolean`	Indicates if the proxy is stored in an external source.
md5Checksum	`string`	The calculated md5 checksum for the asset.
createdOn	`string`	The datetime the asset record was created.
createdBy	`object`	Information about the creator of the asset
createdBy.id	`string`	The unique identifier of the user.
createdBy.name	`string`	The full name of the user.
createdBy.email	`string`	The email of the user.
modifiedOn	`string`	The datetime the asset record was last modified.
lastActivityOn	`string`	The datetime of the last activity of the asset record.
acquisitionSource	`object`	Information about the asset’s source client application.
acquisitionSource.name	`string`	The name of the client application that uploaded the asset.
archiveStatus	`string`	The archive status of the asset. Valid values are ‘Not archived’, ‘Archive in progress’, ‘Archive failed’, ‘Archived’, ‘Cancel archive in progress’.
archiveType	`string`	If available, the kind of archive used for storing the asset. Valid values are `Standard` and `Deep`.
restoreStatus	`string`	The restore status of the asset. This is applicable to assets that have been archived. Valid values are ‘Not restored’, ‘Restore in progress’, ‘Restore failed’, ‘Restored’.
restoreExpirationDate	`string`	If available, the datetime the restored copy of the asset’s source file will no longer be available.
restoreRequestDate	`string`	If available, the datetime the asset’s source file was requested to be restored.
lastRestoreDate	`string`	If available, the datetime the asset’s source file was last restored.
restoredBy	`object`	If available, information about the user who restored the asset.
restoredBy.id	`string`	The unique identifier of the user.
restoredBy.name	`string`	The full name of the user.
restoredBy.email	`string`	The email of the user.
archiveDate	`string`	If available, the datetime the asset’s source file was last archived.
archivedBy	`object`	If available, information about the user who archived the asset.
archivedBy.id	`string`	The unique identifier of the user.
archivedBy.name	`string`	The full name of the user.
archivedBy.email	`string`	The email of the user.
uploadCompleteDate	`string`	The datetime the asset upload was completed.
isTrashed	`boolean`	Indicates if an asset is in the trash bin.
uploadTransferType	`string`	Indicates how the asset was uploaded. Valid values are ‘SinglepartHttp’, ‘MultipartHttp’, ‘Aspera’, ‘Copy’, ‘FTP’, ‘WorkspaceSend’.
runtime	`number`	The duration of the media asset, in seconds.
totalFolderCount	`number`	The amount of folders where the asset exists.
network	`object`	Information about the asset’s network.
network.id	`string`	The unique identifier of the Network.
network.name	`string`	The name of the Network.
network.class	`string`	Indicates if the Network is a ‘Personal’ or ‘Enterprise’ Network.
metadata	`array`	An array of key-value pairs of user-generated and basic technical metadata.
metadata[].name	`string`	The name of the metadata item.
metadata[].value	`string`	the value of the metadata item.
metadata[].readOnly	`boolean`	Flag to set a read-only metadata.
technicalMetadata	`object`	An object that contains all the technical metadata available.
technicalMetadata.type	`string`	The type of the asset. Valid values are either ‘Audio’, ‘Video’ or ‘Image’.
technicalMetadata.location	`string`	Url of the source technical metadata file. Note: the content and structure of the technical metadata file is subject to change at any time.
technicalMetadata.size	`number`	The size of the technical metadata file, in bytes.
technicalMetadata.image	`object`	If the asset’s type is ‘Image’, this property contains the extended image technical metadata.
technicalMetadata.image.width	`number`	The width of the image, in pixels.
technicalMetadata.image.height	`number`	The height of the image, in pixels.
technicalMetadata.image.xResolution	`number`	The number of pixels per resolutionUnit in the width direction.
technicalMetadata.image.yResolution	`number`	The number of pixels per resolutionUnit in the height direction.
technicalMetadata.image.resolutionUnit	`string`	The unit of measurement for xResolution and yResolution. Can be ‘inches’, ‘cm’ or ‘none’.
technicalMetadata.image.cameraMake	`string`	Camera manufacturer name.
technicalMetadata.image.cameraModel	`string`	Camera model name.
technicalMetadata.image.groupingInfo	`string`	If available, the grouping info of the image. String of hexadecimal value (52 characteres) for the byte array object. Byte array order is Litte Endian.
technicalMetadata.image.umidBasic	`string`	If available, the umid basic info of the image. String of hexadecimal value (64 characteres) for the byte array object.
technicalMetadata.image.materialNumber	`string`	If available, the material number of the image. String of hexadecimal value (32 characteres) for the byte array object.
technicalMetadata.image.recordedDate	`string`	The date and Time at which the image was captured.
technicalMetadata.image.locationCity	`string`	Name of the city where the image was created.
technicalMetadata.image.locationState	`string`	Name of the state where the image was created.
technicalMetadata.image.locationCountry	`string`	Name of the country where the image was created.
technicalMetadata.image.exif	`object`	The avalaible EXIF (Exchangeable Image File) metadata.
technicalMetadata.image.exif.imageWidth	`string`	The image width in pixels.
technicalMetadata.image.exif.imageHeight	`string`	The image height in pixels.
technicalMetadata.image.exif.artist	`string`	The image artist info.
technicalMetadata.image.exif.copyright	`string`	The image copyright.
technicalMetadata.image.iptc	`object`	The available IPTC (International Press Telecommunications Council) available.
technicalMetadata.image.iptc.codedCharacterSet	`string`	Determines how the internal IPTC string values are interpreted.
technicalMetadata.image.iptc.headline	`string`	Brief synopsis or summary of the contents of the photograph.
technicalMetadata.image.iptc.credit	`string`	How the image should be credited when published, as specified by the supplier of the image.
technicalMetadata.image.iptc.keywords	`string`	Descriptive words added to the image to enable search and retrieval.
technicalMetadata.image.xmp	`object`	The available XMP (Extensible Metadata Platform) metadata.
technicalMetadata.image.xmp.serialNumber	`string`	Camera Serial Number.
technicalMetadata.image.xmp.creatorRegion	`string`	State / Province for the address of the person that created this image.
technicalMetadata.image.xmp.lens	`string`	Attempts to identify the camera lens used.
technicalMetadata.image.xmp.creatorCountry	`string`	Country name for the address of the person that created this image.
technicalMetadata.avContainer	`object`	If asset type is ‘Audio’ or ‘Video’, this property contains the extended audio / video technical metadata.
technicalMetadata.avContainer.bitRate	`number`	The overall bitrate in the container.
technicalMetadata.avContainer.duration	`number`	The runtime of the media in the container, in seconds.
technicalMetadata.avContainer.start	`number`	The start time in the container, in seconds.
technicalMetadata.avContainer.recordedDate	`string`	The date and Time at which the video was captured.
technicalMetadata.avContainer.deviceManufacturer	`string`	The name of the device Manufacturer.
technicalMetadata.avContainer.timeCode	`string`	The SMPTE timecode in the container.
technicalMetadata.avContainer.derivedTimeCode	`string`	The standardized timecode derived by evaluating stream metadata and converting to drop frame format, if using drop frame rate.
technicalMetadata.avContainer.streams	`array`	Set of audio, video, or data streams contained in the asset.
technicalMetadata.avContainer.streams[].index	`number`	The index of the stream in the container.
technicalMetadata.avContainer.streams[].type	`string`	The type of the stream. Valid values are `Audio`, `Video` or `Data`.
technicalMetadata.avContainer.streams[].bitRate	`number`	If available, the overall bitrate in the stream.
technicalMetadata.avContainer.streams[].bitDepth	`number`	If available, for an `Audio` stream, the bit depth of the stream.
technicalMetadata.avContainer.streams[].bitRateMode	`string`	If available, the bit rate mode of the stream.
technicalMetadata.avContainer.streams[].codec	`string`	If available, the codec used in the stream. For example, `h264`.
technicalMetadata.avContainer.streams[].codecName	`string`	If available, the MediaInfo generated format commercial name for the stream.
technicalMetadata.avContainer.streams[].codecProfile	`string`	If available, the MediaInfo generated format profile for the stream.
technicalMetadata.avContainer.streams[].codecSettings	`string`	If avalable, the MediaInfo generated format settings for the stream.
technicalMetadata.avContainer.streams[].fourCC	`string`	If available, four-character code for the codec used in the stream. For example, `avc1`, `apch`.
technicalMetadata.avContainer.streams[].width	`number`	If available, for a `Video` stream, the width in pixels of the video.
technicalMetadata.avContainer.streams[].height	`number`	If available, for a `Video` stream, the height in pixels of the video.
technicalMetadata.avContainer.streams[].totalFrames	`number`	If available, total number of frames within the `Video` stream.
technicalMetadata.avContainer.streams[].duration	`number`	If available, the runtime of the media in seconds.
technicalMetadata.avContainer.streams[].frameRateNumerator	`number`	If available, the numerator of the frame rate. For example, if the frame rate is 24, the frame rate numerator is 24.
technicalMetadata.avContainer.streams[].frameRateDenominator	`number`	If available, the numerator of the frame rate. For example, if the frame rate is 24, the frame rate denominator is 1.
technicalMetadata.avContainer.streams[].videoPARWidth	`number`	If available, the width part of the pixel aspect ratio.
technicalMetadata.avContainer.streams[].videoPARHeight	`number`	If available, the height part of the pixel aspect ratio.
technicalMetadata.avContainer.streams[].videoDARWidth	`number`	If available, the width part of the display aspect ratio.
technicalMetadata.avContainer.streams[].videoDARHeight	`number`	If available, the height part of the display aspect ratio.
technicalMetadata.avContainer.streams[].start	`number`	If available, the start time in the stream, in seconds.
technicalMetadata.avContainer.streams[].timeCode	`string`	If available, the SMPTE timecode in the stream.
technicalMetadata.avContainer.streams[].videoColorSpace	`string`	If available, for a `Video` stream, the video’s color space / color primaries.
technicalMetadata.avContainer.streams[].videoScanOrder	`string`	If available, for a `Video` stream, the video’s scan order.
technicalMetadata.avContainer.streams[].videoScanType	`string`	If available, for a `Video` stream, the video’s scan type.
technicalMetadata.avContainer.streams[].videoColorPrimaries	`string`	If available, for a `Video` stream, the video’s color primaries.
technicalMetadata.avContainer.streams[].videoChromaSubsampling	`string`	If available, for a `Video` stream, the video’s crhoma subsampling.
technicalMetadata.avContainer.streams[].videoScanTypeStoreMethod	`string`	If available, for a `Video` stream, the video’s scan type store method.
technicalMetadata.avContainer.streams[].audioSampleRate	`number`	If available, for an `Audio` stream, is the sample rate in Hz.
technicalMetadata.avContainer.streams[].audioChannelCount	`number`	If available, for an `Audio` stream, is the number of channels within the stream.
technicalMetadata.avContainer.streams[].audioLayout	`string`	If available, for an `Audio` stream, is the audio channel layout description. For example, `5.1`.
technicalMetadata.avContainer.streams[].audioAnalysis	`string`	If available, for an `Audio` stream, it is further analysis to determine if a stream is true stereo or dual-mono.
technicalMetadata.avContainer.streams[].rotate	`number`	If available, the amount of rotation, in degrees, that should be applied during playback of the video.
technicalMetadata.dolbyContainer	`object`	If asset type is ‘Audio’ and the asset has Dolby Atmos metadata, this property contains the extended Dolby Atmos audio technical metadata.
technicalMetadata.dolbyContainer.duration	`number`	Media duration (in seconds).
technicalMetadata.dolbyContainer.fileSize	`number`	Media size (in bytes).
technicalMetadata.dolbyContainer.overallBitRateMode	`string`	The overall bitrate mode for the Atmos content.
technicalMetadata.dolbyContainer.overallBitRate	`number`	Media bitrate (in bits per second).
technicalMetadata.dolbyContainer.totalChannels	`number`	Number of channels. `Bed channels` plus `Object channels` equals `Total channels`.
technicalMetadata.dolbyContainer.bedChannels	`number`	Number of channel-based premix or stem that includes multichannel panning.
technicalMetadata.dolbyContainer.numberOfBeds	`number`	A bed can be thought of as a traditional channel-based stem with the rules and expectations of stem configurations (such as 2.0, 5.1, and 7.1).
technicalMetadata.dolbyContainer.bitDepth	`number`	Number of bits of information in each sample, generally 16, 24, or 32-bit.
technicalMetadata.dolbyContainer.samplingRate	`number`	Audio sample-rate, generally 44100 or 48000 Hz.
technicalMetadata.dolbyContainer.downmix51X	`string`	Global downmix metadata for monitoring, re-rendering, and encoding.
technicalMetadata.dolbyContainer.trimModesSummary	`string`	A summary of the underlying trim modes.
technicalMetadata.dolbyContainer.trimChannel20Mode	`string`	The type of trim mode supported for 2.0 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
technicalMetadata.dolbyContainer.trimChannel51Mode	`string`	The type of trim mode supported for 5.1 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
technicalMetadata.dolbyContainer.trimChannel71Mode	`string`	The type of trim mode supported for 7.1 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
technicalMetadata.dolbyContainer.trimChannel212Mode	`string`	The type of trim mode supported for 2.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
technicalMetadata.dolbyContainer.trimChannel512Mode	`string`	The type of trim mode supported for 5.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
technicalMetadata.dolbyContainer.trimChannel712Mode	`string`	The type of trim mode supported for 7.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
technicalMetadata.dolbyContainer.trimChannel214Mode	`string`	The type of trim mode supported for 2.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
technicalMetadata.dolbyContainer.trimChannel514Mode	`string`	The type of trim mode supported for 5.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
technicalMetadata.dolbyContainer.trimChannel714Mode	`string`	The type of trim mode supported for 7.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
technicalMetadata.dolbyContainer.associatedVideoFrameRate	`number`	Number of frames per second.
technicalMetadata.dolbyContainer.start	`string`	Start SMPTE timecode based on the video frame rate.
technicalMetadata.dolbyContainer.fFoA	`string`	FFoA (First Frame of Action) SMPTE timecode based on the video frame rate.
technicalMetadata.dolbyContainer.end	`string`	End SMPTE timecode based on the video frame rate.
technicalMetadata.dolbyContainer.metadataFormat	`string`	Format of the metadata in the Atmos content.
technicalMetadata.dolbyContainer.admProfile	`string`	ADM (Audio Definition Model) Profile used in the Atmos content.
technicalMetadata.dolbyContainer.numberOfProgrammes	`number`	Number of programmes in the Atmos content.
technicalMetadata.dolbyContainer.numberOfObjectChannels	`number`	Number of objects in the Atmos Master.
technicalMetadata.dolbyContainer.numberOfPackFormats	`number`	Number of Atmos Pack Formats in the Atmos content.
technicalMetadata.dolbyContainer.numberOfChannelFormats	`number`	Number of channel formats in the Atmos content.
technicalMetadata.dolbyContainer.binauralRenderModesSummary	`string`	Summary of all the binaural render modes used in the Atmos content. Supported strings are a unique combination of: “Off”, “Near”, “Mid”, “Far”.
technicalMetadata.dolbyContainer.binauralRenderModesOffCount	`number`	Number of channels that use the “Off” setting for binaural rendering.
technicalMetadata.dolbyContainer.binauralRenderModesNearCount	`number`	Number of channels that use the “Near” setting for binaural rendering.
technicalMetadata.dolbyContainer.binauralRenderModesMidCount	`number`	Number of channels that use the “Mid” setting for binaural rendering.
technicalMetadata.dolbyContainer.binauralRenderModesFarCount	`number`	Number of channels that use the “Far” setting for binaural rendering.
technicalMetadata.dolbyContainer.truePeakLevels	`number`	The peak event in the audio waveform. Units are dBTP for true peak.
technicalMetadata.dolbyContainer.loudness	`number`	Integrated loudness LKFS (or LUFS).
hlsPlaylistUrl	`string`	A link to the HLS playlist generated from the source file.
acquisitionContext	`object`	The file acquisition information.
acquisitionContext.name	`string`	The original source file name, captured on acquisition.
acquisitionContext.path	`string`	The original source file path, captured on acquisition.
isExternal	`boolean`	Indicates if the file is stored in an external source.
workspace	`object`	Information about the asset’s workspace.
workspace.id	`string`	The unique identifier of the Workspace.
workspace.name	`string`	The name of the Workspace.
workspace.class	`string`	Indicates if the Workspace is a ‘Personal’ or ‘Team’ Workspace.
filmstrips	`array`	The set of filmstrips for the asset. Please check the Previews section for more information.
filmstrips[].type	`string`	The type of filmstrip returned.
filmstrips[].location	`string`	The url of the filmstrip.
filmstrips[].size	`number`	The size of the filmstrip, in bytes.
filmstrips[].frames	`number`	Number of frames contained in the filmstrip.
filmstrips[].frameHeight	`number`	The height of each frame.
filmstrips[].frameWidth	`number`	The width of each frame.
filmstrips[].width	`number`	Total width of the filmstrip.
filmstrips[].height	`number`	Total height of the filmstrip.
waveforms	`array`	The set of waveforms for the asset. Please check the Previews section for more information.
waveforms[].type	`string`	The type of waveform returned.
waveforms[].location	`string`	The url of the waveform.
waveforms[].size	`number`	The size in bytes of the waveform.
waveforms[].maxAmplitude	`number`	Sample values will range from this number to its additive inverse. For example, if this value is 100, then samples within the waveform file will have values between -100 and 100.
waveforms[].sampleMethod	`string`	The type of sample method used to extract samples from the source audio stream. Supported values are ‘SamplesCount’ and ‘SamplesPerSecond’. When ‘SamplesCount’ is returned, then a fixed number of samples was extracted, spanning the duration of the source audio stream. When ‘SamplesPerSecond’ is returned, then a fixed number of samples was extracted per second of audio.
waveforms[].samplesPerSecond	`number`	When the sampleMethod is ‘SamplesPerSecond’, this value indicates the number of samples that were extracted for each second of audio.
waveforms[].uploadCompleteDate	`string`	The datetime the asset upload was completed.
isDeleted	`boolean`	Indicates if an asset is deleted.
trashedOn	`string`	The datetime the asset was trashed.
trashedBy	`object`	Information about the user that trashed the asset.
trashedBy.id	`string`	The unique identifier of the user.
trashedBy.name	`string`	The full name of the user.
trashedBy.email	`string`	The email of the user.

Headers

Content-Type: application/json

Body

{
  "code": "AssetNotFound",
  "message": "Asset not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "name": "Movie.mov",
  "description": "sample description",
  "ingestConfiguration": {
    "autoArchive": true,
    "audioMappings": [
      {
        "mappings": [
          {
            "sourceStream": 1,
            "sourceChannel": 2,
            "targetChannel": 3,
            "amplitude": 0.8
          }
        ]
      }
    ]
  }
}

Property name	Type	Description
name	`string`	The name of the asset, including its extension. Its maximum length is 512 characters.
description	`string`	A brief note associated to the asset. Its maximum length is 1000 characters.
ingestConfiguration	`object`	Settings for customizing the ingest process of the asset.
ingestConfiguration.autoArchive	`boolean`	Indicates if the asset shall be archived right after ingestion.
ingestConfiguration.audioMappings	`array`	A set of objects that specifies ingest customizations that will be used when generating proxies. Currently, we support a single object in this array. If more than 1 object is provided, only the first will be processed and the rest will be ignored.
ingestConfiguration.audioMappings[].mappings	`array`	A set of objects that defines the mapping of a source file’s audio streams to the proxies’ audio streams.
ingestConfiguration.audioMappings[].mappings[].sourceStream	`number`	Index of an audio stream from the source file that will be mapped to each proxy’s audio stream. This index is zero-based.
ingestConfiguration.audioMappings[].mappings[].sourceChannel	`number`	Channel index of the specified source stream that will be mapped to each proxy’s target channels. This index is zero-based and the default is 0.
ingestConfiguration.audioMappings[].mappings[].targetChannel	`number`	Channel index of the proxies’ audio stream. This index is zero-based and the default is 0.
ingestConfiguration.audioMappings[].mappings[].amplitude	`number`	Number between 0 and 1 that determines the amplitude of the proxies’ target channel based on the source channel amplitude. Default is 1.

Responses200400

Headers

Content-Type: application/json

Body

{
  "id": "bcdc34b53e2c4c18ac41ca288e28d11f",
  "name": "Movie.mov",
  "size": 107856722,
  "type": "Video",
  "format": "mov",
  "folder": {
    "id": "9b639e12a82f4b0483f512b474dc052ci",
    "name": "Folder Name"
  },
  "status": "Complete",
  "description": "Final cut",
  "thumbnails": [
    {
      "type": "large",
      "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/thumb.jpg",
      "size": 1024,
      "width": 200,
      "height": 300,
      "source": {
        "id": "elementId1",
        "kind": "element"
      },
      "isExternal": false
    }
  ],
  "proxies": [
    {
      "type": "video-3g",
      "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/proxy.jpg",
      "size": 1024,
      "width": 200,
      "height": 300,
      "videoBitRate": 1650000,
      "audioBitRate": 128000,
      "isExternal": false
    }
  ],
  "md5Checksum": "tk2ma0zrhrp5irco",
  "createdOn": "2017-01-02T00:00:00.000Z",
  "createdBy": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith",
    "email": "johnsmith@example.com"
  },
  "modifiedOn": "2017-01-02T00:00:00.000Z",
  "lastActivityOn": "2017-01-03T00:00:00.000Z",
  "acquisitionSource": {
    "name": "Workspace"
  },
  "archiveStatus": "Not archived",
  "archiveType": "Standard",
  "restoreStatus": "Not restored",
  "restoreExpirationDate": "2017-01-02T00:00:00.000Z",
  "restoreRequestDate": "2017-01-02T00:00:00.000Z",
  "lastRestoreDate": "2017-01-02T00:00:00.000Z",
  "restoredBy": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith",
    "email": "johnsmith@example.com"
  },
  "archiveDate": "2017-01-02T00:00:00.000Z",
  "archivedBy": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith",
    "email": "johnsmith@example.com"
  },
  "uploadCompleteDate": "2017-01-02T00:00:00.000Z",
  "isTrashed": false,
  "uploadTransferType": "SinglepartHttp",
  "runtime": 1024,
  "totalFolderCount": 1,
  "network": {
    "id": "40c2a6b99a474b319dec5ef9c7dbb356",
    "name": "Company Name",
    "class": "Enterprise"
  },
  "metadata": [
    {
      "name": "resolution",
      "value": "1080p",
      "readOnly": false
    }
  ],
  "technicalMetadata": {
    "type": "Video",
    "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/metadata.jpg",
    "size": 1024,
    "image": {
      "width": 100,
      "height": 300,
      "xResolution": 100,
      "yResolution": 100,
      "resolutionUnit": "cm",
      "cameraMake": "Nikon",
      "cameraModel": "D300",
      "groupingInfo": "6445055e520106d9d01769fffefd058901000100000000000000",
      "umidBasic": "060a2b340101010501010143130000006445055e520106cbd01769fffefd0589",
      "materialNumber": "6445055e520106cbd01769fffefd0589",
      "recordedDate": "2023-07-27T01:39:24Z",
      "locationCity": "New York",
      "locationState": "NY",
      "locationCountry": "USA",
      "exif": {
        "imageWidth": "3888",
        "imageHeight": "2592",
        "artist": "Michael W. Steidl.",
        "copyright": "(c) 2011 IPTC - Rights reserved."
      },
      "iptc": {
        "codedCharacterSet": "UTF8",
        "headline": "Bikefestival Vienna",
        "credit": "IPTC/Michael W. Steidl",
        "keywords": "Vienna Air King,cycling,mountain bike"
      },
      "xmp": {
        "serialNumber": "0380227035",
        "creatorRegion": "Roshire",
        "lens": "EF70-300mm f/4-5.6L IS USM",
        "creatorCountry": "United Kingdom"
      }
    },
    "avContainer": {
      "bitRate": 11934620,
      "duration": 100,
      "start": 0,
      "recordedDate": "2022-11-21T06:42:41Z",
      "deviceManufacturer": "Sony",
      "timeCode": "00:00:00:00",
      "derivedTimeCode": "00:00:00:00",
      "streams": [
        {
          "index": 0,
          "type": "Video",
          "bitRate": 11934620,
          "bitDepth": 8,
          "bitRateMode": "CBR",
          "codec": "h264",
          "codecName": "ProRes",
          "codecProfile": "422 HQ",
          "codecSettings": "Little / Signed",
          "fourCC": "avc1",
          "width": 1280,
          "height": 720,
          "totalFrames": 1024,
          "duration": 100,
          "frameRateNumerator": 360,
          "frameRateDenominator": 12,
          "videoPARWidth": 1,
          "videoPARHeight": 1,
          "videoDARWidth": 19,
          "videoDARHeight": 24,
          "start": 0,
          "timeCode": "00:00:00:00",
          "videoColorSpace": "bt709",
          "videoScanOrder": "TFF",
          "videoScanType": "Interlaced",
          "videoColorPrimaries": "DCI P3",
          "videoChromaSubsampling": "4:2:2",
          "videoScanTypeStoreMethod": "Interleaved fields",
          "audioSampleRate": 32000,
          "audioChannelCount": 2,
          "audioLayout": "Stereo",
          "audioAnalysis": "Stereo",
          "rotate": 0
        }
      ]
    },
    "dolbyContainer": {
      "duration": 9.6,
      "fileSize": 80294994,
      "overallBitRateMode": "CBR",
      "overallBitRate": 66912495,
      "totalChannels": 58,
      "bedChannels": 10,
      "numberOfBeds": 1,
      "bitDepth": 24,
      "samplingRate": 48000,
      "downmix51X": "Direct Render",
      "trimModesSummary": "automatic + manual_0",
      "trimChannel20Mode": "manual_0",
      "trimChannel51Mode": "manual_0",
      "trimChannel71Mode": "automatic",
      "trimChannel212Mode": "manual_0",
      "trimChannel512Mode": "automatic",
      "trimChannel712Mode": "manual_0",
      "trimChannel214Mode": "manual_0",
      "trimChannel514Mode": "manual_0",
      "trimChannel714Mode": "manual_0",
      "associatedVideoFrameRate": 23.976,
      "start": "01:00:00:00",
      "fFoA": "01:00:00:00",
      "end": "01:03:30:13",
      "metadataFormat": "ADM, Version 0",
      "admProfile": "Dolby Atmos Master, Version 1",
      "numberOfProgrammes": 1,
      "numberOfObjectChannels": 48,
      "numberOfPackFormats": 49,
      "numberOfChannelFormats": 58,
      "binauralRenderModesSummary": "Off + Near + Mid + Far",
      "binauralRenderModesOffCount": 9,
      "binauralRenderModesNearCount": 8,
      "binauralRenderModesMidCount": 13,
      "binauralRenderModesFarCount": 1,
      "truePeakLevels": -3.14,
      "loudness": -16.67
    }
  },
  "hlsPlaylistUrl": "https://cimediacloud.com/t5y7s3ero3w2ie7/hls",
  "acquisitionContext": {
    "name": "Movie1.mov",
    "path": "original/source/path"
  },
  "isExternal": false,
  "workspace": {
    "id": "gb5ehomv0iv71swg",
    "name": "Workspace Name",
    "class": "Enterprise"
  },
  "filmstrips": [
    {
      "type": "video-filmstrip-small",
      "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/filmstrip.jpg",
      "size": 1024,
      "frames": 100,
      "frameHeight": 100,
      "frameWidth": 100,
      "width": 100,
      "height": 1000
    }
  ],
  "waveforms": [
    {
      "type": "video-waveform",
      "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/waveform.jpg",
      "size": 1024,
      "maxAmplitude": 1000,
      "sampleMethod": "SamplesCount",
      "samplesPerSecond": 12,
      "uploadCompleteDate": "2017-01-02T00:00:00.000Z"
    }
  ],
  "isDeleted": false,
  "trashedOn": "2017-01-02T00:00:00.000Z",
  "trashedBy": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith",
    "email": "johnsmith@example.com"
  }
}

Property name	Type	Description
id	`string`	The unique identifier of the asset.
name	`string`	The name of the asset, including its extension. Its maximum length is 512 characters.
size	`number`	The size of the source file, in bytes.
type	`string`	The type of the asset. Valid values are `Audio`, `Video`, `Image`, `Document`, or `Other`.
format	`string`	The asset’s file format.
folder	`object`	Information about the asset’s parent folder.
folder.id	`string`	The unique identifier of the folder.
folder.name	`string`	The name of folder.
status	`string`	The status of the asset. Valid values are ‘Created’, ‘Complete’, ‘Deleted’, ‘Executable Detected’, ‘Failed’, ‘Limited’, ‘Processing’, ‘Uploading’, ‘Virus Detected’, ‘Waiting’. See this section for more information.
description	`string`	A comment or note associated to the asset. Its maximum length is 1000 characters.
thumbnails	`array`	The set of thumbnails for the asset.
thumbnails[].type	`string`	The type of thumbnail returned. Valid values are ‘small’, ‘medium’ and ‘large’.
thumbnails[].location	`string`	The url of the thumbnail.
thumbnails[].size	`number`	The size of the thumbnail, in bytes.
thumbnails[].width	`number`	The width of the thumbnail.
thumbnails[].height	`number`	The height of the thumbnail.
thumbnails[].source	`object`	Information about the source of thumbnails.
thumbnails[].source.id	`string`	Unique identifier of the thumbnail’s source.
thumbnails[].source.kind	`string`	The kind of entity of the thumbnail’s source.
thumbnails[].isExternal	`boolean`	Indicates if the thumbnail is stored in an external source.
proxies	`array`	The set of proxies for the asset.
proxies[].type	`string`	The type of proxy returned. Valid values are ‘standard-audio’, ‘dolby-audio’, ‘video-3g’, ‘video-sd’, ‘video-sdplus’, ‘video-hd’, ‘video-2k’, ‘video-2kplus’, ‘document-pdf’.
proxies[].location	`string`	The url of the proxy.
proxies[].size	`number`	The size of the proxy, in bytes.
proxies[].width	`number`	The width of the proxy.
proxies[].height	`number`	The height of the proxy.
proxies[].videoBitRate	`number`	The video bitrate of the proxy.
proxies[].audioBitRate	`number`	The audio bitrate of the proxy.
proxies[].isExternal	`boolean`	Indicates if the proxy is stored in an external source.
md5Checksum	`string`	The calculated md5 checksum for the asset.
createdOn	`string`	The datetime the asset record was created.
createdBy	`object`	Information about the creator of the asset
createdBy.id	`string`	The unique identifier of the user.
createdBy.name	`string`	The full name of the user.
createdBy.email	`string`	The email of the user.
modifiedOn	`string`	The datetime the asset record was last modified.
lastActivityOn	`string`	The datetime of the last activity of the asset record.
acquisitionSource	`object`	Information about the asset’s source client application.
acquisitionSource.name	`string`	The name of the client application that uploaded the asset.
archiveStatus	`string`	The archive status of the asset. Valid values are ‘Not archived’, ‘Archive in progress’, ‘Archive failed’, ‘Archived’, ‘Cancel archive in progress’.
archiveType	`string`	If available, the kind of archive used for storing the asset. Valid values are `Standard` and `Deep`.
restoreStatus	`string`	The restore status of the asset. This is applicable to assets that have been archived. Valid values are ‘Not restored’, ‘Restore in progress’, ‘Restore failed’, ‘Restored’.
restoreExpirationDate	`string`	If available, the datetime the restored copy of the asset’s source file will no longer be available.
restoreRequestDate	`string`	If available, the datetime the asset’s source file was requested to be restored.
lastRestoreDate	`string`	If available, the datetime the asset’s source file was last restored.
restoredBy	`object`	If available, information about the user who restored the asset.
restoredBy.id	`string`	The unique identifier of the user.
restoredBy.name	`string`	The full name of the user.
restoredBy.email	`string`	The email of the user.
archiveDate	`string`	If available, the datetime the asset’s source file was last archived.
archivedBy	`object`	If available, information about the user who archived the asset.
archivedBy.id	`string`	The unique identifier of the user.
archivedBy.name	`string`	The full name of the user.
archivedBy.email	`string`	The email of the user.
uploadCompleteDate	`string`	The datetime the asset upload was completed.
isTrashed	`boolean`	Indicates if an asset is in the trash bin.
uploadTransferType	`string`	Indicates how the asset was uploaded. Valid values are ‘SinglepartHttp’, ‘MultipartHttp’, ‘Aspera’, ‘Copy’, ‘FTP’, ‘WorkspaceSend’.
runtime	`number`	The duration of the media asset, in seconds.
totalFolderCount	`number`	The amount of folders where the asset exists.
network	`object`	Information about the asset’s network.
network.id	`string`	The unique identifier of the Network.
network.name	`string`	The name of the Network.
network.class	`string`	Indicates if the Network is a ‘Personal’ or ‘Enterprise’ Network.
metadata	`array`	An array of key-value pairs of user-generated and basic technical metadata.
metadata[].name	`string`	The name of the metadata item.
metadata[].value	`string`	the value of the metadata item.
metadata[].readOnly	`boolean`	Flag to set a read-only metadata.
technicalMetadata	`object`	An object that contains all the technical metadata available.
technicalMetadata.type	`string`	The type of the asset. Valid values are either ‘Audio’, ‘Video’ or ‘Image’.
technicalMetadata.location	`string`	Url of the source technical metadata file. Note: the content and structure of the technical metadata file is subject to change at any time.
technicalMetadata.size	`number`	The size of the technical metadata file, in bytes.
technicalMetadata.image	`object`	If the asset’s type is ‘Image’, this property contains the extended image technical metadata.
technicalMetadata.image.width	`number`	The width of the image, in pixels.
technicalMetadata.image.height	`number`	The height of the image, in pixels.
technicalMetadata.image.xResolution	`number`	The number of pixels per resolutionUnit in the width direction.
technicalMetadata.image.yResolution	`number`	The number of pixels per resolutionUnit in the height direction.
technicalMetadata.image.resolutionUnit	`string`	The unit of measurement for xResolution and yResolution. Can be ‘inches’, ‘cm’ or ‘none’.
technicalMetadata.image.cameraMake	`string`	Camera manufacturer name.
technicalMetadata.image.cameraModel	`string`	Camera model name.
technicalMetadata.image.groupingInfo	`string`	If available, the grouping info of the image. String of hexadecimal value (52 characteres) for the byte array object. Byte array order is Litte Endian.
technicalMetadata.image.umidBasic	`string`	If available, the umid basic info of the image. String of hexadecimal value (64 characteres) for the byte array object.
technicalMetadata.image.materialNumber	`string`	If available, the material number of the image. String of hexadecimal value (32 characteres) for the byte array object.
technicalMetadata.image.recordedDate	`string`	The date and Time at which the image was captured.
technicalMetadata.image.locationCity	`string`	Name of the city where the image was created.
technicalMetadata.image.locationState	`string`	Name of the state where the image was created.
technicalMetadata.image.locationCountry	`string`	Name of the country where the image was created.
technicalMetadata.image.exif	`object`	The avalaible EXIF (Exchangeable Image File) metadata.
technicalMetadata.image.exif.imageWidth	`string`	The image width in pixels.
technicalMetadata.image.exif.imageHeight	`string`	The image height in pixels.
technicalMetadata.image.exif.artist	`string`	The image artist info.
technicalMetadata.image.exif.copyright	`string`	The image copyright.
technicalMetadata.image.iptc	`object`	The available IPTC (International Press Telecommunications Council) available.
technicalMetadata.image.iptc.codedCharacterSet	`string`	Determines how the internal IPTC string values are interpreted.
technicalMetadata.image.iptc.headline	`string`	Brief synopsis or summary of the contents of the photograph.
technicalMetadata.image.iptc.credit	`string`	How the image should be credited when published, as specified by the supplier of the image.
technicalMetadata.image.iptc.keywords	`string`	Descriptive words added to the image to enable search and retrieval.
technicalMetadata.image.xmp	`object`	The available XMP (Extensible Metadata Platform) metadata.
technicalMetadata.image.xmp.serialNumber	`string`	Camera Serial Number.
technicalMetadata.image.xmp.creatorRegion	`string`	State / Province for the address of the person that created this image.
technicalMetadata.image.xmp.lens	`string`	Attempts to identify the camera lens used.
technicalMetadata.image.xmp.creatorCountry	`string`	Country name for the address of the person that created this image.
technicalMetadata.avContainer	`object`	If asset type is ‘Audio’ or ‘Video’, this property contains the extended audio / video technical metadata.
technicalMetadata.avContainer.bitRate	`number`	The overall bitrate in the container.
technicalMetadata.avContainer.duration	`number`	The runtime of the media in the container, in seconds.
technicalMetadata.avContainer.start	`number`	The start time in the container, in seconds.
technicalMetadata.avContainer.recordedDate	`string`	The date and Time at which the video was captured.
technicalMetadata.avContainer.deviceManufacturer	`string`	The name of the device Manufacturer.
technicalMetadata.avContainer.timeCode	`string`	The SMPTE timecode in the container.
technicalMetadata.avContainer.derivedTimeCode	`string`	The standardized timecode derived by evaluating stream metadata and converting to drop frame format, if using drop frame rate.
technicalMetadata.avContainer.streams	`array`	Set of audio, video, or data streams contained in the asset.
technicalMetadata.avContainer.streams[].index	`number`	The index of the stream in the container.
technicalMetadata.avContainer.streams[].type	`string`	The type of the stream. Valid values are `Audio`, `Video` or `Data`.
technicalMetadata.avContainer.streams[].bitRate	`number`	If available, the overall bitrate in the stream.
technicalMetadata.avContainer.streams[].bitDepth	`number`	If available, for an `Audio` stream, the bit depth of the stream.
technicalMetadata.avContainer.streams[].bitRateMode	`string`	If available, the bit rate mode of the stream.
technicalMetadata.avContainer.streams[].codec	`string`	If available, the codec used in the stream. For example, `h264`.
technicalMetadata.avContainer.streams[].codecName	`string`	If available, the MediaInfo generated format commercial name for the stream.
technicalMetadata.avContainer.streams[].codecProfile	`string`	If available, the MediaInfo generated format profile for the stream.
technicalMetadata.avContainer.streams[].codecSettings	`string`	If avalable, the MediaInfo generated format settings for the stream.
technicalMetadata.avContainer.streams[].fourCC	`string`	If available, four-character code for the codec used in the stream. For example, `avc1`, `apch`.
technicalMetadata.avContainer.streams[].width	`number`	If available, for a `Video` stream, the width in pixels of the video.
technicalMetadata.avContainer.streams[].height	`number`	If available, for a `Video` stream, the height in pixels of the video.
technicalMetadata.avContainer.streams[].totalFrames	`number`	If available, total number of frames within the `Video` stream.
technicalMetadata.avContainer.streams[].duration	`number`	If available, the runtime of the media in seconds.
technicalMetadata.avContainer.streams[].frameRateNumerator	`number`	If available, the numerator of the frame rate. For example, if the frame rate is 24, the frame rate numerator is 24.
technicalMetadata.avContainer.streams[].frameRateDenominator	`number`	If available, the numerator of the frame rate. For example, if the frame rate is 24, the frame rate denominator is 1.
technicalMetadata.avContainer.streams[].videoPARWidth	`number`	If available, the width part of the pixel aspect ratio.
technicalMetadata.avContainer.streams[].videoPARHeight	`number`	If available, the height part of the pixel aspect ratio.
technicalMetadata.avContainer.streams[].videoDARWidth	`number`	If available, the width part of the display aspect ratio.
technicalMetadata.avContainer.streams[].videoDARHeight	`number`	If available, the height part of the display aspect ratio.
technicalMetadata.avContainer.streams[].start	`number`	If available, the start time in the stream, in seconds.
technicalMetadata.avContainer.streams[].timeCode	`string`	If available, the SMPTE timecode in the stream.
technicalMetadata.avContainer.streams[].videoColorSpace	`string`	If available, for a `Video` stream, the video’s color space / color primaries.
technicalMetadata.avContainer.streams[].videoScanOrder	`string`	If available, for a `Video` stream, the video’s scan order.
technicalMetadata.avContainer.streams[].videoScanType	`string`	If available, for a `Video` stream, the video’s scan type.
technicalMetadata.avContainer.streams[].videoColorPrimaries	`string`	If available, for a `Video` stream, the video’s color primaries.
technicalMetadata.avContainer.streams[].videoChromaSubsampling	`string`	If available, for a `Video` stream, the video’s crhoma subsampling.
technicalMetadata.avContainer.streams[].videoScanTypeStoreMethod	`string`	If available, for a `Video` stream, the video’s scan type store method.
technicalMetadata.avContainer.streams[].audioSampleRate	`number`	If available, for an `Audio` stream, is the sample rate in Hz.
technicalMetadata.avContainer.streams[].audioChannelCount	`number`	If available, for an `Audio` stream, is the number of channels within the stream.
technicalMetadata.avContainer.streams[].audioLayout	`string`	If available, for an `Audio` stream, is the audio channel layout description. For example, `5.1`.
technicalMetadata.avContainer.streams[].audioAnalysis	`string`	If available, for an `Audio` stream, it is further analysis to determine if a stream is true stereo or dual-mono.
technicalMetadata.avContainer.streams[].rotate	`number`	If available, the amount of rotation, in degrees, that should be applied during playback of the video.
technicalMetadata.dolbyContainer	`object`	If asset type is ‘Audio’ and the asset has Dolby Atmos metadata, this property contains the extended Dolby Atmos audio technical metadata.
technicalMetadata.dolbyContainer.duration	`number`	Media duration (in seconds).
technicalMetadata.dolbyContainer.fileSize	`number`	Media size (in bytes).
technicalMetadata.dolbyContainer.overallBitRateMode	`string`	The overall bitrate mode for the Atmos content.
technicalMetadata.dolbyContainer.overallBitRate	`number`	Media bitrate (in bits per second).
technicalMetadata.dolbyContainer.totalChannels	`number`	Number of channels. `Bed channels` plus `Object channels` equals `Total channels`.
technicalMetadata.dolbyContainer.bedChannels	`number`	Number of channel-based premix or stem that includes multichannel panning.
technicalMetadata.dolbyContainer.numberOfBeds	`number`	A bed can be thought of as a traditional channel-based stem with the rules and expectations of stem configurations (such as 2.0, 5.1, and 7.1).
technicalMetadata.dolbyContainer.bitDepth	`number`	Number of bits of information in each sample, generally 16, 24, or 32-bit.
technicalMetadata.dolbyContainer.samplingRate	`number`	Audio sample-rate, generally 44100 or 48000 Hz.
technicalMetadata.dolbyContainer.downmix51X	`string`	Global downmix metadata for monitoring, re-rendering, and encoding.
technicalMetadata.dolbyContainer.trimModesSummary	`string`	A summary of the underlying trim modes.
technicalMetadata.dolbyContainer.trimChannel20Mode	`string`	The type of trim mode supported for 2.0 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
technicalMetadata.dolbyContainer.trimChannel51Mode	`string`	The type of trim mode supported for 5.1 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
technicalMetadata.dolbyContainer.trimChannel71Mode	`string`	The type of trim mode supported for 7.1 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
technicalMetadata.dolbyContainer.trimChannel212Mode	`string`	The type of trim mode supported for 2.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
technicalMetadata.dolbyContainer.trimChannel512Mode	`string`	The type of trim mode supported for 5.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
technicalMetadata.dolbyContainer.trimChannel712Mode	`string`	The type of trim mode supported for 7.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
technicalMetadata.dolbyContainer.trimChannel214Mode	`string`	The type of trim mode supported for 2.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
technicalMetadata.dolbyContainer.trimChannel514Mode	`string`	The type of trim mode supported for 5.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
technicalMetadata.dolbyContainer.trimChannel714Mode	`string`	The type of trim mode supported for 7.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
technicalMetadata.dolbyContainer.associatedVideoFrameRate	`number`	Number of frames per second.
technicalMetadata.dolbyContainer.start	`string`	Start SMPTE timecode based on the video frame rate.
technicalMetadata.dolbyContainer.fFoA	`string`	FFoA (First Frame of Action) SMPTE timecode based on the video frame rate.
technicalMetadata.dolbyContainer.end	`string`	End SMPTE timecode based on the video frame rate.
technicalMetadata.dolbyContainer.metadataFormat	`string`	Format of the metadata in the Atmos content.
technicalMetadata.dolbyContainer.admProfile	`string`	ADM (Audio Definition Model) Profile used in the Atmos content.
technicalMetadata.dolbyContainer.numberOfProgrammes	`number`	Number of programmes in the Atmos content.
technicalMetadata.dolbyContainer.numberOfObjectChannels	`number`	Number of objects in the Atmos Master.
technicalMetadata.dolbyContainer.numberOfPackFormats	`number`	Number of Atmos Pack Formats in the Atmos content.
technicalMetadata.dolbyContainer.numberOfChannelFormats	`number`	Number of channel formats in the Atmos content.
technicalMetadata.dolbyContainer.binauralRenderModesSummary	`string`	Summary of all the binaural render modes used in the Atmos content. Supported strings are a unique combination of: “Off”, “Near”, “Mid”, “Far”.
technicalMetadata.dolbyContainer.binauralRenderModesOffCount	`number`	Number of channels that use the “Off” setting for binaural rendering.
technicalMetadata.dolbyContainer.binauralRenderModesNearCount	`number`	Number of channels that use the “Near” setting for binaural rendering.
technicalMetadata.dolbyContainer.binauralRenderModesMidCount	`number`	Number of channels that use the “Mid” setting for binaural rendering.
technicalMetadata.dolbyContainer.binauralRenderModesFarCount	`number`	Number of channels that use the “Far” setting for binaural rendering.
technicalMetadata.dolbyContainer.truePeakLevels	`number`	The peak event in the audio waveform. Units are dBTP for true peak.
technicalMetadata.dolbyContainer.loudness	`number`	Integrated loudness LKFS (or LUFS).
hlsPlaylistUrl	`string`	A link to the HLS playlist generated from the source file.
acquisitionContext	`object`	The file acquisition information.
acquisitionContext.name	`string`	The original source file name, captured on acquisition.
acquisitionContext.path	`string`	The original source file path, captured on acquisition.
isExternal	`boolean`	Indicates if the file is stored in an external source.
workspace	`object`	Information about the asset’s workspace.
workspace.id	`string`	The unique identifier of the Workspace.
workspace.name	`string`	The name of the Workspace.
workspace.class	`string`	Indicates if the Workspace is a ‘Personal’ or ‘Team’ Workspace.
filmstrips	`array`	The set of filmstrips for the asset. Please check the Previews section for more information.
filmstrips[].type	`string`	The type of filmstrip returned.
filmstrips[].location	`string`	The url of the filmstrip.
filmstrips[].size	`number`	The size of the filmstrip, in bytes.
filmstrips[].frames	`number`	Number of frames contained in the filmstrip.
filmstrips[].frameHeight	`number`	The height of each frame.
filmstrips[].frameWidth	`number`	The width of each frame.
filmstrips[].width	`number`	Total width of the filmstrip.
filmstrips[].height	`number`	Total height of the filmstrip.
waveforms	`array`	The set of waveforms for the asset. Please check the Previews section for more information.
waveforms[].type	`string`	The type of waveform returned.
waveforms[].location	`string`	The url of the waveform.
waveforms[].size	`number`	The size in bytes of the waveform.
waveforms[].maxAmplitude	`number`	Sample values will range from this number to its additive inverse. For example, if this value is 100, then samples within the waveform file will have values between -100 and 100.
waveforms[].sampleMethod	`string`	The type of sample method used to extract samples from the source audio stream. Supported values are ‘SamplesCount’ and ‘SamplesPerSecond’. When ‘SamplesCount’ is returned, then a fixed number of samples was extracted, spanning the duration of the source audio stream. When ‘SamplesPerSecond’ is returned, then a fixed number of samples was extracted per second of audio.
waveforms[].samplesPerSecond	`number`	When the sampleMethod is ‘SamplesPerSecond’, this value indicates the number of samples that were extracted for each second of audio.
waveforms[].uploadCompleteDate	`string`	The datetime the asset upload was completed.
isDeleted	`boolean`	Indicates if an asset is deleted.
trashedOn	`string`	The datetime the asset was trashed.
trashedBy	`object`	Information about the user that trashed the asset.
trashedBy.id	`string`	The unique identifier of the user.
trashedBy.name	`string`	The full name of the user.
trashedBy.email	`string`	The email of the user.

Headers

Content-Type: application/json

Body

{
  "code": "AssetNotFound",
  "message": "Asset not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Update an Asset
PUT`/assets/{assetId}`

URI Parameters

HideShow

assetId: string (required)
The unique identifier of the asset.

Description

Updates specified properties of an asset. The current version of Ci API supports updating the name, description, and ingestConfiguration of an asset.

When renaming an asset keep this information in mind:

If the correct asset extension / format is not provided it will be appended.
If the asset does not have an extension and the new name does, the asset format and type properties will be updated.
Invalid characters will be replaced by underscores. Invalid characters include, but may not be restricted to, the following:

< (less than)
> (greater than)
: (colon)
" (double quote)
/ (forward slash)
\ (backslash)
| (vertical bar or pipe)
? (question mark)
* (asterisk)

Errors

Status Code	Error Code	Message
400	MissingOrInvalidName	Missing or invalid name. The file name must not be null and its length must be equal to or less than 512 characters.
400	InvalidDescription	Invalid description. The description length must equal to or less than 1000 characters.
400	InvalidFileType	Invalid file type.
404	AssetNotFound	Asset not found.
404	AssetDeleted	Asset is deleted.
409	ProxiesAlreadyCreated	Asset already has one or more proxies.

DELETE https://api.cimediacloud.com/assets/yiireizq1hcowxua

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200404

Headers

Content-Type: application/json

Body

{
  "message": "Asset was deleted"
}

Property name	Type	Description
message	`string`	Indicates the asset was deleted.

Headers

Content-Type: application/json

Body

{
  "code": "AssetNotFound",
  "message": "Asset not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Delete an Asset
DELETE`/assets/{assetId}`

URI Parameters

HideShow

assetId: string (required)
The unique identifier of the asset.

Description

Deletes the specified asset and its associated files permanently. The storage quota is updated to reflect the newly freed space.

Assets are permanently deleted and cannot be recovered.

Errors

Status Code	Error Code	Message
404	AssetNotFound	Asset not found.
404	AssetDeleted	Asset is deleted.

Create Multiple Assets ¶

POST https://api.cimediacloud.com/assets/create

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

[
  {
    "name": "Movie.mov",
    "size": 1024,
    "workspaceId": "oj7mx3vlb2srei89",
    "folderId": "6ovu49kdb3z32z2w",
    "description": "sample description",
    "metadata": {
      "key name 1": "value",
      "key name 2": "value"
    },
    "ingestConfiguration": {
      "autoArchive": true,
      "audioMappings": [
        {
          "mappings": [
            {
              "sourceStream": 1,
              "sourceChannel": 2,
              "targetChannel": 3,
              "amplitude": 0.8
            }
          ]
        }
      ]
    }
  }
]

Property name	Type	Description
name	`string` (required)	The name of the asset, including its extension. Its maximum length is 512 characters.
size	`number` (required)	The size of the asset, in bytes.
workspaceId	`string`	The workspace that will contain the asset. If no value is provided, the asset will be placed in the calling user’s personal workspace.
folderId	`string`	The workspace’s folder that will contain the asset. If no value is provided, the asset will be placed in the workspace’s root folder.
description	`string`	A brief note associated to the asset. Its maximum length is 1000 characters.
metadata	`object`	An object containing key-value pairs of user-generated metadata.
metadata.key name 1	`string`	An example key-value.
metadata.key name 2	`string`	An example key-value.
ingestConfiguration	`object`	Settings for customizing the ingest process of the asset.
ingestConfiguration.autoArchive	`boolean`	Indicates if the asset shall be archived right after ingestion.
ingestConfiguration.audioMappings	`array`	A set of objects that specifies ingest customizations that will be used when generating proxies. Currently, we support a single object in this array. If more than 1 object is provided, only the first will be processed and the rest will be ignored.
ingestConfiguration.audioMappings[].mappings	`array`	A set of objects that defines the mapping of a source file’s audio streams to the proxies’ audio streams.
ingestConfiguration.audioMappings[].mappings[].sourceStream	`number`	Index of an audio stream from the source file that will be mapped to each proxy’s audio stream. This index is zero-based.
ingestConfiguration.audioMappings[].mappings[].sourceChannel	`number`	Channel index of the specified source stream that will be mapped to each proxy’s target channels. This index is zero-based and the default is 0.
ingestConfiguration.audioMappings[].mappings[].targetChannel	`number`	Channel index of the proxies’ audio stream. This index is zero-based and the default is 0.
ingestConfiguration.audioMappings[].mappings[].amplitude	`number`	Number between 0 and 1 that determines the amplitude of the proxies’ target channel based on the source channel amplitude. Default is 1.

Responses200400

Headers

Content-Type: application/json

Body

{
  "count": 1,
  "items": [
    {
      "id": "d9bf018c804a4e78b775b8dc2f242071",
      "name": "Movie.mov"
    }
  ]
}

Property name	Type	Description
count	`number`	The number of assets to be uploaded.
items	`array`	The assets to be uploaded.
items[].id	`string`	The unique identifier of the asset.
items[].name	`string`	The name of asset and its extension.

Headers

Content-Type: application/json

Body

{
  "completeCount": 0,
  "errorCount": 1,
  "errors": [
    {
      "name": "Item name",
      "kind": "Item",
      "errorCode": "ItemNotFound",
      "errorMessage": "Item not found.",
      "id": "ad9289a2019a4e07a08eca9459ef1091"
    }
  ]
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors	`array`	An array containing information about each failed item.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].id	`string`	The unique identifier for the item.

Create Multiple Assets
POST`/assets/create`

Creates multiple asset records in a single operation.

The maximum number of assets for bulk create is 500.

Your plan must have enough free space to accommodate all new assets or the transaction will fail.

This resource will return a failure response if any of the provided asset information is invalid.

Errors

Status Code	Error Code	Message
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	MissingOrInvalidName	Missing or invalid name. The file name must not be null and its length must be equal to or less than 512 characters.
400	InvalidDescription	Invalid description. The description length must equal to or less than 1000 characters.
400	MissingOrInvalidFileSize	Missing or invalid file size.
400	InvalidFileType	Invalid file type.
400	ExceededMaxAssetCount	Max asset count exceeded. The maximum number of assets is 500.
400	WorkspaceNotFound	Workspace not found.
400	InvalidOperationOnWorkspace	Invalid workspaces provided. Creating assets in bulk is limited to one workspace.
400	FolderNotFound	Folder not found.
400	FolderNotMemberOfWorkspace	Folder is not a member of the provided workspace.
400	InvalidIngestConfiguration	Invalid ingest configuration.
409	FolderDeleted	Folder is deleted.
409	FolderTrashed	Folder is trashed.
409	InsufficientSpaceAvailable	Upload will exceed the workspace’s allotted storage.

Get Multiple Assets' Details ¶

POST https://api.cimediacloud.com/assets/details/bulk

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "assetIds": [
    "m90b2siiymehdnhv"
  ],
  "thumbnailExpirationDate": "2030-01-02T00:00:00.000Z",
  "proxyExpirationDate": "2030-01-02T00:00:00.000Z",
  "hlsPlaylistExpirationDate": "2030-01-02T00:00:00.000Z",
  "fields": [
    "size",
    "createdOn"
  ],
  "extraFields": [
    "commentStats"
  ]
}

Property name	Type	Description
assetIds	`array` (required)	The unique identifiers for all assets to retrieve.
thumbnailExpirationDate	`string`	The date and time for thumbnail URL expiration in IS0 8601 date and time format (e.g.: ‘2020-01-01’). Value must be less than ‘2038-01-01’ and greater than the current date and time. If not provided, default of 2 years is used.
proxyExpirationDate	`string`	The date and time for proxy URL expiration in IS0 8601 date and time format (e.g.: ‘2020-01-01’). Value must be less than ‘2038-01-01’ and greater than the current date and time. If not provided, default of 12 hours is used.
hlsPlaylistExpirationDate	`string`	The date and time for HLS playlist URL expiration in IS0 8601 date and time format (e.g.: ‘2020-01-01’). Value must be less than ‘2038-01-01’ and greater than the current date and time. If not provided, default of 12 hours is used.
fields	`array`	A list of fields to return in the response. If this array is empty all fields will be returned. Id, Name and Kind are always returned.
extraFields	`array`	A comma separated list of extra fields to return in the response. If this value is empty, the extra fields will not be included in the response.

Responses200409

Headers

Content-Type: application/json

Body

{
  "count": 1,
  "errorCount": 1,
  "errors": [
    {
      "name": "Item name",
      "kind": "Item",
      "errorCode": "ItemNotFound",
      "errorMessage": "Item not found.",
      "id": "ad9289a2019a4e07a08eca9459ef1091"
    }
  ],
  "items": [
    {
      "id": "bcdc34b53e2c4c18ac41ca288e28d11f",
      "name": "Movie.mov",
      "size": 107856722,
      "type": "Video",
      "format": "mov",
      "folder": {
        "id": "9b639e12a82f4b0483f512b474dc052ci",
        "name": "Folder Name"
      },
      "status": "Complete",
      "description": "Final cut",
      "thumbnails": [
        {
          "type": "large",
          "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/thumb.jpg",
          "size": 1024,
          "width": 200,
          "height": 300,
          "source": {
            "id": "elementId1",
            "kind": "element"
          },
          "isExternal": false
        }
      ],
      "proxies": [
        {
          "type": "video-3g",
          "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/proxy.jpg",
          "size": 1024,
          "width": 200,
          "height": 300,
          "videoBitRate": 1650000,
          "audioBitRate": 128000,
          "isExternal": false
        }
      ],
      "md5Checksum": "tk2ma0zrhrp5irco",
      "createdOn": "2017-01-02T00:00:00.000Z",
      "createdBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "modifiedOn": "2017-01-02T00:00:00.000Z",
      "lastActivityOn": "2017-01-03T00:00:00.000Z",
      "acquisitionSource": {
        "name": "Workspace"
      },
      "archiveStatus": "Not archived",
      "archiveType": "Standard",
      "restoreStatus": "Not restored",
      "restoreExpirationDate": "2017-01-02T00:00:00.000Z",
      "restoreRequestDate": "2017-01-02T00:00:00.000Z",
      "lastRestoreDate": "2017-01-02T00:00:00.000Z",
      "restoredBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "archiveDate": "2017-01-02T00:00:00.000Z",
      "archivedBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "uploadCompleteDate": "2017-01-02T00:00:00.000Z",
      "isTrashed": false,
      "uploadTransferType": "SinglepartHttp",
      "runtime": 1024,
      "totalFolderCount": 1,
      "network": {
        "id": "40c2a6b99a474b319dec5ef9c7dbb356",
        "name": "Company Name",
        "class": "Enterprise"
      },
      "metadata": [
        {
          "name": "resolution",
          "value": "1080p",
          "readOnly": false
        }
      ],
      "technicalMetadata": {
        "type": "Video",
        "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/metadata.jpg",
        "size": 1024,
        "image": {
          "width": 100,
          "height": 300,
          "xResolution": 100,
          "yResolution": 100,
          "resolutionUnit": "cm",
          "cameraMake": "Nikon",
          "cameraModel": "D300",
          "groupingInfo": "6445055e520106d9d01769fffefd058901000100000000000000",
          "umidBasic": "060a2b340101010501010143130000006445055e520106cbd01769fffefd0589",
          "materialNumber": "6445055e520106cbd01769fffefd0589",
          "recordedDate": "2023-07-27T01:39:24Z",
          "locationCity": "New York",
          "locationState": "NY",
          "locationCountry": "USA",
          "exif": {
            "imageWidth": "3888",
            "imageHeight": "2592",
            "artist": "Michael W. Steidl.",
            "copyright": "(c) 2011 IPTC - Rights reserved."
          },
          "iptc": {
            "codedCharacterSet": "UTF8",
            "headline": "Bikefestival Vienna",
            "credit": "IPTC/Michael W. Steidl",
            "keywords": "Vienna Air King,cycling,mountain bike"
          },
          "xmp": {
            "serialNumber": "0380227035",
            "creatorRegion": "Roshire",
            "lens": "EF70-300mm f/4-5.6L IS USM",
            "creatorCountry": "United Kingdom"
          }
        },
        "avContainer": {
          "bitRate": 11934620,
          "duration": 100,
          "start": 0,
          "recordedDate": "2022-11-21T06:42:41Z",
          "deviceManufacturer": "Sony",
          "timeCode": "00:00:00:00",
          "derivedTimeCode": "00:00:00:00",
          "streams": [
            {
              "index": 0,
              "type": "Video",
              "bitRate": 11934620,
              "bitDepth": 8,
              "bitRateMode": "CBR",
              "codec": "h264",
              "codecName": "ProRes",
              "codecProfile": "422 HQ",
              "codecSettings": "Little / Signed",
              "fourCC": "avc1",
              "width": 1280,
              "height": 720,
              "totalFrames": 1024,
              "duration": 100,
              "frameRateNumerator": 360,
              "frameRateDenominator": 12,
              "videoPARWidth": 1,
              "videoPARHeight": 1,
              "videoDARWidth": 19,
              "videoDARHeight": 24,
              "start": 0,
              "timeCode": "00:00:00:00",
              "videoColorSpace": "bt709",
              "videoScanOrder": "TFF",
              "videoScanType": "Interlaced",
              "videoColorPrimaries": "DCI P3",
              "videoChromaSubsampling": "4:2:2",
              "videoScanTypeStoreMethod": "Interleaved fields",
              "audioSampleRate": 32000,
              "audioChannelCount": 2,
              "audioLayout": "Stereo",
              "audioAnalysis": "Stereo",
              "rotate": 0
            }
          ]
        },
        "dolbyContainer": {
          "duration": 9.6,
          "fileSize": 80294994,
          "overallBitRateMode": "CBR",
          "overallBitRate": 66912495,
          "totalChannels": 58,
          "bedChannels": 10,
          "numberOfBeds": 1,
          "bitDepth": 24,
          "samplingRate": 48000,
          "downmix51X": "Direct Render",
          "trimModesSummary": "automatic + manual_0",
          "trimChannel20Mode": "manual_0",
          "trimChannel51Mode": "manual_0",
          "trimChannel71Mode": "automatic",
          "trimChannel212Mode": "manual_0",
          "trimChannel512Mode": "automatic",
          "trimChannel712Mode": "manual_0",
          "trimChannel214Mode": "manual_0",
          "trimChannel514Mode": "manual_0",
          "trimChannel714Mode": "manual_0",
          "associatedVideoFrameRate": 23.976,
          "start": "01:00:00:00",
          "fFoA": "01:00:00:00",
          "end": "01:03:30:13",
          "metadataFormat": "ADM, Version 0",
          "admProfile": "Dolby Atmos Master, Version 1",
          "numberOfProgrammes": 1,
          "numberOfObjectChannels": 48,
          "numberOfPackFormats": 49,
          "numberOfChannelFormats": 58,
          "binauralRenderModesSummary": "Off + Near + Mid + Far",
          "binauralRenderModesOffCount": 9,
          "binauralRenderModesNearCount": 8,
          "binauralRenderModesMidCount": 13,
          "binauralRenderModesFarCount": 1,
          "truePeakLevels": -3.14,
          "loudness": -16.67
        }
      },
      "hlsPlaylistUrl": "https://cimediacloud.com/t5y7s3ero3w2ie7/hls",
      "acquisitionContext": {
        "name": "Movie1.mov",
        "path": "original/source/path"
      },
      "isExternal": false,
      "workspace": {
        "id": "gb5ehomv0iv71swg",
        "name": "Workspace Name",
        "class": "Enterprise"
      },
      "filmstrips": [
        {
          "type": "video-filmstrip-small",
          "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/filmstrip.jpg",
          "size": 1024,
          "frames": 100,
          "frameHeight": 100,
          "frameWidth": 100,
          "width": 100,
          "height": 1000
        }
      ],
      "waveforms": [
        {
          "type": "video-waveform",
          "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/waveform.jpg",
          "size": 1024,
          "maxAmplitude": 1000,
          "sampleMethod": "SamplesCount",
          "samplesPerSecond": 12,
          "uploadCompleteDate": "2017-01-02T00:00:00.000Z"
        }
      ],
      "isDeleted": false,
      "trashedOn": "2017-01-02T00:00:00.000Z",
      "trashedBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "kind": "Asset"
    }
  ]
}

Property name	Type	Description
count	`number`	The number of items.
errorCount	`number`	The number of invalid items.
errors	`array`	An array containing information for each error item.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].id	`string`	The unique identifier for the item.
items	`array`	An array containing information about each asset.
items[].id	`string`	The unique identifier of the asset.
items[].name	`string`	The name of the asset, including its extension. Its maximum length is 512 characters.
items[].size	`number`	The size of the source file, in bytes.
items[].type	`string`	The type of the asset. Valid values are `Audio`, `Video`, `Image`, `Document`, or `Other`.
items[].format	`string`	The asset’s file format.
items[].folder	`object`	Information about the asset’s parent folder.
items[].folder.id	`string`	The unique identifier of the folder.
items[].folder.name	`string`	The name of folder.
items[].status	`string`	The status of the asset. Valid values are ‘Created’, ‘Complete’, ‘Deleted’, ‘Executable Detected’, ‘Failed’, ‘Limited’, ‘Processing’, ‘Uploading’, ‘Virus Detected’, ‘Waiting’. See this section for more information.
items[].description	`string`	A comment or note associated to the asset. Its maximum length is 1000 characters.
items[].thumbnails	`array`	The set of thumbnails for the asset.
items[].thumbnails[].type	`string`	The type of thumbnail returned. Valid values are ‘small’, ‘medium’ and ‘large’.
items[].thumbnails[].location	`string`	The url of the thumbnail.
items[].thumbnails[].size	`number`	The size of the thumbnail, in bytes.
items[].thumbnails[].width	`number`	The width of the thumbnail.
items[].thumbnails[].height	`number`	The height of the thumbnail.
items[].thumbnails[].source	`object`	Information about the source of thumbnails.
items[].thumbnails[].source.id	`string`	Unique identifier of the thumbnail’s source.
items[].thumbnails[].source.kind	`string`	The kind of entity of the thumbnail’s source.
items[].thumbnails[].isExternal	`boolean`	Indicates if the thumbnail is stored in an external source.
items[].proxies	`array`	The set of proxies for the asset.
items[].proxies[].type	`string`	The type of proxy returned. Valid values are ‘standard-audio’, ‘dolby-audio’, ‘video-3g’, ‘video-sd’, ‘video-sdplus’, ‘video-hd’, ‘video-2k’, ‘video-2kplus’, ‘document-pdf’.
items[].proxies[].location	`string`	The url of the proxy.
items[].proxies[].size	`number`	The size of the proxy, in bytes.
items[].proxies[].width	`number`	The width of the proxy.
items[].proxies[].height	`number`	The height of the proxy.
items[].proxies[].videoBitRate	`number`	The video bitrate of the proxy.
items[].proxies[].audioBitRate	`number`	The audio bitrate of the proxy.
items[].proxies[].isExternal	`boolean`	Indicates if the proxy is stored in an external source.
items[].md5Checksum	`string`	The calculated md5 checksum for the asset.
items[].createdOn	`string`	The datetime the asset record was created.
items[].createdBy	`object`	Information about the creator of the asset
items[].createdBy.id	`string`	The unique identifier of the user.
items[].createdBy.name	`string`	The full name of the user.
items[].createdBy.email	`string`	The email of the user.
items[].modifiedOn	`string`	The datetime the asset record was last modified.
items[].lastActivityOn	`string`	The datetime of the last activity of the asset record.
items[].acquisitionSource	`object`	Information about the asset’s source client application.
items[].acquisitionSource.name	`string`	The name of the client application that uploaded the asset.
items[].archiveStatus	`string`	The archive status of the asset. Valid values are ‘Not archived’, ‘Archive in progress’, ‘Archive failed’, ‘Archived’, ‘Cancel archive in progress’.
items[].archiveType	`string`	If available, the kind of archive used for storing the asset. Valid values are `Standard` and `Deep`.
items[].restoreStatus	`string`	The restore status of the asset. This is applicable to assets that have been archived. Valid values are ‘Not restored’, ‘Restore in progress’, ‘Restore failed’, ‘Restored’.
items[].restoreExpirationDate	`string`	If available, the datetime the restored copy of the asset’s source file will no longer be available.
items[].restoreRequestDate	`string`	If available, the datetime the asset’s source file was requested to be restored.
items[].lastRestoreDate	`string`	If available, the datetime the asset’s source file was last restored.
items[].restoredBy	`object`	If available, information about the user who restored the asset.
items[].restoredBy.id	`string`	The unique identifier of the user.
items[].restoredBy.name	`string`	The full name of the user.
items[].restoredBy.email	`string`	The email of the user.
items[].archiveDate	`string`	If available, the datetime the asset’s source file was last archived.
items[].archivedBy	`object`	If available, information about the user who archived the asset.
items[].archivedBy.id	`string`	The unique identifier of the user.
items[].archivedBy.name	`string`	The full name of the user.
items[].archivedBy.email	`string`	The email of the user.
items[].uploadCompleteDate	`string`	The datetime the asset upload was completed.
items[].isTrashed	`boolean`	Indicates if an asset is in the trash bin.
items[].uploadTransferType	`string`	Indicates how the asset was uploaded. Valid values are ‘SinglepartHttp’, ‘MultipartHttp’, ‘Aspera’, ‘Copy’, ‘FTP’, ‘WorkspaceSend’.
items[].runtime	`number`	The duration of the media asset, in seconds.
items[].totalFolderCount	`number`	The amount of folders where the asset exists.
items[].network	`object`	Information about the asset’s network.
items[].network.id	`string`	The unique identifier of the Network.
items[].network.name	`string`	The name of the Network.
items[].network.class	`string`	Indicates if the Network is a ‘Personal’ or ‘Enterprise’ Network.
items[].metadata	`array`	An array of key-value pairs of user-generated and basic technical metadata.
items[].metadata[].name	`string`	The name of the metadata item.
items[].metadata[].value	`string`	the value of the metadata item.
items[].metadata[].readOnly	`boolean`	Flag to set a read-only metadata.
items[].technicalMetadata	`object`	An object that contains all the technical metadata available.
items[].technicalMetadata.type	`string`	The type of the asset. Valid values are either ‘Audio’, ‘Video’ or ‘Image’.
items[].technicalMetadata.location	`string`	Url of the source technical metadata file. Note: the content and structure of the technical metadata file is subject to change at any time.
items[].technicalMetadata.size	`number`	The size of the technical metadata file, in bytes.
items[].technicalMetadata.image	`object`	If the asset’s type is ‘Image’, this property contains the extended image technical metadata.
items[].technicalMetadata.image.width	`number`	The width of the image, in pixels.
items[].technicalMetadata.image.height	`number`	The height of the image, in pixels.
items[].technicalMetadata.image.xResolution	`number`	The number of pixels per resolutionUnit in the width direction.
items[].technicalMetadata.image.yResolution	`number`	The number of pixels per resolutionUnit in the height direction.
items[].technicalMetadata.image.resolutionUnit	`string`	The unit of measurement for xResolution and yResolution. Can be ‘inches’, ‘cm’ or ‘none’.
items[].technicalMetadata.image.cameraMake	`string`	Camera manufacturer name.
items[].technicalMetadata.image.cameraModel	`string`	Camera model name.
items[].technicalMetadata.image.groupingInfo	`string`	If available, the grouping info of the image. String of hexadecimal value (52 characteres) for the byte array object. Byte array order is Litte Endian.
items[].technicalMetadata.image.umidBasic	`string`	If available, the umid basic info of the image. String of hexadecimal value (64 characteres) for the byte array object.
items[].technicalMetadata.image.materialNumber	`string`	If available, the material number of the image. String of hexadecimal value (32 characteres) for the byte array object.
items[].technicalMetadata.image.recordedDate	`string`	The date and Time at which the image was captured.
items[].technicalMetadata.image.locationCity	`string`	Name of the city where the image was created.
items[].technicalMetadata.image.locationState	`string`	Name of the state where the image was created.
items[].technicalMetadata.image.locationCountry	`string`	Name of the country where the image was created.
items[].technicalMetadata.image.exif	`object`	The avalaible EXIF (Exchangeable Image File) metadata.
items[].technicalMetadata.image.exif.imageWidth	`string`	The image width in pixels.
items[].technicalMetadata.image.exif.imageHeight	`string`	The image height in pixels.
items[].technicalMetadata.image.exif.artist	`string`	The image artist info.
items[].technicalMetadata.image.exif.copyright	`string`	The image copyright.
items[].technicalMetadata.image.iptc	`object`	The available IPTC (International Press Telecommunications Council) available.
items[].technicalMetadata.image.iptc.codedCharacterSet	`string`	Determines how the internal IPTC string values are interpreted.
items[].technicalMetadata.image.iptc.headline	`string`	Brief synopsis or summary of the contents of the photograph.
items[].technicalMetadata.image.iptc.credit	`string`	How the image should be credited when published, as specified by the supplier of the image.
items[].technicalMetadata.image.iptc.keywords	`string`	Descriptive words added to the image to enable search and retrieval.
items[].technicalMetadata.image.xmp	`object`	The available XMP (Extensible Metadata Platform) metadata.
items[].technicalMetadata.image.xmp.serialNumber	`string`	Camera Serial Number.
items[].technicalMetadata.image.xmp.creatorRegion	`string`	State / Province for the address of the person that created this image.
items[].technicalMetadata.image.xmp.lens	`string`	Attempts to identify the camera lens used.
items[].technicalMetadata.image.xmp.creatorCountry	`string`	Country name for the address of the person that created this image.
items[].technicalMetadata.avContainer	`object`	If asset type is ‘Audio’ or ‘Video’, this property contains the extended audio / video technical metadata.
items[].technicalMetadata.avContainer.bitRate	`number`	The overall bitrate in the container.
items[].technicalMetadata.avContainer.duration	`number`	The runtime of the media in the container, in seconds.
items[].technicalMetadata.avContainer.start	`number`	The start time in the container, in seconds.
items[].technicalMetadata.avContainer.recordedDate	`string`	The date and Time at which the video was captured.
items[].technicalMetadata.avContainer.deviceManufacturer	`string`	The name of the device Manufacturer.
items[].technicalMetadata.avContainer.timeCode	`string`	The SMPTE timecode in the container.
items[].technicalMetadata.avContainer.derivedTimeCode	`string`	The standardized timecode derived by evaluating stream metadata and converting to drop frame format, if using drop frame rate.
items[].technicalMetadata.avContainer.streams	`array`	Set of audio, video, or data streams contained in the asset.
items[].technicalMetadata.avContainer.streams[].index	`number`	The index of the stream in the container.
items[].technicalMetadata.avContainer.streams[].type	`string`	The type of the stream. Valid values are `Audio`, `Video` or `Data`.
items[].technicalMetadata.avContainer.streams[].bitRate	`number`	If available, the overall bitrate in the stream.
items[].technicalMetadata.avContainer.streams[].bitDepth	`number`	If available, for an `Audio` stream, the bit depth of the stream.
items[].technicalMetadata.avContainer.streams[].bitRateMode	`string`	If available, the bit rate mode of the stream.
items[].technicalMetadata.avContainer.streams[].codec	`string`	If available, the codec used in the stream. For example, `h264`.
items[].technicalMetadata.avContainer.streams[].codecName	`string`	If available, the MediaInfo generated format commercial name for the stream.
items[].technicalMetadata.avContainer.streams[].codecProfile	`string`	If available, the MediaInfo generated format profile for the stream.
items[].technicalMetadata.avContainer.streams[].codecSettings	`string`	If avalable, the MediaInfo generated format settings for the stream.
items[].technicalMetadata.avContainer.streams[].fourCC	`string`	If available, four-character code for the codec used in the stream. For example, `avc1`, `apch`.
items[].technicalMetadata.avContainer.streams[].width	`number`	If available, for a `Video` stream, the width in pixels of the video.
items[].technicalMetadata.avContainer.streams[].height	`number`	If available, for a `Video` stream, the height in pixels of the video.
items[].technicalMetadata.avContainer.streams[].totalFrames	`number`	If available, total number of frames within the `Video` stream.
items[].technicalMetadata.avContainer.streams[].duration	`number`	If available, the runtime of the media in seconds.
items[].technicalMetadata.avContainer.streams[].frameRateNumerator	`number`	If available, the numerator of the frame rate. For example, if the frame rate is 24, the frame rate numerator is 24.
items[].technicalMetadata.avContainer.streams[].frameRateDenominator	`number`	If available, the numerator of the frame rate. For example, if the frame rate is 24, the frame rate denominator is 1.
items[].technicalMetadata.avContainer.streams[].videoPARWidth	`number`	If available, the width part of the pixel aspect ratio.
items[].technicalMetadata.avContainer.streams[].videoPARHeight	`number`	If available, the height part of the pixel aspect ratio.
items[].technicalMetadata.avContainer.streams[].videoDARWidth	`number`	If available, the width part of the display aspect ratio.
items[].technicalMetadata.avContainer.streams[].videoDARHeight	`number`	If available, the height part of the display aspect ratio.
items[].technicalMetadata.avContainer.streams[].start	`number`	If available, the start time in the stream, in seconds.
items[].technicalMetadata.avContainer.streams[].timeCode	`string`	If available, the SMPTE timecode in the stream.
items[].technicalMetadata.avContainer.streams[].videoColorSpace	`string`	If available, for a `Video` stream, the video’s color space / color primaries.
items[].technicalMetadata.avContainer.streams[].videoScanOrder	`string`	If available, for a `Video` stream, the video’s scan order.
items[].technicalMetadata.avContainer.streams[].videoScanType	`string`	If available, for a `Video` stream, the video’s scan type.
items[].technicalMetadata.avContainer.streams[].videoColorPrimaries	`string`	If available, for a `Video` stream, the video’s color primaries.
items[].technicalMetadata.avContainer.streams[].videoChromaSubsampling	`string`	If available, for a `Video` stream, the video’s crhoma subsampling.
items[].technicalMetadata.avContainer.streams[].videoScanTypeStoreMethod	`string`	If available, for a `Video` stream, the video’s scan type store method.
items[].technicalMetadata.avContainer.streams[].audioSampleRate	`number`	If available, for an `Audio` stream, is the sample rate in Hz.
items[].technicalMetadata.avContainer.streams[].audioChannelCount	`number`	If available, for an `Audio` stream, is the number of channels within the stream.
items[].technicalMetadata.avContainer.streams[].audioLayout	`string`	If available, for an `Audio` stream, is the audio channel layout description. For example, `5.1`.
items[].technicalMetadata.avContainer.streams[].audioAnalysis	`string`	If available, for an `Audio` stream, it is further analysis to determine if a stream is true stereo or dual-mono.
items[].technicalMetadata.avContainer.streams[].rotate	`number`	If available, the amount of rotation, in degrees, that should be applied during playback of the video.
items[].technicalMetadata.dolbyContainer	`object`	If asset type is ‘Audio’ and the asset has Dolby Atmos metadata, this property contains the extended Dolby Atmos audio technical metadata.
items[].technicalMetadata.dolbyContainer.duration	`number`	Media duration (in seconds).
items[].technicalMetadata.dolbyContainer.fileSize	`number`	Media size (in bytes).
items[].technicalMetadata.dolbyContainer.overallBitRateMode	`string`	The overall bitrate mode for the Atmos content.
items[].technicalMetadata.dolbyContainer.overallBitRate	`number`	Media bitrate (in bits per second).
items[].technicalMetadata.dolbyContainer.totalChannels	`number`	Number of channels. `Bed channels` plus `Object channels` equals `Total channels`.
items[].technicalMetadata.dolbyContainer.bedChannels	`number`	Number of channel-based premix or stem that includes multichannel panning.
items[].technicalMetadata.dolbyContainer.numberOfBeds	`number`	A bed can be thought of as a traditional channel-based stem with the rules and expectations of stem configurations (such as 2.0, 5.1, and 7.1).
items[].technicalMetadata.dolbyContainer.bitDepth	`number`	Number of bits of information in each sample, generally 16, 24, or 32-bit.
items[].technicalMetadata.dolbyContainer.samplingRate	`number`	Audio sample-rate, generally 44100 or 48000 Hz.
items[].technicalMetadata.dolbyContainer.downmix51X	`string`	Global downmix metadata for monitoring, re-rendering, and encoding.
items[].technicalMetadata.dolbyContainer.trimModesSummary	`string`	A summary of the underlying trim modes.
items[].technicalMetadata.dolbyContainer.trimChannel20Mode	`string`	The type of trim mode supported for 2.0 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel51Mode	`string`	The type of trim mode supported for 5.1 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel71Mode	`string`	The type of trim mode supported for 7.1 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel212Mode	`string`	The type of trim mode supported for 2.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel512Mode	`string`	The type of trim mode supported for 5.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel712Mode	`string`	The type of trim mode supported for 7.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel214Mode	`string`	The type of trim mode supported for 2.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel514Mode	`string`	The type of trim mode supported for 5.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel714Mode	`string`	The type of trim mode supported for 7.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.associatedVideoFrameRate	`number`	Number of frames per second.
items[].technicalMetadata.dolbyContainer.start	`string`	Start SMPTE timecode based on the video frame rate.
items[].technicalMetadata.dolbyContainer.fFoA	`string`	FFoA (First Frame of Action) SMPTE timecode based on the video frame rate.
items[].technicalMetadata.dolbyContainer.end	`string`	End SMPTE timecode based on the video frame rate.
items[].technicalMetadata.dolbyContainer.metadataFormat	`string`	Format of the metadata in the Atmos content.
items[].technicalMetadata.dolbyContainer.admProfile	`string`	ADM (Audio Definition Model) Profile used in the Atmos content.
items[].technicalMetadata.dolbyContainer.numberOfProgrammes	`number`	Number of programmes in the Atmos content.
items[].technicalMetadata.dolbyContainer.numberOfObjectChannels	`number`	Number of objects in the Atmos Master.
items[].technicalMetadata.dolbyContainer.numberOfPackFormats	`number`	Number of Atmos Pack Formats in the Atmos content.
items[].technicalMetadata.dolbyContainer.numberOfChannelFormats	`number`	Number of channel formats in the Atmos content.
items[].technicalMetadata.dolbyContainer.binauralRenderModesSummary	`string`	Summary of all the binaural render modes used in the Atmos content. Supported strings are a unique combination of: “Off”, “Near”, “Mid”, “Far”.
items[].technicalMetadata.dolbyContainer.binauralRenderModesOffCount	`number`	Number of channels that use the “Off” setting for binaural rendering.
items[].technicalMetadata.dolbyContainer.binauralRenderModesNearCount	`number`	Number of channels that use the “Near” setting for binaural rendering.
items[].technicalMetadata.dolbyContainer.binauralRenderModesMidCount	`number`	Number of channels that use the “Mid” setting for binaural rendering.
items[].technicalMetadata.dolbyContainer.binauralRenderModesFarCount	`number`	Number of channels that use the “Far” setting for binaural rendering.
items[].technicalMetadata.dolbyContainer.truePeakLevels	`number`	The peak event in the audio waveform. Units are dBTP for true peak.
items[].technicalMetadata.dolbyContainer.loudness	`number`	Integrated loudness LKFS (or LUFS).
items[].hlsPlaylistUrl	`string`	A link to the HLS playlist generated from the source file.
items[].acquisitionContext	`object`	The file acquisition information.
items[].acquisitionContext.name	`string`	The original source file name, captured on acquisition.
items[].acquisitionContext.path	`string`	The original source file path, captured on acquisition.
items[].isExternal	`boolean`	Indicates if the file is stored in an external source.
items[].workspace	`object`	Information about the asset’s workspace.
items[].workspace.id	`string`	The unique identifier of the Workspace.
items[].workspace.name	`string`	The name of the Workspace.
items[].workspace.class	`string`	Indicates if the Workspace is a ‘Personal’ or ‘Team’ Workspace.
items[].filmstrips	`array`	The set of filmstrips for the asset. Please check the Previews section for more information.
items[].filmstrips[].type	`string`	The type of filmstrip returned.
items[].filmstrips[].location	`string`	The url of the filmstrip.
items[].filmstrips[].size	`number`	The size of the filmstrip, in bytes.
items[].filmstrips[].frames	`number`	Number of frames contained in the filmstrip.
items[].filmstrips[].frameHeight	`number`	The height of each frame.
items[].filmstrips[].frameWidth	`number`	The width of each frame.
items[].filmstrips[].width	`number`	Total width of the filmstrip.
items[].filmstrips[].height	`number`	Total height of the filmstrip.
items[].waveforms	`array`	The set of waveforms for the asset. Please check the Previews section for more information.
items[].waveforms[].type	`string`	The type of waveform returned.
items[].waveforms[].location	`string`	The url of the waveform.
items[].waveforms[].size	`number`	The size in bytes of the waveform.
items[].waveforms[].maxAmplitude	`number`	Sample values will range from this number to its additive inverse. For example, if this value is 100, then samples within the waveform file will have values between -100 and 100.
items[].waveforms[].sampleMethod	`string`	The type of sample method used to extract samples from the source audio stream. Supported values are ‘SamplesCount’ and ‘SamplesPerSecond’. When ‘SamplesCount’ is returned, then a fixed number of samples was extracted, spanning the duration of the source audio stream. When ‘SamplesPerSecond’ is returned, then a fixed number of samples was extracted per second of audio.
items[].waveforms[].samplesPerSecond	`number`	When the sampleMethod is ‘SamplesPerSecond’, this value indicates the number of samples that were extracted for each second of audio.
items[].waveforms[].uploadCompleteDate	`string`	The datetime the asset upload was completed.
items[].isDeleted	`boolean`	Indicates if an asset is deleted.
items[].trashedOn	`string`	The datetime the asset was trashed.
items[].trashedBy	`object`	Information about the user that trashed the asset.
items[].trashedBy.id	`string`	The unique identifier of the user.
items[].trashedBy.name	`string`	The full name of the user.
items[].trashedBy.email	`string`	The email of the user.
items[].kind	`string`	Indicates the kind of item returned. Will be ‘Asset’ for assets.

Headers

Content-Type: application/json

Body

{
  "count": 0,
  "errorCount": 1,
  "errors": [
    {
      "name": "Item name",
      "kind": "Item",
      "errorCode": "ItemNotFound",
      "errorMessage": "Item not found.",
      "id": "ad9289a2019a4e07a08eca9459ef1091"
    }
  ]
}

Property name	Type	Description
count	`number`	The number of successful items.
errorCount	`number`	The number of invalid items.
errors	`array`	An array containing information for each error item.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].id	`string`	The unique identifier for the item.

Get Multiple Assets' Details
POST`/assets/details/bulk`

Description

Retrieves asset information for the specified assets.

500 is the maximum number of assets that can be retrieved in a single operation.

Use custom url expiration parameters for the following use cases:

Caching thumbnail urls for long periods of time.
Limiting the amount of time a proxy or HLS playlist is available for viewing.

Errors

Status Code	Error Code	Message	Notes
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	AssetIdNotProvided	Asset Id not provided.
400	InvalidExpiration	Invalid expiration.
400	ExceededMaxAssetCount	Max asset count exceeded. The maximum number of assets is 500.
409	BulkOperationFailed	The bulk operation failed. See the errors array for more information.	This message appears if there were no successfully retrieved assets.

Errors represented in errors array

Error Code	Message
AssetNotFound	Asset not found.
AssetDeleted	Asset is deleted.

List Assets by Metadata Field ¶

GET https://api.cimediacloud.com/contents/metadata?name=resolution&value=1080p&limit=1&offset=0

Requestsexample

Headers

Content-Type: application/json
Authorization: Basic [encoded bearer token]

Responses200400

Headers

Content-Type: application/json

Body

{
  "limit": 1,
  "offset": 0,
  "count": 10,
  "order": {
    "by": "Name",
    "direction": "asc"
  },
  "items": [
    {
      "id": "bcdc34b53e2c4c18ac41ca288e28d11f",
      "name": "Movie.mov",
      "size": 107856722,
      "type": "Video",
      "format": "mov",
      "folder": {
        "id": "9b639e12a82f4b0483f512b474dc052ci",
        "name": "Folder Name"
      },
      "status": "Complete",
      "description": "Final cut",
      "thumbnails": [
        {
          "type": "large",
          "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/thumb.jpg",
          "size": 1024,
          "width": 200,
          "height": 300,
          "source": {
            "id": "elementId1",
            "kind": "element"
          },
          "isExternal": false
        }
      ],
      "proxies": [
        {
          "type": "video-3g",
          "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/proxy.jpg",
          "size": 1024,
          "width": 200,
          "height": 300,
          "videoBitRate": 1650000,
          "audioBitRate": 128000,
          "isExternal": false
        }
      ],
      "md5Checksum": "tk2ma0zrhrp5irco",
      "createdOn": "2017-01-02T00:00:00.000Z",
      "createdBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "modifiedOn": "2017-01-02T00:00:00.000Z",
      "lastActivityOn": "2017-01-03T00:00:00.000Z",
      "acquisitionSource": {
        "name": "Workspace"
      },
      "archiveStatus": "Not archived",
      "archiveType": "Standard",
      "restoreStatus": "Not restored",
      "restoreExpirationDate": "2017-01-02T00:00:00.000Z",
      "restoreRequestDate": "2017-01-02T00:00:00.000Z",
      "lastRestoreDate": "2017-01-02T00:00:00.000Z",
      "restoredBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "archiveDate": "2017-01-02T00:00:00.000Z",
      "archivedBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "uploadCompleteDate": "2017-01-02T00:00:00.000Z",
      "isTrashed": false,
      "uploadTransferType": "SinglepartHttp",
      "runtime": 1024,
      "totalFolderCount": 1,
      "network": {
        "id": "40c2a6b99a474b319dec5ef9c7dbb356",
        "name": "Company Name",
        "class": "Enterprise"
      },
      "metadata": [
        {
          "name": "resolution",
          "value": "1080p",
          "readOnly": false
        }
      ],
      "technicalMetadata": {
        "type": "Video",
        "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/metadata.jpg",
        "size": 1024,
        "image": {
          "width": 100,
          "height": 300,
          "xResolution": 100,
          "yResolution": 100,
          "resolutionUnit": "cm",
          "cameraMake": "Nikon",
          "cameraModel": "D300",
          "groupingInfo": "6445055e520106d9d01769fffefd058901000100000000000000",
          "umidBasic": "060a2b340101010501010143130000006445055e520106cbd01769fffefd0589",
          "materialNumber": "6445055e520106cbd01769fffefd0589",
          "recordedDate": "2023-07-27T01:39:24Z",
          "locationCity": "New York",
          "locationState": "NY",
          "locationCountry": "USA",
          "exif": {
            "imageWidth": "3888",
            "imageHeight": "2592",
            "artist": "Michael W. Steidl.",
            "copyright": "(c) 2011 IPTC - Rights reserved."
          },
          "iptc": {
            "codedCharacterSet": "UTF8",
            "headline": "Bikefestival Vienna",
            "credit": "IPTC/Michael W. Steidl",
            "keywords": "Vienna Air King,cycling,mountain bike"
          },
          "xmp": {
            "serialNumber": "0380227035",
            "creatorRegion": "Roshire",
            "lens": "EF70-300mm f/4-5.6L IS USM",
            "creatorCountry": "United Kingdom"
          }
        },
        "avContainer": {
          "bitRate": 11934620,
          "duration": 100,
          "start": 0,
          "recordedDate": "2022-11-21T06:42:41Z",
          "deviceManufacturer": "Sony",
          "timeCode": "00:00:00:00",
          "derivedTimeCode": "00:00:00:00",
          "streams": [
            {
              "index": 0,
              "type": "Video",
              "bitRate": 11934620,
              "bitDepth": 8,
              "bitRateMode": "CBR",
              "codec": "h264",
              "codecName": "ProRes",
              "codecProfile": "422 HQ",
              "codecSettings": "Little / Signed",
              "fourCC": "avc1",
              "width": 1280,
              "height": 720,
              "totalFrames": 1024,
              "duration": 100,
              "frameRateNumerator": 360,
              "frameRateDenominator": 12,
              "videoPARWidth": 1,
              "videoPARHeight": 1,
              "videoDARWidth": 19,
              "videoDARHeight": 24,
              "start": 0,
              "timeCode": "00:00:00:00",
              "videoColorSpace": "bt709",
              "videoScanOrder": "TFF",
              "videoScanType": "Interlaced",
              "videoColorPrimaries": "DCI P3",
              "videoChromaSubsampling": "4:2:2",
              "videoScanTypeStoreMethod": "Interleaved fields",
              "audioSampleRate": 32000,
              "audioChannelCount": 2,
              "audioLayout": "Stereo",
              "audioAnalysis": "Stereo",
              "rotate": 0
            }
          ]
        },
        "dolbyContainer": {
          "duration": 9.6,
          "fileSize": 80294994,
          "overallBitRateMode": "CBR",
          "overallBitRate": 66912495,
          "totalChannels": 58,
          "bedChannels": 10,
          "numberOfBeds": 1,
          "bitDepth": 24,
          "samplingRate": 48000,
          "downmix51X": "Direct Render",
          "trimModesSummary": "automatic + manual_0",
          "trimChannel20Mode": "manual_0",
          "trimChannel51Mode": "manual_0",
          "trimChannel71Mode": "automatic",
          "trimChannel212Mode": "manual_0",
          "trimChannel512Mode": "automatic",
          "trimChannel712Mode": "manual_0",
          "trimChannel214Mode": "manual_0",
          "trimChannel514Mode": "manual_0",
          "trimChannel714Mode": "manual_0",
          "associatedVideoFrameRate": 23.976,
          "start": "01:00:00:00",
          "fFoA": "01:00:00:00",
          "end": "01:03:30:13",
          "metadataFormat": "ADM, Version 0",
          "admProfile": "Dolby Atmos Master, Version 1",
          "numberOfProgrammes": 1,
          "numberOfObjectChannels": 48,
          "numberOfPackFormats": 49,
          "numberOfChannelFormats": 58,
          "binauralRenderModesSummary": "Off + Near + Mid + Far",
          "binauralRenderModesOffCount": 9,
          "binauralRenderModesNearCount": 8,
          "binauralRenderModesMidCount": 13,
          "binauralRenderModesFarCount": 1,
          "truePeakLevels": -3.14,
          "loudness": -16.67
        }
      },
      "hlsPlaylistUrl": "https://cimediacloud.com/t5y7s3ero3w2ie7/hls",
      "acquisitionContext": {
        "name": "Movie1.mov",
        "path": "original/source/path"
      },
      "isExternal": false,
      "workspace": {
        "id": "gb5ehomv0iv71swg",
        "name": "Workspace Name",
        "class": "Enterprise"
      },
      "kind": "Asset"
    }
  ]
}

Property name	Type	Description
limit	`number`	The limit used for the query.
offset	`number`	The offset used for the query.
count	`number`	The total count of items available.
order	`object`	Information about the ordering of the results.
order.by	`string`	Indicates the field used to sort the results.
order.direction	`string`	Indicates the direction used to sort the results.
items	`array`	The search results returned.
items[].id	`string`	The unique identifier of the asset.
items[].name	`string`	The name of the asset, including its extension. Its maximum length is 512 characters.
items[].size	`number`	The size of the source file, in bytes.
items[].type	`string`	The type of the asset. Valid values are `Audio`, `Video`, `Image`, `Document`, or `Other`.
items[].format	`string`	The asset’s file format.
items[].folder	`object`	Information about the asset’s parent folder.
items[].folder.id	`string`	The unique identifier of the folder.
items[].folder.name	`string`	The name of folder.
items[].status	`string`	The status of the asset. Valid values are ‘Created’, ‘Complete’, ‘Deleted’, ‘Executable Detected’, ‘Failed’, ‘Limited’, ‘Processing’, ‘Uploading’, ‘Virus Detected’, ‘Waiting’. See this section for more information.
items[].description	`string`	A comment or note associated to the asset. Its maximum length is 1000 characters.
items[].thumbnails	`array`	The set of thumbnails for the asset.
items[].thumbnails[].type	`string`	The type of thumbnail returned. Valid values are ‘small’, ‘medium’ and ‘large’.
items[].thumbnails[].location	`string`	The url of the thumbnail.
items[].thumbnails[].size	`number`	The size of the thumbnail, in bytes.
items[].thumbnails[].width	`number`	The width of the thumbnail.
items[].thumbnails[].height	`number`	The height of the thumbnail.
items[].thumbnails[].source	`object`	Information about the source of thumbnails.
items[].thumbnails[].source.id	`string`	Unique identifier of the thumbnail’s source.
items[].thumbnails[].source.kind	`string`	The kind of entity of the thumbnail’s source.
items[].thumbnails[].isExternal	`boolean`	Indicates if the thumbnail is stored in an external source.
items[].proxies	`array`	The set of proxies for the asset.
items[].proxies[].type	`string`	The type of proxy returned. Valid values are ‘standard-audio’, ‘dolby-audio’, ‘video-3g’, ‘video-sd’, ‘video-sdplus’, ‘video-hd’, ‘video-2k’, ‘video-2kplus’, ‘document-pdf’.
items[].proxies[].location	`string`	The url of the proxy.
items[].proxies[].size	`number`	The size of the proxy, in bytes.
items[].proxies[].width	`number`	The width of the proxy.
items[].proxies[].height	`number`	The height of the proxy.
items[].proxies[].videoBitRate	`number`	The video bitrate of the proxy.
items[].proxies[].audioBitRate	`number`	The audio bitrate of the proxy.
items[].proxies[].isExternal	`boolean`	Indicates if the proxy is stored in an external source.
items[].md5Checksum	`string`	The calculated md5 checksum for the asset.
items[].createdOn	`string`	The datetime the asset record was created.
items[].createdBy	`object`	Information about the creator of the asset
items[].createdBy.id	`string`	The unique identifier of the user.
items[].createdBy.name	`string`	The full name of the user.
items[].createdBy.email	`string`	The email of the user.
items[].modifiedOn	`string`	The datetime the asset record was last modified.
items[].lastActivityOn	`string`	The datetime of the last activity of the asset record.
items[].acquisitionSource	`object`	Information about the asset’s source client application.
items[].acquisitionSource.name	`string`	The name of the client application that uploaded the asset.
items[].archiveStatus	`string`	The archive status of the asset. Valid values are ‘Not archived’, ‘Archive in progress’, ‘Archive failed’, ‘Archived’, ‘Cancel archive in progress’.
items[].archiveType	`string`	If available, the kind of archive used for storing the asset. Valid values are `Standard` and `Deep`.
items[].restoreStatus	`string`	The restore status of the asset. This is applicable to assets that have been archived. Valid values are ‘Not restored’, ‘Restore in progress’, ‘Restore failed’, ‘Restored’.
items[].restoreExpirationDate	`string`	If available, the datetime the restored copy of the asset’s source file will no longer be available.
items[].restoreRequestDate	`string`	If available, the datetime the asset’s source file was requested to be restored.
items[].lastRestoreDate	`string`	If available, the datetime the asset’s source file was last restored.
items[].restoredBy	`object`	If available, information about the user who restored the asset.
items[].restoredBy.id	`string`	The unique identifier of the user.
items[].restoredBy.name	`string`	The full name of the user.
items[].restoredBy.email	`string`	The email of the user.
items[].archiveDate	`string`	If available, the datetime the asset’s source file was last archived.
items[].archivedBy	`object`	If available, information about the user who archived the asset.
items[].archivedBy.id	`string`	The unique identifier of the user.
items[].archivedBy.name	`string`	The full name of the user.
items[].archivedBy.email	`string`	The email of the user.
items[].uploadCompleteDate	`string`	The datetime the asset upload was completed.
items[].isTrashed	`boolean`	Indicates if an asset is in the trash bin.
items[].uploadTransferType	`string`	Indicates how the asset was uploaded. Valid values are ‘SinglepartHttp’, ‘MultipartHttp’, ‘Aspera’, ‘Copy’, ‘FTP’, ‘WorkspaceSend’.
items[].runtime	`number`	The duration of the media asset, in seconds.
items[].totalFolderCount	`number`	The amount of folders where the asset exists.
items[].network	`object`	Information about the asset’s network.
items[].network.id	`string`	The unique identifier of the Network.
items[].network.name	`string`	The name of the Network.
items[].network.class	`string`	Indicates if the Network is a ‘Personal’ or ‘Enterprise’ Network.
items[].metadata	`array`	An array of key-value pairs of user-generated and basic technical metadata.
items[].metadata[].name	`string`	The name of the metadata item.
items[].metadata[].value	`string`	the value of the metadata item.
items[].metadata[].readOnly	`boolean`	Flag to set a read-only metadata.
items[].technicalMetadata	`object`	An object that contains all the technical metadata available.
items[].technicalMetadata.type	`string`	The type of the asset. Valid values are either ‘Audio’, ‘Video’ or ‘Image’.
items[].technicalMetadata.location	`string`	Url of the source technical metadata file. Note: the content and structure of the technical metadata file is subject to change at any time.
items[].technicalMetadata.size	`number`	The size of the technical metadata file, in bytes.
items[].technicalMetadata.image	`object`	If the asset’s type is ‘Image’, this property contains the extended image technical metadata.
items[].technicalMetadata.image.width	`number`	The width of the image, in pixels.
items[].technicalMetadata.image.height	`number`	The height of the image, in pixels.
items[].technicalMetadata.image.xResolution	`number`	The number of pixels per resolutionUnit in the width direction.
items[].technicalMetadata.image.yResolution	`number`	The number of pixels per resolutionUnit in the height direction.
items[].technicalMetadata.image.resolutionUnit	`string`	The unit of measurement for xResolution and yResolution. Can be ‘inches’, ‘cm’ or ‘none’.
items[].technicalMetadata.image.cameraMake	`string`	Camera manufacturer name.
items[].technicalMetadata.image.cameraModel	`string`	Camera model name.
items[].technicalMetadata.image.groupingInfo	`string`	If available, the grouping info of the image. String of hexadecimal value (52 characteres) for the byte array object. Byte array order is Litte Endian.
items[].technicalMetadata.image.umidBasic	`string`	If available, the umid basic info of the image. String of hexadecimal value (64 characteres) for the byte array object.
items[].technicalMetadata.image.materialNumber	`string`	If available, the material number of the image. String of hexadecimal value (32 characteres) for the byte array object.
items[].technicalMetadata.image.recordedDate	`string`	The date and Time at which the image was captured.
items[].technicalMetadata.image.locationCity	`string`	Name of the city where the image was created.
items[].technicalMetadata.image.locationState	`string`	Name of the state where the image was created.
items[].technicalMetadata.image.locationCountry	`string`	Name of the country where the image was created.
items[].technicalMetadata.image.exif	`object`	The avalaible EXIF (Exchangeable Image File) metadata.
items[].technicalMetadata.image.exif.imageWidth	`string`	The image width in pixels.
items[].technicalMetadata.image.exif.imageHeight	`string`	The image height in pixels.
items[].technicalMetadata.image.exif.artist	`string`	The image artist info.
items[].technicalMetadata.image.exif.copyright	`string`	The image copyright.
items[].technicalMetadata.image.iptc	`object`	The available IPTC (International Press Telecommunications Council) available.
items[].technicalMetadata.image.iptc.codedCharacterSet	`string`	Determines how the internal IPTC string values are interpreted.
items[].technicalMetadata.image.iptc.headline	`string`	Brief synopsis or summary of the contents of the photograph.
items[].technicalMetadata.image.iptc.credit	`string`	How the image should be credited when published, as specified by the supplier of the image.
items[].technicalMetadata.image.iptc.keywords	`string`	Descriptive words added to the image to enable search and retrieval.
items[].technicalMetadata.image.xmp	`object`	The available XMP (Extensible Metadata Platform) metadata.
items[].technicalMetadata.image.xmp.serialNumber	`string`	Camera Serial Number.
items[].technicalMetadata.image.xmp.creatorRegion	`string`	State / Province for the address of the person that created this image.
items[].technicalMetadata.image.xmp.lens	`string`	Attempts to identify the camera lens used.
items[].technicalMetadata.image.xmp.creatorCountry	`string`	Country name for the address of the person that created this image.
items[].technicalMetadata.avContainer	`object`	If asset type is ‘Audio’ or ‘Video’, this property contains the extended audio / video technical metadata.
items[].technicalMetadata.avContainer.bitRate	`number`	The overall bitrate in the container.
items[].technicalMetadata.avContainer.duration	`number`	The runtime of the media in the container, in seconds.
items[].technicalMetadata.avContainer.start	`number`	The start time in the container, in seconds.
items[].technicalMetadata.avContainer.recordedDate	`string`	The date and Time at which the video was captured.
items[].technicalMetadata.avContainer.deviceManufacturer	`string`	The name of the device Manufacturer.
items[].technicalMetadata.avContainer.timeCode	`string`	The SMPTE timecode in the container.
items[].technicalMetadata.avContainer.derivedTimeCode	`string`	The standardized timecode derived by evaluating stream metadata and converting to drop frame format, if using drop frame rate.
items[].technicalMetadata.avContainer.streams	`array`	Set of audio, video, or data streams contained in the asset.
items[].technicalMetadata.avContainer.streams[].index	`number`	The index of the stream in the container.
items[].technicalMetadata.avContainer.streams[].type	`string`	The type of the stream. Valid values are `Audio`, `Video` or `Data`.
items[].technicalMetadata.avContainer.streams[].bitRate	`number`	If available, the overall bitrate in the stream.
items[].technicalMetadata.avContainer.streams[].bitDepth	`number`	If available, for an `Audio` stream, the bit depth of the stream.
items[].technicalMetadata.avContainer.streams[].bitRateMode	`string`	If available, the bit rate mode of the stream.
items[].technicalMetadata.avContainer.streams[].codec	`string`	If available, the codec used in the stream. For example, `h264`.
items[].technicalMetadata.avContainer.streams[].codecName	`string`	If available, the MediaInfo generated format commercial name for the stream.
items[].technicalMetadata.avContainer.streams[].codecProfile	`string`	If available, the MediaInfo generated format profile for the stream.
items[].technicalMetadata.avContainer.streams[].codecSettings	`string`	If avalable, the MediaInfo generated format settings for the stream.
items[].technicalMetadata.avContainer.streams[].fourCC	`string`	If available, four-character code for the codec used in the stream. For example, `avc1`, `apch`.
items[].technicalMetadata.avContainer.streams[].width	`number`	If available, for a `Video` stream, the width in pixels of the video.
items[].technicalMetadata.avContainer.streams[].height	`number`	If available, for a `Video` stream, the height in pixels of the video.
items[].technicalMetadata.avContainer.streams[].totalFrames	`number`	If available, total number of frames within the `Video` stream.
items[].technicalMetadata.avContainer.streams[].duration	`number`	If available, the runtime of the media in seconds.
items[].technicalMetadata.avContainer.streams[].frameRateNumerator	`number`	If available, the numerator of the frame rate. For example, if the frame rate is 24, the frame rate numerator is 24.
items[].technicalMetadata.avContainer.streams[].frameRateDenominator	`number`	If available, the numerator of the frame rate. For example, if the frame rate is 24, the frame rate denominator is 1.
items[].technicalMetadata.avContainer.streams[].videoPARWidth	`number`	If available, the width part of the pixel aspect ratio.
items[].technicalMetadata.avContainer.streams[].videoPARHeight	`number`	If available, the height part of the pixel aspect ratio.
items[].technicalMetadata.avContainer.streams[].videoDARWidth	`number`	If available, the width part of the display aspect ratio.
items[].technicalMetadata.avContainer.streams[].videoDARHeight	`number`	If available, the height part of the display aspect ratio.
items[].technicalMetadata.avContainer.streams[].start	`number`	If available, the start time in the stream, in seconds.
items[].technicalMetadata.avContainer.streams[].timeCode	`string`	If available, the SMPTE timecode in the stream.
items[].technicalMetadata.avContainer.streams[].videoColorSpace	`string`	If available, for a `Video` stream, the video’s color space / color primaries.
items[].technicalMetadata.avContainer.streams[].videoScanOrder	`string`	If available, for a `Video` stream, the video’s scan order.
items[].technicalMetadata.avContainer.streams[].videoScanType	`string`	If available, for a `Video` stream, the video’s scan type.
items[].technicalMetadata.avContainer.streams[].videoColorPrimaries	`string`	If available, for a `Video` stream, the video’s color primaries.
items[].technicalMetadata.avContainer.streams[].videoChromaSubsampling	`string`	If available, for a `Video` stream, the video’s crhoma subsampling.
items[].technicalMetadata.avContainer.streams[].videoScanTypeStoreMethod	`string`	If available, for a `Video` stream, the video’s scan type store method.
items[].technicalMetadata.avContainer.streams[].audioSampleRate	`number`	If available, for an `Audio` stream, is the sample rate in Hz.
items[].technicalMetadata.avContainer.streams[].audioChannelCount	`number`	If available, for an `Audio` stream, is the number of channels within the stream.
items[].technicalMetadata.avContainer.streams[].audioLayout	`string`	If available, for an `Audio` stream, is the audio channel layout description. For example, `5.1`.
items[].technicalMetadata.avContainer.streams[].audioAnalysis	`string`	If available, for an `Audio` stream, it is further analysis to determine if a stream is true stereo or dual-mono.
items[].technicalMetadata.avContainer.streams[].rotate	`number`	If available, the amount of rotation, in degrees, that should be applied during playback of the video.
items[].technicalMetadata.dolbyContainer	`object`	If asset type is ‘Audio’ and the asset has Dolby Atmos metadata, this property contains the extended Dolby Atmos audio technical metadata.
items[].technicalMetadata.dolbyContainer.duration	`number`	Media duration (in seconds).
items[].technicalMetadata.dolbyContainer.fileSize	`number`	Media size (in bytes).
items[].technicalMetadata.dolbyContainer.overallBitRateMode	`string`	The overall bitrate mode for the Atmos content.
items[].technicalMetadata.dolbyContainer.overallBitRate	`number`	Media bitrate (in bits per second).
items[].technicalMetadata.dolbyContainer.totalChannels	`number`	Number of channels. `Bed channels` plus `Object channels` equals `Total channels`.
items[].technicalMetadata.dolbyContainer.bedChannels	`number`	Number of channel-based premix or stem that includes multichannel panning.
items[].technicalMetadata.dolbyContainer.numberOfBeds	`number`	A bed can be thought of as a traditional channel-based stem with the rules and expectations of stem configurations (such as 2.0, 5.1, and 7.1).
items[].technicalMetadata.dolbyContainer.bitDepth	`number`	Number of bits of information in each sample, generally 16, 24, or 32-bit.
items[].technicalMetadata.dolbyContainer.samplingRate	`number`	Audio sample-rate, generally 44100 or 48000 Hz.
items[].technicalMetadata.dolbyContainer.downmix51X	`string`	Global downmix metadata for monitoring, re-rendering, and encoding.
items[].technicalMetadata.dolbyContainer.trimModesSummary	`string`	A summary of the underlying trim modes.
items[].technicalMetadata.dolbyContainer.trimChannel20Mode	`string`	The type of trim mode supported for 2.0 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel51Mode	`string`	The type of trim mode supported for 5.1 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel71Mode	`string`	The type of trim mode supported for 7.1 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel212Mode	`string`	The type of trim mode supported for 2.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel512Mode	`string`	The type of trim mode supported for 5.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel712Mode	`string`	The type of trim mode supported for 7.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel214Mode	`string`	The type of trim mode supported for 2.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel514Mode	`string`	The type of trim mode supported for 5.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel714Mode	`string`	The type of trim mode supported for 7.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.associatedVideoFrameRate	`number`	Number of frames per second.
items[].technicalMetadata.dolbyContainer.start	`string`	Start SMPTE timecode based on the video frame rate.
items[].technicalMetadata.dolbyContainer.fFoA	`string`	FFoA (First Frame of Action) SMPTE timecode based on the video frame rate.
items[].technicalMetadata.dolbyContainer.end	`string`	End SMPTE timecode based on the video frame rate.
items[].technicalMetadata.dolbyContainer.metadataFormat	`string`	Format of the metadata in the Atmos content.
items[].technicalMetadata.dolbyContainer.admProfile	`string`	ADM (Audio Definition Model) Profile used in the Atmos content.
items[].technicalMetadata.dolbyContainer.numberOfProgrammes	`number`	Number of programmes in the Atmos content.
items[].technicalMetadata.dolbyContainer.numberOfObjectChannels	`number`	Number of objects in the Atmos Master.
items[].technicalMetadata.dolbyContainer.numberOfPackFormats	`number`	Number of Atmos Pack Formats in the Atmos content.
items[].technicalMetadata.dolbyContainer.numberOfChannelFormats	`number`	Number of channel formats in the Atmos content.
items[].technicalMetadata.dolbyContainer.binauralRenderModesSummary	`string`	Summary of all the binaural render modes used in the Atmos content. Supported strings are a unique combination of: “Off”, “Near”, “Mid”, “Far”.
items[].technicalMetadata.dolbyContainer.binauralRenderModesOffCount	`number`	Number of channels that use the “Off” setting for binaural rendering.
items[].technicalMetadata.dolbyContainer.binauralRenderModesNearCount	`number`	Number of channels that use the “Near” setting for binaural rendering.
items[].technicalMetadata.dolbyContainer.binauralRenderModesMidCount	`number`	Number of channels that use the “Mid” setting for binaural rendering.
items[].technicalMetadata.dolbyContainer.binauralRenderModesFarCount	`number`	Number of channels that use the “Far” setting for binaural rendering.
items[].technicalMetadata.dolbyContainer.truePeakLevels	`number`	The peak event in the audio waveform. Units are dBTP for true peak.
items[].technicalMetadata.dolbyContainer.loudness	`number`	Integrated loudness LKFS (or LUFS).
items[].hlsPlaylistUrl	`string`	A link to the HLS playlist generated from the source file.
items[].acquisitionContext	`object`	The file acquisition information.
items[].acquisitionContext.name	`string`	The original source file name, captured on acquisition.
items[].acquisitionContext.path	`string`	The original source file path, captured on acquisition.
items[].isExternal	`boolean`	Indicates if the file is stored in an external source.
items[].workspace	`object`	Information about the asset’s workspace.
items[].workspace.id	`string`	The unique identifier of the Workspace.
items[].workspace.name	`string`	The name of the Workspace.
items[].workspace.class	`string`	Indicates if the Workspace is a ‘Personal’ or ‘Team’ Workspace.
items[].kind	`string`	The type of item returned. Will always be ‘Asset’ for assets.

Headers

Content-Type: application/json

Body

{
  "code": "WorkspaceNotFound",
  "message": "Workspace not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

List Assets by Metadata Field
GET`/contents/metadata{?name,value,limit,offset}`

URI Parameters

HideShow

limit: number (optional)
The number of elements to return. The default is 50, and the maximum is 50.
offset: number (optional)
The element at which to begin the response. The default is 0.
name: string (required)
The metadata field name to search for.
value: string (required)
The metadata field value to search for.

Description

Returns all assets that have the provided metadata key-value pair. This API works across all Spaces that the calling user has access to.

Errors

Status Code	error	error_description
400	InvalidLimitOrOffset	Invalid limit or offset value. Limit must be a number between 1 and 100. Offset must be greater than or equal to 0.

List Asset Copies ¶

GET https://api.cimediacloud.com/assets/0000600f04b14c388ccdb1a001986123/copies?limit=1&offset=0&fields=name,thumbnails

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200404

Headers

Content-Type: application/json

Body

{
  "limit": 1,
  "offset": 0,
  "count": 10,
  "totalWorkspaceCount": 4,
  "totalCatalogCount": 0,
  "items": [
    {
      "id": "bcdc34b53e2c4c18ac41ca288e28d11f",
      "name": "Movie.mov",
      "size": 107856722,
      "type": "Video",
      "format": "mov",
      "folder": {
        "id": "9b639e12a82f4b0483f512b474dc052ci",
        "name": "Folder Name"
      },
      "status": "Complete",
      "description": "Final cut",
      "thumbnails": [
        {
          "type": "large",
          "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/thumb.jpg",
          "size": 1024,
          "width": 200,
          "height": 300,
          "source": {
            "id": "elementId1",
            "kind": "element"
          },
          "isExternal": false
        }
      ],
      "proxies": [
        {
          "type": "video-3g",
          "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/proxy.jpg",
          "size": 1024,
          "width": 200,
          "height": 300,
          "videoBitRate": 1650000,
          "audioBitRate": 128000,
          "isExternal": false
        }
      ],
      "md5Checksum": "tk2ma0zrhrp5irco",
      "createdOn": "2017-01-02T00:00:00.000Z",
      "createdBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "modifiedOn": "2017-01-02T00:00:00.000Z",
      "lastActivityOn": "2017-01-03T00:00:00.000Z",
      "acquisitionSource": {
        "name": "Workspace"
      },
      "archiveStatus": "Not archived",
      "archiveType": "Standard",
      "restoreStatus": "Not restored",
      "restoreExpirationDate": "2017-01-02T00:00:00.000Z",
      "restoreRequestDate": "2017-01-02T00:00:00.000Z",
      "lastRestoreDate": "2017-01-02T00:00:00.000Z",
      "restoredBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "archiveDate": "2017-01-02T00:00:00.000Z",
      "archivedBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "uploadCompleteDate": "2017-01-02T00:00:00.000Z",
      "isTrashed": false,
      "uploadTransferType": "SinglepartHttp",
      "runtime": 1024,
      "totalFolderCount": 1,
      "network": {
        "id": "40c2a6b99a474b319dec5ef9c7dbb356",
        "name": "Company Name",
        "class": "Enterprise"
      },
      "metadata": [
        {
          "name": "resolution",
          "value": "1080p",
          "readOnly": false
        }
      ],
      "technicalMetadata": {
        "type": "Video",
        "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/metadata.jpg",
        "size": 1024,
        "image": {
          "width": 100,
          "height": 300,
          "xResolution": 100,
          "yResolution": 100,
          "resolutionUnit": "cm",
          "cameraMake": "Nikon",
          "cameraModel": "D300",
          "groupingInfo": "6445055e520106d9d01769fffefd058901000100000000000000",
          "umidBasic": "060a2b340101010501010143130000006445055e520106cbd01769fffefd0589",
          "materialNumber": "6445055e520106cbd01769fffefd0589",
          "recordedDate": "2023-07-27T01:39:24Z",
          "locationCity": "New York",
          "locationState": "NY",
          "locationCountry": "USA",
          "exif": {
            "imageWidth": "3888",
            "imageHeight": "2592",
            "artist": "Michael W. Steidl.",
            "copyright": "(c) 2011 IPTC - Rights reserved."
          },
          "iptc": {
            "codedCharacterSet": "UTF8",
            "headline": "Bikefestival Vienna",
            "credit": "IPTC/Michael W. Steidl",
            "keywords": "Vienna Air King,cycling,mountain bike"
          },
          "xmp": {
            "serialNumber": "0380227035",
            "creatorRegion": "Roshire",
            "lens": "EF70-300mm f/4-5.6L IS USM",
            "creatorCountry": "United Kingdom"
          }
        },
        "avContainer": {
          "bitRate": 11934620,
          "duration": 100,
          "start": 0,
          "recordedDate": "2022-11-21T06:42:41Z",
          "deviceManufacturer": "Sony",
          "timeCode": "00:00:00:00",
          "derivedTimeCode": "00:00:00:00",
          "streams": [
            {
              "index": 0,
              "type": "Video",
              "bitRate": 11934620,
              "bitDepth": 8,
              "bitRateMode": "CBR",
              "codec": "h264",
              "codecName": "ProRes",
              "codecProfile": "422 HQ",
              "codecSettings": "Little / Signed",
              "fourCC": "avc1",
              "width": 1280,
              "height": 720,
              "totalFrames": 1024,
              "duration": 100,
              "frameRateNumerator": 360,
              "frameRateDenominator": 12,
              "videoPARWidth": 1,
              "videoPARHeight": 1,
              "videoDARWidth": 19,
              "videoDARHeight": 24,
              "start": 0,
              "timeCode": "00:00:00:00",
              "videoColorSpace": "bt709",
              "videoScanOrder": "TFF",
              "videoScanType": "Interlaced",
              "videoColorPrimaries": "DCI P3",
              "videoChromaSubsampling": "4:2:2",
              "videoScanTypeStoreMethod": "Interleaved fields",
              "audioSampleRate": 32000,
              "audioChannelCount": 2,
              "audioLayout": "Stereo",
              "audioAnalysis": "Stereo",
              "rotate": 0
            }
          ]
        },
        "dolbyContainer": {
          "duration": 9.6,
          "fileSize": 80294994,
          "overallBitRateMode": "CBR",
          "overallBitRate": 66912495,
          "totalChannels": 58,
          "bedChannels": 10,
          "numberOfBeds": 1,
          "bitDepth": 24,
          "samplingRate": 48000,
          "downmix51X": "Direct Render",
          "trimModesSummary": "automatic + manual_0",
          "trimChannel20Mode": "manual_0",
          "trimChannel51Mode": "manual_0",
          "trimChannel71Mode": "automatic",
          "trimChannel212Mode": "manual_0",
          "trimChannel512Mode": "automatic",
          "trimChannel712Mode": "manual_0",
          "trimChannel214Mode": "manual_0",
          "trimChannel514Mode": "manual_0",
          "trimChannel714Mode": "manual_0",
          "associatedVideoFrameRate": 23.976,
          "start": "01:00:00:00",
          "fFoA": "01:00:00:00",
          "end": "01:03:30:13",
          "metadataFormat": "ADM, Version 0",
          "admProfile": "Dolby Atmos Master, Version 1",
          "numberOfProgrammes": 1,
          "numberOfObjectChannels": 48,
          "numberOfPackFormats": 49,
          "numberOfChannelFormats": 58,
          "binauralRenderModesSummary": "Off + Near + Mid + Far",
          "binauralRenderModesOffCount": 9,
          "binauralRenderModesNearCount": 8,
          "binauralRenderModesMidCount": 13,
          "binauralRenderModesFarCount": 1,
          "truePeakLevels": -3.14,
          "loudness": -16.67
        }
      },
      "hlsPlaylistUrl": "https://cimediacloud.com/t5y7s3ero3w2ie7/hls",
      "acquisitionContext": {
        "name": "Movie1.mov",
        "path": "original/source/path"
      },
      "isExternal": false,
      "folders": [
        {
          "id": "9b639e12a82f4b0483f512b474dc052ci",
          "name": "Folder Name"
        }
      ],
      "workspace": {
        "id": "gb5ehomv0iv71swg",
        "name": "Workspace Name",
        "class": "Enterprise"
      }
    }
  ]
}

Property name	Type	Description
limit	`number`	The limit used for the query.
offset	`number`	The offset used for the query.
count	`number`	The total count of items available.
totalWorkspaceCount	`number`	The count of Workspaces that have copies of the asset, including the ones where the user doesn’t have access to.
totalCatalogCount	`number`	The count of Catalogs that have copies of the asset, including the ones where the user doesn’t have access to.
items	`array`	The items returned.
items[].id	`string`	The unique identifier of the asset.
items[].name	`string`	The name of the asset, including its extension. Its maximum length is 512 characters.
items[].size	`number`	The size of the source file, in bytes.
items[].type	`string`	The type of the asset. Valid values are `Audio`, `Video`, `Image`, `Document`, or `Other`.
items[].format	`string`	The asset’s file format.
items[].folder	`object`	Information about the asset’s parent folder.
items[].folder.id	`string`	The unique identifier of the folder.
items[].folder.name	`string`	The name of folder.
items[].status	`string`	The status of the asset. Valid values are ‘Created’, ‘Complete’, ‘Deleted’, ‘Executable Detected’, ‘Failed’, ‘Limited’, ‘Processing’, ‘Uploading’, ‘Virus Detected’, ‘Waiting’. See this section for more information.
items[].description	`string`	A comment or note associated to the asset. Its maximum length is 1000 characters.
items[].thumbnails	`array`	The set of thumbnails for the asset.
items[].thumbnails[].type	`string`	The type of thumbnail returned. Valid values are ‘small’, ‘medium’ and ‘large’.
items[].thumbnails[].location	`string`	The url of the thumbnail.
items[].thumbnails[].size	`number`	The size of the thumbnail, in bytes.
items[].thumbnails[].width	`number`	The width of the thumbnail.
items[].thumbnails[].height	`number`	The height of the thumbnail.
items[].thumbnails[].source	`object`	Information about the source of thumbnails.
items[].thumbnails[].source.id	`string`	Unique identifier of the thumbnail’s source.
items[].thumbnails[].source.kind	`string`	The kind of entity of the thumbnail’s source.
items[].thumbnails[].isExternal	`boolean`	Indicates if the thumbnail is stored in an external source.
items[].proxies	`array`	The set of proxies for the asset.
items[].proxies[].type	`string`	The type of proxy returned. Valid values are ‘standard-audio’, ‘dolby-audio’, ‘video-3g’, ‘video-sd’, ‘video-sdplus’, ‘video-hd’, ‘video-2k’, ‘video-2kplus’, ‘document-pdf’.
items[].proxies[].location	`string`	The url of the proxy.
items[].proxies[].size	`number`	The size of the proxy, in bytes.
items[].proxies[].width	`number`	The width of the proxy.
items[].proxies[].height	`number`	The height of the proxy.
items[].proxies[].videoBitRate	`number`	The video bitrate of the proxy.
items[].proxies[].audioBitRate	`number`	The audio bitrate of the proxy.
items[].proxies[].isExternal	`boolean`	Indicates if the proxy is stored in an external source.
items[].md5Checksum	`string`	The calculated md5 checksum for the asset.
items[].createdOn	`string`	The datetime the asset record was created.
items[].createdBy	`object`	Information about the creator of the asset
items[].createdBy.id	`string`	The unique identifier of the user.
items[].createdBy.name	`string`	The full name of the user.
items[].createdBy.email	`string`	The email of the user.
items[].modifiedOn	`string`	The datetime the asset record was last modified.
items[].lastActivityOn	`string`	The datetime of the last activity of the asset record.
items[].acquisitionSource	`object`	Information about the asset’s source client application.
items[].acquisitionSource.name	`string`	The name of the client application that uploaded the asset.
items[].archiveStatus	`string`	The archive status of the asset. Valid values are ‘Not archived’, ‘Archive in progress’, ‘Archive failed’, ‘Archived’, ‘Cancel archive in progress’.
items[].archiveType	`string`	If available, the kind of archive used for storing the asset. Valid values are `Standard` and `Deep`.
items[].restoreStatus	`string`	The restore status of the asset. This is applicable to assets that have been archived. Valid values are ‘Not restored’, ‘Restore in progress’, ‘Restore failed’, ‘Restored’.
items[].restoreExpirationDate	`string`	If available, the datetime the restored copy of the asset’s source file will no longer be available.
items[].restoreRequestDate	`string`	If available, the datetime the asset’s source file was requested to be restored.
items[].lastRestoreDate	`string`	If available, the datetime the asset’s source file was last restored.
items[].restoredBy	`object`	If available, information about the user who restored the asset.
items[].restoredBy.id	`string`	The unique identifier of the user.
items[].restoredBy.name	`string`	The full name of the user.
items[].restoredBy.email	`string`	The email of the user.
items[].archiveDate	`string`	If available, the datetime the asset’s source file was last archived.
items[].archivedBy	`object`	If available, information about the user who archived the asset.
items[].archivedBy.id	`string`	The unique identifier of the user.
items[].archivedBy.name	`string`	The full name of the user.
items[].archivedBy.email	`string`	The email of the user.
items[].uploadCompleteDate	`string`	The datetime the asset upload was completed.
items[].isTrashed	`boolean`	Indicates if an asset is in the trash bin.
items[].uploadTransferType	`string`	Indicates how the asset was uploaded. Valid values are ‘SinglepartHttp’, ‘MultipartHttp’, ‘Aspera’, ‘Copy’, ‘FTP’, ‘WorkspaceSend’.
items[].runtime	`number`	The duration of the media asset, in seconds.
items[].totalFolderCount	`number`	The amount of folders where the asset exists.
items[].network	`object`	Information about the asset’s network.
items[].network.id	`string`	The unique identifier of the Network.
items[].network.name	`string`	The name of the Network.
items[].network.class	`string`	Indicates if the Network is a ‘Personal’ or ‘Enterprise’ Network.
items[].metadata	`array`	An array of key-value pairs of user-generated and basic technical metadata.
items[].metadata[].name	`string`	The name of the metadata item.
items[].metadata[].value	`string`	the value of the metadata item.
items[].metadata[].readOnly	`boolean`	Flag to set a read-only metadata.
items[].technicalMetadata	`object`	An object that contains all the technical metadata available.
items[].technicalMetadata.type	`string`	The type of the asset. Valid values are either ‘Audio’, ‘Video’ or ‘Image’.
items[].technicalMetadata.location	`string`	Url of the source technical metadata file. Note: the content and structure of the technical metadata file is subject to change at any time.
items[].technicalMetadata.size	`number`	The size of the technical metadata file, in bytes.
items[].technicalMetadata.image	`object`	If the asset’s type is ‘Image’, this property contains the extended image technical metadata.
items[].technicalMetadata.image.width	`number`	The width of the image, in pixels.
items[].technicalMetadata.image.height	`number`	The height of the image, in pixels.
items[].technicalMetadata.image.xResolution	`number`	The number of pixels per resolutionUnit in the width direction.
items[].technicalMetadata.image.yResolution	`number`	The number of pixels per resolutionUnit in the height direction.
items[].technicalMetadata.image.resolutionUnit	`string`	The unit of measurement for xResolution and yResolution. Can be ‘inches’, ‘cm’ or ‘none’.
items[].technicalMetadata.image.cameraMake	`string`	Camera manufacturer name.
items[].technicalMetadata.image.cameraModel	`string`	Camera model name.
items[].technicalMetadata.image.groupingInfo	`string`	If available, the grouping info of the image. String of hexadecimal value (52 characteres) for the byte array object. Byte array order is Litte Endian.
items[].technicalMetadata.image.umidBasic	`string`	If available, the umid basic info of the image. String of hexadecimal value (64 characteres) for the byte array object.
items[].technicalMetadata.image.materialNumber	`string`	If available, the material number of the image. String of hexadecimal value (32 characteres) for the byte array object.
items[].technicalMetadata.image.recordedDate	`string`	The date and Time at which the image was captured.
items[].technicalMetadata.image.locationCity	`string`	Name of the city where the image was created.
items[].technicalMetadata.image.locationState	`string`	Name of the state where the image was created.
items[].technicalMetadata.image.locationCountry	`string`	Name of the country where the image was created.
items[].technicalMetadata.image.exif	`object`	The avalaible EXIF (Exchangeable Image File) metadata.
items[].technicalMetadata.image.exif.imageWidth	`string`	The image width in pixels.
items[].technicalMetadata.image.exif.imageHeight	`string`	The image height in pixels.
items[].technicalMetadata.image.exif.artist	`string`	The image artist info.
items[].technicalMetadata.image.exif.copyright	`string`	The image copyright.
items[].technicalMetadata.image.iptc	`object`	The available IPTC (International Press Telecommunications Council) available.
items[].technicalMetadata.image.iptc.codedCharacterSet	`string`	Determines how the internal IPTC string values are interpreted.
items[].technicalMetadata.image.iptc.headline	`string`	Brief synopsis or summary of the contents of the photograph.
items[].technicalMetadata.image.iptc.credit	`string`	How the image should be credited when published, as specified by the supplier of the image.
items[].technicalMetadata.image.iptc.keywords	`string`	Descriptive words added to the image to enable search and retrieval.
items[].technicalMetadata.image.xmp	`object`	The available XMP (Extensible Metadata Platform) metadata.
items[].technicalMetadata.image.xmp.serialNumber	`string`	Camera Serial Number.
items[].technicalMetadata.image.xmp.creatorRegion	`string`	State / Province for the address of the person that created this image.
items[].technicalMetadata.image.xmp.lens	`string`	Attempts to identify the camera lens used.
items[].technicalMetadata.image.xmp.creatorCountry	`string`	Country name for the address of the person that created this image.
items[].technicalMetadata.avContainer	`object`	If asset type is ‘Audio’ or ‘Video’, this property contains the extended audio / video technical metadata.
items[].technicalMetadata.avContainer.bitRate	`number`	The overall bitrate in the container.
items[].technicalMetadata.avContainer.duration	`number`	The runtime of the media in the container, in seconds.
items[].technicalMetadata.avContainer.start	`number`	The start time in the container, in seconds.
items[].technicalMetadata.avContainer.recordedDate	`string`	The date and Time at which the video was captured.
items[].technicalMetadata.avContainer.deviceManufacturer	`string`	The name of the device Manufacturer.
items[].technicalMetadata.avContainer.timeCode	`string`	The SMPTE timecode in the container.
items[].technicalMetadata.avContainer.derivedTimeCode	`string`	The standardized timecode derived by evaluating stream metadata and converting to drop frame format, if using drop frame rate.
items[].technicalMetadata.avContainer.streams	`array`	Set of audio, video, or data streams contained in the asset.
items[].technicalMetadata.avContainer.streams[].index	`number`	The index of the stream in the container.
items[].technicalMetadata.avContainer.streams[].type	`string`	The type of the stream. Valid values are `Audio`, `Video` or `Data`.
items[].technicalMetadata.avContainer.streams[].bitRate	`number`	If available, the overall bitrate in the stream.
items[].technicalMetadata.avContainer.streams[].bitDepth	`number`	If available, for an `Audio` stream, the bit depth of the stream.
items[].technicalMetadata.avContainer.streams[].bitRateMode	`string`	If available, the bit rate mode of the stream.
items[].technicalMetadata.avContainer.streams[].codec	`string`	If available, the codec used in the stream. For example, `h264`.
items[].technicalMetadata.avContainer.streams[].codecName	`string`	If available, the MediaInfo generated format commercial name for the stream.
items[].technicalMetadata.avContainer.streams[].codecProfile	`string`	If available, the MediaInfo generated format profile for the stream.
items[].technicalMetadata.avContainer.streams[].codecSettings	`string`	If avalable, the MediaInfo generated format settings for the stream.
items[].technicalMetadata.avContainer.streams[].fourCC	`string`	If available, four-character code for the codec used in the stream. For example, `avc1`, `apch`.
items[].technicalMetadata.avContainer.streams[].width	`number`	If available, for a `Video` stream, the width in pixels of the video.
items[].technicalMetadata.avContainer.streams[].height	`number`	If available, for a `Video` stream, the height in pixels of the video.
items[].technicalMetadata.avContainer.streams[].totalFrames	`number`	If available, total number of frames within the `Video` stream.
items[].technicalMetadata.avContainer.streams[].duration	`number`	If available, the runtime of the media in seconds.
items[].technicalMetadata.avContainer.streams[].frameRateNumerator	`number`	If available, the numerator of the frame rate. For example, if the frame rate is 24, the frame rate numerator is 24.
items[].technicalMetadata.avContainer.streams[].frameRateDenominator	`number`	If available, the numerator of the frame rate. For example, if the frame rate is 24, the frame rate denominator is 1.
items[].technicalMetadata.avContainer.streams[].videoPARWidth	`number`	If available, the width part of the pixel aspect ratio.
items[].technicalMetadata.avContainer.streams[].videoPARHeight	`number`	If available, the height part of the pixel aspect ratio.
items[].technicalMetadata.avContainer.streams[].videoDARWidth	`number`	If available, the width part of the display aspect ratio.
items[].technicalMetadata.avContainer.streams[].videoDARHeight	`number`	If available, the height part of the display aspect ratio.
items[].technicalMetadata.avContainer.streams[].start	`number`	If available, the start time in the stream, in seconds.
items[].technicalMetadata.avContainer.streams[].timeCode	`string`	If available, the SMPTE timecode in the stream.
items[].technicalMetadata.avContainer.streams[].videoColorSpace	`string`	If available, for a `Video` stream, the video’s color space / color primaries.
items[].technicalMetadata.avContainer.streams[].videoScanOrder	`string`	If available, for a `Video` stream, the video’s scan order.
items[].technicalMetadata.avContainer.streams[].videoScanType	`string`	If available, for a `Video` stream, the video’s scan type.
items[].technicalMetadata.avContainer.streams[].videoColorPrimaries	`string`	If available, for a `Video` stream, the video’s color primaries.
items[].technicalMetadata.avContainer.streams[].videoChromaSubsampling	`string`	If available, for a `Video` stream, the video’s crhoma subsampling.
items[].technicalMetadata.avContainer.streams[].videoScanTypeStoreMethod	`string`	If available, for a `Video` stream, the video’s scan type store method.
items[].technicalMetadata.avContainer.streams[].audioSampleRate	`number`	If available, for an `Audio` stream, is the sample rate in Hz.
items[].technicalMetadata.avContainer.streams[].audioChannelCount	`number`	If available, for an `Audio` stream, is the number of channels within the stream.
items[].technicalMetadata.avContainer.streams[].audioLayout	`string`	If available, for an `Audio` stream, is the audio channel layout description. For example, `5.1`.
items[].technicalMetadata.avContainer.streams[].audioAnalysis	`string`	If available, for an `Audio` stream, it is further analysis to determine if a stream is true stereo or dual-mono.
items[].technicalMetadata.avContainer.streams[].rotate	`number`	If available, the amount of rotation, in degrees, that should be applied during playback of the video.
items[].technicalMetadata.dolbyContainer	`object`	If asset type is ‘Audio’ and the asset has Dolby Atmos metadata, this property contains the extended Dolby Atmos audio technical metadata.
items[].technicalMetadata.dolbyContainer.duration	`number`	Media duration (in seconds).
items[].technicalMetadata.dolbyContainer.fileSize	`number`	Media size (in bytes).
items[].technicalMetadata.dolbyContainer.overallBitRateMode	`string`	The overall bitrate mode for the Atmos content.
items[].technicalMetadata.dolbyContainer.overallBitRate	`number`	Media bitrate (in bits per second).
items[].technicalMetadata.dolbyContainer.totalChannels	`number`	Number of channels. `Bed channels` plus `Object channels` equals `Total channels`.
items[].technicalMetadata.dolbyContainer.bedChannels	`number`	Number of channel-based premix or stem that includes multichannel panning.
items[].technicalMetadata.dolbyContainer.numberOfBeds	`number`	A bed can be thought of as a traditional channel-based stem with the rules and expectations of stem configurations (such as 2.0, 5.1, and 7.1).
items[].technicalMetadata.dolbyContainer.bitDepth	`number`	Number of bits of information in each sample, generally 16, 24, or 32-bit.
items[].technicalMetadata.dolbyContainer.samplingRate	`number`	Audio sample-rate, generally 44100 or 48000 Hz.
items[].technicalMetadata.dolbyContainer.downmix51X	`string`	Global downmix metadata for monitoring, re-rendering, and encoding.
items[].technicalMetadata.dolbyContainer.trimModesSummary	`string`	A summary of the underlying trim modes.
items[].technicalMetadata.dolbyContainer.trimChannel20Mode	`string`	The type of trim mode supported for 2.0 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel51Mode	`string`	The type of trim mode supported for 5.1 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel71Mode	`string`	The type of trim mode supported for 7.1 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel212Mode	`string`	The type of trim mode supported for 2.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel512Mode	`string`	The type of trim mode supported for 5.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel712Mode	`string`	The type of trim mode supported for 7.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel214Mode	`string`	The type of trim mode supported for 2.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel514Mode	`string`	The type of trim mode supported for 5.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel714Mode	`string`	The type of trim mode supported for 7.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.associatedVideoFrameRate	`number`	Number of frames per second.
items[].technicalMetadata.dolbyContainer.start	`string`	Start SMPTE timecode based on the video frame rate.
items[].technicalMetadata.dolbyContainer.fFoA	`string`	FFoA (First Frame of Action) SMPTE timecode based on the video frame rate.
items[].technicalMetadata.dolbyContainer.end	`string`	End SMPTE timecode based on the video frame rate.
items[].technicalMetadata.dolbyContainer.metadataFormat	`string`	Format of the metadata in the Atmos content.
items[].technicalMetadata.dolbyContainer.admProfile	`string`	ADM (Audio Definition Model) Profile used in the Atmos content.
items[].technicalMetadata.dolbyContainer.numberOfProgrammes	`number`	Number of programmes in the Atmos content.
items[].technicalMetadata.dolbyContainer.numberOfObjectChannels	`number`	Number of objects in the Atmos Master.
items[].technicalMetadata.dolbyContainer.numberOfPackFormats	`number`	Number of Atmos Pack Formats in the Atmos content.
items[].technicalMetadata.dolbyContainer.numberOfChannelFormats	`number`	Number of channel formats in the Atmos content.
items[].technicalMetadata.dolbyContainer.binauralRenderModesSummary	`string`	Summary of all the binaural render modes used in the Atmos content. Supported strings are a unique combination of: “Off”, “Near”, “Mid”, “Far”.
items[].technicalMetadata.dolbyContainer.binauralRenderModesOffCount	`number`	Number of channels that use the “Off” setting for binaural rendering.
items[].technicalMetadata.dolbyContainer.binauralRenderModesNearCount	`number`	Number of channels that use the “Near” setting for binaural rendering.
items[].technicalMetadata.dolbyContainer.binauralRenderModesMidCount	`number`	Number of channels that use the “Mid” setting for binaural rendering.
items[].technicalMetadata.dolbyContainer.binauralRenderModesFarCount	`number`	Number of channels that use the “Far” setting for binaural rendering.
items[].technicalMetadata.dolbyContainer.truePeakLevels	`number`	The peak event in the audio waveform. Units are dBTP for true peak.
items[].technicalMetadata.dolbyContainer.loudness	`number`	Integrated loudness LKFS (or LUFS).
items[].hlsPlaylistUrl	`string`	A link to the HLS playlist generated from the source file.
items[].acquisitionContext	`object`	The file acquisition information.
items[].acquisitionContext.name	`string`	The original source file name, captured on acquisition.
items[].acquisitionContext.path	`string`	The original source file path, captured on acquisition.
items[].isExternal	`boolean`	Indicates if the file is stored in an external source.
items[].folders	`array`	Information about the other folders that the asset belongs to, if the asset is located in more than one folder.
items[].workspace	`object`	Information about the asset’s workspace.
items[].workspace.id	`string`	The unique identifier of the Workspace.
items[].workspace.name	`string`	The name of the Workspace.
items[].workspace.class	`string`	Indicates if the Workspace is a ‘Personal’ or ‘Team’ Workspace.

Headers

Content-Type: application/json

Body

{
  "code": "AssetNotFound",
  "message": "Asset not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

List Asset Copies
GET`/assets/{assetId}/copies{?limit,offset,fields}`

URI Parameters

HideShow

assetId: string (required)
The unique identifier of the asset.
limit: number (optional) Default: 50
The number of items to return. The maximum is 100.
offset: number (optional) Default: 0
The item at which to begin the response.
fields: string (optional)
A comma separated list of fields to return in the response. If this value is empty all fields will be returned. Id and Name are always returned.

Description

Retrieves the copies of the given asset. This query supports pagination using limit and offset.

Errors

Status Code	Error Code	Message
400	InvalidLimitOrOffset	Invalid limit or offset value. Limit must be a number between 1 and 100. Offset must be greater than or equal to 0.
404	AssetNotFound	Asset not found.

Trash an Asset ¶

POST https://api.cimediacloud.com/assets/yiireizq1hcowxua/trash

Requestssimple example

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200404

Headers

Content-Type: application/json

Body

{
  "message": "Asset was trashed"
}

Property name	Type	Description
message	`string`	Indicates the asset was trashed.

Headers

Content-Type: application/json

Body

{
  "code": "AssetNotFound",
  "message": "Asset not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Trash an Asset
POST`/assets/{assetId}/trash`

URI Parameters

HideShow

assetId: string (required)
The unique identifier of the asset.

Description

Sends the asset to the trash bin. Items in the trash bin are not considered available for additional operations, i.e. downloading. However, they are still physically available and can be removed from the trash.

Please note that the asset’s size is still counted against the Workspace and Network storage quota while it exists in the trash bin.

Errors

Status Code	Error Code	Message
404	AssetNotFound	Asset not found.
404	AssetDeleted	Asset is deleted.
409	AssetTrashed	Asset is trashed.

Trash Multiple Assets ¶

POST https://api.cimediacloud.com/assets/trash

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "assetIds": [
    "6i3x3hp1ni2wo5bd"
  ]
}

Property name	Type	Description
assetIds	`array`	The unique identifiers for all assets.

Responses200409

Headers

Content-Type: application/json

Body

{
  "completeCount": 1,
  "errorCount": 1,
  "errors": [
    {
      "name": "Item name",
      "kind": "Item",
      "errorCode": "ItemNotFound",
      "errorMessage": "Item not found.",
      "id": "ad9289a2019a4e07a08eca9459ef1091"
    }
  ],
  "complete": [
    {
      "id": "d9bf018c804a4e78b775b8dc2f242071",
      "name": "Movie.mov",
      "kind": "Asset"
    }
  ]
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors	`array`	An array containing information about each failed item.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].id	`string`	The unique identifier for the item.
complete	`array`	An array containing information about each completed item.
complete[].id	`string`	The unique identifier of the asset.
complete[].name	`string`	The name of asset and its extension.
complete[].kind	`string`	The kind of item returned. Will be ‘Asset’ for assets.

Headers

Content-Type: application/json

Body

{
  "completeCount": 0,
  "errorCount": 1,
  "errors": [
    {
      "name": "Item name",
      "kind": "Item",
      "errorCode": "ItemNotFound",
      "errorMessage": "Item not found.",
      "id": "ad9289a2019a4e07a08eca9459ef1091"
    }
  ]
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors	`array`	An array containing information about each failed item.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].id	`string`	The unique identifier for the item.

Trash Multiple Assets
POST`/assets/trash`

Description

Sends multiple assets to the trash bin.

500 is the maximum number of assets that can be trashed in a single operation.

Please note that the total size for all trashed assets still counts against your storage quota while they exist in the trash bin.

Errors

Status Code	Error Code	Message	Notes
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	AssetIdNotProvided	Asset Id not provided.
400	ExceededMaxAssetCount	Max asset count exceeded. The maximum number of assets is 500.
409	BulkOperationFailed	The bulk operation failed. See the errors array for more information.	This message appears if there were no successfully trashed assets.

Errors represented in errors array

Error Code	Message
AssetNotFound	Asset not found.
AssetDeleted	Asset is deleted.
AssetTrashed	Asset is trashed.

Untrash an Asset ¶

POST https://api.cimediacloud.com/assets/yiireizq1hcowxua/untrash

Requestssimple example

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200404

Headers

Content-Type: application/json

Body

{
  "message": "Asset was untrashed"
}

Property name	Type	Description
message	`string`	Indicates the asset was untrashed.

Headers

Content-Type: application/json

Body

{
  "code": "AssetNotFound",
  "message": "Asset not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Untrash an Asset
POST`/assets/{assetId}/untrash`

URI Parameters

HideShow

assetId: string (required)
The unique identifier of the asset.

Description

Removes a previously-trashed asset from the trash bin.

Untrashing an asset will untrash its parent folders, if trashed, but will not untrash any parent folder contents.

Errors

Status Code	Error Code	Message
404	AssetNotFound	Asset not found.
404	AssetDeleted	Asset is deleted.
409	AssetNotTrashed	Asset is already untrashed.

Untrash Multiple Assets ¶

POST https://api.cimediacloud.com/assets/untrash

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "assetIds": [
    "6i3x3hp1ni2wo5bd"
  ]
}

Property name	Type	Description
assetIds	`array`	The unique identifiers for all assets.

Responses200409

Headers

Content-Type: application/json

Body

{
  "completeCount": 1,
  "errorCount": 1,
  "errors": [
    {
      "name": "Item name",
      "kind": "Item",
      "errorCode": "ItemNotFound",
      "errorMessage": "Item not found.",
      "id": "ad9289a2019a4e07a08eca9459ef1091"
    }
  ],
  "complete": [
    {
      "id": "d9bf018c804a4e78b775b8dc2f242071",
      "name": "Movie.mov",
      "kind": "Asset"
    }
  ]
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors	`array`	An array containing information about each failed item.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].id	`string`	The unique identifier for the item.
complete	`array`	An array containing information about each completed item.
complete[].id	`string`	The unique identifier of the asset.
complete[].name	`string`	The name of asset and its extension.
complete[].kind	`string`	The kind of item returned. Will be ‘Asset’ for assets.

Headers

Content-Type: application/json

Body

{
  "completeCount": 0,
  "errorCount": 1,
  "errors": [
    {
      "name": "Item name",
      "kind": "Item",
      "errorCode": "ItemNotFound",
      "errorMessage": "Item not found.",
      "id": "ad9289a2019a4e07a08eca9459ef1091"
    }
  ]
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors	`array`	An array containing information about each failed item.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].id	`string`	The unique identifier for the item.

Untrash Multiple Assets
POST`/assets/untrash`

Description

Removes previously-trashed assets from the trash bin.

500 is the maximum number of assets that can be untrashed in a single operation.

Untrashing assets will untrash their parent folders, if trashed, but will not untrash any parent folder contents.

Errors

Status Code	Error Code	Message	Notes
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	AssetIdNotProvided	Asset Id not provided.
400	ExceededMaxAssetCount	Max asset count exceeded. The maximum number of assets is 500.
409	BulkOperationFailed	The bulk operation failed. See the errors array for more information.	This message appears if there were no successfully untrashed assets.

Errors represented in errors array

Error Code	Message
AssetNotFound	Asset not found.
AssetDeleted	Asset is deleted.
AssetNotTrashed	Asset is already untrashed.

Delete Multiple Assets ¶

POST https://api.cimediacloud.com/assets/delete

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "assetIds": [
    "6i3x3hp1ni2wo5bd"
  ]
}

Property name	Type	Description
assetIds	`array` (required)	The unique identifiers for all assets.

Responses200409

Headers

Content-Type: application/json

Body

{
  "completeCount": 1,
  "errorCount": 1,
  "errors": [
    {
      "name": "Item name",
      "kind": "Item",
      "errorCode": "ItemNotFound",
      "errorMessage": "Item not found.",
      "id": "ad9289a2019a4e07a08eca9459ef1091"
    }
  ],
  "complete": [
    {
      "id": "d9bf018c804a4e78b775b8dc2f242071",
      "name": "Movie.mov",
      "kind": "Asset"
    }
  ]
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors	`array`	An array containing information about each failed item.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].id	`string`	The unique identifier for the item.
complete	`array`	An array containing information about each completed item.
complete[].id	`string`	The unique identifier of the asset.
complete[].name	`string`	The name of asset and its extension.
complete[].kind	`string`	The kind of item returned. Will be ‘Asset’ for assets.

Headers

Content-Type: application/json

Body

{
  "completeCount": 0,
  "errorCount": 1,
  "errors": [
    {
      "name": "Item name",
      "kind": "Item",
      "errorCode": "ItemNotFound",
      "errorMessage": "Item not found.",
      "id": "ad9289a2019a4e07a08eca9459ef1091"
    }
  ]
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors	`array`	An array containing information about each failed item.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].id	`string`	The unique identifier for the item.

Delete Multiple Assets
POST`/assets/delete`

Description

Deletes the specified assets and their associated files permanently. The storage quota is updated to reflect the newly freed space.

500 is the maximum number of assets that can be deleted in a single operation.

Errors

Status Code	Error Code	Message	Notes
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	AssetIdNotProvided	Asset Id not provided.
400	ExceededMaxAssetCount	Max asset count exceeded. The maximum number of assets is 500.
409	BulkOperationFailed	The bulk operation failed. See the errors array for more information.	This message appears if there were no successfully deleted assets.

Errors represented in errors array

Error Code	Message
AssetNotFound	Asset not found.
AssetDeleted	Asset is deleted.

Copy Multiple Assets ¶

POST https://api.cimediacloud.com/assets/copy

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "assetIds": [
    "dc4ed1a7bfd14e1a9f9444de5ba0f9a3"
  ],
  "targets": [
    {
      "workspaceId": "gyr2s6zos9lsljw7",
      "folderId": "mgywjrcggsbx465p"
    }
  ]
}

Property name	Type	Description
assetIds	`array`	The unique identifiers for all assets.
targets	`array`	A set of objects that specifies the workspaceId and folderId that serves as target.
targets[].workspaceId	`string` (required)	The unique identifier for the target workspace.
targets[].folderId	`string`	The unique identifier for the target folder. If not provided the asset will go to the root folder.

Responses200409

Headers

Content-Type: application/json

Body

{
  "completeCount": 1,
  "errorCount": 1,
  "errors": [
    {
      "name": "Item name",
      "kind": "Item",
      "errorCode": "ItemNotFound",
      "errorMessage": "Item not found.",
      "id": "ad9289a2019a4e07a08eca9459ef1091"
    }
  ],
  "complete": [
    {
      "id": "d9bf018c804a4e78b775b8dc2f242071",
      "name": "Movie.mov",
      "kind": "Asset",
      "sourceAssetId": "dc4ed1a7bfd14e1a9f9444de5ba0f9a3",
      "folderId": "eynde5qbjzc0ww16",
      "workspaceId": "9hdf6pk2quj0ion6"
    }
  ]
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors	`array`	An array containing information about each failed item.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].id	`string`	The unique identifier for the item.
complete	`array`	An array containing information about each completed item.
complete[].id	`string`	The unique identifier of the asset.
complete[].name	`string`	The name of asset and its extension.
complete[].kind	`string`	The kind of item returned. Will be ‘Asset’ for assets.
complete[].sourceAssetId	`string`	The unique identifier of the source asset.
complete[].folderId	`string`	The unique identifier of the parent folder.
complete[].workspaceId	`string`	The unique identifier of the parent Workspace.

Headers

Content-Type: application/json

Body

{
  "completeCount": 0,
  "errorCount": 1,
  "errors": [
    {
      "name": "Item name",
      "kind": "Item",
      "errorCode": "ItemNotFound",
      "errorMessage": "Item not found.",
      "id": "ad9289a2019a4e07a08eca9459ef1091"
    }
  ]
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors	`array`	An array containing information about each failed item.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].id	`string`	The unique identifier for the item.

Copy Multiple Assets
POST`/assets/copy`

Description

Copies the specified assets to the target workspaces. A folder id can be specified per workspace; if not, the asset will be copied into the root folder of that workspace. The storage quota of each workspace is updated to reflect the storage used by this operation.

500 is the maximum number of assets that can be created in a single operation. For example, specifying 100 source assets and 4 target workspaces would result in 400 assets to be created.

Errors

Status Code	Error Code	Message
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	InvalidCopyRequest	Invalid copy request. The request must contain at least one asset id and at least one target containing a workspace id. There cannot be any duplicate assets or targets.
400	AssetNotFound	Asset not found.
400	AssetNotReady	Asset not ready. Its status must be either “Complete” or “Limited”.
400	WorkspaceNotFound	Workspace not found.
400	FolderNotFound	Folder not found.
400	FolderNotMemberOfWorkspace	Folder is not a member of the provided workspace.
400	ExceededMaxAssetCount	Max asset count exceeded. The maximum number of assets is 500.
409	InvalidAssetState	Asset is archived or in the process of being archived and therefore cannot be copied. The asset archiveStatus must be ‘Not archived’ for a copy operation to succeed.
409	InsufficientSpaceAvailable	Copy will exceed the workspace’s allotted storage.

Move Multiple Assets ¶

POST https://api.cimediacloud.com/assets/move

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "assetIds": [
    "6i3x3hp1ni2wo5bd"
  ],
  "folderId": "mgywjrcggsbx465p"
}

Property name	Type	Description
assetIds	`array`	The unique identifiers for all assets.
folderId	`string`	The unique identifier for the target folder.

Responses200409

Headers

Content-Type: application/json

Body

{
  "completeCount": 1,
  "errorCount": 1,
  "errors": [
    {
      "name": "Item name",
      "kind": "Item",
      "errorCode": "ItemNotFound",
      "errorMessage": "Item not found.",
      "id": "ad9289a2019a4e07a08eca9459ef1091"
    }
  ],
  "complete": [
    {
      "id": "d9bf018c804a4e78b775b8dc2f242071",
      "name": "Movie.mov",
      "kind": "Asset"
    }
  ]
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors	`array`	An array containing information about each failed item.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].id	`string`	The unique identifier for the item.
complete	`array`	An array containing information about each completed item.
complete[].id	`string`	The unique identifier of the asset.
complete[].name	`string`	The name of asset and its extension.
complete[].kind	`string`	The kind of item returned. Will be ‘Asset’ for assets.

Headers

Content-Type: application/json

Body

{
  "completeCount": 0,
  "errorCount": 1,
  "errors": [
    {
      "name": "Item name",
      "kind": "Item",
      "errorCode": "ItemNotFound",
      "errorMessage": "Item not found.",
      "id": "ad9289a2019a4e07a08eca9459ef1091"
    }
  ]
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors	`array`	An array containing information about each failed item.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].id	`string`	The unique identifier for the item.

Move Multiple Assets
POST`/assets/move`

Description

Moves the specified assets to the target folder.

500 is the maximum number of assets that can be moved in a single operation.

The target folder must be in the same workspace as the assets being moved.

Errors

Status Code	Error Code	Message	Notes
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	InvalidMoveRequest	Invalid move request. The request must contain at least one asset id and a folder id. There cannot be any duplicate assets.
400	ExceededMaxAssetCount	Max asset count exceeded. The maximum number of assets is 500.
400	InvalidAssets	Assets belong to multiple workspaces.
400	InvalidAssets	Assets container type are different. It should be `Workspace` or `Catalog` only.
400	FolderNotFound	Folder not found.
400	FolderNotMemberOfWorkspace	Folder is not a member of the provided workspace.
400	FolderTrashed	Folder is trashed.
400	FolderDeleted	Folder is deleted.
409	BulkOperationFailed	The bulk operation failed. See the errors array for more information.	This message appears if there were no successfully deleted assets.

Errors represented in errors array

Error Code	Message
AssetNotFound	Asset not found.
AssetTrashed	Asset is trashed.
AssetDeleted	Asset is deleted.

Metadata ¶

POST https://api.cimediacloud.com/assets/yiireizq1hcowxua/metadata/

Requestssimple example

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "metadata": [
    {
      "name": "resolution",
      "value": "1080p",
      "readOnly": false
    }
  ]
}

Property name	Type	Description
metadata	`array`	Set of items to add.
metadata[].name	`string`	The name of the metadata item.
metadata[].value	`string`	the value of the metadata item.
metadata[].readOnly	`boolean`	Flag to set a read-only metadata.

Responses200404

Headers

Content-Type: application/json

Body

{
  "metadata": [
    {
      "name": "resolution",
      "value": "1080p",
      "readOnly": false
    }
  ]
}

Property name	Type	Description
metadata	`array`	Set of items added.
metadata[].name	`string`	The name of the metadata item.
metadata[].value	`string`	the value of the metadata item.
metadata[].readOnly	`boolean`	Flag to set a read-only metadata.

Headers

Content-Type: application/json

Body

{
  "Attributes": {
    "code": "AssetNotFound",
    "message": "Asset not found."
  }
}

Property name	Type	Description
Attributes	`object`
Attributes.code	`string`	Machine readable error code
Attributes.message	`string`	Error message

Add Metadata
POST`/assets/{assetId}/metadata/`

URI Parameters

HideShow

assetId: string (required)
The unique identifier of the asset.

Description

Adds one or more metadata items to an asset.

Errors

Status Code	Error Code	Message
404	AssetNotFound	Asset not found.
404	AssetDeleted	Asset is deleted.
409	AssetNotTrashed	Asset is already untrashed.

PUT https://api.cimediacloud.com/assets/yiireizq1hcowxua/metadata/resolution

Requestssimple example

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "value": "1080p"
}

Property name	Type	Description
value	`string`	Updated value.

Responses200404

Headers

Content-Type: application/json

Body

{
  "metadata": {
    "name": "resolution",
    "value": "1080p",
    "readOnly": false
  }
}

Property name	Type	Description
metadata	`object`	Items updated.
metadata.name	`string`	The name of the metadata item.
metadata.value	`string`	the value of the metadata item.
metadata.readOnly	`boolean`	Flag to set a read-only metadata.

Headers

Content-Type: application/json

Body

{
  "Attributes": {
    "code": "AssetNotFound",
    "message": "Asset not found."
  }
}

Property name	Type	Description
Attributes	`object`
Attributes.code	`string`	Machine readable error code
Attributes.message	`string`	Error message

Update Metadata
PUT`/assets/{assetId}/metadata/{name}`

URI Parameters

HideShow

assetId: string (required)
The unique identifier of the asset.
name: string (required)
The name of the metadata item.

Description

Updates an existing metadata item.

Errors

Status Code	Error Code	Message
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
404	AssetNotFound	Asset not found.
404	MetadataNotFound	Metadata not found.

DELETE https://api.cimediacloud.com/assets/yiireizq1hcowxua/metadata/resolution

Requestssimple example

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200404

Headers

Content-Type: application/json

Body

{
  "message": "The metadata was deleted."
}

Property name	Type	Description
message	`string`	Indicates the metadata item was deleted.

Headers

Content-Type: application/json

Body

{
  "Attributes": {
    "code": "AssetNotFound",
    "message": "Asset not found."
  }
}

Property name	Type	Description
Attributes	`object`
Attributes.code	`string`	Machine readable error code
Attributes.message	`string`	Error message

Delete Metadata
DELETE`/assets/{assetId}/metadata/{name}`

URI Parameters

HideShow

assetId: string (required)
The unique identifier of the asset.
name: string (required)
The name of the metadata item.

Description

Deletes a user metadata item.

Errors

Status Code	Error Code	Message
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
404	AssetNotFound	Asset not found.
404	MetadataNotFound	Metadata not found.

Update Multiple Assets ¶

POST https://api.cimediacloud.com/assets/changes

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "changes": [
    {
      "assetIds": [
        "6i3x3hp1ni2wo5bd"
      ],
      "description": "This is a description."
    }
  ]
}

Property name	Type	Description
changes	`array`	The groups of changes to process.

Responses200409

Headers

Content-Type: application/json

Body

{
  "completeCount": 1,
  "errorCount": 1,
  "errors": [
    {
      "name": "Item name",
      "kind": "Item",
      "errorCode": "ItemNotFound",
      "errorMessage": "Item not found.",
      "id": "ad9289a2019a4e07a08eca9459ef1091"
    }
  ],
  "complete": [
    {
      "id": "d9bf018c804a4e78b775b8dc2f242071",
      "name": "Movie.mov",
      "kind": "Asset"
    }
  ]
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors	`array`	An array containing information about each failed item.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].id	`string`	The unique identifier for the item.
complete	`array`	An array containing information about each completed item.
complete[].id	`string`	The unique identifier of the asset.
complete[].name	`string`	The name of asset and its extension.
complete[].kind	`string`	The kind of item returned. Will be ‘Asset’ for assets.

Headers

Content-Type: application/json

Body

{
  "completeCount": 0,
  "errorCount": 1,
  "errors": [
    {
      "name": "Item name",
      "kind": "Item",
      "errorCode": "ItemNotFound",
      "errorMessage": "Item not found.",
      "id": "ad9289a2019a4e07a08eca9459ef1091"
    }
  ]
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors	`array`	An array containing information about each failed item.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].id	`string`	The unique identifier for the item.

Update Multiple Assets
POST`/assets/changes`

Description

Allows to update the description for multiple assets.

An asset can only be affected by a single group of changes. That is, different groups cannot include the same asset id.

500 is the maximum number of assets that can be updated in a single operation.

500 is the maximum number of changes that can included in a single operation.

Status Code	Error Code	Message	Notes
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	OverlappingChanges	At least an asset is part of different changesets.
400	ExceededMaxAssetCount	Max asset count exceeded. The maximum number of assets is 500.
400	ExceededMaxChangeCount	Max change count exceeded.
409	BulkOperationFailed	The bulk operation failed. See the errors array for more information.	This message appears if no changes were successfully processed.

Errors represented in errors array

Error Code	Message
AssetIdNotProvided	Asset Id not provided.
AssetNotFound	Asset not found.
AssetDeleted	Asset is deleted.
EmptyChanges	A changeset doesn’t have any change defined.

Update Multiple Assets' Metadata ¶

POST https://api.cimediacloud.com/assets/metadata/changes

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "changes": [
    {
      "assetIds": [
        "6i3x3hp1ni2wo5bd"
      ],
      "set": [
        {
          "name": "Owner",
          "value": "Sony",
          "readOnly": false
        }
      ],
      "unset": [
        {
          "name": "Runtime"
        }
      ]
    }
  ]
}

Property name	Type	Description
changes	`array`	The groups of changes to process.

Responses200409

Headers

Content-Type: application/json

Body

{
  "completeCount": 1,
  "errorCount": 1,
  "errors": [
    {
      "name": "Item name",
      "kind": "Item",
      "errorCode": "ItemNotFound",
      "errorMessage": "Item not found.",
      "id": "ad9289a2019a4e07a08eca9459ef1091"
    }
  ],
  "complete": [
    {
      "id": "d9bf018c804a4e78b775b8dc2f242071",
      "name": "Movie.mov",
      "kind": "Asset"
    }
  ]
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors	`array`	An array containing information about each failed item.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].id	`string`	The unique identifier for the item.
complete	`array`	An array containing information about each completed item.
complete[].id	`string`	The unique identifier of the asset.
complete[].name	`string`	The name of asset and its extension.
complete[].kind	`string`	The kind of item returned. Will be ‘Asset’ for assets.

Headers

Content-Type: application/json

Body

{
  "completeCount": 0,
  "errorCount": 1,
  "errors": [
    {
      "name": "Item name",
      "kind": "Item",
      "errorCode": "ItemNotFound",
      "errorMessage": "Item not found.",
      "id": "ad9289a2019a4e07a08eca9459ef1091"
    }
  ]
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors	`array`	An array containing information about each failed item.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].id	`string`	The unique identifier for the item.

Update Multiple Assets' Metadata
POST`/assets/metadata/changes`

Description

Adds, updates and removes metadata for multiple assets. This resource allows you to perform multiple metadata changes to multiple assets in a single request.

Each group of changes define which metadata items are added or updated (if any), which metadata items are removed (if any), and which assets are affected by these changes.

An asset can only be affected by a single group of changes. That is, different groups cannot include the same asset id. Also, a group of changes cannot add (or update) and remove a specific metadata item.

The metadata item’s name is case insensitive.

500 is the maximum number of assets that can be updated in a single operation.

500 is the maximum number of changes that can included in a single operation.

Status Code	Error Code	Message	Notes
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	OverlappingChanges	At least an asset is part of different changesets.
400	ExceededMaxAssetCount	Max asset count exceeded. The maximum number of assets is 500.
400	ExceededMaxChangeCount	Max change count exceeded.
409	BulkOperationFailed	The bulk operation failed. See the errors array for more information.	This message appears if no changes were successfully processed.

Errors represented in errors array

Error Code	Message
AssetIdNotProvided	Asset Id not provided.
AssetNotFound	Asset not found.
AssetDeleted	Asset is deleted.
EmptyChanges	A changeset doesn’t have any change defined.
ConflictingChanges	A changeset has conflicting changes.
InvalidChanges	A changeset has invalid, incomplete changes.

Create Playback Streams ¶

POST https://api.cimediacloud.com/assets/hwgles9nn6hcb2vb/streams

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "streams": [
    {
      "name": "stream1",
      "expirationDate": "2018-01-01T00:00:00.000Z",
      "videoSources": [
        {
          "type": "video-3g",
          "displayName": "Video 3G"
        },
        {
          "type": "video-sd",
          "displayName": "Video SD"
        }
      ],
      "captionSources": [
        {
          "language": "eng",
          "type": "example-closed-caption-type",
          "elementId": "example-closed-caption-elementId",
          "assetId": "example-closed-caption-assetId",
          "displayName": "English, UK",
          "startTimeOffset": "01:00:00.000"
        },
        {
          "language": "fra",
          "elementId": "example-closed-caption-elementId",
          "displayName": "French"
        },
        {
          "language": "spa",
          "assetId": "example-closed-caption-assetId",
          "displayName": "Spanish, Cuba",
          "startTimeOffset": "01:00:03.456"
        },
        {
          "language": "zho",
          "type": "example-closed-caption-type",
          "displayName": "Chinese"
        }
      ]
    }
  ]
}

Property name	Type	Description
streams	`array` (required)	The specifications for the playback stream. This can be a single stream specification or it can contain an array of stream specifications.
streams[].name	`string`	Uniquely identifies this stream from others submitted in the batch. It can be as simple as a name or a sequential number.
streams[].expirationDate	`string`	The date and time for streaming URL expiration in IS0 8601 date and time format (e.g.: ‘2020-01-01’). Value must be less than ‘2038-01-01’ and greater than the current date and time. If not provided, a default of 3 hours is used.
streams[].videoSources	`array` (required)	The list of asset proxies or elements used in the streams. When using standard proxies (i.e. ‘video-3g’, ‘video-sd’), then multiple sources may be used. If using a custom element proxy, then only a single source may be specified.
streams[].videoSources[].type	`string` (required)	The unique type of each asset proxy or element used in the streams. Check the Previews section for available proxy types. Additional types may be available if custom proxy elements have been generated for an asset; please contact Customer Service if you want to learn more about custom proxies.
streams[].videoSources[].displayName	`string`	The text that the video player displays to identify this video source. The displayName for each videoSource is included internally in the adaptive stream to identify each video resolution. It is also included in the response body to identify each progressive stream. The stream name is used to identify the displayName for the adaptive stream. If the displayName is blank, the default name for that proxy/element will be used. Its maximum length is 40 characters. Valid characters include the following: a - z (letters) 0 - 9 (numbers) . (period) - (hyphen) _ (underscore) + (plus)
streams[].captionSources	`array` (required)	The list of captions files to be included in the streams (there is a maximum of 30 caption files). `type`, `elementId` or `assetId` must be included for each captionSource. Please contact Customer Service if you want to learn more about caption extraction for assets.
streams[].captionSources[].language	`string` (required)	Indicates the language of the caption file, can be expressed as an ISO 639-2/T three character format or any other string that adheres to RFC 5646.
streams[].captionSources[].type	`string`	The unique type of each closed caption element used in the stream. Any caption type extracted by Ci is allowed. Valid caption types are: `cc-scc`, `cc-srt`, and `cc-vtt` which may be available if custom proxy elements have been generated for an asset; please contact Customer Service if you want to learn more about custom proxies.
streams[].captionSources[].elementId	`string`	The elementId corresponding to the closed caption element extracted from the source ‘assetId’ specified in the Url
streams[].captionSources[].assetId	`string`	Any valid assetId that the user has permissions to access. Asset can be almost any valid closed caption format.
streams[].captionSources[].displayName	`string`	The user friendly string that appears to identify this caption when a user wants to view or change languages. If omitted, defaults to the ISO639-2 name associated with the language code.
streams[].captionSources[].startTimeOffset	`string`	An optional timespan to subtract from all caption start and end times. This is useful in cases where the video source’s start timecode is included in the captions file and needs to be removed.

Responses200

Headers

Content-Type: application/json

Body

{
  "completeCount": 1,
  "errorCount": 1,
  "errors": [
    {
      "name": "stream2",
      "kind": "Stream",
      "errorCode": "InvalidStreamSource",
      "errorMessage": "One or more source proxies and/or elements are invalid. Review Ci API documentation for valid source requirements."
    }
  ],
  "complete": [
    {
      "name": "stream1",
      "kind": "Stream",
      "streams": [
        {
          "method": "adaptive",
          "type": "hls",
          "url": "http://io.api.cimediacloud.com/assets/54169409604e4a30b0dde9ae23233eee/streams/smil_md5hash.m3u8?Expires=expirationDate&Signature=234gf234hg2f34==",
          "displayName": "stream1"
        },
        {
          "method": "progressive",
          "type": "video-3g",
          "url": "http://cloudfront.cimediacloud.com/54169409604e4a30b0dde9ae23233eee/video-3g.mp4?Expires=expirationDate&Signature=234gf234hg2f34==1",
          "displayName": "Video 3G"
        },
        {
          "method": "progressive",
          "type": "video-sd",
          "url": "http://cloudfront.cimediacloud.com/54169409604e4a30b0dde9ae23233eee/video-sd.mp4?Expires=expirationDate&Signature=234gf234hg2f34==1",
          "displayName": "Video SD"
        }
      ],
      "captions": [
        {
          "displayName": "English, UK",
          "language": "eng",
          "url": "http://cloudfront.cimediacloud.com/54169409604e4a30b0dde9ae23233eee/cc-vtt.vtt?Expires=expirationDate&Signature=234gf234hg2f34==1"
        },
        {
          "displayName": "French",
          "language": "fra",
          "url": "http://cloudfront.cimediacloud.com/example-closed-caption-elementId/cc-vtt.vtt?Expires=expirationDate&Signature=234gf234hg2f34==1"
        },
        {
          "displayName": "Spanish, Cuba",
          "language": "spa",
          "url": "http://cloudfront.cimediacloud.com/example-closed-caption-assetId/cc-vtt.vtt?Expires=expirationDate&Signature=234gf234hg2f34==1"
        }
      ]
    }
  ]
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors	`array`	An array containing information about each failed item.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
complete	`array`	An array containing information about each completed item.
complete[].name	`string`	The unique identifier that was optionally supplied when the request was submitted.
complete[].kind	`string`	The kind value for streaming URL requests will always be ‘Stream’.
complete[].streams	`array` (required)	The list of stream objects that were created.
complete[].streams[].method	`string` (required)	Indicates the streaming method. Values can be `adaptive` for HLS streams or `progressive` for progressive streams.
complete[].streams[].type	`string` (required)	Indicates the type of stream. Value will be `hls` for adaptive or will be the proxy/element type (for example, `video-3g` or `video-sd`) for progressive.
complete[].streams[].url	`string` (required)	The url for the adaptive or progressive video stream.
complete[].streams[].displayName	`string` (required)	The display name text for each stream (that was sent in the request body).
complete[].captions	`array` (required)	The list of caption objects that were created.
complete[].captions[].displayName	`string` (required)	The user friendly string that appears to identify this caption when a user wants to view or change languages.
complete[].captions[].language	`string` (required)	Indicates the language of the caption file, expressed as an ISO 639-2/T three character format.
complete[].captions[].url	`string` (required)	The url for the closed caption file.

Create Playback Streams
POST`/assets/{assetId}/streams`

URI Parameters

HideShow

assetId: string (required)
The source asset id used.

Description

Creates both progressive and adaptive (HLS) playback streams from an existing asset’s proxies and / or elements along with one or more optional closed caption files.

Errors

Status Code	Error Code	Message	Notes
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
404	AssetNotFound	Asset not found.
404	AssetDeleted	Asset is deleted.
409	AssetTrashed	Asset is trashed.
409	BulkOperationFailed	The bulk operation failed. See the errors array for more information.	This message appears if there were no successfully created jobs.

Errors represented in errors array

Error Code	Message
InvalidStreamSource	One or more source proxies and/or elements are invalid. Review Ci API documentation for valid source requirements.
InvalidFileType	Invalid file type.

Thumbnails ¶

POST https://api.cimediacloud.com/assets/yiireizq1hcowxua/thumbnails

Requestssimple example

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "source": {
    "id": "elementId1",
    "kind": "element"
  }
}

Property name	Type	Description
source	`object`	Information about the entity that will be the new source for the asset’s thumbnails. The source must be of type `Image`.
source.id	`string` (required)	Unique identifier of the thumbnail’s source.
source.kind	`string` (required)	The kind of entity of the provided source. At this point only ‘element’ kind is accepted.

Responses200404

Headers

Content-Type: application/json

Body

{
  "assetId": "yiireizq1hcowxua",
  "thumbnails": [
    {
      "type": "large",
      "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/thumb.jpg",
      "size": 1024,
      "width": 200,
      "height": 300,
      "source": {
        "id": "elementId1",
        "kind": "element"
      },
      "isExternal": false
    }
  ]
}

Property name	Type	Description
assetId	`string`	The unique identifier of the asset.
thumbnails	`array`	The thumbnails that has been set for the asset.

Headers

Content-Type: application/json

Body

{
  "Attributes": {
    "code": "AssetNotFound",
    "message": "Asset not found."
  }
}

Property name	Type	Description
Attributes	`object`
Attributes.code	`string`	Machine readable error code
Attributes.message	`string`	Error message

Set Thumbnails
POST`/assets/{assetId}/thumbnails`

URI Parameters

HideShow

assetId: string (required)
The unique identifier of the asset.

Description

Allows to change the thumbnails for an asset. Default thumbnails for an asset are extracted automatically after upload. This API allows you to replace them by the thumbnails of an image Element.

If the parent asset has already assigned a thumbnail element that is currently locked, the operation will fail. The current thumbnail element must be unlocked before another element can be assigned as thumbnail.

Errors

Status Code	Error Code	Message
400	InvalidThumbnailsSource	Thumbnails’ source Id was not provided.
400	InvalidThumbnailsSource	Only <element> kind is allowed as source of thumbnails.
400	InvalidThumbnailsSource	Thumbnails source not found.
400	InvalidThumbnailsSource	Thumbnails source is deleted.
400	InvalidThumbnailsSource	Only <image> file type is allowed as source of thumbnails.
400	InvalidThumbnailsSource	The provided thumbnails Source has no thumbnails.
400	AssetNotReady	Asset not ready. Its status must be either “Complete” or “Limited”.
404	AssetNotFound	Asset not found.
404	AssetDeleted	Asset is deleted.
409	AssetTrashed	Asset is trashed.
409	InvalidOperationOnElement	The current asset has a locked element configured as thumbnail. While locked, an element cannot be replaced as thumbnail.

Asset Live Stream Upload ¶

Create Asset and Initiate Upload ¶

POST https://api.cimediacloud.com/upload/livestream

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "name": "Movie.mp4",
  "workspaceId": "oj7mx3vlb2srei89",
  "folderId": "6ovu49kdb3z32z2w",
  "inputType": "HlsPull",
  "inputUrls": [
    "'https://a.com/index.m3u8'"
  ]
}

Property name	Type	Description
name	`string` (required)	The name of the asset, including its extension. Its maximum length is 512 characters.
workspaceId	`string`	The workspace that will contain the asset. If no value is provided, the asset will be placed in the calling user’s personal workspace.
folderId	`string`	The workspace’s folder that will contain the asset. If no value is provided, the asset will be placed in the workspace’s root folder.
inputType	`string` (required)	The type of transfer to be used for this live stream. It can be ‘RtmpPush’, or ‘HlsPull’.
inputUrls	`array`	For an HlsPull type of transfer, please provide the URL that the live streaming service needs to access in order to feed the live stream input. One or two redundant URL’s can be specified. For an RtmpPush type of transfer, no parameters are required.

Responses200400

Headers

Content-Type: application/json

Body

{
  "assetId": "5v99qywnb6gzneha",
  "streams": [
    {
      "inputUrl": "rtmp://1.2.3.4:1935/a/b",
      "destinationUrl": "rtmp://4.3.2.1:1935/9791a50cc5c84e0cade8f89da952c547/9d657a7841274e4dbb0c8ae10955bdc5",
      "liveStreamUrl": "https://asdfqwer.cloudfront.net/9791a50cc5c84e0cade8f89da952c547/A.m3u8"
    }
  ]
}

Property name	Type	Description
assetId	`string`	The unique identifier for the asset.
streams	`array`	An array of live streams (up to two).
streams[].inputUrl	`string`	For a HlsPull type of transfer, the source input Url that is associated with the liveStreamUrl
streams[].destinationUrl	`string`	For a RtmpPush type of transfer, this is the location where the live stream should be transmitted.
streams[].liveStreamUrl	`string`	The URL that rebroadcasts the live stream as it is being processed.

Headers

Content-Type: application/json

Body

{
  "code": "FolderNotFound",
  "message": "Folder not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Create Asset and Initiate Upload
POST`/upload/livestream`

Description

Asset Live Stream Upload enables you to upload a live stream of up to 5 terabytes, in a four-step process:

Initiate Upload (creates the asset record and returns live stream URLs)
Check whether the channel is live and running
Stream your video
Complete Upload (signal the completion of live streaming)

This operation creates the asset record and initiates the live stream upload channel, returning the asset identifier to be used in subsequent requests.

Input Type

RTMP PUSH

Your device acts as an RTMP client. We act as the RTMP server. When you specify this transfer type, we will return two redundant RTMP URLs to which you can send your stream(s).

Usage:

Attribute	Value
inputType	RtmpPush
inputUrl	[The array should be empty]

HLS PULL

You create your own HLS live or event stream. We act as a client that will consume that HLS stream. When you specify this transfer type, you’ll also need to specify at least one (up to two) source HLS URLs.

Usage:

Attribute	Value
inputType	HlsPull
inputUrl	Please provide the complete HLS URL where we can receive the live stream. Please ensure that the URL you provide is accessible to the public.

Errors

Status Code	Error Code	Message
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	MissingOrInvalidLiveStreamInputType	Missing or Invalid Live Stream InputType. Please refer to the API documentation for recognized values.
400	MissingOrInvalidLiveStreamInputUrl	Missing or Invalid Live Stream InputUrl. Please refer to the API documentation for recognized values.
400	WorkspaceNotFound	Workspace not found.
400	FolderNotFound	Folder not found.
400	FolderNotMemberOfWorkspace	Folder is not a member of the provided workspace.
400	InvalidIngestConfiguration	Invalid proxy type specified.
409	InsufficientSpaceAvailable	Upload will exceed the workspaces’s allotted storage.
409	InvalidAssetState	Asset cannot be uploaded. To upload an asset it cannot be trashed and its status must be ‘Created’, ‘Failed’, ‘Executable Detected’ or ‘Virus Detected’.
409	EntitlementRequired	Live Streams entitlement is required for the provided settings.

Complete the Live Stream ¶

POST https://api.cimediacloud.com/upload/livestream/yiireizq1hcowxua/complete

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200404

Headers

Content-Type: application/json

Body

{
  "assetId": "yiireizq1hcowxua"
}

Property name	Type	Description
assetId	`string`	The unique identifer of the asset.

Headers

Content-Type: application/json

Body

{
  "code": "AssetNotFound",
  "message": "Asset not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Complete the Live Stream
POST`/upload/livestream/{assetId}/complete`

URI Parameters

HideShow

assetId: string (required)
The unique identifier of the asset.

Description

This operation initiates the completion of a live stream asset. The live stream will be shut down and converted to a video asset.

Errors

Status Code	Error Code	Message
404	AssetNotFound	Asset not found.
404	AssetDeleted	Asset is deleted.
409	AssetNotLiveStreaming	Asset is not currently live streaming.

Search ¶

Search Assets and Folders ¶

POST https://api.cimediacloud.com/faceted-search

Requestsexample with asset in responseexample with folder in response

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "limit": 1,
  "offset": 0,
  "orderBy": "relevance",
  "customMetadataOrderBy": "artist",
  "orderDirection": "asc",
  "query": "movies",
  "fields": [
    "name",
    "thumbnails"
  ],
  "extraFields": [
    "commentStats"
  ],
  "networkIds": [
    "9hdf6pk2quj0ion6"
  ],
  "workspaceIds": [
    "gb5ehomv0iv71swg"
  ],
  "folderId": "qekyzblpu7o31w0h",
  "kind": "all",
  "archiveStatuses": [
    "Archived"
  ],
  "presentationAspectRatios": [
    "16:9"
  ],
  "audioChannelCounts": [
    "6"
  ],
  "audioSampleRates": [
    "44100"
  ],
  "videoCodecs": [
    "Apple ProRes 422 HQ"
  ],
  "frameRates": [
    "29.97"
  ],
  "pixelDimensions": [
    "640x360"
  ],
  "runtimeMinimum": 0,
  "runtimeMaximum": 120,
  "tagFilters": [
    "approved"
  ],
  "metadata": [
    {
      "name": "HouseId",
      "value": "12345"
    }
  ]
}

Property name	Type	Description
limit	`number`	The number of items to return. The maximum is 100 and the default is 50.
offset	`number`	The item at which to begin the response. Default is 0.
orderBy	`string`	The field to sort the items by. Accepted values are `createdOn`, `name`, `relevance`, `lastactivityon`, `size`, `type`, `createdby`, `archivestatus`, `network`, `space`. Defaults to `relevance`.
customMetadataOrderBy	`string`	This parameters enables sorting by a custom metadata field. Any custom metadata `name` value is permitted.
orderDirection	`string`	The order direction the items should be returned. Accepted values are `asc` and `desc`. Defaults to `desc`.
query	`string`	The keywords used to search for assets and folders. Values can be unquoted for general matching or quoted for phrase matching. For general matching, the length must be 2 or more characters and can contain multiple keywords which must be between 2 to 20 characters each. Keywords must be separated by whitespace. For example, `demo movie`. For phrase matching, enclose quotes around the phrases and you will get matches that contain the exact phrase provided. Search also supports `AND` and `OR` search operators. Please refer to the Search Tips modal in the Ci UI for more information. That is available by clicking the `?` in the search modal.
fields	`array`	A comma separated list of fields to return in the response. If this value is empty all fields will be returned. Id and Name are always returned.
extraFields	`array`	A comma separated list of extra fields to return in the response. If this value is empty, the extra fields will not be included in the response.
networkIds	`array`	The Networks to filter. Users will only see results for Workspaces they have access to.
workspaceIds	`array`	The Workspaces to filter.
folderId	`string`	The folder to filter. This will limit results to the provided folder and all content within any sub-folders.
kind	`string`	Determines which kind of items will be returned. Accepted values are `all`, `folder`, `asset`.
archiveStatuses	`array`	An array of archive statuses to filter. Accepted values are `Not archived`, `Archive in progress`, `Archived`, `Restore in progress`, `Restored`.
presentationAspectRatios	`array`	An array of presentation aspect ratios to filter. Suggested values are `4:3`, `16:9`, `21:9`, `16:10`, `5:4`, `3:2`.
audioChannelCounts	`array`	An array of audio channels to filter by.
audioSampleRates	`array`	An array of audio sample rates to filter by.
videoCodecs	`array`	An array of video codecs to filter by.
frameRates	`array`	An array of frame rates values to filter by.
pixelDimensions	`array`	An array of pixel dimensions to filter by.
runtimeMinimum	`number`	A number representing the minimum runtime (in seconds) to filter by.
runtimeMaximum	`number`	A number representing the maximum runtime (in seconds) to filter by.
tagFilters	`array`	An array of file types, valid values include `video`, `audio`, `image`, `other`, `document`.
metadata	`array`	Metadata name filters and value keywords.
metadata[].name	`string`	The metadata item name to filter on. This must be an exact match to a metadata item’s name.
metadata[].value	`string`	The metadata item value to search on. The same rules for the `query` parameter apply here.

Responses200404

Headers

Content-Type: application/json

Body

{
  "limit": 1,
  "offset": 0,
  "count": 10,
  "order": {
    "by": "Name",
    "direction": "asc"
  },
  "kind": [
    "All"
  ],
  "items": [
    {
      "id": "bcdc34b53e2c4c18ac41ca288e28d11f",
      "name": "Movie.mov",
      "size": 107856722,
      "type": "Video",
      "format": "mov",
      "folder": {
        "id": "9b639e12a82f4b0483f512b474dc052ci",
        "name": "Folder Name"
      },
      "status": "Complete",
      "description": "Final cut",
      "thumbnails": [
        {
          "type": "large",
          "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/thumb.jpg",
          "size": 1024,
          "width": 200,
          "height": 300,
          "source": {
            "id": "elementId1",
            "kind": "element"
          },
          "isExternal": false
        }
      ],
      "proxies": [
        {
          "type": "video-3g",
          "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/proxy.jpg",
          "size": 1024,
          "width": 200,
          "height": 300,
          "videoBitRate": 1650000,
          "audioBitRate": 128000,
          "isExternal": false
        }
      ],
      "md5Checksum": "tk2ma0zrhrp5irco",
      "createdOn": "2017-01-02T00:00:00.000Z",
      "createdBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "modifiedOn": "2017-01-02T00:00:00.000Z",
      "lastActivityOn": "2017-01-03T00:00:00.000Z",
      "acquisitionSource": {
        "name": "Workspace"
      },
      "archiveStatus": "Not archived",
      "archiveType": "Standard",
      "restoreStatus": "Not restored",
      "restoreExpirationDate": "2017-01-02T00:00:00.000Z",
      "restoreRequestDate": "2017-01-02T00:00:00.000Z",
      "lastRestoreDate": "2017-01-02T00:00:00.000Z",
      "restoredBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "archiveDate": "2017-01-02T00:00:00.000Z",
      "archivedBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "uploadCompleteDate": "2017-01-02T00:00:00.000Z",
      "isTrashed": false,
      "uploadTransferType": "SinglepartHttp",
      "runtime": 1024,
      "totalFolderCount": 1,
      "network": {
        "id": "40c2a6b99a474b319dec5ef9c7dbb356",
        "name": "Company Name",
        "class": "Enterprise"
      },
      "metadata": [
        {
          "name": "resolution",
          "value": "1080p",
          "readOnly": false
        }
      ],
      "technicalMetadata": {
        "type": "Video",
        "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/metadata.jpg",
        "size": 1024,
        "image": {
          "width": 100,
          "height": 300,
          "xResolution": 100,
          "yResolution": 100,
          "resolutionUnit": "cm",
          "cameraMake": "Nikon",
          "cameraModel": "D300",
          "groupingInfo": "6445055e520106d9d01769fffefd058901000100000000000000",
          "umidBasic": "060a2b340101010501010143130000006445055e520106cbd01769fffefd0589",
          "materialNumber": "6445055e520106cbd01769fffefd0589",
          "recordedDate": "2023-07-27T01:39:24Z",
          "locationCity": "New York",
          "locationState": "NY",
          "locationCountry": "USA",
          "exif": {
            "imageWidth": "3888",
            "imageHeight": "2592",
            "artist": "Michael W. Steidl.",
            "copyright": "(c) 2011 IPTC - Rights reserved."
          },
          "iptc": {
            "codedCharacterSet": "UTF8",
            "headline": "Bikefestival Vienna",
            "credit": "IPTC/Michael W. Steidl",
            "keywords": "Vienna Air King,cycling,mountain bike"
          },
          "xmp": {
            "serialNumber": "0380227035",
            "creatorRegion": "Roshire",
            "lens": "EF70-300mm f/4-5.6L IS USM",
            "creatorCountry": "United Kingdom"
          }
        },
        "avContainer": {
          "bitRate": 11934620,
          "duration": 100,
          "start": 0,
          "recordedDate": "2022-11-21T06:42:41Z",
          "deviceManufacturer": "Sony",
          "timeCode": "00:00:00:00",
          "derivedTimeCode": "00:00:00:00",
          "streams": [
            {
              "index": 0,
              "type": "Video",
              "bitRate": 11934620,
              "bitDepth": 8,
              "bitRateMode": "CBR",
              "codec": "h264",
              "codecName": "ProRes",
              "codecProfile": "422 HQ",
              "codecSettings": "Little / Signed",
              "fourCC": "avc1",
              "width": 1280,
              "height": 720,
              "totalFrames": 1024,
              "duration": 100,
              "frameRateNumerator": 360,
              "frameRateDenominator": 12,
              "videoPARWidth": 1,
              "videoPARHeight": 1,
              "videoDARWidth": 19,
              "videoDARHeight": 24,
              "start": 0,
              "timeCode": "00:00:00:00",
              "videoColorSpace": "bt709",
              "videoScanOrder": "TFF",
              "videoScanType": "Interlaced",
              "videoColorPrimaries": "DCI P3",
              "videoChromaSubsampling": "4:2:2",
              "videoScanTypeStoreMethod": "Interleaved fields",
              "audioSampleRate": 32000,
              "audioChannelCount": 2,
              "audioLayout": "Stereo",
              "audioAnalysis": "Stereo",
              "rotate": 0
            }
          ]
        },
        "dolbyContainer": {
          "duration": 9.6,
          "fileSize": 80294994,
          "overallBitRateMode": "CBR",
          "overallBitRate": 66912495,
          "totalChannels": 58,
          "bedChannels": 10,
          "numberOfBeds": 1,
          "bitDepth": 24,
          "samplingRate": 48000,
          "downmix51X": "Direct Render",
          "trimModesSummary": "automatic + manual_0",
          "trimChannel20Mode": "manual_0",
          "trimChannel51Mode": "manual_0",
          "trimChannel71Mode": "automatic",
          "trimChannel212Mode": "manual_0",
          "trimChannel512Mode": "automatic",
          "trimChannel712Mode": "manual_0",
          "trimChannel214Mode": "manual_0",
          "trimChannel514Mode": "manual_0",
          "trimChannel714Mode": "manual_0",
          "associatedVideoFrameRate": 23.976,
          "start": "01:00:00:00",
          "fFoA": "01:00:00:00",
          "end": "01:03:30:13",
          "metadataFormat": "ADM, Version 0",
          "admProfile": "Dolby Atmos Master, Version 1",
          "numberOfProgrammes": 1,
          "numberOfObjectChannels": 48,
          "numberOfPackFormats": 49,
          "numberOfChannelFormats": 58,
          "binauralRenderModesSummary": "Off + Near + Mid + Far",
          "binauralRenderModesOffCount": 9,
          "binauralRenderModesNearCount": 8,
          "binauralRenderModesMidCount": 13,
          "binauralRenderModesFarCount": 1,
          "truePeakLevels": -3.14,
          "loudness": -16.67
        }
      },
      "hlsPlaylistUrl": "https://cimediacloud.com/t5y7s3ero3w2ie7/hls",
      "acquisitionContext": {
        "name": "Movie1.mov",
        "path": "original/source/path"
      },
      "isExternal": false,
      "workspace": {
        "id": "gb5ehomv0iv71swg",
        "name": "Workspace Name",
        "class": "Enterprise"
      },
      "kind": "Asset"
    }
  ],
  "facets": {
    "networks": [
      {
        "id": "gb5ehomv0iv71swg",
        "name": "My Network",
        "count": 10
      }
    ],
    "workspaces": [
      {
        "id": "gb5ehomv0iv71swg",
        "name": "My Workspace",
        "count": 10,
        "network": {
          "id": "9hdf6pk2quj0ion6",
          "name": "My Network"
        }
      }
    ],
    "types": [
      {
        "name": "Video",
        "count": 10
      }
    ],
    "archiveStatuses": [
      {
        "name": "Archived",
        "count": 10
      }
    ],
    "presentationAspectRatios": [
      {
        "name": "16:9",
        "count": 10
      }
    ],
    "audioChannelCounts": [
      {
        "name": "5",
        "count": 10
      }
    ],
    "audioSampleRates": [
      {
        "name": "48000",
        "count": 10
      }
    ],
    "videoCodecs": [
      {
        "name": "Proress",
        "count": 10
      }
    ],
    "frameRates": [
      {
        "name": "29.97",
        "count": 10
      }
    ],
    "pixelDimensions": [
      {
        "name": "1000x1000",
        "count": 10
      }
    ],
    "runtimes": [
      {
        "name": "0",
        "count": 10
      }
    ]
  },
  "maxSearchResults": 1000000
}

Property name	Type	Description
limit	`number`	The limit used for the query.
offset	`number`	The offset used for the query.
count	`number`	The total count of items available.
order	`object`	Information about the ordering of the results.
order.by	`string`	Indicates the field used to sort the results.
order.direction	`string`	Indicates the direction used to sort the results.
kind	`array`	Indicates the kind filter used in the request. Returned values are `All`, `Asset`, and `Folder`.
items	`array`	The items returned. Can be both assets and folders.
items[].id	`string`	The unique identifier of the asset.
items[].name	`string`	The name of the asset, including its extension. Its maximum length is 512 characters.
items[].size	`number`	The size of the source file, in bytes.
items[].type	`string`	The type of the asset. Valid values are `Audio`, `Video`, `Image`, `Document`, or `Other`.
items[].format	`string`	The asset’s file format.
items[].folder	`object`	Information about the asset’s parent folder.
items[].folder.id	`string`	The unique identifier of the folder.
items[].folder.name	`string`	The name of folder.
items[].status	`string`	The status of the asset. Valid values are ‘Created’, ‘Complete’, ‘Deleted’, ‘Executable Detected’, ‘Failed’, ‘Limited’, ‘Processing’, ‘Uploading’, ‘Virus Detected’, ‘Waiting’. See this section for more information.
items[].description	`string`	A comment or note associated to the asset. Its maximum length is 1000 characters.
items[].thumbnails	`array`	The set of thumbnails for the asset.
items[].thumbnails[].type	`string`	The type of thumbnail returned. Valid values are ‘small’, ‘medium’ and ‘large’.
items[].thumbnails[].location	`string`	The url of the thumbnail.
items[].thumbnails[].size	`number`	The size of the thumbnail, in bytes.
items[].thumbnails[].width	`number`	The width of the thumbnail.
items[].thumbnails[].height	`number`	The height of the thumbnail.
items[].thumbnails[].source	`object`	Information about the source of thumbnails.
items[].thumbnails[].source.id	`string`	Unique identifier of the thumbnail’s source.
items[].thumbnails[].source.kind	`string`	The kind of entity of the thumbnail’s source.
items[].thumbnails[].isExternal	`boolean`	Indicates if the thumbnail is stored in an external source.
items[].proxies	`array`	The set of proxies for the asset.
items[].proxies[].type	`string`	The type of proxy returned. Valid values are ‘standard-audio’, ‘dolby-audio’, ‘video-3g’, ‘video-sd’, ‘video-sdplus’, ‘video-hd’, ‘video-2k’, ‘video-2kplus’, ‘document-pdf’.
items[].proxies[].location	`string`	The url of the proxy.
items[].proxies[].size	`number`	The size of the proxy, in bytes.
items[].proxies[].width	`number`	The width of the proxy.
items[].proxies[].height	`number`	The height of the proxy.
items[].proxies[].videoBitRate	`number`	The video bitrate of the proxy.
items[].proxies[].audioBitRate	`number`	The audio bitrate of the proxy.
items[].proxies[].isExternal	`boolean`	Indicates if the proxy is stored in an external source.
items[].md5Checksum	`string`	The calculated md5 checksum for the asset.
items[].createdOn	`string`	The datetime the asset record was created.
items[].createdBy	`object`	Information about the creator of the asset
items[].createdBy.id	`string`	The unique identifier of the user.
items[].createdBy.name	`string`	The full name of the user.
items[].createdBy.email	`string`	The email of the user.
items[].modifiedOn	`string`	The datetime the asset record was last modified.
items[].lastActivityOn	`string`	The datetime of the last activity of the asset record.
items[].acquisitionSource	`object`	Information about the asset’s source client application.
items[].acquisitionSource.name	`string`	The name of the client application that uploaded the asset.
items[].archiveStatus	`string`	The archive status of the asset. Valid values are ‘Not archived’, ‘Archive in progress’, ‘Archive failed’, ‘Archived’, ‘Cancel archive in progress’.
items[].archiveType	`string`	If available, the kind of archive used for storing the asset. Valid values are `Standard` and `Deep`.
items[].restoreStatus	`string`	The restore status of the asset. This is applicable to assets that have been archived. Valid values are ‘Not restored’, ‘Restore in progress’, ‘Restore failed’, ‘Restored’.
items[].restoreExpirationDate	`string`	If available, the datetime the restored copy of the asset’s source file will no longer be available.
items[].restoreRequestDate	`string`	If available, the datetime the asset’s source file was requested to be restored.
items[].lastRestoreDate	`string`	If available, the datetime the asset’s source file was last restored.
items[].restoredBy	`object`	If available, information about the user who restored the asset.
items[].restoredBy.id	`string`	The unique identifier of the user.
items[].restoredBy.name	`string`	The full name of the user.
items[].restoredBy.email	`string`	The email of the user.
items[].archiveDate	`string`	If available, the datetime the asset’s source file was last archived.
items[].archivedBy	`object`	If available, information about the user who archived the asset.
items[].archivedBy.id	`string`	The unique identifier of the user.
items[].archivedBy.name	`string`	The full name of the user.
items[].archivedBy.email	`string`	The email of the user.
items[].uploadCompleteDate	`string`	The datetime the asset upload was completed.
items[].isTrashed	`boolean`	Indicates if an asset is in the trash bin.
items[].uploadTransferType	`string`	Indicates how the asset was uploaded. Valid values are ‘SinglepartHttp’, ‘MultipartHttp’, ‘Aspera’, ‘Copy’, ‘FTP’, ‘WorkspaceSend’.
items[].runtime	`number`	The duration of the media asset, in seconds.
items[].totalFolderCount	`number`	The amount of folders where the asset exists.
items[].network	`object`	Information about the asset’s network.
items[].network.id	`string`	The unique identifier of the Network.
items[].network.name	`string`	The name of the Network.
items[].network.class	`string`	Indicates if the Network is a ‘Personal’ or ‘Enterprise’ Network.
items[].metadata	`array`	An array of key-value pairs of user-generated and basic technical metadata.
items[].metadata[].name	`string`	The name of the metadata item.
items[].metadata[].value	`string`	the value of the metadata item.
items[].metadata[].readOnly	`boolean`	Flag to set a read-only metadata.
items[].technicalMetadata	`object`	An object that contains all the technical metadata available.
items[].technicalMetadata.type	`string`	The type of the asset. Valid values are either ‘Audio’, ‘Video’ or ‘Image’.
items[].technicalMetadata.location	`string`	Url of the source technical metadata file. Note: the content and structure of the technical metadata file is subject to change at any time.
items[].technicalMetadata.size	`number`	The size of the technical metadata file, in bytes.
items[].technicalMetadata.image	`object`	If the asset’s type is ‘Image’, this property contains the extended image technical metadata.
items[].technicalMetadata.image.width	`number`	The width of the image, in pixels.
items[].technicalMetadata.image.height	`number`	The height of the image, in pixels.
items[].technicalMetadata.image.xResolution	`number`	The number of pixels per resolutionUnit in the width direction.
items[].technicalMetadata.image.yResolution	`number`	The number of pixels per resolutionUnit in the height direction.
items[].technicalMetadata.image.resolutionUnit	`string`	The unit of measurement for xResolution and yResolution. Can be ‘inches’, ‘cm’ or ‘none’.
items[].technicalMetadata.image.cameraMake	`string`	Camera manufacturer name.
items[].technicalMetadata.image.cameraModel	`string`	Camera model name.
items[].technicalMetadata.image.groupingInfo	`string`	If available, the grouping info of the image. String of hexadecimal value (52 characteres) for the byte array object. Byte array order is Litte Endian.
items[].technicalMetadata.image.umidBasic	`string`	If available, the umid basic info of the image. String of hexadecimal value (64 characteres) for the byte array object.
items[].technicalMetadata.image.materialNumber	`string`	If available, the material number of the image. String of hexadecimal value (32 characteres) for the byte array object.
items[].technicalMetadata.image.recordedDate	`string`	The date and Time at which the image was captured.
items[].technicalMetadata.image.locationCity	`string`	Name of the city where the image was created.
items[].technicalMetadata.image.locationState	`string`	Name of the state where the image was created.
items[].technicalMetadata.image.locationCountry	`string`	Name of the country where the image was created.
items[].technicalMetadata.image.exif	`object`	The avalaible EXIF (Exchangeable Image File) metadata.
items[].technicalMetadata.image.exif.imageWidth	`string`	The image width in pixels.
items[].technicalMetadata.image.exif.imageHeight	`string`	The image height in pixels.
items[].technicalMetadata.image.exif.artist	`string`	The image artist info.
items[].technicalMetadata.image.exif.copyright	`string`	The image copyright.
items[].technicalMetadata.image.iptc	`object`	The available IPTC (International Press Telecommunications Council) available.
items[].technicalMetadata.image.iptc.codedCharacterSet	`string`	Determines how the internal IPTC string values are interpreted.
items[].technicalMetadata.image.iptc.headline	`string`	Brief synopsis or summary of the contents of the photograph.
items[].technicalMetadata.image.iptc.credit	`string`	How the image should be credited when published, as specified by the supplier of the image.
items[].technicalMetadata.image.iptc.keywords	`string`	Descriptive words added to the image to enable search and retrieval.
items[].technicalMetadata.image.xmp	`object`	The available XMP (Extensible Metadata Platform) metadata.
items[].technicalMetadata.image.xmp.serialNumber	`string`	Camera Serial Number.
items[].technicalMetadata.image.xmp.creatorRegion	`string`	State / Province for the address of the person that created this image.
items[].technicalMetadata.image.xmp.lens	`string`	Attempts to identify the camera lens used.
items[].technicalMetadata.image.xmp.creatorCountry	`string`	Country name for the address of the person that created this image.
items[].technicalMetadata.avContainer	`object`	If asset type is ‘Audio’ or ‘Video’, this property contains the extended audio / video technical metadata.
items[].technicalMetadata.avContainer.bitRate	`number`	The overall bitrate in the container.
items[].technicalMetadata.avContainer.duration	`number`	The runtime of the media in the container, in seconds.
items[].technicalMetadata.avContainer.start	`number`	The start time in the container, in seconds.
items[].technicalMetadata.avContainer.recordedDate	`string`	The date and Time at which the video was captured.
items[].technicalMetadata.avContainer.deviceManufacturer	`string`	The name of the device Manufacturer.
items[].technicalMetadata.avContainer.timeCode	`string`	The SMPTE timecode in the container.
items[].technicalMetadata.avContainer.derivedTimeCode	`string`	The standardized timecode derived by evaluating stream metadata and converting to drop frame format, if using drop frame rate.
items[].technicalMetadata.avContainer.streams	`array`	Set of audio, video, or data streams contained in the asset.
items[].technicalMetadata.avContainer.streams[].index	`number`	The index of the stream in the container.
items[].technicalMetadata.avContainer.streams[].type	`string`	The type of the stream. Valid values are `Audio`, `Video` or `Data`.
items[].technicalMetadata.avContainer.streams[].bitRate	`number`	If available, the overall bitrate in the stream.
items[].technicalMetadata.avContainer.streams[].bitDepth	`number`	If available, for an `Audio` stream, the bit depth of the stream.
items[].technicalMetadata.avContainer.streams[].bitRateMode	`string`	If available, the bit rate mode of the stream.
items[].technicalMetadata.avContainer.streams[].codec	`string`	If available, the codec used in the stream. For example, `h264`.
items[].technicalMetadata.avContainer.streams[].codecName	`string`	If available, the MediaInfo generated format commercial name for the stream.
items[].technicalMetadata.avContainer.streams[].codecProfile	`string`	If available, the MediaInfo generated format profile for the stream.
items[].technicalMetadata.avContainer.streams[].codecSettings	`string`	If avalable, the MediaInfo generated format settings for the stream.
items[].technicalMetadata.avContainer.streams[].fourCC	`string`	If available, four-character code for the codec used in the stream. For example, `avc1`, `apch`.
items[].technicalMetadata.avContainer.streams[].width	`number`	If available, for a `Video` stream, the width in pixels of the video.
items[].technicalMetadata.avContainer.streams[].height	`number`	If available, for a `Video` stream, the height in pixels of the video.
items[].technicalMetadata.avContainer.streams[].totalFrames	`number`	If available, total number of frames within the `Video` stream.
items[].technicalMetadata.avContainer.streams[].duration	`number`	If available, the runtime of the media in seconds.
items[].technicalMetadata.avContainer.streams[].frameRateNumerator	`number`	If available, the numerator of the frame rate. For example, if the frame rate is 24, the frame rate numerator is 24.
items[].technicalMetadata.avContainer.streams[].frameRateDenominator	`number`	If available, the numerator of the frame rate. For example, if the frame rate is 24, the frame rate denominator is 1.
items[].technicalMetadata.avContainer.streams[].videoPARWidth	`number`	If available, the width part of the pixel aspect ratio.
items[].technicalMetadata.avContainer.streams[].videoPARHeight	`number`	If available, the height part of the pixel aspect ratio.
items[].technicalMetadata.avContainer.streams[].videoDARWidth	`number`	If available, the width part of the display aspect ratio.
items[].technicalMetadata.avContainer.streams[].videoDARHeight	`number`	If available, the height part of the display aspect ratio.
items[].technicalMetadata.avContainer.streams[].start	`number`	If available, the start time in the stream, in seconds.
items[].technicalMetadata.avContainer.streams[].timeCode	`string`	If available, the SMPTE timecode in the stream.
items[].technicalMetadata.avContainer.streams[].videoColorSpace	`string`	If available, for a `Video` stream, the video’s color space / color primaries.
items[].technicalMetadata.avContainer.streams[].videoScanOrder	`string`	If available, for a `Video` stream, the video’s scan order.
items[].technicalMetadata.avContainer.streams[].videoScanType	`string`	If available, for a `Video` stream, the video’s scan type.
items[].technicalMetadata.avContainer.streams[].videoColorPrimaries	`string`	If available, for a `Video` stream, the video’s color primaries.
items[].technicalMetadata.avContainer.streams[].videoChromaSubsampling	`string`	If available, for a `Video` stream, the video’s crhoma subsampling.
items[].technicalMetadata.avContainer.streams[].videoScanTypeStoreMethod	`string`	If available, for a `Video` stream, the video’s scan type store method.
items[].technicalMetadata.avContainer.streams[].audioSampleRate	`number`	If available, for an `Audio` stream, is the sample rate in Hz.
items[].technicalMetadata.avContainer.streams[].audioChannelCount	`number`	If available, for an `Audio` stream, is the number of channels within the stream.
items[].technicalMetadata.avContainer.streams[].audioLayout	`string`	If available, for an `Audio` stream, is the audio channel layout description. For example, `5.1`.
items[].technicalMetadata.avContainer.streams[].audioAnalysis	`string`	If available, for an `Audio` stream, it is further analysis to determine if a stream is true stereo or dual-mono.
items[].technicalMetadata.avContainer.streams[].rotate	`number`	If available, the amount of rotation, in degrees, that should be applied during playback of the video.
items[].technicalMetadata.dolbyContainer	`object`	If asset type is ‘Audio’ and the asset has Dolby Atmos metadata, this property contains the extended Dolby Atmos audio technical metadata.
items[].technicalMetadata.dolbyContainer.duration	`number`	Media duration (in seconds).
items[].technicalMetadata.dolbyContainer.fileSize	`number`	Media size (in bytes).
items[].technicalMetadata.dolbyContainer.overallBitRateMode	`string`	The overall bitrate mode for the Atmos content.
items[].technicalMetadata.dolbyContainer.overallBitRate	`number`	Media bitrate (in bits per second).
items[].technicalMetadata.dolbyContainer.totalChannels	`number`	Number of channels. `Bed channels` plus `Object channels` equals `Total channels`.
items[].technicalMetadata.dolbyContainer.bedChannels	`number`	Number of channel-based premix or stem that includes multichannel panning.
items[].technicalMetadata.dolbyContainer.numberOfBeds	`number`	A bed can be thought of as a traditional channel-based stem with the rules and expectations of stem configurations (such as 2.0, 5.1, and 7.1).
items[].technicalMetadata.dolbyContainer.bitDepth	`number`	Number of bits of information in each sample, generally 16, 24, or 32-bit.
items[].technicalMetadata.dolbyContainer.samplingRate	`number`	Audio sample-rate, generally 44100 or 48000 Hz.
items[].technicalMetadata.dolbyContainer.downmix51X	`string`	Global downmix metadata for monitoring, re-rendering, and encoding.
items[].technicalMetadata.dolbyContainer.trimModesSummary	`string`	A summary of the underlying trim modes.
items[].technicalMetadata.dolbyContainer.trimChannel20Mode	`string`	The type of trim mode supported for 2.0 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel51Mode	`string`	The type of trim mode supported for 5.1 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel71Mode	`string`	The type of trim mode supported for 7.1 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel212Mode	`string`	The type of trim mode supported for 2.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel512Mode	`string`	The type of trim mode supported for 5.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel712Mode	`string`	The type of trim mode supported for 7.1.2 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel214Mode	`string`	The type of trim mode supported for 2.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel514Mode	`string`	The type of trim mode supported for 5.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.trimChannel714Mode	`string`	The type of trim mode supported for 7.1.4 channel configuration. The supported values are `automatic`, `manual_0`, `manual_custom`.
items[].technicalMetadata.dolbyContainer.associatedVideoFrameRate	`number`	Number of frames per second.
items[].technicalMetadata.dolbyContainer.start	`string`	Start SMPTE timecode based on the video frame rate.
items[].technicalMetadata.dolbyContainer.fFoA	`string`	FFoA (First Frame of Action) SMPTE timecode based on the video frame rate.
items[].technicalMetadata.dolbyContainer.end	`string`	End SMPTE timecode based on the video frame rate.
items[].technicalMetadata.dolbyContainer.metadataFormat	`string`	Format of the metadata in the Atmos content.
items[].technicalMetadata.dolbyContainer.admProfile	`string`	ADM (Audio Definition Model) Profile used in the Atmos content.
items[].technicalMetadata.dolbyContainer.numberOfProgrammes	`number`	Number of programmes in the Atmos content.
items[].technicalMetadata.dolbyContainer.numberOfObjectChannels	`number`	Number of objects in the Atmos Master.
items[].technicalMetadata.dolbyContainer.numberOfPackFormats	`number`	Number of Atmos Pack Formats in the Atmos content.
items[].technicalMetadata.dolbyContainer.numberOfChannelFormats	`number`	Number of channel formats in the Atmos content.
items[].technicalMetadata.dolbyContainer.binauralRenderModesSummary	`string`	Summary of all the binaural render modes used in the Atmos content. Supported strings are a unique combination of: “Off”, “Near”, “Mid”, “Far”.
items[].technicalMetadata.dolbyContainer.binauralRenderModesOffCount	`number`	Number of channels that use the “Off” setting for binaural rendering.
items[].technicalMetadata.dolbyContainer.binauralRenderModesNearCount	`number`	Number of channels that use the “Near” setting for binaural rendering.
items[].technicalMetadata.dolbyContainer.binauralRenderModesMidCount	`number`	Number of channels that use the “Mid” setting for binaural rendering.
items[].technicalMetadata.dolbyContainer.binauralRenderModesFarCount	`number`	Number of channels that use the “Far” setting for binaural rendering.
items[].technicalMetadata.dolbyContainer.truePeakLevels	`number`	The peak event in the audio waveform. Units are dBTP for true peak.
items[].technicalMetadata.dolbyContainer.loudness	`number`	Integrated loudness LKFS (or LUFS).
items[].hlsPlaylistUrl	`string`	A link to the HLS playlist generated from the source file.
items[].acquisitionContext	`object`	The file acquisition information.
items[].acquisitionContext.name	`string`	The original source file name, captured on acquisition.
items[].acquisitionContext.path	`string`	The original source file path, captured on acquisition.
items[].isExternal	`boolean`	Indicates if the file is stored in an external source.
items[].workspace	`object`	Information about the asset’s workspace.
items[].workspace.id	`string`	The unique identifier of the Workspace.
items[].workspace.name	`string`	The name of the Workspace.
items[].workspace.class	`string`	Indicates if the Workspace is a ‘Personal’ or ‘Team’ Workspace.
items[].kind	`string`	The type of item returned. Will always be ‘Asset’ for assets.
facets	`object`	Faceted metrics for selected values returned in the results.
facets.networks	`array`	Networks for the returned results.
facets.networks[].id	`string`	The id of the Network.
facets.networks[].name	`string`	The name of the Network.
facets.networks[].count	`number`	The number of items in this facet.
facets.workspaces	`array`	Workspaces for the returned results.
facets.workspaces[].id	`string`	The id of the Workspace.
facets.workspaces[].name	`string`	The name of the Workspace.
facets.workspaces[].count	`number`	The number of items in this facet.
facets.workspaces[].network	`object`	Information about the Workspace’s parent Network.
facets.workspaces[].network.id	`string`	The id of the Network.
facets.workspaces[].network.name	`string`	The name of the Network.
facets.types	`array`	Types for the returned results. Returned values are `Video`, `Audio`, `Image`, `Document`, `Other`.
facets.types[].name	`string`	The name of facet.
facets.types[].count	`number`	The number of items in this facet.
facets.archiveStatuses	`array`	Archive statuses for the returned results.
facets.archiveStatuses[].name	`string`	The name of facet.
facets.archiveStatuses[].count	`number`	The number of items in this facet.
facets.presentationAspectRatios	`array`	Presentation aspect ratios for the returned results.
facets.presentationAspectRatios[].name	`string`	The name of facet.
facets.presentationAspectRatios[].count	`number`	The number of items in this facet.
facets.audioChannelCounts	`array`	Audio channel counts for the returned results.
facets.audioChannelCounts[].name	`string`	The name of facet.
facets.audioChannelCounts[].count	`number`	The number of items in this facet.
facets.audioSampleRates	`array`	Audio sample rates for the returned results.
facets.audioSampleRates[].name	`string`	The name of facet.
facets.audioSampleRates[].count	`number`	The number of items in this facet.
facets.videoCodecs	`array`	Video codes for the returned results.
facets.videoCodecs[].name	`string`	The name of facet.
facets.videoCodecs[].count	`number`	The number of items in this facet.
facets.frameRates	`array`	Frame rates for the returned results.
facets.frameRates[].name	`string`	The name of facet.
facets.frameRates[].count	`number`	The number of items in this facet.
facets.pixelDimensions	`array`	Pixel dimensions for the returned results.
facets.pixelDimensions[].name	`string`	The name of facet.
facets.pixelDimensions[].count	`number`	The number of items in this facet.
facets.runtimes	`array`	Runtimes for the returned results, in seconds.
facets.runtimes[].name	`string`	600 (string) - The name of facet.
facets.runtimes[].count	`number`	The number of items in this facet.
maxSearchResults	`number`	The maximum value of total results that can display.

Headers

Content-Type: application/json

Body

{
  "code": "WorkspaceNotFound",
  "message": "Workspace not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "limit": 1,
  "offset": 0,
  "orderBy": "relevance",
  "customMetadataOrderBy": "artist",
  "orderDirection": "asc",
  "query": "movies",
  "fields": [
    "name",
    "thumbnails"
  ],
  "extraFields": [
    "commentStats"
  ],
  "networkIds": [
    "9hdf6pk2quj0ion6"
  ],
  "workspaceIds": [
    "gb5ehomv0iv71swg"
  ],
  "folderId": "qekyzblpu7o31w0h",
  "kind": "all",
  "archiveStatuses": [
    "Archived"
  ],
  "presentationAspectRatios": [
    "16:9"
  ],
  "audioChannelCounts": [
    "6"
  ],
  "audioSampleRates": [
    "44100"
  ],
  "videoCodecs": [
    "Apple ProRes 422 HQ"
  ],
  "frameRates": [
    "29.97"
  ],
  "pixelDimensions": [
    "640x360"
  ],
  "runtimeMinimum": 0,
  "runtimeMaximum": 120,
  "tagFilters": [
    "approved"
  ],
  "metadata": [
    {
      "name": "HouseId",
      "value": "12345"
    }
  ]
}

Property name	Type	Description
limit	`number`	The number of items to return. The maximum is 100 and the default is 50.
offset	`number`	The item at which to begin the response. Default is 0.
orderBy	`string`	The field to sort the items by. Accepted values are `createdOn`, `name`, `relevance`, `lastactivityon`, `size`, `type`, `createdby`, `archivestatus`, `network`, `space`. Defaults to `relevance`.
customMetadataOrderBy	`string`	This parameters enables sorting by a custom metadata field. Any custom metadata `name` value is permitted.
orderDirection	`string`	The order direction the items should be returned. Accepted values are `asc` and `desc`. Defaults to `desc`.
query	`string`	The keywords used to search for assets and folders. Values can be unquoted for general matching or quoted for phrase matching. For general matching, the length must be 2 or more characters and can contain multiple keywords which must be between 2 to 20 characters each. Keywords must be separated by whitespace. For example, `demo movie`. For phrase matching, enclose quotes around the phrases and you will get matches that contain the exact phrase provided. Search also supports `AND` and `OR` search operators. Please refer to the Search Tips modal in the Ci UI for more information. That is available by clicking the `?` in the search modal.
fields	`array`	A comma separated list of fields to return in the response. If this value is empty all fields will be returned. Id and Name are always returned.
extraFields	`array`	A comma separated list of extra fields to return in the response. If this value is empty, the extra fields will not be included in the response.
networkIds	`array`	The Networks to filter. Users will only see results for Workspaces they have access to.
workspaceIds	`array`	The Workspaces to filter.
folderId	`string`	The folder to filter. This will limit results to the provided folder and all content within any sub-folders.
kind	`string`	Determines which kind of items will be returned. Accepted values are `all`, `folder`, `asset`.
archiveStatuses	`array`	An array of archive statuses to filter. Accepted values are `Not archived`, `Archive in progress`, `Archived`, `Restore in progress`, `Restored`.
presentationAspectRatios	`array`	An array of presentation aspect ratios to filter. Suggested values are `4:3`, `16:9`, `21:9`, `16:10`, `5:4`, `3:2`.
audioChannelCounts	`array`	An array of audio channels to filter by.
audioSampleRates	`array`	An array of audio sample rates to filter by.
videoCodecs	`array`	An array of video codecs to filter by.
frameRates	`array`	An array of frame rates values to filter by.
pixelDimensions	`array`	An array of pixel dimensions to filter by.
runtimeMinimum	`number`	A number representing the minimum runtime (in seconds) to filter by.
runtimeMaximum	`number`	A number representing the maximum runtime (in seconds) to filter by.
tagFilters	`array`	An array of file types, valid values include `video`, `audio`, `image`, `other`, `document`.
metadata	`array`	Metadata name filters and value keywords.
metadata[].name	`string`	The metadata item name to filter on. This must be an exact match to a metadata item’s name.
metadata[].value	`string`	The metadata item value to search on. The same rules for the `query` parameter apply here.

Responses200404

Headers

Content-Type: application/json

Body

{
  "limit": 1,
  "offset": 0,
  "count": 10,
  "order": {
    "by": "Name",
    "direction": "asc"
  },
  "kind": [
    "All"
  ],
  "items": [
    {
      "id": "9b639e12a82f4b0483f512b474dc052ci",
      "name": "My Folder",
      "createdOn": "2017-01-02T00:00:00.000Z",
      "createdBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "lastActivityOn": "2017-01-03T00:00:00.000Z",
      "network": {
        "id": "40c2a6b99a474b319dec5ef9c7dbb356",
        "name": "Company Name",
        "class": "Enterprise"
      },
      "metadata": [
        {
          "name": "intendedFor",
          "value": "landscapeImages"
        }
      ],
      "stats": {
        "childFolderCount": 2
      },
      "parentId": "nqyptt047b7qc9y3",
      "workspace": {
        "id": "gb5ehomv0iv71swg",
        "name": "Workspace Name",
        "class": "Enterprise"
      },
      "parentFolder": {
        "id": "9b639e12a82f4b0483f512b474dc052ci",
        "name": "Folder Name"
      },
      "isTrashed": false,
      "kind": "Folder"
    }
  ],
  "facets": {
    "networks": [
      {
        "id": "gb5ehomv0iv71swg",
        "name": "My Workspace",
        "count": 10
      }
    ],
    "workspaces": [
      {
        "id": "gb5ehomv0iv71swg",
        "name": "My Workspace",
        "count": 10,
        "network": {
          "id": "9hdf6pk2quj0ion6",
          "name": "My Workspace"
        }
      }
    ],
    "types": [
      {
        "name": "Video",
        "count": 10
      }
    ],
    "archiveStatuses": [
      {
        "name": "Archived",
        "count": 10
      }
    ],
    "presentationAspectRatios": [
      {
        "name": "16:9",
        "count": 10
      }
    ],
    "audioChannelCounts": [
      {
        "name": "5",
        "count": 10
      }
    ],
    "audioSampleRates": [
      {
        "name": "48000",
        "count": 10
      }
    ],
    "videoCodecs": [
      {
        "name": "Proress",
        "count": 10
      }
    ],
    "frameRates": [
      {
        "name": "29.97",
        "count": 10
      }
    ],
    "pixelDimensions": [
      {
        "name": "1000x1000",
        "count": 10
      }
    ],
    "runtimes": [
      {
        "name": "0",
        "count": 10
      }
    ]
  },
  "maxSearchResults": 1000000
}

Property name	Type	Description
limit	`number`	The limit used for the query.
offset	`number`	The offset used for the query.
count	`number`	The total count of items available.
order	`object`	Information about the ordering of the results.
order.by	`string`	Indicates the field used to sort the results.
order.direction	`string`	Indicates the direction used to sort the results.
kind	`array`	Indicates the kind filter used in the request. Returned values are `All`, `Asset`, and `Folder`.
items	`array`	The items returned. Can be both assets and folders.
items[].id	`string`	The unique identifier of folder.
items[].name	`string`	The name of the folder.
items[].createdOn	`string`	The datetime the folder was created.
items[].createdBy	`object`	Information about the creator of the folder.
items[].createdBy.id	`string`	The unique identifier of the user.
items[].createdBy.name	`string`	The full name of the user.
items[].createdBy.email	`string`	The email of the user.
items[].lastActivityOn	`string`	The datetime of the last activity of the folder.
items[].network	`object`	Information about the folder’s parent network.
items[].network.id	`string`	The unique identifier of the Network.
items[].network.name	`string`	The name of the Network.
items[].network.class	`string`	Indicates if the Network is a ‘Personal’ or ‘Enterprise’ Network.
items[].metadata	`array`	An array of key-value pairs of user-generated metadata.
items[].metadata[].name	`string`	The name of the metadata item.
items[].metadata[].value	`string`	the value of the metadata item.
items[].stats	`object`	Statistics about the folder.
items[].stats.childFolderCount	`number`	The number of child folders for the given folder.
items[].parentId	`string`	The unique identifier of the parent folder, if it is a child folder, or the workspace id, if it is the Workspace’s root folder.
items[].workspace	`object`	Information about the folder’s parent workspace.
items[].workspace.id	`string`	The unique identifier of the Workspace.
items[].workspace.name	`string`	The name of the Workspace.
items[].workspace.class	`string`	Indicates if the Workspace is a ‘Personal’ or ‘Team’ Workspace.
items[].parentFolder	`object`	Information about the folder’s parent folder. If the folder is the root folder of a Workspace this property will not be available.
items[].parentFolder.id	`string`	The unique identifier of the folder.
items[].parentFolder.name	`string`	The name of folder.
items[].isTrashed	`boolean`	Indicates if a folder is in the trash bin.
items[].kind	`string`	The type of item returned. Will always be ‘Folder’ for folders.
facets	`object`	Information about Workspaces, Networks and types returned in the results.
facets.networks	`array`	Networks for the returned results.
facets.networks[].id	`string`	The id of the Workspace.
facets.networks[].name	`string`	The name of the Workspace.
facets.networks[].count	`number`	The number of items in this facet.
facets.workspaces	`array`	Workspaces for the returned results.
facets.workspaces[].id	`string`	The id of the Workspace.
facets.workspaces[].name	`string`	The name of the Workspace.
facets.workspaces[].count	`number`	The number of items in this facet.
facets.workspaces[].network	`object`	Information about the Workspace’s parent Network.
facets.workspaces[].network.id	`string`	The id of the Network.
facets.workspaces[].network.name	`string`	The name of the Network.
facets.types	`array`	Types for the returned results. Returned values are `Video`, `Audio`, `Image`, `Document`, `Other`.
facets.types[].name	`string`	The name of facet.
facets.types[].count	`number`	The number of items in this facet.
facets.archiveStatuses	`array`	Archive statuses for the returned results.
facets.archiveStatuses[].name	`string`	The name of facet.
facets.archiveStatuses[].count	`number`	The number of items in this facet.
facets.presentationAspectRatios	`array`	Presentation aspect ratios for the returned results.
facets.presentationAspectRatios[].name	`string`	The name of facet.
facets.presentationAspectRatios[].count	`number`	The number of items in this facet.
facets.audioChannelCounts	`array`	Audio channel counts for the returned results.
facets.audioChannelCounts[].name	`string`	The name of facet.
facets.audioChannelCounts[].count	`number`	The number of items in this facet.
facets.audioSampleRates	`array`	Audio sample rates for the returned results.
facets.audioSampleRates[].name	`string`	The name of facet.
facets.audioSampleRates[].count	`number`	The number of items in this facet.
facets.videoCodecs	`array`	Video codes for the returned results.
facets.videoCodecs[].name	`string`	The name of facet.
facets.videoCodecs[].count	`number`	The number of items in this facet.
facets.frameRates	`array`	Frame rates for the returned results.
facets.frameRates[].name	`string`	The name of facet.
facets.frameRates[].count	`number`	The number of items in this facet.
facets.pixelDimensions	`array`	Pixel dimensions for the returned results.
facets.pixelDimensions[].name	`string`	The name of facet.
facets.pixelDimensions[].count	`number`	The number of items in this facet.
facets.runtimes	`array`	Runtimes for the returned results, in seconds.
facets.runtimes[].name	`string`	600 (string) - The name of facet.
facets.runtimes[].count	`number`	The number of items in this facet.
maxSearchResults	`number`	The maximum value of total results that can display.

Headers

Content-Type: application/json

Body

{
  "code": "WorkspaceNotFound",
  "message": "Workspace not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Search Assets and Folders
POST`/faceted-search`

Description

Searches for assets and folders with multiple filters available and returns results with facets to provide insight into the search result data.

Errors

Status Code	Error Code	Message
400	InvalidLimitOrOffset	Invalid limit or offset value. Limit must be a number between 1 and 100. Offset must be greater than or equal to 0.
400	InvalidQueryOrderField	Invalid order field. It must be either ‘CreatedOn’, ‘Name’, or ‘Relevance’.
400	InvalidQueryOrderDirection	Invalid order direction. It must be either ‘Asc’ or ‘Desc’.
400	InvalidQueryKindFilter	Invalid kind filter. It must be either ‘All’, ‘Asset’ or ‘Folder’.
400	InvalidArchiveStatus	Invalid archive status. Please check our API docs for valid statuses.
400	InvalidRuntime	Invalid runtime. The runtime must be a number and equal to or greater than 0.
400	NetworkNotFound	Network not found.
400	WorkspaceNotFound	Workspace not found.
400	FolderNotFound	Folder not found.

Search Timed Texts ¶

POST https://api.cimediacloud.com/timed-text-search

Requestsexample with timed texts in response

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "query": "movies",
  "limit": 50,
  "offset": 0,
  "orderBy": "relevance",
  "orderDirection": "asc",
  "assetId": "nooumy2aiumufg3w",
  "elementId": "qekyzblpu7o31w0h"
}

Property name	Type	Description
query	`string`	The keywords used to search for timed texts. Values can be unquoted for general matching or quoted for phrase matching. For general matching, the length must be 2 or more characters and can contain multiple keywords which must be between 2 to 20 characters each. Keywords must be separated by whitespace. For example, `demo movie`. For phrase matching, enclose quotes around the phrases and you will get matches that contain the exact phrase provided. Search also supports `AND` and `OR` search operators.
limit	`number`	The number of items to return. The maximum is 100 and the default is 50.
offset	`number`	The item at which to begin the response. Default is 0.
orderBy	`string`	The field to sort the items by. Accepted values are `relevance`, `markinmilliseconds`. Defaults to `relevance`.
orderDirection	`string`	The order direction the items should be returned. Accepted values are `asc` and `desc`. Defaults to `desc`.
assetId	`string`	The asset to filter. This will limit results to timed texts of elements of the specified asset
elementId	`string`	The element to filter. This will limit results to timed texts of the specified element.

Responses200

Headers

Content-Type: application/json

Body

{
  "limit": 1,
  "offset": 0,
  "count": 10,
  "order": {
    "by": "relevance",
    "direction": "asc"
  },
  "items": [
    {
      "id": "bcdc34b53e2c4c18ac41ca288e28d11f",
      "text": "we are going to the movies",
      "markIn": {
        "type": "Seconds",
        "value": "0.5",
        "valueMilliseconds": 500
      },
      "markOut": {
        "type": "Seconds",
        "value": "2",
        "valueMilliseconds": 2000
      },
      "element": {
        "id": "qekyzblpu7o31w0h",
        "name": "693130.vtt"
      },
      "asset": {
        "id": "nooumy2aiumufg3w",
        "name": "Movie.mov"
      }
    }
  ]
}

Property name	Type	Description
limit	`number`	The limit used for the query.
offset	`number`	The offset used for the query.
count	`number`	The total count of items available.
order	`object`	Information about the ordering of the results.
order.by	`string`	Indicates the field used to sort the results.
order.direction	`string`	Indicates the direction used to sort the results.
items	`array`	The items returned. Contains data from the timed text entry, Asset and Element.
items[].id	`string`	The unique identifier of the timed text.
items[].text	`string`	The complete text of the timed text entry matching the query.
items[].markIn	`object`	Information about the initial time of the text entry.
items[].markIn.type	`string`	Indicates the type of the time entry.
items[].markIn.value	`string`	Indicates the value of the time entry.
items[].markIn.valueMilliseconds	`number`	Indicates the value in milliseconds of the time entry.
items[].markOut	`object`	Information about the end time of the text entry.
items[].markOut.type	`string`	Indicates the type of the time entry.
items[].markOut.value	`string`	Indicates the value of the time entry.
items[].markOut.valueMilliseconds	`number`	Indicates the value in milliseconds of the time entry.
items[].element	`object`	The timed text Element.
items[].element.id	`string`	The unique identifier of the timed text element.
items[].element.name	`string`	The name of the timed text element and its extension.
items[].asset	`object`	The Asset of the Element.
items[].asset.id	`string`	The unique identifier of the asset.
items[].asset.name	`string`	The name of asset and its extension.

Search Timed Texts
POST`/timed-text-search`

Description

Searches for timed text entries given an asset or for a specific timed text element. The search can be run with multiple filters that are available.

Errors

Status Code	Error Code	Message
400	InvalidLimitOrOffset	Invalid limit or offset value. Limit must be a number between 1 and 100. Offset must be greater than or equal to 0.
400	InvalidQueryOrderField	Invalid order field. It must be either ‘StartTimecode’ or ‘Relevance’.
400	InvalidQueryOrderDirection	Invalid order direction. It must be either ‘Asc’ or ‘Desc’.
400	ArgumentNull	Invalid User ID, Asset ID or Element ID.
400	AssetAccessDenied	Access denied. If Asset ID is provided validates access to Asset (if Asset is in a Catalog checks access to folders inside the Catalog). If Element ID is provided checks access to the Element.

Asset Singlepart Upload ¶

Ci API provides four different ways to upload assets:

Singlepart HTTP upload
Multipart HTTP upload
Aspera upload
URL import

The singlepart HTTP upload is the easiest to use. It creates the asset record and uploads its content in a single operation. It is, however, limited to 150 megabytes.

It is important to note that an asset record can be created as part of the upload process or it can be created separately - allowing you the flexibility to upload the content to the asset at any time.

Finally, please pay attention to the subdomain used for singlepart and multipart HTTP uploads. The subdomain for those operations is https://io.cimediacloud.com.

Create Asset and Upload ¶

POST https://api.cimediacloud.com/upload

Requestsexampleexample json body for metadata parameter

Headers

Content-Type: multipart/form-data;boundary=----WebKitFormBoundary8M3sSU13ul5lXSJm
Authorization: Bearer [bearer token]

Body

------WebKitFormBoundary8M3sSU13ul5lXSJm
Content-Disposition: form-data; name="metadata"

{
    "name": "Movie.mov",
    "size": 1024
}

------WebKitFormBoundary8M3sSU13ul5lXSJm

Content-Disposition: form-data; name="filename"; filename="Movie.mov"
Content-Type: image/jpeg

data
------WebKitFormBoundary8M3sSU13ul5lXSJm--

Responses200400

Headers

Content-Type: application/json

Body

{
  "assetId": "5v99qywnb6gzneha"
}

Property name	Type	Description
assetId	`string`	The unique identifier for the asset.

Headers

Content-Type: application/json

Body

{
  "code": "FolderNotFound",
  "message": "Folder not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "name": "Movie.mov",
  "size": 1024,
  "workspaceId": "oj7mx3vlb2srei89",
  "folderId": "6ovu49kdb3z32z2w",
  "description": "sample description",
  "metadata": {
    "key name 1": "value",
    "key name 2": "value"
  },
  "ingestConfiguration": {
    "autoArchive": true,
    "audioMappings": [
      {
        "mappings": [
          {
            "sourceStream": 1,
            "sourceChannel": 2,
            "targetChannel": 3,
            "amplitude": 0.8
          }
        ]
      }
    ]
  }
}

Property name	Type	Description
name	`string` (required)	The name of the asset, including its extension. Its maximum length is 512 characters.
size	`number` (required)	The size of the asset, in bytes.
workspaceId	`string`	The workspace that will contain the asset. If no value is provided, the asset will be placed in the calling user’s personal workspace.
folderId	`string`	The workspace’s folder that will contain the asset. If no value is provided, the asset will be placed in the workspace’s root folder.
description	`string`	A brief note associated to the asset. Its maximum length is 1000 characters.
metadata	`object`	An object containing key-value pairs of user-generated metadata.
metadata.key name 1	`string`	An example key-value.
metadata.key name 2	`string`	An example key-value.
ingestConfiguration	`object`	Settings for customizing the ingest process of the asset.
ingestConfiguration.autoArchive	`boolean`	Indicates if the asset shall be archived right after ingestion.
ingestConfiguration.audioMappings	`array`	A set of objects that specifies ingest customizations that will be used when generating proxies. Currently, we support a single object in this array. If more than 1 object is provided, only the first will be processed and the rest will be ignored.
ingestConfiguration.audioMappings[].mappings	`array`	A set of objects that defines the mapping of a source file’s audio streams to the proxies’ audio streams.
ingestConfiguration.audioMappings[].mappings[].sourceStream	`number`	Index of an audio stream from the source file that will be mapped to each proxy’s audio stream. This index is zero-based.
ingestConfiguration.audioMappings[].mappings[].sourceChannel	`number`	Channel index of the specified source stream that will be mapped to each proxy’s target channels. This index is zero-based and the default is 0.
ingestConfiguration.audioMappings[].mappings[].targetChannel	`number`	Channel index of the proxies’ audio stream. This index is zero-based and the default is 0.
ingestConfiguration.audioMappings[].mappings[].amplitude	`number`	Number between 0 and 1 that determines the amplitude of the proxies’ target channel based on the source channel amplitude. Default is 1.

Responses200400

Headers

Content-Type: application/json

Body

{
  "assetId": "5v99qywnb6gzneha"
}

Property name	Type	Description
assetId	`string`	The unique identifier for the asset.

Headers

Content-Type: application/json

Body

{
  "code": "FolderNotFound",
  "message": "Folder not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Create Asset and Upload
POST`/upload`

Description

Creates and uploads an asset into Ci in a single operation using HTTP. This is ideal for smaller files. There is an upper limit of 150 megabytes for this endpoint due primarily to the limitations of the HTTP protocol. If the HTTP session is interrupted during this upload process, there is no way to recover from the point of failure. You will need to upload the file again.

For larger files, we recommend that you use our Multipart Upload or, if you have access to an Aspera server or have the Aspera Connect plugin as part of your application, use our Aspera Upload for accelerated uploads with no file size limitations.

The request body must be encoded using multipart/form-data, using 1 or 2 parts.

The first part must be the content to be uploaded, setting the filename content property with the desired asset name.

The second part is optional, containing the metadata, workspace and folder as a json entity.

A different API host handles HTTP uploads. Please use the host https://io.cimediacloud.com/ to perform this operation.

The upload operation will fail if the user does not have enough free space for the new asset.

As security is paramount to all that we do, we don’t allow the following types of files to be uploaded to Ci:

Batch files
COM files
Executable files
HTML files
JavaScript files
JavaServer Pages
MSI files
PHP files
Python files
Ruby files
SWF files
VBScript files

Errors

Status Code	Error Code	Message
400	MissingOrInvalidFile	Missing or invalid file content.
400	MissingOrInvalidName	Missing or invalid name. The file name must not be null and its length must be equal to or less than 512 characters.
400	InvalidDescription	Invalid description. The description length must equal to or less than 1000 characters.
400	InvalidFileType	Invalid file type.
400	AssetTooLarge	File size is too large for a singlepart HTTP upload. The maximum size is 150 megabytes.
400	WorkspaceNotFound	Workspace not found.
400	FolderNotFound	Folder not found.
400	FolderNotMemberOfWorkspace	Folder is not a member of the provided workspace.
400	InvalidIngestConfiguration	Invalid ingest configuration.
400	DataTransferLimitExceeded	Data Transfer limit exceeded.
409	InsufficientSpaceAvailable	Upload will exceed the workspace’s allotted storage.
415	UnsupportedMediaType	Unsupported media type. Please use multipart/form-multidata.
500	AssetUploadFailed	File upload failed.

Upload File To Created Asset ¶

POST https://api.cimediacloud.com/assets/yiireizq1hcowxua/upload

Requestsexample

Headers

Content-Type: multipart/form-data;boundary=----WebKitFormBoundary8M3sSU13ul5lXSJm
Authorization: Bearer [bearer token]

Body

------WebKitFormBoundary8M3sSU13ul5lXSJm

Content-Disposition: form-data; name="filename"; filename="Movie.mov"
Content-Type: image/jpeg

data
------WebKitFormBoundary8M3sSU13ul5lXSJm--

Responses200400

Headers

Content-Type: application/json

Body

{
  "assetId": "5v99qywnb6gzneha"
}

Property name	Type	Description
assetId	`string`	The unique identifier for the asset.

Headers

Content-Type: application/json

Body

{
  "code": "FolderNotFound",
  "message": "Folder not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Upload File To Created Asset
POST`/assets/{assetId}/upload`

URI Parameters

HideShow

assetId: string (required)
The unique identifier of the asset.

Description

Uploads a source file via HTTP to an asset record that has already been created but has not been backed by a source file yet. If you want to create the asset record and upload its source file using Singlepart HTTP Upload at the same time use Singlepart HTTP Create and Upload instead.

The request body must contain the content to be uploaded, along with the file name and it must be encoded using multipart/form-data.

This operation can only be done if the asset has not previously had a file uploaded to it, if the upload failed, or if the previously uploaded file has a virus.

A different API host handles HTTP uploads. Please use the host https://io.cimediacloud.com/ to perform this operation.

The upload operation will fail if the user does not have enough free space for the new asset.

Errors

Status Code	Error Code	Message
400	MissingOrInvalidFile	Missing or invalid file content.
400	MissingOrInvalidName	Missing or invalid name. The file name must not be null and its length must be equal to or less than 512 characters.
400	InvalidDescription	Invalid description. The description length must equal to or less than 1000 characters.
400	InvalidFileType	Invalid file type.
400	AssetTooLarge	File size is too large for a singlepart HTTP upload. The maximum size is 150 megabytes.
400	DataTransferLimitExceeded	Data Transfer limit exceeded.
404	AssetNotFound	Asset not found.
409	InsufficientSpaceAvailable	Upload will exceed the workspace’s allotted storage.
409	InvalidAssetState	Asset cannot be uploaded. To upload an asset it cannot be trashed and its status must be ‘Created’, ‘Failed’, or ‘Virus Detected’.
415	UnsupportedMediaType	Unsupported media type. Please use multipart/form-multidata.
500	AssetUploadFailed	File upload failed.

Asset Multipart Upload ¶

Ci API provides four different ways to upload assets:

Singlepart HTTP upload
Multipart HTTP upload
Aspera upload
URL import

Multipart HTTP upload enables the upload of small and large assets, up to 5 terabytes, in a five-step process:

Create Asset and Initiate Upload
Create and Retrieve Batch of Part Upload URLs
Upload Parts
Complete Batch of Parts
Complete Upload

Please pay attention to the subdomain used for singlepart and multipart HTTP uploads. The subdomain for those operations is https://io.cimediacloud.com.

Create Asset and Initiate Upload ¶

POST https://api.cimediacloud.com/upload/multipart

Requestssimple examplefull example

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "name": "Movie.mov",
  "size": 1024,
  "workspaceId": "oj7mx3vlb2srei89",
  "folderId": "6ovu49kdb3z32z2w",
  "UploadMethod": "DirectToCloud",
  "PartSize": 1024
}

Property name	Type	Description
name	`string` (required)	The name of the asset, including its extension. Its maximum length is 512 characters.
size	`number` (required)	The size of the asset, in bytes.
workspaceId	`string`	The workspace that will contain the asset. If no value is provided, the asset will be placed in the calling user’s personal workspace.
folderId	`string`	The workspace’s folder that will contain the asset. If no value is provided, the asset will be placed in the workspace’s root folder.
UploadMethod	`string` (required)	Value should be `DirectToCloud` to use this upload method.
PartSize	`number` (required)	Indicates the size for each part to be uploaded.

Responses200400

Headers

Content-Type: application/json

Body

{
  "assetId": "d9bf018c804a4e78b775b8dc2f242071",
  "partCount": 100
}

Property name	Type	Description
assetId	`string`	The unique identifier for the asset.
partCount	`number`	Total number of parts that composes the upload.

Headers

Content-Type: application/json

Body

{
  "code": "FolderNotFound",
  "message": "Folder not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "name": "Movie.mov",
  "size": 1024,
  "workspaceId": "oj7mx3vlb2srei89",
  "folderId": "6ovu49kdb3z32z2w",
  "description": "sample description",
  "metadata": {
    "key name 1": "value",
    "key name 2": "value"
  },
  "ingestConfiguration": {
    "autoArchive": true,
    "audioMappings": [
      {
        "mappings": [
          {
            "sourceStream": 1,
            "sourceChannel": 2,
            "targetChannel": 3,
            "amplitude": 0.8
          }
        ]
      }
    ]
  },
  "UploadMethod": "DirectToCloud",
  "PartSize": 1024
}

Property name	Type	Description
name	`string` (required)	The name of the asset, including its extension. Its maximum length is 512 characters.
size	`number` (required)	The size of the asset, in bytes.
workspaceId	`string`	The workspace that will contain the asset. If no value is provided, the asset will be placed in the calling user’s personal workspace.
folderId	`string`	The workspace’s folder that will contain the asset. If no value is provided, the asset will be placed in the workspace’s root folder.
description	`string`	A brief note associated to the asset. Its maximum length is 1000 characters.
metadata	`object`	An object containing key-value pairs of user-generated metadata.
metadata.key name 1	`string`	An example key-value.
metadata.key name 2	`string`	An example key-value.
ingestConfiguration	`object`	Settings for customizing the ingest process of the asset.
ingestConfiguration.autoArchive	`boolean`	Indicates if the asset shall be archived right after ingestion.
ingestConfiguration.audioMappings	`array`	A set of objects that specifies ingest customizations that will be used when generating proxies. Currently, we support a single object in this array. If more than 1 object is provided, only the first will be processed and the rest will be ignored.
ingestConfiguration.audioMappings[].mappings	`array`	A set of objects that defines the mapping of a source file’s audio streams to the proxies’ audio streams.
ingestConfiguration.audioMappings[].mappings[].sourceStream	`number`	Index of an audio stream from the source file that will be mapped to each proxy’s audio stream. This index is zero-based.
ingestConfiguration.audioMappings[].mappings[].sourceChannel	`number`	Channel index of the specified source stream that will be mapped to each proxy’s target channels. This index is zero-based and the default is 0.
ingestConfiguration.audioMappings[].mappings[].targetChannel	`number`	Channel index of the proxies’ audio stream. This index is zero-based and the default is 0.
ingestConfiguration.audioMappings[].mappings[].amplitude	`number`	Number between 0 and 1 that determines the amplitude of the proxies’ target channel based on the source channel amplitude. Default is 1.
UploadMethod	`string` (required)	Value should be `DirectToCloud` to use this upload method.
PartSize	`number` (required)	Indicates the size for each part to be uploaded.

Responses200400

Headers

Content-Type: application/json

Body

{
  "assetId": "d9bf018c804a4e78b775b8dc2f242071",
  "partCount": 100
}

Property name	Type	Description
assetId	`string`	The unique identifier for the asset.
partCount	`number`	Total number of parts that composes the upload.

Headers

Content-Type: application/json

Body

{
  "code": "FolderNotFound",
  "message": "Folder not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Create Asset and Initiate Upload
POST`/upload/multipart`

Description

The operation described below creates the asset record and initiates the multipart upload, returning an asset identifier to be used in subsequent requests. You will be required to provide a PartSize parameter. This value will be the size of each individual part of the file that will be uploaded. For example, if you have a 10 GB file you might consider a PartSize of 524,288,000 which will equal 20 total part uploads. For files under 10MB we recommend using the actual file size as the PartSize and performing a single part upload.

The file size must be smaller than 5 TB to use this upload mechanism. The storage space is reserved against your plan as soon as the asset is registered and remains so until the asset is deleted.

A different API host handles HTTP uploads. Please use the host https://io.cimediacloud.com/ to perform this operation.

The upload operation will fail if the user does not have enough free space for the new asset.

As security is paramount to all that we do, we don’t allow the following types of files to be uploaded to Ci:

Batch files
COM files
Executable files
HTML files
JavaScript files
JavaServer Pages
MSI files
PHP files
Python files
Ruby files
SWF files
VBScript files

Errors

Status Code	Error Code	Message
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	MissingOrInvalidName	Missing or invalid name. The file name must not be null and its length must be equal to or less than 512 characters.
400	InvalidFileType	Invalid file type.
400	InvalidDescription	Invalid description. The description length must equal to or less than 1000 characters.
400	AssetTooLarge	Asset size is too large for multipart upload. The maximum size is 5 terabytes.
400	AssetPartSizeTooSmall	Part size is too small for the file size specified. Cannot exceed 10,000 parts in a multi-part upload.
400	WorkspaceNotFound	Workspace not found.
400	FolderIdNotProvided	Folder Id was not provided.
400	FolderNotFound	Folder not found.
400	FolderNotMemberOfWorkspace	Folder is not a member of the provided workspace.
400	InvalidIngestConfiguration	Invalid proxy type specified.
400	DataTransferLimitExceeded	Data Transfer limit exceeded.
403	InsufficientPermissions	Insufficient permissions for creating an asset.
409	InsufficientSpaceAvailable	Upload will exceed the workspaces’s allotted storage.
409	FolderDeleted	Folder is deleted.
409	FolderTrashed	Folder is trashed.

Create and Retrieve Batch of Upload URLs ¶

POST https://api.cimediacloud.com/upload/multipart/d9bf018c804a4e78b775b8dc2f242071/batch

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "partNumbers": [
    1
  ]
}

Property name	Type	Description
partNumbers	`array` (required)	The part numbers for which to retrieve upload URLs. The maximum number of parts is 10,000.

Responses200404

Headers

Content-Type: application/json

Body

{
  "assetId": "d9bf018c804a4e78b775b8dc2f242071",
  "parts": [
    {
      "partNumber": 1,
      "uploadUrl": "https://example.com/upload/part",
      "startOffset": 0,
      "endOffset": 1023,
      "size": 1024
    }
  ]
}

Property name	Type	Description
assetId	`string`	The unique identifier of the asset to upload.
parts	`array`	The array of parts that contains upload information.
parts[].partNumber	`number`	The part number that is expected for the supplied `uploadUrl`.
parts[].uploadUrl	`string`	The upload URL for uploading the part. The upload URL will be prefixed with HTTPS, for SSL, but can be replaced to use HTTP – unencrypted over the wire.
parts[].startOffset	`number`	The start byte for this part.
parts[].endOffset	`number`	The end byte for this part.
parts[].size	`number`	The part size.

Headers

Content-Type: application/json

Body

{
  "code": "AssetNotFound",
  "message": "Asset not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Create and Retrieve Batch of Upload URLs
POST`/upload/multipart/{assetId}/batch`

URI Parameters

HideShow

assetId: string (required)
The unique identifier of the asset.

Description

The purpose of this operation is to create and retrieve a batch of upload URLs that will be used to upload each part of your asset. You do not need to generate all part upload URLs at once. We recommend generating the list of URLs as they are needed by the upload client.

Each returned URL is signed with a 24 hour expiration for security purposes. You do not need to send OAuth credentials in the header for these returned URLs.

A different API host handles HTTP uploads. Please use the host https://io.cimediacloud.com/ to perform this operation.

The upload operation will fail if the user does not have enough free space for the new asset.

Errors

Status Code	Error Code	Message
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	InvalidRequest	No part numbers were provided or they exceeded the maximum allowed number.
400	InvalidRequest	Part not found.
404	AssetNotFound	Asset not found.
404	AssetDeleted	Asset is deleted.
409	AssetUploadNotInitiated	There is no initiated upload for this file.
409	FileManifestDoesNotExist	The file manifest defined for this file does not exist.
409	InvalidAssetState	Asset is already uploaded and available.
409	AssetTrashed	Asset is trashed.

Upload Parts ¶

PUT https://api.cimediacloud.com/example/upload/part

Requestsexample

Body

raw file part

Responses200

This response has no content.

Upload Parts
PUT`/example/upload/part`

Description

This is the operation used to upload individual parts using the upload URLs from Step 2. When setting a timeout on this request, please allow for the slowest anticipated upload of twice the part content (i.e. take lowest potential throughput and divide it by two to account for client bandwidth constraints). Given the nature of HTTP, it may become necessary to “reupload” a part to ensure all of the bits are received in the allotted time. In accordance with HTTP, the API won’t respond while still persisting the file.

Content-Type header should be ommitted when uploading a file part.

The request body should contain the raw part of the file that is being uploaded.

Complete Batch of Parts ¶

POST https://api.cimediacloud.com/upload/multipart/d9bf018c804a4e78b775b8dc2f242071/batch/complete

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "parts": [
    {
      "partNumber": 0,
      "checksum": "b435k5345n"
    }
  ]
}

Property name	Type	Description
parts	`array`	An array of parts that have been successfully uploaded.
parts[].partNumber	`number` (required)	The part number.
parts[].checksum	`string`	The MD5 hash calculated client-side, if any.

Responses200404

Headers

Content-Type: application/json

Body

{
  "completeCount": 1,
  "errorCount": 1,
  "errors": [
    {
      "kind": "UploadPart",
      "errorCode": "ChecksumMismatch",
      "errorMessage": "The provided MD5 checksum does not match the calculated value.",
      "partNumber": 0
    }
  ],
  "complete": [
    {
      "partNumber": 0,
      "kind": "UploadPart"
    }
  ]
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors	`array`	An array containing information about each failed part.
errors[].kind	`string`	The kind of the job.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].partNumber	`number`	The part number that failed.
complete	`array`	An array containing information about each part uploaded.
complete[].partNumber	`number`	The successfully completed part number.
complete[].kind	`string`	Will always be “UploadPart” for this resource.

Headers

Content-Type: application/json

Body

{
  "completeCount": 0,
  "errorCount": 1,
  "errors": [
    {
      "kind": "UploadPart",
      "errorCode": "ChecksumMismatch",
      "errorMessage": "The provided MD5 checksum does not match the calculated value.",
      "partNumber": 0
    }
  ]
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors	`array`	An array containing information about each failed part.
errors[].kind	`string`	The kind of the job.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].partNumber	`number`	The part number that failed.

Complete Batch of Parts
POST`/upload/multipart/{assetId}/batch/complete`

URI Parameters

HideShow

assetId: string (required)
The unique identifier of the asset.

Description

This operation signals the successful upload of 1 or more parts. It is recommended to send this with a batch of completed part numbers (as opposed to sending it with a single part number after each part upload is completed).

A different API host handles HTTP uploads. Please use the host https://io.cimediacloud.com/ to perform this operation.

The upload operation will fail if the user does not have enough free space for the new asset.

Errors

Status Code	Error Code	Message
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	InvalidRequest	No part numbers were provided or they exceeded the maximum allowed number.
400	InvalidRequest	Part not found.
404	AssetNotFound	Asset not found.
409	FileManifestDoesNotExist	The file manifest defined for this file does not exist.
409	InvalidAssetState	Asset is already uploaded and available.
409	AssetUploadNotInitiated	There is no initiated upload for this file.
409	BulkOperationFailed	The bulk operation failed. See the errors array for more information.

Complete the Upload ¶

POST https://api.cimediacloud.com/upload/multipart/d9bf018c804a4e78b775b8dc2f242071/complete

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200404

Headers

Content-Type: application/json

Body

{
  "assetId": "d9bf018c804a4e78b775b8dc2f242071"
}

Property name	Type	Description
assetId	`string`	The unique identifer of the asset.

Headers

Content-Type: application/json

Body

{
  "code": "AssetNotFound",
  "message": "Asset not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Complete the Upload
POST`/upload/multipart/{assetId}/complete`

URI Parameters

HideShow

assetId: string (required)
The unique identifier of the asset.

Description

This operation is used once all parts are uploaded and marked as complete. The available space in the project will be updated to reflect the actual size of the file that was transferred.

A different API host handles HTTP uploads. Please use the host https://io.cimediacloud.com/ to perform this operation.

The upload operation will fail if the user does not have enough free space for the new asset.

Errors

Status Code	Error Code	Message
400	NoPartsUploaded	No parts were transferred. The upload cannot be completed.
400	AssetTooLarge	Asset size is too large for multipart upload. The maximum size is 5 terabytes.
404	AssetNotFound	Asset not found.
404	AssetDeleted	Asset is deleted.
409	AssetTrashed	Asset is trashed.
409	InsufficientSpaceAvailable	Upload will exceed the workspaces’s allotted storage.
409	InvalidAssetState	Asset is already uploaded and available.
409	AssetUploadNotIntiated	There is no initiated upload for this asset.

Get Upload Parts ¶

POST https://api.cimediacloud.com/upload/multipart/d9bf018c804a4e78b775b8dc2f242071/parts?offset=0&limit=1&status=complete

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200404

Headers

Content-Type: application/json

Body

{
  "limit": 1,
  "offset": 0,
  "count": 1,
  "items": [
    {
      "partNumber": 0,
      "startOffset": 0,
      "endOffset": 1023,
      "size": 1024,
      "status": "Complete",
      "kind": "UploadPart"
    }
  ]
}

Property name	Type	Description
limit	`number`	The limit used for the query.
offset	`number`	The offset used for the query.
count	`number`	The total count of parts.
items	`array`	An array containing information about each part uploaded.
items[].partNumber	`number`	The successfully completed part number.
items[].startOffset	`number`	The part’s start offset.
items[].endOffset	`number`	The part’s end offset.
items[].size	`number`	The part size.
items[].status	`string`	Specifies if the part is already completed or not. Supported values are “Complete” or “Pending”.
items[].kind	`string`	The kind of item returned. Will always be ‘UploadPart’ for this resource.

Headers

Content-Type: application/json

Body

{
  "code": "AssetNotFound",
  "message": "Asset not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Get Upload Parts
POST`/upload/multipart/{assetId}/parts{?offset,limit,status}`

URI Parameters

HideShow

assetId: string (required)
The unique identifier of the asset.
limit: number (optional)
The number of parts to return. The default is 100, and the maximum is 1000.
offset: number (optional)
The element at which to begin the response. The default is 0.
status: string (optional)
The status value to filter by. Supported values are ‘all’, ‘complete’ or ‘pending’. The default is ‘all’.

Description

The purpose of this step is to get the list of upload parts, in order to know which parts are already completed and which ones remain to be sent or marked as complete. This is especially helpful in case of fatal error on the client side, where an upload restart is required.

A different API host handles HTTP uploads. Please use the host https://io.cimediacloud.com/ to perform this operation.

The upload operation will fail if the user does not have enough free space for the new asset.

Errors

Status Code	Error Code	Message
400	InvalidQueryFilter	Invalid query filter.
404	AssetNotFound	Asset not found.
404	AssetDeleted	Asset is deleted.
409	AssetTrashed	Asset is trashed.
409	AssetUploadNotInitiated	There is no initiated upload for this file.

Asset Aspera Upload ¶

Ci API provides four different ways to upload assets:

Singlepart HTTP upload
Multipart HTTP upload
Aspera upload
URL import

The Aspera upload also has a maximum of 5 terabytes and utilizes an accelerated transfer protocol to achieve exceptionally fast transfer speeds. It requires that you have an Aspera client or server available which can initiate transfers to our aspera environment.

Create Asset and Get Transfer Specs ¶

POST https://api.cimediacloud.com/upload/aspera

Requestssimple examplefull example

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "name": "Movie.mov",
  "size": 1024,
  "workspaceId": "oj7mx3vlb2srei89",
  "folderId": "6ovu49kdb3z32z2w"
}

Property name	Type	Description
name	`string` (required)	The name of the asset, including its extension. Its maximum length is 512 characters.
size	`number` (required)	The size of the asset, in bytes.
workspaceId	`string`	The workspace that will contain the asset. If no value is provided, the asset will be placed in the calling user’s personal workspace.
folderId	`string`	The workspace’s folder that will contain the asset. If no value is provided, the asset will be placed in the workspace’s root folder.

Responses200400

Headers

Content-Type: application/json

Body

{
  "assetId": "bcdc34b53e2c4c18ac41ca288e28d11f",
  "uploadConfiguration": {
    "paths": [
      {
        "source": "Movie.mov",
        "destination": "Movie.mov"
      }
    ],
    "host": "apod.cimediacloud.com",
    "sshPort": 33001,
    "user": "uxassets",
    "token": "6xnz5qwxzu6i6c8t",
    "targetRate": 1024,
    "minRate": 1024,
    "httpFallback": false,
    "destinationRoot": "01b5718d1a95443d8658b57b22c72cd9",
    "cookie": "assetId:bcdc34b53e2c4c18ac41ca288e28d11f"
  }
}

Property name	Type	Description
assetId	`string`	The unique identifier of the registered asset.
uploadConfiguration	`object`	Information about the Aspera upload specs.
uploadConfiguration.paths	`array`	Array containing source and destination properties for the asset. This array will always contain a single item.
uploadConfiguration.paths[].source	`string`	The local source path for the asset.
uploadConfiguration.paths[].destination	`string`	The destination path for the asset in Ci.
uploadConfiguration.host	`string`	The hostname of the destination Aspera server.
uploadConfiguration.sshPort	`number`	The port used for authentication on the destination Aspera server.
uploadConfiguration.user	`string`	The username on the destination Aspera server.
uploadConfiguration.token	`string`	The authorization token for the aspera transfer. This is time sensitive and will expire after 24 hours.
uploadConfiguration.targetRate	`number`	The target transfer rate, in kbps.
uploadConfiguration.minRate	`number`	The minimum transfer rate, in kbps.
uploadConfiguration.httpFallback	`boolean`	HTTP fallback for Aspera currently isn’t supported.
uploadConfiguration.destinationRoot	`string`	The destination folder for the files.
uploadConfiguration.cookie	`string`	The cookie that should be included in the aspera transfer.

Headers

Content-Type: application/json

Body

{
  "code": "FolderNotFound",
  "message": "Folder not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "name": "Movie.mov",
  "size": 1024,
  "workspaceId": "oj7mx3vlb2srei89",
  "folderId": "6ovu49kdb3z32z2w",
  "description": "sample description",
  "metadata": {
    "key name 1": "value",
    "key name 2": "value"
  },
  "ingestConfiguration": {
    "autoArchive": true,
    "audioMappings": [
      {
        "mappings": [
          {
            "sourceStream": 1,
            "sourceChannel": 2,
            "targetChannel": 3,
            "amplitude": 0.8
          }
        ]
      }
    ]
  }
}

Property name	Type	Description
name	`string` (required)	The name of the asset, including its extension. Its maximum length is 512 characters.
size	`number` (required)	The size of the asset, in bytes.
workspaceId	`string`	The workspace that will contain the asset. If no value is provided, the asset will be placed in the calling user’s personal workspace.
folderId	`string`	The workspace’s folder that will contain the asset. If no value is provided, the asset will be placed in the workspace’s root folder.
description	`string`	A brief note associated to the asset. Its maximum length is 1000 characters.
metadata	`object`	An object containing key-value pairs of user-generated metadata.
metadata.key name 1	`string`	An example key-value.
metadata.key name 2	`string`	An example key-value.
ingestConfiguration	`object`	Settings for customizing the ingest process of the asset.
ingestConfiguration.autoArchive	`boolean`	Indicates if the asset shall be archived right after ingestion.
ingestConfiguration.audioMappings	`array`	A set of objects that specifies ingest customizations that will be used when generating proxies. Currently, we support a single object in this array. If more than 1 object is provided, only the first will be processed and the rest will be ignored.
ingestConfiguration.audioMappings[].mappings	`array`	A set of objects that defines the mapping of a source file’s audio streams to the proxies’ audio streams.
ingestConfiguration.audioMappings[].mappings[].sourceStream	`number`	Index of an audio stream from the source file that will be mapped to each proxy’s audio stream. This index is zero-based.
ingestConfiguration.audioMappings[].mappings[].sourceChannel	`number`	Channel index of the specified source stream that will be mapped to each proxy’s target channels. This index is zero-based and the default is 0.
ingestConfiguration.audioMappings[].mappings[].targetChannel	`number`	Channel index of the proxies’ audio stream. This index is zero-based and the default is 0.
ingestConfiguration.audioMappings[].mappings[].amplitude	`number`	Number between 0 and 1 that determines the amplitude of the proxies’ target channel based on the source channel amplitude. Default is 1.

Responses200400

Headers

Content-Type: application/json

Body

{
  "assetId": "bcdc34b53e2c4c18ac41ca288e28d11f",
  "uploadConfiguration": {
    "paths": [
      {
        "source": "Movie.mov",
        "destination": "Movie.mov"
      }
    ],
    "host": "apod.cimediacloud.com",
    "sshPort": 33001,
    "user": "uxassets",
    "token": "6xnz5qwxzu6i6c8t",
    "targetRate": 1024,
    "minRate": 1024,
    "httpFallback": false,
    "destinationRoot": "01b5718d1a95443d8658b57b22c72cd9",
    "cookie": "assetId:bcdc34b53e2c4c18ac41ca288e28d11f"
  }
}

Property name	Type	Description
assetId	`string`	The unique identifier of the registered asset.
uploadConfiguration	`object`	Information about the Aspera upload specs.
uploadConfiguration.paths	`array`	Array containing source and destination properties for the asset. This array will always contain a single item.
uploadConfiguration.paths[].source	`string`	The local source path for the asset.
uploadConfiguration.paths[].destination	`string`	The destination path for the asset in Ci.
uploadConfiguration.host	`string`	The hostname of the destination Aspera server.
uploadConfiguration.sshPort	`number`	The port used for authentication on the destination Aspera server.
uploadConfiguration.user	`string`	The username on the destination Aspera server.
uploadConfiguration.token	`string`	The authorization token for the aspera transfer. This is time sensitive and will expire after 24 hours.
uploadConfiguration.targetRate	`number`	The target transfer rate, in kbps.
uploadConfiguration.minRate	`number`	The minimum transfer rate, in kbps.
uploadConfiguration.httpFallback	`boolean`	HTTP fallback for Aspera currently isn’t supported.
uploadConfiguration.destinationRoot	`string`	The destination folder for the files.
uploadConfiguration.cookie	`string`	The cookie that should be included in the aspera transfer.

Headers

Content-Type: application/json

Body

{
  "code": "FolderNotFound",
  "message": "Folder not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Create Asset and Get Transfer Specs
POST`/upload/aspera`

Description

Creates the asset record and responds with Aspera transfer configuration information so the client can initiate an upload using an Aspera client or server.

Your plan must have enough free space to accommodate the asset or the transaction will fail.

You will need access to an Aspera server or client that can initiate aspera transfers to effectively use the information that this operation returns.

The name provided in this request must match the filename transferred using Aspera. If the asset is uploaded again using the same token the source file will get overwritten, however, the proxies will not be recreated.

As security is paramount to all that we do, we don’t allow the following types of files to be uploaded to Ci:

Batch files
COM files
Executable files
HTML files
JavaScript files
JavaServer Pages
MSI files
PHP files
Python files
Ruby files
SWF files
VBScript files

Errors

Status Code	Error Code	Message
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	MissingOrInvalidName	Missing or invalid name. The file name must not be null and its length must be equal to or less than 512 characters.
400	InvalidDescription	Invalid description. The description length must equal to or less than 1000 characters.
400	MissingOrInvalidFileSize	Missing or invalid file size.
400	InvalidFileType	Invalid file type.
400	WorkspaceNotFound	Workspace not found.
400	FolderNotFound	Folder not found.
400	FolderNotMemberOfWorkspace	Folder is not a member of the provided workspace.
400	InvalidIngestConfiguration	Invalid ingest configuration.
400	DataTransferLimitExceeded	Data Transfer limit exceeded.
409	FolderDeleted	Folder is deleted.
409	FolderTrashed	Folder is trashed.
409	InsufficientSpaceAvailable	Upload will exceed the workspace’s allotted storage.
409	EntitlementRequired	Workspace does not have Aspera enabled.

Get Transfer Specs for Created Asset ¶

POST https://api.cimediacloud.com/assets/yiireizq1hcowxua/upload/aspera

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200400

Headers

Content-Type: application/json

Body

{
  "assetId": "bcdc34b53e2c4c18ac41ca288e28d11f",
  "uploadConfiguration": {
    "paths": [
      {
        "source": "Movie.mov",
        "destination": "Movie.mov"
      }
    ],
    "host": "apod.cimediacloud.com",
    "sshPort": 33001,
    "user": "uxassets",
    "token": "6xnz5qwxzu6i6c8t",
    "targetRate": 1024,
    "minRate": 1024,
    "httpFallback": false,
    "destinationRoot": "01b5718d1a95443d8658b57b22c72cd9",
    "cookie": "assetId:bcdc34b53e2c4c18ac41ca288e28d11f"
  }
}

Property name	Type	Description
assetId	`string`	The unique identifier of the registered asset.
uploadConfiguration	`object`	Information about the Aspera upload specs.
uploadConfiguration.paths	`array`	Array containing source and destination properties for the asset. This array will always contain a single item.
uploadConfiguration.paths[].source	`string`	The local source path for the asset.
uploadConfiguration.paths[].destination	`string`	The destination path for the asset in Ci.
uploadConfiguration.host	`string`	The hostname of the destination Aspera server.
uploadConfiguration.sshPort	`number`	The port used for authentication on the destination Aspera server.
uploadConfiguration.user	`string`	The username on the destination Aspera server.
uploadConfiguration.token	`string`	The authorization token for the aspera transfer. This is time sensitive and will expire after 24 hours.
uploadConfiguration.targetRate	`number`	The target transfer rate, in kbps.
uploadConfiguration.minRate	`number`	The minimum transfer rate, in kbps.
uploadConfiguration.httpFallback	`boolean`	HTTP fallback for Aspera currently isn’t supported.
uploadConfiguration.destinationRoot	`string`	The destination folder for the files.
uploadConfiguration.cookie	`string`	The cookie that should be included in the aspera transfer.

Headers

Content-Type: application/json

Body

{
  "code": "FolderNotFound",
  "message": "Folder not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Get Transfer Specs for Created Asset
POST`/assets/{assetId}/upload/aspera`

URI Parameters

HideShow

assetId: string (required)
The unique identifier of the asset.

Description

Returns a new Aspera transfer configuration object that can be used to upload the content of an existing asset. If you want to create the asset record and upload its source file using Aspera at the same time use Aspera Create and Upload instead.

The name provided in the create an asset request must match the filename transferred using Aspera.

This operation can only be done if the asset has not previously had a file uploaded to it, if the upload failed, or if the previously uploaded file has a virus.

Errors

Status Code	Error Code	Message
400	DataTransferLimitExceeded	Data Transfer limit exceeded.
404	AssetNotFound	Asset not found.
409	InvalidAssetState	Asset cannot be uploaded. To upload an asset it cannot be trashed and its status must be ‘Created’, ‘Failed’, or ‘Virus Detected’.
409	EntitlementRequired	Workspace does not have Aspera enabled.

Upload Multiple Files ¶

POST https://api.cimediacloud.com/upload/aspera/bulk

Requestsexample to create new assetsexample to upload to existing assets

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

[
  {
    "name": "Movie.mov",
    "size": 1024,
    "workspaceId": "oj7mx3vlb2srei89",
    "folderId": "6ovu49kdb3z32z2w",
    "description": "sample description",
    "metadata": {
      "key name 1": "value",
      "key name 2": "value"
    },
    "ingestConfiguration": {
      "autoArchive": true,
      "audioMappings": [
        {
          "mappings": [
            {
              "sourceStream": 1,
              "sourceChannel": 2,
              "targetChannel": 3,
              "amplitude": 0.8
            }
          ]
        }
      ]
    }
  }
]

Property name	Type	Description
name	`string` (required)	The name of the asset, including its extension. Its maximum length is 512 characters.
size	`number` (required)	The size of the asset, in bytes.
workspaceId	`string`	The workspace that will contain the asset. If no value is provided, the asset will be placed in the calling user’s personal workspace.
folderId	`string`	The workspace’s folder that will contain the asset. If no value is provided, the asset will be placed in the workspace’s root folder.
description	`string`	A brief note associated to the asset. Its maximum length is 1000 characters.
metadata	`object`	An object containing key-value pairs of user-generated metadata.
metadata.key name 1	`string`	An example key-value.
metadata.key name 2	`string`	An example key-value.
ingestConfiguration	`object`	Settings for customizing the ingest process of the asset.
ingestConfiguration.autoArchive	`boolean`	Indicates if the asset shall be archived right after ingestion.
ingestConfiguration.audioMappings	`array`	A set of objects that specifies ingest customizations that will be used when generating proxies. Currently, we support a single object in this array. If more than 1 object is provided, only the first will be processed and the rest will be ignored.
ingestConfiguration.audioMappings[].mappings	`array`	A set of objects that defines the mapping of a source file’s audio streams to the proxies’ audio streams.
ingestConfiguration.audioMappings[].mappings[].sourceStream	`number`	Index of an audio stream from the source file that will be mapped to each proxy’s audio stream. This index is zero-based.
ingestConfiguration.audioMappings[].mappings[].sourceChannel	`number`	Channel index of the specified source stream that will be mapped to each proxy’s target channels. This index is zero-based and the default is 0.
ingestConfiguration.audioMappings[].mappings[].targetChannel	`number`	Channel index of the proxies’ audio stream. This index is zero-based and the default is 0.
ingestConfiguration.audioMappings[].mappings[].amplitude	`number`	Number between 0 and 1 that determines the amplitude of the proxies’ target channel based on the source channel amplitude. Default is 1.

Responses200400

Headers

Content-Type: application/json

Body

{
  "count": 1,
  "items": [
    {
      "id": "d9bf018c804a4e78b775b8dc2f242071",
      "name": "Movie.mov"
    }
  ],
  "uploadConfiguration": {
    "paths": [
      {
        "source": "Movie.mov",
        "destination": "Movie.mov"
      }
    ],
    "host": "apod.cimediacloud.com",
    "sshPort": 33001,
    "user": "uxassets",
    "token": "6xnz5qwxzu6i6c8t",
    "targetRate": 1024,
    "minRate": 1024,
    "httpFallback": false
  }
}

Property name	Type	Description
count	`number`	The number of assets to be uploaded.
items	`array`	The assets to be uploaded.
items[].id	`string`	The unique identifier of the asset.
items[].name	`string`	The name of asset and its extension.
uploadConfiguration	`object`	Information about the Aspera upload specs.
uploadConfiguration.paths	`array`	Array containing source and destination properties for the asset. This array will always contain a single item.
uploadConfiguration.paths[].source	`string`	The local source path for the asset.
uploadConfiguration.paths[].destination	`string`	The destination path for the asset in Ci.
uploadConfiguration.host	`string`	The hostname of the destination Aspera server.
uploadConfiguration.sshPort	`number`	The port used for authentication on the destination Aspera server.
uploadConfiguration.user	`string`	The username on the destination Aspera server.
uploadConfiguration.token	`string`	The authorization token for the aspera transfer. This is time sensitive and will expire after 24 hours.
uploadConfiguration.targetRate	`number`	The target transfer rate, in kbps.
uploadConfiguration.minRate	`number`	The minimum transfer rate, in kbps.
uploadConfiguration.httpFallback	`boolean`	HTTP fallback for Aspera currently isn’t supported.

Headers

Content-Type: application/json

Body

{
  "completeCount": 0,
  "errorCount": 1,
  "errors": [
    {
      "name": "Item name",
      "kind": "Item",
      "errorCode": "ItemNotFound",
      "errorMessage": "Item not found.",
      "id": "ad9289a2019a4e07a08eca9459ef1091"
    }
  ]
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors	`array`	An array containing information about each failed item.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].id	`string`	The unique identifier for the item.

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

[
  {
    "assetId": "srik9m8g2edjq88q"
  }
]

Property name	Type	Description
assetId	`string`	The unique identifier for the created asset. Only provide this value if you are not creating new assets but instead uploading to existing assets.

Responses200400

Headers

Content-Type: application/json

Body

{
  "count": 1,
  "items": [
    {
      "id": "d9bf018c804a4e78b775b8dc2f242071",
      "name": "Movie.mov"
    }
  ],
  "uploadConfiguration": {
    "paths": [
      {
        "source": "Movie.mov",
        "destination": "Movie.mov"
      }
    ],
    "host": "apod.cimediacloud.com",
    "sshPort": 33001,
    "user": "uxassets",
    "token": "6xnz5qwxzu6i6c8t",
    "targetRate": 1024,
    "minRate": 1024,
    "httpFallback": false
  }
}

Property name	Type	Description
count	`number`	The number of assets to be uploaded.
items	`array`	The assets to be uploaded.
items[].id	`string`	The unique identifier of the asset.
items[].name	`string`	The name of asset and its extension.
uploadConfiguration	`object`	Information about the Aspera upload specs.
uploadConfiguration.paths	`array`	Array containing source and destination properties for the asset. This array will always contain a single item.
uploadConfiguration.paths[].source	`string`	The local source path for the asset.
uploadConfiguration.paths[].destination	`string`	The destination path for the asset in Ci.
uploadConfiguration.host	`string`	The hostname of the destination Aspera server.
uploadConfiguration.sshPort	`number`	The port used for authentication on the destination Aspera server.
uploadConfiguration.user	`string`	The username on the destination Aspera server.
uploadConfiguration.token	`string`	The authorization token for the aspera transfer. This is time sensitive and will expire after 24 hours.
uploadConfiguration.targetRate	`number`	The target transfer rate, in kbps.
uploadConfiguration.minRate	`number`	The minimum transfer rate, in kbps.
uploadConfiguration.httpFallback	`boolean`	HTTP fallback for Aspera currently isn’t supported.

Headers

Content-Type: application/json

Body

{
  "code": "AssetNotFound",
  "message": "Asset not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Upload Multiple Files
POST`/upload/aspera/bulk`

Description

Creates multiple asset records and responds with Aspera transfer configuration information so the client can initiate a bulk upload using an Aspera client or server.

You can also retrieve the Aspera transfer configuration information for existing assets.

Both new assets and existing assets can be mixed in the same request.

The maximum number of assets for bulk Aspera upload is 500.

Your plan must have enough free space to accommodate all new assets or the transaction will fail.

You will need access to an Aspera server or client that can initiate aspera transfers to effectively use the information that this operation returns.

The names provided in this request must match the filenames transferred using Aspera. If the assets are uploaded again using the same token the source file will get overwritten, however, the proxies will not be recreated.

This resource will return a failure response if any of the provided asset information is invalid.

Errors

Status Code	Error Code	Message
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	MissingOrInvalidName	Missing or invalid name. The file name must not be null and its length must be equal to or less than 512 characters.
400	InvalidDescription	Invalid description. The description length must equal to or less than 1000 characters.
400	MissingOrInvalidFileSize	Missing or invalid file size.
400	InvalidFileType	Invalid file type.
400	ExceededMaxAssetCount	Max asset count exceeded. The maximum number of assets is 500.
400	WorkspaceNotFound	Workspace not found.
400	InvalidOperationOnWorkspace	Invalid workspaces provided. Creating assets in bulk is limited to one workspace.
400	FolderNotFound	Folder not found.
400	FolderNotMemberOfWorkspace	Folder is not a member of the provided workspace.
400	AssetNotFound	Asset not found.
400	InvalidIngestConfiguration	Invalid ingest configuration.
400	DataTransferLimitExceeded	Data Transfer limit exceeded.
409	FolderDeleted	Folder is deleted.
409	FolderTrashed	Folder is trashed.
409	AssetTrashed	Asset is trashed.
409	InvalidAssetState	Asset cannot be uploaded. To upload an asset it cannot be trashed and its status must be ‘Created’, ‘Failed’, or ‘Virus Detected’.
409	InsufficientSpaceAvailable	Upload will exceed the workspace’s allotted storage.
409	EntitlementRequired	Workspace does not have Aspera enabled.

Get Upload Status ¶

POST https://api.cimediacloud.com/assets/yiireizq1hcowxua/upload/status

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200404

Headers

Content-Type: application/json

Body

{
  "status": "Completed",
  "errorMessage": "",
  "bytesWritten": 53687091200,
  "bytesExpected": 53687091200,
  "elapsed": 345897,
  "percentComplete": 100,
  "transferType": "Aspera"
}

Property name	Type	Description
status	`string`	The status of the upload. Valid values are: ‘Completed’, ‘Running’, ‘Paused’, ‘Cancelled’, ‘Error’, ‘Willretry’, ‘Orphaned’.
errorMessage	`string`	If available, a description of any error encountered.
bytesWritten	`number`	If available, number of bytes written to disk.
bytesExpected	`number`	Number of bytes expected to be written in total.
elapsed	`number`	If available, number of microseconds since the upload was initiated.
percentComplete	`number`	If available, this is the percent complete expressed as a whole number.
transferType	`string`	The type of transfer. Will always be Aspera.

Headers

Content-Type: application/json

Body

{
  "code": "AssetNotFound",
  "message": "Asset not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Get Upload Status
POST`/assets/{assetId}/upload/status`

URI Parameters

HideShow

assetId: string (required)
The unique identifier of the asset.

Description

Provides status information about Aspera file transfers for a given asset id.

Retrieving upload status for assets that were uploaded using Aspera more than 1 hour ago may result in incomplete transfer information. This is due to the fact that asset upload information is only available by querying the actual Aspera instance used to upload the asset. Therefore, if the Aspera instance used to upload your asset is no longer online the upload information will be derived from other data sources.

Errors

Status Code	Error Code	Message
404	AssetNotFound	Asset not found.
404	AssetDeleted	Asset is deleted.
409	AssetUploadNotInitiated	Asset upload status is unavailable at this time. You must initiate an upload before requesting upload status.
409	AssetUploadStatusUnavailable	Asset was uploaded using multipart HTTP. The current version of Ci does not support retrieving asset upload status for assets uploaded using multipart HTTP. Use this resource instead: /upload/multipart/{assetId}.
409	AssetUploadStatusUnavailable	Asset was uploaded using singlepart HTTP. Asset upload status cannot be retrieved for assets uploaded using singlepart HTTP.
409	AssetUploadStatusUnavailable	Asset upload status is unavailable at this time. Either the upload has not been initiated or upload status cannot be found.
409	EntitlementRequired	Workspace does not have Aspera enabled.

Asset Import from URL ¶

Ci API provides four different ways to upload assets:

Singlepart HTTP upload
Multipart HTTP upload
Aspera upload
URL import

The asset import from URL resource allows clients to provide an asset’s source file from a publicly accessible URL. This eliminates the need to download a file from an external system before uploading it to Ci.

It is important to note that an asset record can be created as part of the import process or it can be created separately - allowing you the flexibility to import the asset’s source file at any time.

Create Asset and Import ¶

POST https://api.cimediacloud.com/upload/url

Requestssimple examplefull example

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "name": "Movie.mov",
  "size": 1024,
  "workspaceId": "oj7mx3vlb2srei89",
  "folderId": "6ovu49kdb3z32z2w",
  "url": "http://example.com/video.mov"
}

Property name	Type	Description
name	`string` (required)	The name of the asset, including its extension. Its maximum length is 512 characters.
size	`number` (required)	The size of the asset, in bytes.
workspaceId	`string`	The workspace that will contain the asset. If no value is provided, the asset will be placed in the calling user’s personal workspace.
folderId	`string`	The workspace’s folder that will contain the asset. If no value is provided, the asset will be placed in the workspace’s root folder.
url	`string` (required)	The URL of the asset to be created. The url must be publicly accessible, and must use `http` or `https`.

Responses200400

Headers

Content-Type: application/json

Body

{
  "assetId": "5v99qywnb6gzneha"
}

Property name	Type	Description
assetId	`string`	The unique identifier for the asset.

Headers

Content-Type: application/json

Body

{
  "code": "FolderNotFound",
  "message": "Folder not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "name": "Movie.mov",
  "size": 1024,
  "workspaceId": "oj7mx3vlb2srei89",
  "folderId": "6ovu49kdb3z32z2w",
  "description": "sample description",
  "metadata": {
    "key name 1": "value",
    "key name 2": "value"
  },
  "url": "http://example.com/video.mov",
  "ingestConfiguration": {
    "autoArchive": true,
    "audioMappings": [
      {
        "mappings": [
          {
            "sourceStream": 1,
            "sourceChannel": 2,
            "targetChannel": 3,
            "amplitude": 0.8
          }
        ]
      }
    ],
    "include": {
      "proxies": [
        {
          "type": "video-3g"
        }
      ],
      "thumbnails": [
        {
          "type": "small"
        }
      ]
    }
  }
}

Property name	Type	Description
name	`string` (required)	The name of the asset, including its extension. Its maximum length is 512 characters.
size	`number` (required)	The size of the asset, in bytes.
workspaceId	`string`	The workspace that will contain the asset. If no value is provided, the asset will be placed in the calling user’s personal workspace.
folderId	`string`	The workspace’s folder that will contain the asset. If no value is provided, the asset will be placed in the workspace’s root folder.
description	`string`	A brief note associated to the asset. Its maximum length is 1000 characters.
metadata	`object`	An object containing key-value pairs of user-generated metadata.
metadata.key name 1	`string`	An example key-value.
metadata.key name 2	`string`	An example key-value.
url	`string` (required)	The URL of the asset to be created. The url must be publicly accessible, and must use `http` or `https`.
ingestConfiguration	`object`	Settings for customizing the ingest process of the asset.
ingestConfiguration.autoArchive	`boolean`	Indicates if the asset shall be archived right after ingestion.
ingestConfiguration.audioMappings	`array`	A set of objects that specifies ingest customizations that will be used when generating proxies. Currently, we support a single object in this array. If more than 1 object is provided, only the first will be processed and the rest will be ignored.
ingestConfiguration.audioMappings[].mappings	`array`	A set of objects that defines the mapping of a source file’s audio streams to the proxies’ audio streams.
ingestConfiguration.audioMappings[].mappings[].sourceStream	`number`	Index of an audio stream from the source file that will be mapped to each proxy’s audio stream. This index is zero-based.
ingestConfiguration.audioMappings[].mappings[].sourceChannel	`number`	Channel index of the specified source stream that will be mapped to each proxy’s target channels. This index is zero-based and the default is 0.
ingestConfiguration.audioMappings[].mappings[].targetChannel	`number`	Channel index of the proxies’ audio stream. This index is zero-based and the default is 0.
ingestConfiguration.audioMappings[].mappings[].amplitude	`number`	Number between 0 and 1 that determines the amplitude of the proxies’ target channel based on the source channel amplitude. Default is 1.
ingestConfiguration.include	`object`	A set of objects that specifies ingest customizations that will be used when generating proxies and thumbnails.
ingestConfiguration.include.proxies	`array`	The full list of proxies to create.
ingestConfiguration.include.proxies[].type	`string`	The type of the proxy (or set of proxies) to which the customizations will apply. The list of valid values can be obtained from Previews. The “default-proxies” value means the configuration applies to all default proxies.
ingestConfiguration.include.thumbnails	`array`	The full list of thumbnails to create.
ingestConfiguration.include.thumbnails[].type	`string`	The type of the thumbnail (or set of thumbnails) to which the customizations will apply. The list of valid values can be obtained from Previews. The “default-thumbnails” value means the configuration applies to all default thumbnails.

Responses200400

Headers

Content-Type: application/json

Body

{
  "assetId": "5v99qywnb6gzneha"
}

Property name	Type	Description
assetId	`string`	The unique identifier for the asset.

Headers

Content-Type: application/json

Body

{
  "code": "FolderNotFound",
  "message": "Folder not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Create Asset and Import
POST`/upload/url`

Description

This operation creates the asset record and initiates the import, returning the asset identifier to be used in subsequent requests.

The source file URL must be:

Publicly accessible
Use http or https scheme
No more than 2048 characters

Also, the name provided in the request will become the name of the asset in Ci (the name of the file in the URL will be ignored).

As security is paramount to all that we do, we don’t allow the following types of files to be uploaded to Ci:

Batch files
COM files
Executable files
HTML files
JavaScript files
JavaServer Pages
MSI files
PHP files
Python files
Ruby files
SWF files
VBScript files

Errors

Status Code	Error Code	Message
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	MissingOrInvalidName	Missing or invalid name. The file name must not be null and its length must be equal to or less than 512 characters.
400	InvalidDescription	Invalid description. The description length must equal to or less than 1000 characters.
400	InvalidFileType	Invalid file type.
400	WorkspaceNotFound	Workspace not found.
400	FolderNotFound	Folder not found.
400	FolderNotMemberOfWorkspace	Folder is not a member of the provided workspace.
400	InvalidIngestConfiguration	Invalid ingest configuration.
400	InvalidSourceFileUrl	Source file URL is invalid.
409	InsufficientSpaceAvailable	Upload will exceed the workspace’s allotted storage.

Import to Created Asset ¶

POST https://api.cimediacloud.com/assets/yiireizq1hcowxua/upload/url

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "url": "http://example.com/video.mov"
}

Property name	Type	Description
url	`string` (required)	The URL of the asset to be created. The url must be publicly accessible, and must use `http` or `https`.

Responses200404

Headers

Content-Type: application/json

Body

{
  "assetId": "5v99qywnb6gzneha"
}

Property name	Type	Description
assetId	`string`	The unique identifier for the asset.

Headers

Content-Type: application/json

Body

{
  "code": "AssetNotFound",
  "message": "Asset not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Import to Created Asset
POST`/assets/{assetId}/upload/url`

URI Parameters

HideShow

assetId: string (required)
The unique identifier of the asset.

Description

Initiates an import to an asset that has already been created but has not been backed by a source file yet. If you want to create the asset record and import its source file at the same time, use Create Asset and Import instead.

The source file URL must be:

Publicly accessible
Use http or https scheme
No more than 2048 characters

Also, the name provided in the request will become the name of the asset in Ci (the name of the file in the URL will be ignored).

Errors

Status Code	Error Code	Message
400	InvalidSourceFileUrl	Source file URL is invalid.
404	AssetNotFound	Asset not found.
409	InvalidAssetState	Asset cannot be uploaded. To upload an asset it cannot be trashed and its status must be ‘Created’, ‘Failed’, or ‘Virus Detected’.

Media Services ¶

When an asset is uploaded into Ci we will automatically initiate jobs. These jobs typically include creating proxies and thumbnails, extracting metadata, generating MD5 checksum, checking for viruses, and others. However, in some cases, these jobs are not performed or there may be additional jobs that would add value to the asset. This suite of API resources gives customers the ability to run specific jobs on demand for any asset and check the status of those jobs.

Additionally, Ci provides the ability to transcode assets with various specifications so customers can create new Assets using our transcoding capabilities.

Media Service Jobs for Assets ¶

POST https://api.cimediacloud.com/assets/yiireizq1hcowxua/jobs

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "proxies": [
    {
      "type": "video-2k",
      "requestItemId": "a1"
    }
  ],
  "captions": [
    {
      "type": "cc-example",
      "requestItemId": "a2"
    }
  ],
  "thumbnails": [
    {
      "type": "small",
      "requestItemId": "a3"
    }
  ],
  "general": [
    {
      "type": "technicalMetadata",
      "requestItemId": "a4"
    }
  ]
}

Property name	Type	Description
proxies	`array`	The specifications for proxy jobs.
proxies[].type	`string`	The type of proxy job to be created. Check the Previews section for available proxy types. Proxies can also be generated with custom profiles; please contact Customer Service if you want to learn more.
proxies[].requestItemId	`string`	Caller provided string to be used as an identifier for this request.
captions	`array`	The specifications for caption jobs.
captions[].type	`string`	The type of caption job to be created. Captions can only be generated with custom profiles; please contact Customer Service if you want to learn more.
captions[].requestItemId	`string`	Caller provided string to be used as an identifier for this request.
thumbnails	`array`	The specifications for thumbnail jobs.
thumbnails[].type	`string`	The size of thumbnail to be created, such as ‘small’ or ‘large’. Check the Previews section for available thumbnail sizes.
thumbnails[].requestItemId	`string`	Caller provided string to be used as an identifier for this request.
general	`array`	The specifications for general jobs.
general[].type	`string`	The type of general job to be created. Currently, the only general jobs available are “technicalMetadata” and “dolby-technicalMetadata”. Invalid general job types will be ignored.
general[].requestItemId	`string`	Caller provided string to be used as an identifier for this request.

Responses200409

Headers

Content-Type: application/json

Body

{
  "count": 1,
  "errorCount": 1,
  "errors": [
    {
      "name": "Item name",
      "kind": "Item",
      "errorCode": "ItemNotFound",
      "errorMessage": "Item not found.",
      "assetId": "u57kfgxbynrkt267"
    }
  ],
  "complete": [
    {
      "jobId": "4xjxx1bcvxvajef6",
      "assetId": "irefisy6y6vwhsrl",
      "elementId": "9buxd3oqybkvqxtv",
      "type": "video",
      "kind": "Proxy"
    }
  ]
}

Property name	Type	Description
count	`number`	The number of items.
errorCount	`number`	The number of invalid items.
errors	`array`	An array containing information about each failed item.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].assetId	`string`	The unique identifier for the asset.
complete	`array`	An array containing information about each successfully created job.
complete[].jobId	`string`	The unique identifier of the job.
complete[].assetId	`string`	The unique identifier of the asset.
complete[].elementId	`string`	If applicable, the unique identifier of the element that will be created as result of the job execution. Currently, files output using custom profiles will contain an elementId and are accessible via our Elements APIs.
complete[].type	`string`	2k (string) - Indicates the type of the job. For jobs that generate an asset preview (a proxy or a thumbnail), please check the Previews section for available types. For General jobs, this value will be ‘TechnicalMetadata’, ‘ExecutableCheck’, ‘Checksum’, or ‘VirusScan’. For Caption kinds of jobs, please contact Customer Service to learn more.
complete[].kind	`string`	Indicates the kind of the job. This value will be ‘Proxy’ for proxies, ‘Thumbnail’ for thumbnails, ‘Caption’ for caption files, and ‘General’ for general jobs.

Headers

Content-Type: application/json

Body

{
  "completeCount": 0,
  "errorCount": 1,
  "errors": [
    {
      "name": "Item name",
      "kind": "Item",
      "errorCode": "ItemNotFound",
      "errorMessage": "Item not found.",
      "assetId": "u57kfgxbynrkt267"
    }
  ]
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors	`array`	An array containing information about each failed item.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].assetId	`string`	The unique identifier for the asset.

Create Job for an Asset
POST`/assets/{assetId}/jobs`

URI Parameters

HideShow

assetId: string (required)
The unique identifier of the asset.

Description

Allows for the creation of jobs an a single asset.

Kinds of jobs currently available:

Proxies - Creates new proxies for the asset. Proxies can only be created for video or audio assets. Check the Previews section for available proxy types. You can also create custom profile proxies; see the note below for more information.
Captions - Creates new caption files for the asset. Caption files can only be requested using a custom profile; see the note below for more information.
Thumbnails - Creates new thumbnails for the asset. Thumbnails can only be created for video, audio or image assets. Check the Previews section for available thumbnail sizes.
General - Creates other, general jobs. Additional job types will be added soon.
- Technical Metadata - Extracts technical metadata from the asset.
- Dolby Metadata - Extracts Dolby Atmos technical metadata from the asset.

Custom profiles are a feature of Company Networks that let you define custom proxy and caption file specifications. Files generated using custom profiles are available as Elements of an asset. If you want to learn more, please drop a line to Customer Service.

To create jobs for an archived asset it must be restored with a restore expiration date that is greater than 24 hours. To extend the restore date for an asset you can use the Restore resource.

Errors

Status Code	Error Code	Message	Notes
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	AssetIdNotProvided	Asset Id not provided.
400	AssetNotReady	Asset not ready. Its status must be either “Complete” or “Limited”.
400	InvalidRequest	Multiple technical metadata job requests are not supported.
404	AssetNotFound	Asset not found.
404	AssetDeleted	Asset is deleted.
409	AssetTrashed	Asset is trashed.
409	InvalidAssetState	Asset has not been uploaded and jobs cannot be created.
409	InvalidAssetState	Asset is archived and jobs cannot be created. The asset must be restored before any jobs can be created.
409	InvalidAssetState	Asset is currently being archived and jobs cannot be created. The asset archive operation must complete and the asset must be restored before any jobs can be created.
409	InvalidAssetState	Asset is currently being restored and jobs cannot be created. The asset restore operation must complete before any jobs can be created.
409	InvalidAssetState	Asset restore expires in less than 24 hours. The asset restore expiration must be longer than 24 hours before any jobs can be created.
409	BulkOperationFailed	The bulk operation failed. See the errors array for more information.	This message appears if there were no successfully created jobs.

Errors represented in errors array

Error Code	Message
InvalidJobRequest	Invalid job configuration.
InvalidJobRequest	Invalid file type for job. The job specified is not compatible with the provided file type.
EntitlementRequired	Entitlement is required for specified job.
JobAlreadyExists	Job already exists.

GET https://api.cimediacloud.com/assets/yiireizq1hcowxua/jobs

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200404

Headers

Content-Type: application/json

Body

{
  "count": 1,
  "errorCount": 0,
  "errors": [],
  "items": [
    {
      "jobId": "4xjxx1bcvxvajef6",
      "assetId": "irefisy6y6vwhsrl",
      "elementId": "9buxd3oqybkvqxtv",
      "type": "video",
      "kind": "Proxy",
      "status": "Complete",
      "progress": {
        "percentComplete": 100
      }
    }
  ]
}

Property name	Type	Description
count	`number`	The number of items.
errorCount	`number`	The number of invalid items.
errors		This array will be empty.
items	`array`	An array containing information about each successfully created job.
items[].jobId	`string`	The unique identifier of the job.
items[].assetId	`string`	The unique identifier of the asset.
items[].elementId	`string`	If applicable, the unique identifier of the element that will be created as result of the job execution. Currently, files output using custom profiles will contain an elementId and are accessible via our Elements APIs.
items[].type	`string`	2k (string) - Indicates the type of the job. For jobs that generate an asset preview (a proxy or a thumbnail), please check the Previews section for available types. For General jobs, this value will be ‘TechnicalMetadata’, ‘ExecutableCheck’, ‘Checksum’, or ‘VirusScan’. For Caption kinds of jobs, please contact Customer Service to learn more.
items[].kind	`string`	Indicates the kind of the job. This value will be ‘Proxy’ for proxies, ‘Thumbnail’ for thumbnails, ‘Caption’ for caption files, and ‘General’ for general jobs.
items[].status	`string`	Indicates the processing status of the job. Returned values include ‘Waiting’, ‘Processing’, ‘Complete’ or ‘Failed’.
items[].progress	`object`	If available, an object that contains detailed progress information.
items[].progress.percentComplete	`number`	If available, this is the percent complete expressed as a decimal value.

Headers

Content-Type: application/json

Body

{
  "code": "AssetNotFound",
  "message": "Asset not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Get Jobs for an Asset
GET`/assets/{assetId}/jobs`

URI Parameters

HideShow

assetId: string (required)
The unique identifier of the asset.

Description

Gets job details for any jobs created during the ingest process that happens after upload and any jobs created using the Create Jobs resource.

Errors

Status Code	Error Code	Message
404	AssetNotFound	Asset not found.
404	AssetDeleted	Asset is deleted.
409	AssetTrashed	Asset is trashed.

General Media Service Jobs ¶

POST https://api.cimediacloud.com/jobs/

Requeststranscode video example

Headers

Content-Type: application/json
Authorization: Basic [bearer token]

Body

{
  "transcode": {
    "target": {
      "kind": "asset",
      "name": "Movie.mov",
      "workspaceId": "mcwrvvjlg7itptt7",
      "folderId": "irefisy6y6vwhsrl",
      "type": "video-hd"
    },
    "sources": [
      {
        "id": "sourceId1",
        "kind": "asset",
        "assetId": "mcwrvvjlg7itptt7",
        "elementId": "c1"
      }
    ],
    "requestItemId": "r1",
    "options": {
      "videoSourceId": "sourceId1",
      "markIn": {
        "value": 2,
        "unit": "seconds"
      },
      "markOut": {
        "value": 60,
        "unit": "seconds"
      },
      "embedCaptions": {
        "sourceId": "c1"
      },
      "audioMapping": {
        "mappings": [
          {
            "sourceStream": 1,
            "sourceChannel": 2,
            "targetChannel": 3,
            "amplitude": 0.8
          }
        ]
      }
    }
  }
}

Property name	Type	Description
transcode	`object` (required)	The specifications for transcode video jobs. This can be a single transcode video specification or it can contain an array of transcode specifications.
transcode.target	`object` (required)	The target file’s location and specifications.
transcode.target.kind	`string`	Describes the kind of the target output. For this resource `Asset` is the only accepted option.
transcode.target.name	`string` (required)	Indicates the asset name for the target asset upon completion. The name must have the correct file extension to match any requested transcode format.
transcode.target.workspaceId	`string`	Indicates which Workspace will contain the target asset upon completion. If omitted, this defaults to the personal Workspace of the authenticated user account.
transcode.target.folderId	`string`	Indicates which folder will contain the target asset upon completion. If omitted, this defaults to the root folder of the selected Workspace.
transcode.target.type	`string` (required)	Specifies the media format of the rendered video, for example `video-hd`. Check the Previews section for available target types. Additional types may be available upon request.
transcode.sources	`array` (required)	A list of source Assets or Elements.
transcode.sources[].id	`string`	Caller provided identifier for the source, unique within the request, used to link to a reference in the `otions` to an item in the `sources` array.
transcode.sources[].kind	`string`	Describes the kind of the target output. For this resource `Asset` and `Element` are accepted options.
transcode.sources[].assetId	`string`	Indicates the id of an existing asset.
transcode.sources[].elementId	`string`	Indicates the id of an existing element.
transcode.requestItemId	`string`	Any string to be used as an identifier for this job request.
transcode.options	`object`	Optional specifications for transcode.
transcode.options.videoSourceId	`string`	The id from the sources array that will be used as the source video for transcoding.
transcode.options.markIn	`object`	When trimming a video, information about the start point of the clip.
transcode.options.markIn.value	`number`	The time value that represents the start point of the clip.
transcode.options.markIn.unit	`string`	The unit of time that represents the clip mark in start point. This value can be `milliseconds` or `seconds`.
transcode.options.markOut	`object`	When trimming a video, information about the end point of the clip.
transcode.options.markOut.value	`number`	The time value that represents the end point of the clip.
transcode.options.markOut.unit	`string`	The unit of time that represents the clip mark out end point. This value can be `milliseconds` or `seconds`.
transcode.options.embedCaptions	`object`	Information about the captions to embed.
transcode.options.embedCaptions.sourceId	`string`	The id from the sources array that will be used as the captions file to embed as a stream in the transcoded output.
transcode.options.audioMapping	`object`	Information about the audio channel mapping to perform from the source to the target.
transcode.options.audioMapping.mappings	`array`	A set of objects that defines the mapping of a source file’s audio streams to the proxies’ audio streams.
transcode.options.audioMapping.mappings[].sourceStream	`number`	Index of an audio stream from the source file that will be mapped to each target’s audio stream. This index is zero-based.
transcode.options.audioMapping.mappings[].sourceChannel	`number`	Channel index of the specified source stream that will be mapped to each target’s channels. This index is zero-based and the default is 0.
transcode.options.audioMapping.mappings[].targetChannel	`number`	Channel index of the target audio stream. This index is zero-based and the default is 0.
transcode.options.audioMapping.mappings[].amplitude	`number`	Number between 0 and 1 that determines the amplitude of the target channel based on the source channel amplitude. Default is 1.

Responses200400

Headers

Content-Type: application/json

Body

{
  "completeCount": 1,
  "errorCount": 1,
  "errors": [
    {
      "kind": "VideoTranscode",
      "errorCode": "InvalidFileType",
      "errorMessage": "Invalid file type.",
      "requestItemId": "r1"
    }
  ],
  "complete": [
    {
      "jobId": "4xjxx1bcvxvajef6",
      "kind": "Kind",
      "assetId": "irefisy6y6vwhsrl",
      "requestItemId": "r1"
    }
  ]
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors	`array`	An array containing information about each failed job request.
errors[].kind	`string`	The kind of the job.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].requestItemId	`string`	Request item id for this request, if it was supplied.
complete	`array`	An array containing information about each successfully created job.
complete[].jobId	`string`	The unique identifier of the job.
complete[].kind	`string`	The kind of job created.
complete[].assetId	`string`	The unique identifer of the asset.
complete[].requestItemId	`string`	Caller provided id for this request, if supplied.

Headers

Content-Type: application/json

Body

{
  "completeCount": 0,
  "errorCount": 1,
  "errors": [
    {
      "kind": "VideoTranscode",
      "errorCode": "InvalidFileType",
      "errorMessage": "Invalid file type.",
      "requestItemId": "r1"
    }
  ]
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors	`array`	An array containing information about each failed item.
errors[].kind	`string`	The kind of the job.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].requestItemId	`string`	Request item id for this request, if it was supplied.

Create Job
POST`/jobs/`

Description

Gives customers the ability to create new assets or elements by transcoding a source video asset with optional specifications including mark in / out settings for video trimming, captions to embed, and audio channel mapping. Check the Previews section for available target output types. Additional types may be available upon request.

Creating a trimmed video clip

To output a trimmed video asset you will need to provide the options.videoSourceId along with options.markIn and options.markOut and Ci will trim the asset according those specifications. It is permitted to omit the markIn and/or markOut object. If markIn is omitted, the beginning of the source video is assumed. If the markOut is omitted, the end of the source video is assumed. The markOut must be greater than the markIn.

Adding captions

To include a caption file as a stream in the transcoded target you will need to provde the options.embeddedCaptions.sourceId that references a source caption file in the sources array. The source captions file can be an Asset or Element.

When trimming a video source and embedding closed captions, Ci will trim the target output to the duration of the captions that appear in the specified mark in / out range. If the duration of a caption at mark in or mark out exceeds the provided trim values we will favor the caption file and trim the target output accordingly. This may result in a longer runtime than specified.

For example, if the specified mark in is 60 seconds and the mark out is 120 seconds but there are captions that run from 58 seconds to 62 seconds and 118 seconds to 122 seconds. The actual trim values would be 58 seconds to 122 seconds to ensure all captions are accurately included in the target output.

Errors

Status Code	Error Code	Message	Notes
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
409	BulkOperationFailed	The bulk operation failed. See the errors array for more information.	This message appears if there were no successfully created jobs.

Errors represented in errors array

Error Code	Message
AssetNotFound	Asset not found.
FolderNotFound	Folder not found.
FolderNotMemberOfWorkspace	Folder is not a member of the provided workspace.
FolderTrashed	Folder is trashed.
FolderDeleted	Folder is deleted.
InvalidRequest	Invalid source, target, or clip specifications. Review API documentation for valid requirements.
InvalidJobSource	One or more sources are invalid. Review API documentation for valid source requirements.
InvalidFileType	Invalid file type.
InsufficientSpaceAvailable	Upload will exceed the workspace’s allotted storage.
WorkspaceNotFound	Workspace not found.

GET https://api.cimediacloud.com/jobs/yiireizq1hcowxua

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200404

Headers

Content-Type: application/json

Body

{
  "jobId": "4xjxx1bcvxvajef6",
  "assetId": "irefisy6y6vwhsrl",
  "elementId": "9buxd3oqybkvqxtv",
  "type": "video",
  "kind": "Proxy",
  "status": "Complete",
  "progress": {
    "percentComplete": 100
  }
}

Property name	Type	Description
jobId	`string`	The unique identifier of the job.
assetId	`string`	The unique identifier of the asset.
elementId	`string`	If applicable, the unique identifier of the element that will be created as result of the job execution. Currently, files output using custom profiles will contain an elementId and are accessible via our Elements APIs.
type	`string`	2k (string) - Indicates the type of the job. For jobs that generate an asset preview (a proxy or a thumbnail), please check the Previews section for available types. For General jobs, this value will be ‘TechnicalMetadata’, ‘ExecutableCheck’, ‘Checksum’, or ‘VirusScan’. For Caption kinds of jobs, please contact Customer Service to learn more.
kind	`string`	Indicates the kind of the job. This value will be ‘Proxy’ for proxies, ‘Thumbnail’ for thumbnails, ‘Caption’ for caption files, and ‘General’ for general jobs.
status	`string`	Indicates the processing status of the job. Returned values include ‘Waiting’, ‘Processing’, ‘Complete’ or ‘Failed’.
progress	`object`	If available, an object that contains detailed progress information.
progress.percentComplete	`number`	If available, this is the percent complete expressed as a decimal value.

Headers

Content-Type: application/json

Body

{
  "code": "JobNotFound",
  "message": "Job not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Get Job Details
GET`/jobs/{jobId}`

URI Parameters

HideShow

jobId: string (required)
The unique identifier of the job.

Description

Gets details for any Media Service created job.

Errors

Status Code	Error Code	Message
404	JobNotFound	Job not found.

Get Multiple Jobs' Details ¶

POST https://api.cimediacloud.com/jobs/details/bulk

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "jobIds": [
    "6i3x3hp1ni2wo5bd"
  ]
}

Property name	Type	Description
jobIds	`array`	The unique identifiers for all jobs.

Responses200409

Headers

Content-Type: application/json

Body

{
  "count": 1,
  "errorCount": 1,
  "errors": [
    {
      "jobId": "6i3x3hp1ni2wo5bd",
      "errorCode": "JobNotFound",
      "errorMessage": "Job not found."
    }
  ],
  "items": [
    {
      "jobId": "4xjxx1bcvxvajef6",
      "assetId": "irefisy6y6vwhsrl",
      "elementId": "9buxd3oqybkvqxtv",
      "type": "video",
      "kind": "Proxy",
      "status": "Complete",
      "progress": {
        "percentComplete": 100
      }
    }
  ]
}

Property name	Type	Description
count	`number`	The number of items.
errorCount	`number`	The number of invalid items.
errors	`array`	Information about the errors.
errors[].jobId	`string`	The unique identifier of the job.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
items	`array`	An array containing information about each successfully created job.
items[].jobId	`string`	The unique identifier of the job.
items[].assetId	`string`	The unique identifier of the asset.
items[].elementId	`string`	If applicable, the unique identifier of the element that will be created as result of the job execution. Currently, files output using custom profiles will contain an elementId and are accessible via our Elements APIs.
items[].type	`string`	2k (string) - Indicates the type of the job. For jobs that generate an asset preview (a proxy or a thumbnail), please check the Previews section for available types. For General jobs, this value will be ‘TechnicalMetadata’, ‘ExecutableCheck’, ‘Checksum’, or ‘VirusScan’. For Caption kinds of jobs, please contact Customer Service to learn more.
items[].kind	`string`	Indicates the kind of the job. This value will be ‘Proxy’ for proxies, ‘Thumbnail’ for thumbnails, ‘Caption’ for caption files, and ‘General’ for general jobs.
items[].status	`string`	Indicates the processing status of the job. Returned values include ‘Waiting’, ‘Processing’, ‘Complete’ or ‘Failed’.
items[].progress	`object`	If available, an object that contains detailed progress information.
items[].progress.percentComplete	`number`	If available, this is the percent complete expressed as a decimal value.

Headers

Content-Type: application/json

Body

{
  "completeCount": 0,
  "errorCount": 1,
  "errors": [
    {
      "jobId": "6i3x3hp1ni2wo5bd",
      "errorCode": "JobNotFound",
      "errorMessage": "Job not found."
    }
  ]
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors	`array`	Information about the errors.
errors[].jobId	`string`	The unique identifier of the job.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.

Get Multiple Jobs' Details
POST`/jobs/details/bulk`

Description

Gets details for any jobs created using the Create Jobs resource.

500 is the maximum number of jobs that can be retrieved in a single operation.

Errors

Status Code	Error Code	Message	Notes
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	JobIdNotProvided	Job Id not provided.
400	ExceededMaxJobCount	Max job count exceeded. The maximum number of jobs is 500.
409	BulkOperationFailed	The bulk operation failed. See the errors array for more information.	This message appears if there were no successfully retrieved jobs.

Errors represented in errors array

Error Code	Message
JobNotFound	Job not found.

Elements ¶

Sometimes one file just isn’t enough to fully express yourself. That’s why we’ve created Elements. Elements are separate files that can be uploaded and associated with your primary Assets. Add a QC report, camera metadata, chapter stops, caption file, camera LUT, basically, anything you need to increase the value of your content and to make your workflow easier.

Tag each element with one or more custom keys to facilitate their retrieval and downstream use later. You can also add metadata as a set of key-value pairs for each element.

As part of the upload process, we will generate a checksum and scan the file for viruses. Additional proxies and thumbnails are not generated for elements.

Get Element Details ¶

GET https://api.cimediacloud.com/elements/yiireizq1hcowxua?downloadExpirationDate=2017-01-02T00:00:00.000Z&elementNameOverride=override-element-name

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200404

Headers

Content-Type: application/json

Body

{
  "id": "9buxd3oqybkvqxtv",
  "asset": {
    "id": "d9bf018c804a4e78b775b8dc2f242071",
    "name": "Movie.mov"
  },
  "size": 1024,
  "downloadUrl": "https://cimediacloud.com/t5y7s3ero3w2ie7/element.jpg",
  "name": "Element.mov",
  "createdOn": "2017-01-02T00:00:00.000Z",
  "md5Checksum": "oaeybnyoggs97nzw",
  "metadata": [
    {
      "name": "resolution",
      "value": "1080p",
      "readOnly": false
    }
  ],
  "status": "Complete",
  "customKeys": [
    "examplekey"
  ],
  "isLocked": true,
  "lastLockActionBy": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith",
    "email": "johnsmith@example.com"
  },
  "lastLockActionOn": "2019-01-02T00:00:00.000Z",
  "isExternal": false
}

Property name	Type	Description
id	`string`	The unique identifier of the element.
asset	`object`	Information about the element’s parent asset.
asset.id	`string`	The unique identifier of the asset.
asset.name	`string`	The name of asset and its extension.
size	`number`	The size in bytes of the element.
downloadUrl	`string`	A link to the element.
name	`string`	The name of the element.
createdOn	`string`	The datetime the element record was created.
md5Checksum	`string`	The MD5 checksum calculated on the element file.
metadata	`array`	An array of key-value pairs of user-generated metadata.
metadata[].name	`string`	The name of the metadata item.
metadata[].value	`string`	the value of the metadata item.
metadata[].readOnly	`boolean`	Flag to set a read-only metadata.
status	`string`	The status of the element. Valid values are ‘Created’, ‘Uploading’, ‘Processing’, ‘Complete’, ‘Deleted’, ‘Failed’, ‘Virus Detected’.
customKeys	`array`	An array of strings that represents custom keys over the element that the user wants to add.
isLocked	`boolean`	Indicates if the element is blocked.
lastLockActionBy	`object`	Information about the user who performed the last lock or unlock.
lastLockActionBy.id	`string`	The unique identifier of the user.
lastLockActionBy.name	`string`	The full name of the user.
lastLockActionBy.email	`string`	The email of the user.
lastLockActionOn	`string`	The datetime the element record was last locked or unlocked.
isExternal	`boolean`	Indicates if the file is stored in an external source.

Headers

Content-Type: application/json

Body

{
  "code": "ElementNotFound",
  "message": "Element not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Get Element Details
GET`/elements/{elementId}{?downloadExpirationDate,elementNameOverride}`

URI Parameters

HideShow

elementId: string (required)
The unique identifier of the element.
downloadExpirationDate: string (optional)
downloadExpirationDate: The date and time for download URL expiration in IS0 8601 date and time format (e.g.: ‘2020-01-01’). Value must be less than ‘2038-01-01’ and greater than the current date and time. If not provided, default of 3 hours is used.
elementNameOverride: string (optional)
elementNameOverride: The file name to use in place of the element name for download links.

Description

Retrieves the element information for the specified element.

Errors

Status Code	Error Code	Message
400	InvalidExpiration	Invalid expiration.
400	MissingOrInvalidName	Missing or invalid name. The file name must not be null and its length must be equal to or less than 512 characters.
404	ElementNotFound	Element not found.

Get Multiple Element Details ¶

POST https://api.cimediacloud.com/elements/details/bulk

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "assetIds": [
    "d9bf018c804a4e78b775b8dc2f242071"
  ],
  "elementIds": [
    "ad9289a2019a4e07a08eca9459ef1091"
  ],
  "limit": 1,
  "offset": 0,
  "orderBy": "name",
  "orderDirection": "asc"
}

Property name	Type	Description
assetIds	`array` (required)	The unique identifiers for all assets to retrieve.
elementIds	`array` (required)	The unique identifiers for all elements to retrieve.
limit	`number`	The number of items to return. The maximum is 50.
offset	`number`	The item at which to begin the response.
orderBy	`string`	The field to sort the items by. The supported values are `name` and `createdOn`.
orderDirection	`string`	The order direction the items should be returned. The supported values are `asc` and `desc`.

Responses200409

Headers

Content-Type: application/json

Body

{
  "count": 1,
  "errorCount": 1,
  "errors": [
    {
      "name": "Item name",
      "kind": "Item",
      "errorCode": "ItemNotFound",
      "errorMessage": "Item not found.",
      "id": "ad9289a2019a4e07a08eca9459ef1091"
    }
  ],
  "items": [
    {
      "id": "9buxd3oqybkvqxtv",
      "asset": {
        "id": "d9bf018c804a4e78b775b8dc2f242071",
        "name": "Movie.mov"
      },
      "size": 1024,
      "downloadUrl": "https://cimediacloud.com/t5y7s3ero3w2ie7/element.jpg",
      "name": "Element.mov",
      "createdOn": "2017-01-02T00:00:00.000Z",
      "md5Checksum": "oaeybnyoggs97nzw",
      "metadata": [
        {
          "name": "resolution",
          "value": "1080p",
          "readOnly": false
        }
      ],
      "status": "Complete",
      "customKeys": [
        "examplekey"
      ],
      "isLocked": true,
      "lastLockActionBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "lastLockActionOn": "2019-01-02T00:00:00.000Z",
      "isExternal": false
    }
  ]
}

Property name	Type	Description
count	`number`	The number of items.
errorCount	`number`	The number of invalid items.
errors	`array`	An array containing information for each error item.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].id	`string`	The unique identifier for the item.
items	`array`	An array containing information about each element.
items[].id	`string`	The unique identifier of the element.
items[].asset	`object`	Information about the element’s parent asset.
items[].asset.id	`string`	The unique identifier of the asset.
items[].asset.name	`string`	The name of asset and its extension.
items[].size	`number`	The size in bytes of the element.
items[].downloadUrl	`string`	A link to the element.
items[].name	`string`	The name of the element.
items[].createdOn	`string`	The datetime the element record was created.
items[].md5Checksum	`string`	The MD5 checksum calculated on the element file.
items[].metadata	`array`	An array of key-value pairs of user-generated metadata.
items[].metadata[].name	`string`	The name of the metadata item.
items[].metadata[].value	`string`	the value of the metadata item.
items[].metadata[].readOnly	`boolean`	Flag to set a read-only metadata.
items[].status	`string`	The status of the element. Valid values are ‘Created’, ‘Uploading’, ‘Processing’, ‘Complete’, ‘Deleted’, ‘Failed’, ‘Virus Detected’.
items[].customKeys	`array`	An array of strings that represents custom keys over the element that the user wants to add.
items[].isLocked	`boolean`	Indicates if the element is blocked.
items[].lastLockActionBy	`object`	Information about the user who performed the last lock or unlock.
items[].lastLockActionBy.id	`string`	The unique identifier of the user.
items[].lastLockActionBy.name	`string`	The full name of the user.
items[].lastLockActionBy.email	`string`	The email of the user.
items[].lastLockActionOn	`string`	The datetime the element record was last locked or unlocked.
items[].isExternal	`boolean`	Indicates if the file is stored in an external source.

Headers

Content-Type: application/json

Body

{
  "count": 0,
  "errorCount": 1,
  "errors": [
    {
      "name": "Item name",
      "kind": "Item",
      "errorCode": "ItemNotFound",
      "errorMessage": "Item not found.",
      "id": "ad9289a2019a4e07a08eca9459ef1091"
    }
  ]
}

Property name	Type	Description
count	`number`	The number of successful items.
errorCount	`number`	The number of invalid items.
errors	`array`	An array containing information for each error item.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].id	`string`	The unique identifier for the item.

Get Multiple Element Details
POST`/elements/details/bulk`

Description

Retrieves the elements for the specified asset and / or element list. This query supports pagination using limit and offset. The results can be ordered by createdOn, name and size.

500 is the maximum number of elements that can be retrieved in a single operation.

100 is the maximun combined number of asset ids and element ids that can be requested in a single operation.

Errors

Status Code	Error Code	Message	Notes
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	ItemIdNotProvided	Neither Asset Ids or Element Ids were provided.	This message appears only if both ElementIds and AssetIds parameters are empty
400	ExceededMaxItemCount	The sum of Asset ids and Element Ids exceeded the allowed value. The maximun number of items is 100.
400	InvalidLimitOrOffset	Invalid limit or offset value. Limit must be a number between 1 and 50. Offset must be greater than or equal to 0.
400	InvalidQueryOrderField	Invalid order field. It must be either ‘CreatedOn’ or ‘Name’.
400	InvalidQueryOrderDirection	Invalid order direction. It must be either ‘Asc’ or ‘Desc’.
409	BulkOperationFailed	The bulk operation failed. See the errors array for more information.	This message appears if there were no successfully retrieved elements.

Errors represented in errors array

Error Code	Message
AssetNotFound	Asset not found.
AssetDeleted	Asset is deleted.
ElementNotFound	Element not found.
ElementDeleted	Element is deleted.

Update an Element ¶

PUT https://api.cimediacloud.com/elements/yiireizq1hcowxua

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "name": "Movie.mov"
}

Property name	Type	Description
name	`string`	The name of the element. Its maximum length is 512 characters.

Responses200404

Headers

Content-Type: application/json

Body

{
  "id": "9buxd3oqybkvqxtv",
  "asset": {
    "id": "d9bf018c804a4e78b775b8dc2f242071",
    "name": "Movie.mov"
  },
  "size": 1024,
  "downloadUrl": "https://cimediacloud.com/t5y7s3ero3w2ie7/element.jpg",
  "name": "Element.mov",
  "createdOn": "2017-01-02T00:00:00.000Z",
  "md5Checksum": "oaeybnyoggs97nzw",
  "metadata": [
    {
      "name": "resolution",
      "value": "1080p",
      "readOnly": false
    }
  ],
  "status": "Complete",
  "customKeys": [
    "examplekey"
  ],
  "isLocked": true,
  "lastLockActionBy": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith",
    "email": "johnsmith@example.com"
  },
  "lastLockActionOn": "2019-01-02T00:00:00.000Z",
  "isExternal": false
}

Property name	Type	Description
id	`string`	The unique identifier of the element.
asset	`object`	Information about the element’s parent asset.
asset.id	`string`	The unique identifier of the asset.
asset.name	`string`	The name of asset and its extension.
size	`number`	The size in bytes of the element.
downloadUrl	`string`	A link to the element.
name	`string`	The name of the element.
createdOn	`string`	The datetime the element record was created.
md5Checksum	`string`	The MD5 checksum calculated on the element file.
metadata	`array`	An array of key-value pairs of user-generated metadata.
metadata[].name	`string`	The name of the metadata item.
metadata[].value	`string`	the value of the metadata item.
metadata[].readOnly	`boolean`	Flag to set a read-only metadata.
status	`string`	The status of the element. Valid values are ‘Created’, ‘Uploading’, ‘Processing’, ‘Complete’, ‘Deleted’, ‘Failed’, ‘Virus Detected’.
customKeys	`array`	An array of strings that represents custom keys over the element that the user wants to add.
isLocked	`boolean`	Indicates if the element is blocked.
lastLockActionBy	`object`	Information about the user who performed the last lock or unlock.
lastLockActionBy.id	`string`	The unique identifier of the user.
lastLockActionBy.name	`string`	The full name of the user.
lastLockActionBy.email	`string`	The email of the user.
lastLockActionOn	`string`	The datetime the element record was last locked or unlocked.
isExternal	`boolean`	Indicates if the file is stored in an external source.

Headers

Content-Type: application/json

Body

{
  "code": "ElementNotFound",
  "message": "Element not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Update an Element
PUT`/elements/{elementId}`

URI Parameters

HideShow

elementId: string (required)
The unique identifier of the element.

Description

Updates specified properties of an element. The current version of Ci API only supports renaming an element.

When renaming an element keep this information in mind:

If the correct element extension / format is not provided it will be appended.
The extension on the element may not be changed (type of the Element cannot be changed).
Invalid characters will be replaced by underscores. Invalid characters include, but may not be restricted to, the following:

< (less than)
> (greater than)
: (colon)
" (double quote)
/ (forward slash)
\ (backslash)
| (vertical bar or pipe)
? (question mark)
* (asterisk)

Errors

Status Code	Error Code	Message
400	ElementDeleted	Element is deleted.
400	AssetDeleted	Element’s parent asset is deleted.
400	AssetTrashed	Element’s parent asset is trashed.
400	MissingOrInvalidName	Missing or invalid name. The file name must not be null and its length must be equal to or less than 512 characters.
400	InvalidFileType	Invalid file type.
403	InsufficientPermissionsForUpdatingElement	Insufficient permissions for updating an element.
404	ElementNotFound	Element not found.
404	AssetNotFound	Asset not found.
409	InvalidOperationOnElementCode	The current element is locked. While locked, an element cannot be renamed.

List Elements for Asset ¶

GET https://api.cimediacloud.com/assets/moqxhkej4epvgrwz/elements?limit=1&offset=0&orderBy=name&orderDirection=asc

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200404

Headers

Content-Type: application/json

Body

{
  "count": 1,
  "errorCount": 1,
  "errors": [],
  "items": [
    {
      "id": "9buxd3oqybkvqxtv",
      "asset": {
        "id": "d9bf018c804a4e78b775b8dc2f242071",
        "name": "Movie.mov"
      },
      "size": 1024,
      "downloadUrl": "https://cimediacloud.com/t5y7s3ero3w2ie7/element.jpg",
      "name": "Element.mov",
      "createdOn": "2017-01-02T00:00:00.000Z",
      "md5Checksum": "oaeybnyoggs97nzw",
      "metadata": [
        {
          "name": "resolution",
          "value": "1080p",
          "readOnly": false
        }
      ],
      "status": "Complete",
      "customKeys": [
        "examplekey"
      ],
      "isLocked": true,
      "lastLockActionBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "lastLockActionOn": "2019-01-02T00:00:00.000Z",
      "isExternal": false
    }
  ]
}

Property name	Type	Description
count	`number`	The number of items.
errorCount	`number`	The number of invalid items.
errors		This array will have no items.
items	`array`	An array containing information about each element.
items[].id	`string`	The unique identifier of the element.
items[].asset	`object`	Information about the element’s parent asset.
items[].asset.id	`string`	The unique identifier of the asset.
items[].asset.name	`string`	The name of asset and its extension.
items[].size	`number`	The size in bytes of the element.
items[].downloadUrl	`string`	A link to the element.
items[].name	`string`	The name of the element.
items[].createdOn	`string`	The datetime the element record was created.
items[].md5Checksum	`string`	The MD5 checksum calculated on the element file.
items[].metadata	`array`	An array of key-value pairs of user-generated metadata.
items[].metadata[].name	`string`	The name of the metadata item.
items[].metadata[].value	`string`	the value of the metadata item.
items[].metadata[].readOnly	`boolean`	Flag to set a read-only metadata.
items[].status	`string`	The status of the element. Valid values are ‘Created’, ‘Uploading’, ‘Processing’, ‘Complete’, ‘Deleted’, ‘Failed’, ‘Virus Detected’.
items[].customKeys	`array`	An array of strings that represents custom keys over the element that the user wants to add.
items[].isLocked	`boolean`	Indicates if the element is blocked.
items[].lastLockActionBy	`object`	Information about the user who performed the last lock or unlock.
items[].lastLockActionBy.id	`string`	The unique identifier of the user.
items[].lastLockActionBy.name	`string`	The full name of the user.
items[].lastLockActionBy.email	`string`	The email of the user.
items[].lastLockActionOn	`string`	The datetime the element record was last locked or unlocked.
items[].isExternal	`boolean`	Indicates if the file is stored in an external source.

Headers

Content-Type: application/json

Body

{
  "code": "AssetNotFound",
  "message": "Asset not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

List Elements for Asset
GET`/assets/{assetId}/elements{?limit,offset,orderBy,orderDirection}`

URI Parameters

HideShow

assetId

string (required)

The unique identifier of the asset.

limit

number (optional) Default: 50

The number of items to return. The maximum is 50.

offset

number (optional) Default: 0

The item at which to begin the response.

orderBy

string (optional) Default: name

The field to sort the items by.

Choices: createdOn name

orderDirection

string (optional) Default: asc

The order direction the items should be returned.

Choices: asc desc

Description

Retrieves the elements for the specified asset. This query supports pagination using limit and offset. The results can be ordered by createdOn, name and size.

Errors

Status Code	Error Code	Message
400	InvalidLimitOrOffset	Invalid limit or offset value. Limit must be a number between 1 and 50. Offset must be greater than or equal to 0.
400	InvalidQueryOrderField	Invalid order field. It must be either ‘CreatedOn’ or ‘Name’.
400	InvalidQueryOrderDirection	Invalid order direction. It must be either ‘Asc’ or ‘Desc’.
404	AssetNotFound	Asset not found.

Copy Multiple Elements ¶

POST https://api.cimediacloud.com/elements/copy

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "operations": [
    {
      "sources": [
        {
          "assetId": "d9bf018c804a4e78b775b8dc2f242071",
          "elementIds": [
            "77c61d61e9db411dbdd9645084296309"
          ]
        }
      ],
      "targets": [
        {
          "assetId": "3c1dc975d2584e2d953c7cff816b8c10"
        }
      ]
    }
  ]
}

Property name	Type	Description
operations	`array`	The copy operations to perform.
operations[].sources	`array`	The sources to copy.
operations[].sources[].assetId	`string`	The unique identifier of the asset that owns all the elements to copy.
operations[].sources[].elementIds	`array`	The unique identifiers for all source folders you may want to move the asset from.
operations[].targets	`array`	The targets where to copy the sources to.
operations[].targets[].assetId	`string`	The target asset where to copy the elements to.

Responses200400

Headers

Content-Type: application/json

Body

{
  "completeCount": 1,
  "errorCount": 1,
  "errors": [
    {
      "id": "elementId2",
      "assetId": "u57kfgxbynrkt267",
      "name": "element2.jpg",
      "kind": "Element",
      "errorCode": "ElementNotFound",
      "errorMessage": "Element not found."
    }
  ],
  "complete": [
    {
      "id": "90d69c891da1457ca3bd3d856ad487c2",
      "name": "stillImage.jpg",
      "kind": "Element",
      "assetId": "d9bf018c804a4e78b775b8dc2f242071"
    }
  ]
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors	`array`	An array containing information about each failed item.
errors[].id	`string`	The unique identifier of the failed item.
errors[].assetId	`string`	The unique identifier for the asset.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
complete	`array`	An array containing information about each completed item.
complete[].id	`string`	The unique identifier of the element.
complete[].name	`string`	The name of the element and its extension.
complete[].kind	`string`	The kind of item returned. Will be ‘Element’ for element.
complete[].assetId	`string`	The unique identifier of the asset to which the element is attached.

Headers

Content-Type: application/json

Body

{
  "code": "AssetNotFound",
  "message": "Asset not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Copy Multiple Elements
POST`/elements/copy`

Description

Copies the specified elements or asset’s elements to the given target assets.

500 is the maximum number of sources and targets that can be used in a single request.

Errors

Status Code	Error Code	Message
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	InvalidCopyRequest	Invalid copy request. The request must contain at least one valid source (element or asset) and at least one target. There cannot be any duplicate sources or targets.
400	ExceededMaxOperationCount	Max sources and targets count exceeded. The maximum number of is 500.
400	ElementNotFound	Element not found.
400	AssetNotFound	Asset not found.
400	ElementNotReady	Either a source element is not ready for copy or there are no elements that can be copied. Check that the source element status is either ‘Complete’ or ‘Limited’ or that the source asset has elements with the correct status.

Delete Multiple Elements ¶

POST https://api.cimediacloud.com/elements/delete

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "elementIds": [
    "elementId1",
    "elementId2"
  ]
}

Property name	Type	Description
elementIds	`array` (required)	The unique identifiers for all elements to delete.

Responses200409

Headers

Content-Type: application/json

Body

{
  "completeCount": 1,
  "errorCount": 1,
  "errors": [
    {
      "id": "elementId2",
      "assetId": "u57kfgxbynrkt267",
      "name": "element2.jpg",
      "kind": "Element",
      "errorCode": "ElementNotFound",
      "errorMessage": "Element not found."
    }
  ],
  "complete": [
    {
      "id": "90d69c891da1457ca3bd3d856ad487c2",
      "name": "stillImage.jpg",
      "kind": "Element",
      "assetId": "d9bf018c804a4e78b775b8dc2f242071"
    }
  ]
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors	`array`	An array containing information about each failed item.
errors[].id	`string`	The unique identifier of the failed item.
errors[].assetId	`string`	The unique identifier for the asset.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
complete	`array`	An array containing information about each completed item.
complete[].id	`string`	The unique identifier of the element.
complete[].name	`string`	The name of the element and its extension.
complete[].kind	`string`	The kind of item returned. Will be ‘Element’ for element.
complete[].assetId	`string`	The unique identifier of the asset to which the element is attached.

Headers

Content-Type: application/json

Body

{
  "completeCount": 0,
  "errorCount": 1,
  "errors": [
    {
      "name": "Item name",
      "kind": "Item",
      "errorCode": "ItemNotFound",
      "errorMessage": "Item not found.",
      "id": "ad9289a2019a4e07a08eca9459ef1091"
    }
  ]
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors	`array`	An array containing information about each failed item.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].id	`string`	The unique identifier for the item.

Delete Multiple Elements
POST`/elements/delete`

Description

Deletes the specified elements and their associated files permanently. The storage quota is updated to reflect the newly freed space.

500 is the maximum number of elements that can be deleted in a single operation.

Errors

Status Code	Error Code	Message	Notes
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	ElementIdNotProvided	Element Id not provided.
400	ExceededMaxElementCount	Max element count exceeded. The maximum number of elements is 500.
409	BulkOperationFailed	The bulk operation failed. See the errors array for more information.	This message appears if there were no successfully deleted assets.

Errors represented in errors array

Error Code	Message
ElementNotFound	Element not found.
ElementDeleted	Element is deleted.
InvalidDeleteOnLockedElement	The element is locked and cannot be deleted.

Update Multiple Elements' Metadata ¶

POST https://api.cimediacloud.com/elements/metadata/changes

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "changes": [
    {
      "elementIds": [
        "6i3x3hp1ni2wo5bd"
      ],
      "set": [
        {
          "name": "Owner",
          "value": "Sony",
          "readOnly": false
        }
      ],
      "unset": [
        {
          "name": "Runtime"
        }
      ]
    }
  ]
}

Property name	Type	Description
changes	`array`	The groups of changes to process.

Responses200409

Headers

Content-Type: application/json

Body

{
  "completeCount": 1,
  "errorCount": 1,
  "errors": [
    {
      "id": "elementId2",
      "assetId": "u57kfgxbynrkt267",
      "name": "element2.jpg",
      "kind": "Element",
      "errorCode": "ElementNotFound",
      "errorMessage": "Element not found."
    }
  ],
  "complete": [
    {
      "id": "90d69c891da1457ca3bd3d856ad487c2",
      "name": "stillImage.jpg",
      "kind": "Element",
      "assetId": "d9bf018c804a4e78b775b8dc2f242071"
    }
  ]
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors	`array`	An array containing information about each failed item.
errors[].id	`string`	The unique identifier of the failed item.
errors[].assetId	`string`	The unique identifier for the asset.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
complete	`array`	An array containing information about each completed item.
complete[].id	`string`	The unique identifier of the element.
complete[].name	`string`	The name of the element and its extension.
complete[].kind	`string`	The kind of item returned. Will be ‘Element’ for element.
complete[].assetId	`string`	The unique identifier of the asset to which the element is attached.

Headers

Content-Type: application/json

Body

{
  "completeCount": 0,
  "errorCount": 1,
  "errors": [
    {
      "id": "elementId2",
      "assetId": "u57kfgxbynrkt267",
      "name": "element2.jpg",
      "kind": "Element",
      "errorCode": "ElementNotFound",
      "errorMessage": "Element not found."
    }
  ]
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors	`array`	An array containing information about each failed item.
errors[].id	`string`	The unique identifier of the failed item.
errors[].assetId	`string`	The unique identifier for the asset.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.

Update Multiple Elements' Metadata
POST`/elements/metadata/changes`

Description

Adds, updates and removes metadata for multiple elements. This resource allows you to perform multiple metadata changes to multiple elements in a single request.

Each group of changes define which metadata items are added or updated (if any), which metadata items are removed (if any), and which elements are affected by these changes.

An element can only be affected by a single group of changes. That is, different groups cannot include the same element id. Also, a group of changes cannot add (or update) and remove a specific metadata item.

The metadata item’s name is case insensitive.

500 is the maximum number of elements that can be updated in a single operation.

500 is the maximum number of changes that can included in a single operation.

Status Code	Error Code	Message	Notes
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	OverlappingChanges	At least an element is part of different changesets.
400	ExceededMaxElementCount	Max element count exceeded. The maximum number of elements is 500.
400	ExceededMaxChangeCount	Max change count exceeded.
409	BulkOperationFailed	The bulk operation failed. See the errors array for more information.	This message appears if no changes were successfully processed.

Errors represented in errors array

Error Code	Message
ElementIdNotProvided	Element Id not provided.
ElementNotFound	Element not found.
ElementDeleted	Element is deleted.
EmptyChanges	A changeset doesn’t have any change defined.
ConflictingChanges	A changeset has conflicting changes.
InvalidChanges	A changeset has invalid, incomplete changes.

Create Element From Asset ¶

POST https://api.cimediacloud.com/elements/upload/asset

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "sourceAssetId": "38c00727d8ff4ad5adffa7d5761ebf30",
  "assetId": "bcdc34b53e2c4c18ac41ca288e28d11f",
  "name": "Element.mov"
}

Property name	Type	Description
sourceAssetId	`string` (required)	The unique identifier of the source asset.
assetId	`string` (required)	The asset id for the new element’s parent asset.
name	`string`	Name of the new element.

Responses200400

Headers

Content-Type: application/json

Body

{
  "sourceAssetId": "38c00727d8ff4ad5adffa7d5761ebf30",
  "targetAssetId": "bcdc34b53e2c4c18ac41ca288e28d11f",
  "elementId": "06f0def567b3467d9e9d8453fb357a8f"
}

Property name	Type	Description
sourceAssetId	`string`	The unique identifier for the source asset.
targetAssetId	`string`	The unique identifier for the target asset.
elementId	`string`	The unique identifier of the new element.

Headers

Content-Type: application/json

Body

{
  "code": "SourceAssetDeleted",
  "message": "Source asset is deleted."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Create Element From Asset
POST`/elements/upload/asset`

Description

Creates a new element from a source asset. Clients can provide a source asset that will be copied as an element to another asset.

Errors

Status Code	Error Code	Message
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	SourceAssetIdNotProvided	The source Asset Id was not provided.
400	AssetIdNotProvided	Asset Id was not provided.
400	AssetNotFound	Asset not found.
400	SourceAssetDeleted	Source asset is deleted.
409	SourceAssetAlreadyArchived	Source Asset has already been archived.
400	SourceAssetNotIngested	Source Asset has not been fully processed. Some operations are unavailable until the processing of the file is complete.
400	TargetAssetDeleted	Target asset is deleted.
403	InsufficientPermissionsForCreateElement	Insufficient permissions for creating an element.

Element Singlepart Upload ¶

Singlepart HTTP upload is currently available for Elements.

Create Element and Upload ¶

POST https://api.cimediacloud.com/elements/upload

Requestsexampleexample json body for metadata parameter

Headers

Content-Type: multipart/form-data;boundary=----WebKitFormBoundary8M3sSU13ul5lXSJm
Authorization: Bearer [bearer token]

Body

------WebKitFormBoundary8M3sSU13ul5lXSJm
Content-Disposition: form-data; name="metadata"

{
    "assetId": "yiireizq1hcowxua"
}

------WebKitFormBoundary8M3sSU13ul5lXSJm

Content-Disposition: form-data; name="filename"; filename="Movie.mov"
Content-Type: image/jpeg

data
------WebKitFormBoundary8M3sSU13ul5lXSJm--

Responses200404

Headers

Content-Type: application/json

Body

{
  "assetId": "yiireizq1hcowxua",
  "elementId": "5v99qywnb6gzneha"
}

Property name	Type	Description
assetId	`string`	The unique identifier for the parent asset.
elementId	`string`	The unique identifier for the element.

Headers

Content-Type: application/json

Body

{
  "code": "AssetNotFound",
  "message": "Asset not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "assetId": "yiireizq1hcowxua",
  "metadata": {
    "name": "resolution",
    "value": "1080p",
    "readOnly": false
  },
  "customKeys": [
    "examplekey"
  ]
}

Property name	Type	Description
assetId	`string`	The unique identifier for the parent asset.
metadata	`object`	Information about the element’s metadata.
metadata.name	`string`	The name of the metadata item.
metadata.value	`string`	the value of the metadata item.
metadata.readOnly	`boolean`	Flag to set a read-only metadata.
customKeys	`array`	An array of strings that represents a list of custom keys to associate with an element.

Responses200

Headers

Content-Type: application/json

Body

{
  "assetId": "5v99qywnb6gzneha"
}

Property name	Type	Description
assetId	`string`	The unique identifier for the asset.

Create Element and Upload
POST`/elements/upload`

Description

Creates and uploads an element in a single operation using HTTP. There is an upper limit of 150 megabytes for this endpoint due primarily to the limitations of the HTTP protocol. If the HTTP session is interrupted during this upload process, there is no way to recover. You will need to upload the file again.

Please use https://io.cimediacloud.com/elements/upload to perform this operation.

When submitting custom keys, keep this information in mind:

All characters will be converted to lower case.
Leading and trailing whitespace will be removed.
Each custom key must not be longer than 36 characters.
A maximum of 20 custom keys may be submitted.
Valid characters for a custom key include the following:

a - z (letters)
0 - 9 (numbers)
. (period)
- (hyphen)
_ (underscore)

Errors

Status Code	Error Code	Message
400	MissingOrInvalidFile	Missing or invalid file content.
400	MissingOrInvalidName	Missing or invalid name. The file name must not be null and its length must be equal to or less than 512 characters.
400	InvalidDescription	Invalid description. The description length must equal to or less than 1000 characters.
400	InvalidFileType	Invalid file type.
400	ElementTooLarge	File size is too large for a singlepart HTTP upload. The maximum size is 150 megabytes.
400	AssetIdNotProvided	Asset Id was not provided.
400	InvalidCustomKey	Too many or invalid custom keys.
400	AssetDeleted	Asset is deleted.
404	ElementNotFound	Element not found.
400	AssetNotFound	Asset not found.
400	InvalidAssetState	Element cannot be uploaded. To upload an element it’s parent asset cannot be trashed and its status must not be ‘Executable Detected’ or ‘Virus Detected’.
403	InvalidOperationOnWorkspace	Workspace is not allowed to upload elements of this type.
409	InsufficientSpaceAvailable	Upload will exceed the workspace’s allotted storage.
415	UnsupportedMediaType	Unsupported media type. Please use application/form-multidata.
500	ElementUploadFailed	File upload failed.

Upload Cover Element ¶

POST https://api.cimediacloud.com/assets/moqxhkej4epvgrwz/coverelement/upload

Requestsexample

Headers

Content-Type: multipart/form-data;boundary=----WebKitFormBoundary8M3sSU13ul5lXSJm
Authorization: Bearer [bearer token]

Body

------WebKitFormBoundary8M3sSU13ul5lXSJm

Content-Disposition: form-data; name="filename"; filename="thumbnail.jpg"
Content-Type: image/jpeg

data
------WebKitFormBoundary8M3sSU13ul5lXSJm--

Responses200404

Headers

Content-Type: application/json

Body

{
  "assetId": "yiireizq1hcowxua",
  "thumbnails": [
    {
      "type": "large",
      "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/thumb.jpg",
      "size": 1024,
      "width": 200,
      "height": 300,
      "source": {
        "id": "elementId1",
        "kind": "element"
      },
      "isExternal": false
    }
  ]
}

Property name	Type	Description
assetId	`string`	The unique identifier for the parent asset.
thumbnails	`array`	Information about the new asset cover.
thumbnails[].type	`string`	The type of thumbnail returned. Valid values are ‘small’, ‘medium’ and ‘large’.
thumbnails[].location	`string`	The url of the thumbnail.
thumbnails[].size	`number`	The size of the thumbnail, in bytes.
thumbnails[].width	`number`	The width of the thumbnail.
thumbnails[].height	`number`	The height of the thumbnail.
thumbnails[].source	`object`	Information about the source of thumbnails.
thumbnails[].source.id	`string`	Unique identifier of the thumbnail’s source.
thumbnails[].source.kind	`string`	The kind of entity of the thumbnail’s source.
thumbnails[].isExternal	`boolean`	Indicates if the thumbnail is stored in an external source.

Headers

Content-Type: application/json

Body

{
  "code": "AssetNotFound",
  "message": "Asset not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Upload Cover Element
POST`/assets/{assetId}/coverelement/upload`

URI Parameters

HideShow

assetId: string (required)
The unique identifier of the asset.

Description

Uploads a new cover element in a single operation using HTTP. Uploading a new cover element will replace the asset’s current cover element with the uploaded one. Additionally, we will generate a new set of thumbnails for the uploaded image. If the HTTP session is interrupted during this upload process, there is no way to recover. You will need to upload the file again.

The request body must be encoded using multipart/form-data, using 1 part.

The part must be the content to be uploaded, setting the filename content property with the cover element file name.

Please use https://io.cimediacloud.com/assets/{assetId}/coverelement/upload to perform this operation.

The following image extensions are allowed: jpg, jpeg, gif, png, tif, tiff, bmp

The maximum file size is 20 megabytes.

Errors

Status Code	Error Code	Message
400	AssetIdNotProvided	Asset Id was not provided.
400	MissingOrInvalidFile	Missing or invalid file content.
400	MissingOrInvalidName	Missing or invalid name. The file name must not be null and its length must be equal to or less than 512 characters.
400	InvalidFileType	Invalid file type.
400	MissingOrInvalidFileSize	Missing or invalid file size.
400	AssetDeleted	Asset is deleted.
400	InvalidAssetState	Element cannot be uploaded. To upload an element it’s parent asset cannot be trashed and its status must not be ‘Executable Detected’ or ‘Virus Detected’.
404	AssetNotFound	Asset not found.
415	UnsupportedMediaType	Unsupported media type. Please use application/form-multidata.

Download ¶

HTTP Download ¶

GET https://api.cimediacloud.com/assets/moqxhkej4epvgrwz/download?downloadExpirationDate=2018-01-01T00:00:00.000Z&assetNameOverride=override-asset-name&useUnicodeEncoding=false

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200404

Headers

Content-Type: application/json

Body

{
  "id": "alr7wdoaftr0mtpz",
  "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/source-file.jpg",
  "size": 1024,
  "proxies": [
    {
      "type": "video-3g",
      "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/proxy.jpg",
      "size": 1024,
      "width": 200,
      "height": 300,
      "videoBitRate": 1650000,
      "audioBitRate": 128000,
      "isExternal": false
    }
  ],
  "thumbnails": [
    {
      "type": "large",
      "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/thumb.jpg",
      "size": 1024,
      "width": 200,
      "height": 300,
      "source": {
        "id": "elementId1",
        "kind": "element"
      },
      "isExternal": false
    }
  ]
}

Property name	Type	Description
id	`string`	The unique identifier for the asset to download.
location	`string`	If available, a secure, time-restricted link to the file. The link is valid for 3 hours. This property may not be available if the asset is being archived or restored, or is already archived and a restored copy is not available.
size	`number`	The size, in bytes, of the source file.
proxies	`array`	If available, a list of available proxies for download.
proxies[].type	`string`	The type of proxy returned. Valid values are ‘standard-audio’, ‘dolby-audio’, ‘video-3g’, ‘video-sd’, ‘video-sdplus’, ‘video-hd’, ‘video-2k’, ‘video-2kplus’, ‘document-pdf’.
proxies[].location	`string`	The url of the proxy.
proxies[].size	`number`	The size of the proxy, in bytes.
proxies[].width	`number`	The width of the proxy.
proxies[].height	`number`	The height of the proxy.
proxies[].videoBitRate	`number`	The video bitrate of the proxy.
proxies[].audioBitRate	`number`	The audio bitrate of the proxy.
proxies[].isExternal	`boolean`	Indicates if the proxy is stored in an external source.
thumbnails	`array`	If available, a list of available thumbnails for download.
thumbnails[].type	`string`	The type of thumbnail returned. Valid values are ‘small’, ‘medium’ and ‘large’.
thumbnails[].location	`string`	The url of the thumbnail.
thumbnails[].size	`number`	The size of the thumbnail, in bytes.
thumbnails[].width	`number`	The width of the thumbnail.
thumbnails[].height	`number`	The height of the thumbnail.
thumbnails[].source	`object`	Information about the source of thumbnails.
thumbnails[].source.id	`string`	Unique identifier of the thumbnail’s source.
thumbnails[].source.kind	`string`	The kind of entity of the thumbnail’s source.
thumbnails[].isExternal	`boolean`	Indicates if the thumbnail is stored in an external source.

Headers

Content-Type: application/json

Body

{
  "code": "AssetNotFound",
  "message": "Asset not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

HTTP Download
GET`/assets/{assetId}/download{?downloadExpirationDate,assetNameOverride,useUnicodeEncoding}`

URI Parameters

HideShow

assetId: string (required)
The unique identifier of the asset.
downloadExpirationDate: string (optional)
downloadExpirationDate: The date and time for the donwload URL expiration in IS0 8601 date and time format (e.g.: ‘2020-01-01’). Value must be less than ‘2038-01-01’, greater than the current date and time and less or equal than 36 hours from the current date and time. If not provided, default of 3 hours is used.
assetNameOverride: string (optional)
assetNameOverride: The file name to use in place of the asset name for source, proxy and thumbnail download links. We recommend omitting a file extension in this property (so Ci can manage all appropriate extensions for proxies and thumbnails).
useUnicodeEncoding: bool (optional)
Uses UTF-8 unicode encoding for filename when downloaded. Default value is false.

Description

Generates a secure, time-restricted link to download the asset’s source file, proxies and thumbnails. The link is valid for 3 hours before expiration. If the link expires prior to you initiating the download, just call this endpoint again.

If the asset has been archived and a restored copy is not currently available, the asset will have to be restored prior to downloading the source file. Additionally, if the asset is currently being archived or restored the source file will be not be available for download. In these scenarios the “location” property will not be returned but the “proxies” and “thumbnails” arrays, if they exist, will be returned and available for download.

Errors

Status Code	Error Code	Message
400	InvalidExpiration	Invalid expiration.
400	MissingOrInvalidName	Missing or invalid name. The file name must not be null and its length must be equal to or less than 512 characters.
400	DataTransferLimitExceeded	Data Transfer limit exceeded.
404	AssetNotFound	Asset not found.
404	AssetDeleted	Asset is deleted.
409	AssetTrashed	Asset is trashed.
409	InvalidAssetState	Asset has not been uploaded. Please try again once the asset is uploaded.

Aspera Download ¶

POST https://api.cimediacloud.com/download/aspera

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "assetIds": [
    "moqxhkej4epvgrwz"
  ]
}

Property name	Type	Description
assetIds	`array`	An array of asset ids to download. Note: the current version only supports a single asset Id.

Responses200404

Headers

Content-Type: application/json

Body

{
  "host": "apod.cimediacloud.com",
  "sshPort": 33001,
  "targetRate": 1024,
  "minRate": 1024,
  "httpFallback": false,
  "asperaDownloadConfigurations": [
    {
      "user": "dxassets",
      "token": "nxyjaifiu3611ow2",
      "path": "/workspace/T654eroiSHY6GHtwieu74/Movie.mov",
      "destination": "Movie.mov",
      "assetId": "moqxhkej4epvgrwz",
      "elementId": "lj6u9aeqj8m3xkx7",
      "kind": "Asset",
      "type": "original",
      "paths": [
        {
          "source": "/workspace/T654eroiSHY6GHtwieu74/Movie.mov",
          "destination": "Movie.mov"
        }
      ]
    }
  ]
}

Property name	Type	Description
host	`string`	The hostname of the destination Aspera server.
sshPort	`number`	The port used for authentication on the destination Aspera server.
targetRate	`number`	The target transfer rate, in kbps.
minRate	`number`	The minimum transfer rate, in kbps.
httpFallback	`boolean`	HTTP fallback for Aspera currently isn’t supported.
asperaDownloadConfigurations	`array`	An array containing configuration information that can be used to download files using Aspera.
asperaDownloadConfigurations[].user	`string`	The username on the destination Aspera server.
asperaDownloadConfigurations[].token	`string`	The authorization token for the Aspera transfer. This is time sensitive and will expire after 24 hours.
asperaDownloadConfigurations[].path	`string`	The path to the remote file in Ci.
asperaDownloadConfigurations[].destination	`string`	The suggested destination (filename) for the asset.
asperaDownloadConfigurations[].assetId	`string`	The unique identifier of the registered asset.
asperaDownloadConfigurations[].elementId	`string`	If available, the unique identifier of the registered element. User uploaded elements and files generated from custom profiles will all have an elementId property.
asperaDownloadConfigurations[].kind	`string`	Indicates the kind of the file. This value will be ‘Asset’ for the original source file, ‘Proxy’ for proxies, ‘Thumbnail’ for thumbnails, ‘Caption’ for caption files, and ‘Element’ for user uploaded elements.
asperaDownloadConfigurations[].type	`string`	If available, the type of file available for download. The original source file will always have a type of “original”. You can see the other proxy types in the Asset Previews section.
asperaDownloadConfigurations[].paths	`array`	An array containing information about the asset being downloaded. This is similar to the path and destination properties above.
asperaDownloadConfigurations[].paths[].source	`string`	The path to the remote file including filename. This is the same value as asperaDownloadConfigurations.path.
asperaDownloadConfigurations[].paths[].destination	`string`	The suggested destination (filename) for the asset. This is the same value as asperaDownloadConfigurations.destination.

Headers

Content-Type: application/json

Body

{
  "code": "AssetNotFound",
  "message": "Asset not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Aspera Download
POST`/download/aspera`

Description

Retrieve Aspera configuration information that can be used to download an asset’s original source file, proxies, thumbnails, files generated from custom profiles, and user uploaded elements. The “kind” property indicates whether the file is an asset (source file), proxy, thumbnail, or element. Additionally, the “type” property will give you information about each kind (for instance a “Proxy” kind can be a type of “video-3g”). The original source will always have a “type” equal to “original”. You can see proxy and thumbnails types in the Asset Previews section.

If the asset has been archived and a restored copy is not currently available, the asset will have to be restored prior to downloading it.

Errors

Status Code	Error Code	Message
400	AssetIdNotProvided	Asset Id was not provided.
400	MultipleAssetIdsProvided	Only one AssetId is allowed for Aspera download in the current version.
400	DataTransferLimitExceeded	Data Transfer limit exceeded.
404	AssetNotFound	Asset not found.
404	AssetDeleted	Asset is deleted.
409	AssetTrashed	Asset is trashed.
409	InvalidAssetState	Asset has not been uploaded. Please try again once the asset is uploaded.
409	InvalidAssetState	Asset is currently being archived and cannot be transferred using Aspera. The asset archive operation must complete and the asset must be restored before it can be transferred.
409	InvalidAssetState	Asset is currently being restored and cannot be transferred using Aspera. The asset restore operation must complete before it can be transferred.
409	InvalidAssetState	Asset is archived and cannot be transferred using Aspera. The asset must be restored before it can be transferred.
409	EntitlementRequired	Workspace does not have Aspera enabled.

Aspera Bulk Download ¶

POST https://api.cimediacloud.com/download/aspera/bulk

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "assetIds": [
    "moqxhkej4epvgrwz"
  ]
}

Property name	Type	Description
assetIds	`array`	An array of asset ids to download.

Responses200409

Headers

Content-Type: application/json

Body

{
  "count": 1,
  "errorCount": 1,
  "errors": [
    {
      "name": "Item name",
      "kind": "Item",
      "errorCode": "ItemNotFound",
      "errorMessage": "Item not found.",
      "id": "ad9289a2019a4e07a08eca9459ef1091"
    }
  ],
  "items": [
    {
      "id": "d9bf018c804a4e78b775b8dc2f242071",
      "name": "Movie.mov",
      "kind": "Asset"
    }
  ],
  "downloadConfiguration": {
    "host": "apod.cimediacloud.com",
    "sshPort": 33001,
    "targetRate": 1024,
    "minRate": 1024,
    "httpFallback": false,
    "configurations": [
      {
        "user": "dxassets",
        "token": "aoe4pzkgrg44aj6s",
        "kind": "Active",
        "paths": [
          {
            "source": "/workspace/T654eroiSHY6GHtwieu74/Movie.mov",
            "destination": "Movie.mov",
            "assetId": "moqxhkej4epvgrwz"
          }
        ]
      }
    ]
  }
}

Property name	Type	Description
count	`number`	The number of items.
errorCount	`number`	The number of invalid items.
errors	`array`	An array containing information for each error item.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].id	`string`	The unique identifier for the item.
items	`array`	An array containing information about each asset.
items[].id	`string`	The unique identifier of the asset.
items[].name	`string`	The name of asset and its extension.
items[].kind	`string`	The kind of item returned. Will be ‘Asset’ for assets.
downloadConfiguration	`object`	Information about the Aspera download specs.
downloadConfiguration.host	`string`	The hostname of the destination Aspera server.
downloadConfiguration.sshPort	`number`	The port used for authentication on the destination Aspera server.
downloadConfiguration.targetRate	`number`	The target transfer rate, in kbps.
downloadConfiguration.minRate	`number`	The minimum transfer rate, in kbps.
downloadConfiguration.httpFallback	`boolean`	HTTP fallback for Aspera currently isn’t supported.
downloadConfiguration.configurations	`array`	An array containing configuration information that can be used to download files using Aspera. At most there will be 2 array items. One representing active, non-archived assets and one representing archived, restored assets.
downloadConfiguration.configurations[].user	`string`	The username on the destination Aspera server.
downloadConfiguration.configurations[].token	`string`	The authorization token for the Aspera transfer. This is time sensitive and will expire after 24 hours.
downloadConfiguration.configurations[].kind	`string`	Indicates whether the download configuration is for active, non-archived assets or for archived, restored assets. Value will be either “Active” or “Restored”.
downloadConfiguration.configurations[].paths	`array`	An array containing information about each asset being downloaded in the specific configuration.
downloadConfiguration.configurations[].paths[].source	`string`	The remote location of the asset.
downloadConfiguration.configurations[].paths[].destination	`string`	The destination path for the asset on the local system.
downloadConfiguration.configurations[].paths[].assetId	`string`	The unique identifier of the asset.

Headers

Content-Type: application/json

Body

{
  "count": 1,
  "errorCount": 1,
  "errors": [
    {
      "name": "Item name",
      "kind": "Item",
      "errorCode": "ItemNotFound",
      "errorMessage": "Item not found.",
      "id": "ad9289a2019a4e07a08eca9459ef1091"
    }
  ]
}

Property name	Type	Description
count	`number`	The number of items.
errorCount	`number`	The number of invalid items.
errors	`array`	An array containing information for each error item.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].id	`string`	The unique identifier for the item.

Aspera Bulk Download
POST`/download/aspera/bulk`

Description

Retrieve Aspera configuration information that can be used to download multiple assets using Aspera.

500 is the maximum number of assets that can downloaded in a single operation.

If the asset has been archived and a restored copy is not currently available, the asset will have to be restored prior to downloading it.

Only assets from a single Workspace can be downloaded in a single transfer session.

Errors

Status Code	Error Code	Message	Notes
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	AssetIdNotProvided	Asset Id not provided.
400	ExceededMaxAssetCount	Max asset count exceeded. The maximum number of assets is 500.
400	InvalidAssets	Assets belong to multiple workspaces.
400	DataTransferLimitExceeded	Data Transfer limit exceeded.
409	EntitlementRequired	Workspace does not have Aspera enabled.
409	BulkOperationFailed	The bulk operation failed. See the errors array for more information.	This message appears if there were no available assets for download.

Errors represented in errors array

Error Code	Message
AssetNotFound	Asset not found.
AssetDeleted	Asset is deleted.
AssetTrashed	Asset is trashed.
InvalidAssetState	Asset has not been uploaded. Please try again once the asset is uploaded.
InvalidAssetState	There are no transferable files found for this asset. If the asset is archived or in the process of being archived you must restore it before transfering the source file.

Bulk Element Download ¶

POST https://api.cimediacloud.com/elements/download

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "elementIds": [
    "da836655e2c04e01930fb4b06b1c4e4c"
  ]
}

Property name	Type	Description
elementIds	`array`	The element ids to be downloaded.

Responses200

Headers

Content-Type: application/json

Body

{
  "count": 10,
  "items": [
    {
      "id": "da836655e2c04e01930fb4b06b1c4e4c",
      "name": "Movie.mov",
      "size": 1125225855,
      "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/Movie.mov",
      "kind": "Element"
    }
  ],
  "errors": [
    {
      "id": "da836655e2c04e01930fb4b06b1c4e4c",
      "errorCode": "InvalidDownloadRequest",
      "errorMessage": "File not available for download."
    }
  ]
}

Property name	Type	Description
count	`number`	Number of successful element download links returned.
items	`array`	List of elements available for download.
items[].id	`string`	Element id.
items[].name	`string`	Name of the element
items[].size	`number`	Size of the element
items[].location	`string`	The url to download the element.
items[].kind	`string`	Kind of file
errors	`array`	List of elements not available for download.
errors[].id	`string`	Element id.
errors[].errorCode	`string`	Error code.
errors[].errorMessage	`string`	Error message.

Bulk Element Download
POST`/elements/download`

Description

Generates a secure, time-restricted link to download element files. If the link expires prior to you initiating the download, just call this endpoint again.

The maximum number of elements for bulk is 500.

Errors

Status Code	Error Code	Message
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	ExceededMaxFileDownloadCount	Max file count for download exceeded. The maximum number of items is 500.
400	DataTransferLimitExceeded	Data Transfer limit exceeded.

Bulk Proxy Download ¶

POST https://api.cimediacloud.com/assets/proxies/download

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "downloads": [
    {
      "assetIds": [
        "da836655e2c04e01930fb4b06b1c4e4c"
      ],
      "types": [
        "video-sd"
      ]
    }
  ]
}

Property name	Type	Description
downloads	`array`	List with asset ids and proxy keys to be downloaded.
downloads[].assetIds	`array`	The asset ids of the proxy files to be downloaded.
downloads[].types	`array`	Proxy keys to be downloaded. Valid values are `video-3g`, `video-sd`, `video-hd`, `video-hd+`, `video-2k`, and `video-2k+`.

Responses200

Headers

Content-Type: application/json

Body

{
  "count": 10,
  "items": [
    {
      "assetId": "da836655e2c04e01930fb4b06b1c4e4c",
      "name": "Movie.mov",
      "size": 1125225855,
      "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/Movie.mov",
      "kind": "Proxy",
      "type": "video-sd"
    }
  ],
  "errors": [
    {
      "assetId": "da836655e2c04e01930fb4b06b1c4e4c",
      "type": "Video2K",
      "errorCode": "InvalidDownloadRequest",
      "errorMessage": "File not available for download."
    }
  ]
}

Property name	Type	Description
count	`number`	Number of successful proxy download links returned.
items	`array`	List of proxies available for download.
items[].assetId	`string`	Asset id.
items[].name	`string`	Name of the proxy
items[].size	`number`	Size of the proxy
items[].location	`string`	The url to download the proxy.
items[].kind	`string`	Kind of file
items[].type	`string`	Proxy type
errors	`array`	List of proxies not available for download.
errors[].assetId	`string`	Asset id.
errors[].type	`string`	Proxy type.
errors[].errorCode	`string`	Error code.
errors[].errorMessage	`string`	Error message.

Bulk Proxy Download
POST`/assets/proxies/download`

Description

Generates a secure, time-restricted link to download proxy files that belong to assets. If the link expires prior to you initiating the download, just call this endpoint again.

The maximum number of assets for bulk proxy download is 500.

Errors

Status Code	Error Code	Message
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	ExceededMaxFileDownloadCount	Max file count for download exceeded. The maximum number of items is 500.

Bulk Thumbnail Download ¶

POST https://api.cimediacloud.com/assets/thumbnails/download

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "downloads": [
    {
      "assetIds": [
        "da836655e2c04e01930fb4b06b1c4e4c"
      ],
      "types": [
        "small"
      ]
    }
  ]
}

Property name	Type	Description
downloads	`array`	List with asset ids and proxy keys to be downloaded.
downloads[].assetIds	`array`	The asset ids of the thumbnail files to be downloaded.
downloads[].types	`array`	Thumbnail keys to be downloaded. Valid values are `small`, `medium`, `large`, `2000px`.

Responses200

Headers

Content-Type: application/json

Body

{
  "count": 10,
  "items": [
    {
      "assetId": "da836655e2c04e01930fb4b06b1c4e4c",
      "name": "Thumbnail.jpg",
      "size": 1125225855,
      "location": "https://cimediacloud.com/t5y7s3ero3w2ie7/Thumbnail.jpg",
      "kind": "Thumbnail",
      "type": "small"
    }
  ],
  "errors": [
    {
      "assetId": "da836655e2c04e01930fb4b06b1c4e4c",
      "type": "small",
      "errorCode": "InvalidDownloadRequest",
      "errorMessage": "File not available for download."
    }
  ]
}

Property name	Type	Description
count	`number`	Number of successful thumbnail download links returned.
items	`array`	List of thumbnails available for download.
items[].assetId	`string`	Asset id.
items[].name	`string`	Name of the thumbnail
items[].size	`number`	Size of the thumbnail
items[].location	`string`	The url to download the thumbnail.
items[].kind	`string`	Kind of file
items[].type	`string`	Thumbnail type
errors	`array`	List of thumbnails not available for download.
errors[].assetId	`string`	Asset id.
errors[].type	`string`	Thumbnail type.
errors[].errorCode	`string`	Error code.
errors[].errorMessage	`string`	Error message.

Bulk Thumbnail Download
POST`/assets/thumbnails/download`

Description

Generates a secure, time-restricted link to download thumbnail files that belong to assets. If the link expires prior to you initiating the download, just call this endpoint again.

The maximum number of assets for bulk thumbnail download is 500.

Errors

Status Code	Error Code	Message
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	ExceededMaxFileDownloadCount	Max file count for download exceeded. The maximum number of items is 500.

S3 Push Transfer ¶

S3 push transfer enables file delivery from Ci to S3 buckets.

Create S3 Push Transfer ¶

POST https://api.cimediacloud.com/transfer/s3

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "bucket": "mybucket",
  "prefix": "parent/child",
  "region": "us-east-1",
  "credentials": {
    "type": "aws-access-keys",
    "id": "AKIAXBZE5",
    "secret": "AQEW9Rv"
  },
  "assets": [
    {
      "id": "moqxhkej4epvgrwz",
      "destinationPath": "/subdirectory",
      "transferSourceFile": true,
      "elements": [
        {
          "id": "9buxd3oqybkvqxtv",
          "destinationPath": "/subdirectory"
        }
      ],
      "proxies": [
        {
          "type": "video-hd",
          "destinationPath": "/subdirectory"
        }
      ],
      "thumbnails": [
        {
          "type": "large",
          "destinationPath": "/subdirectory"
        }
      ]
    }
  ]
}

Property name	Type	Description
bucket	`string` (required)	The target bucket for the S3 push transfer.
prefix	`string` (required)	The target prefix for the S3 push transfer. Omit this value if pushing files to the root of the S3 bucket.
region	`string`	The region field is not required but is helpful for visibility to where transfers are going. Additionally, it is useful if the bucket name has a period (`.`) in it (this is a constraint from AWS and this requirement may be eliminated in the future). If provided, we will attempt to validate the Access Key information provided has access to the region given.
credentials	`object`	Credentials for the target bucket. These values are required if the target bucket has access control enabled.
credentials.type	`string` (required)	When providing credentials, always use `aws-access-keys` for this property
credentials.id	`string`	The AWS access key that grants access to the target bucket
credentials.secret	`string`	The AWS secret access key the grants access to the target bucket
assets	`array` (required)	The list of assets to transfer.
assets[].id	`string` (required)	The unique identifier of the asset to transfer.
assets[].destinationPath	`string`	The path on the remote Aspera instance where the file will be transferred.
assets[].transferSourceFile	`boolean`	Indicates if the asset’s source file should be transferred. Defaults to `true`.
assets[].elements	`array`	The list of asset elements that should be transferred with this request.
assets[].elements[].id	`string`	The unique identifer for the element to transfer. Invalid element ids will be ignored.
assets[].elements[].destinationPath	`string`	The path on the remote Aspera instance where the file will be transferred.
assets[].proxies	`array`	The list of asset proxies that should be transferred with this request.
assets[].proxies[].type	`string`	The type of proxy to transfer. If `all` is provided all proxies will be transferred. Invalid proxy types will be ignored. Check the Previews section for available proxy types.
assets[].proxies[].destinationPath	`string`	The path on the remote Aspera instance where the file will be transferred.
assets[].thumbnails	`array`	The list of asset thumbnails that should be transferred with this request.
assets[].thumbnails[].type	`string`	The type of thumbnail to transfer. If `all` is provided all thumbnails will be transferred. Invalid thumbnails types will be ignored. Check the Previews section for available thumbnail types.
assets[].thumbnails[].destinationPath	`string`	The path on the remote Aspera instance where the file will be transferred.

Responses200409

Headers

Content-Type: application/json

Body

{
  "count": 1,
  "errorCount": 1,
  "errors": [
    {
      "name": "Item name",
      "kind": "Item",
      "errorCode": "ItemNotFound",
      "errorMessage": "Item not found.",
      "id": "ad9289a2019a4e07a08eca9459ef1091"
    }
  ],
  "items": [
    {
      "id": "moqxhkej4epvgrwz",
      "assetId": "",
      "name": "Movie.mov",
      "kind": "Asset",
      "type": ""
    },
    {
      "id": "",
      "assetId": "6b9i17kcyci4e46k",
      "name": "Movie.mov",
      "kind": "Proxy",
      "type": "video-hd"
    }
  ],
  "transferSessionId": "lj6u9aeqj8m3xkx7"
}

Property name	Type	Description
count	`number`	The number of items.
errorCount	`number`	The number of invalid items.
errors	`array`	An array containing information for each error item.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].id	`string`	The unique identifier for the item.
items	`array` (required)	An array containing information about each asset.
items[].id	`string` (required)	If available, the unique identifier for the asset, element, or folder transferred. This property will not be returned for proxies and thumbnails.
items[].assetId	`string` (required)	If available, the unique identifier for the element, proxy, or thumbnail’s parent asset id. This property will not be returned for assets or folders.
items[].name	`string` (required)	The name of the item being transferred.
items[].kind	`string` (required)	The kind of item being transferred. Can be ‘Asset’, ‘Element’, ‘Proxy’, ‘Thumbnail’, or ‘Folder’ for this resource.
items[].type	`string` (required)	If the item kind is ‘Proxy’ or ‘Thumbnail’, this property indicates the type of proxy or thumbnail returned. Will not be returned for ‘Asset’, ‘Element’, or ‘Folder’ kinds.
transferSessionId	`string`	The unique identifier for the transfer session.

Headers

Content-Type: application/json

Body

{
  "count": 0,
  "errorCount": 1,
  "errors": [
    {
      "name": "Item name",
      "kind": "Item",
      "errorCode": "ItemNotFound",
      "errorMessage": "Item not found.",
      "id": "ad9289a2019a4e07a08eca9459ef1091"
    }
  ]
}

Property name	Type	Description
count	`number`	The number of successful items.
errorCount	`number`	The number of invalid items.
errors	`array`	An array containing information for each error item.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].id	`string`	The unique identifier for the item.

Create S3 Push Transfer
POST`/transfer/s3`

Description

Initiates an S3 push transfer.

Assets that are archived (and not restored) or in the process of archiving or restoring cannot be transferred. However, elements, proxies, and thumbnails for assets in these states can be transferred.

500 is the maximum number of assets that can be transferred in a single operation.

Errors

Status Code	Error Code	Message	Notes
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	InvalidRequest	Invalid S3 transfer configuration. Please supply all required properties for the S3 transfer, and verify that the target bucket is allowed.
400	AssetIdNotProvided	Asset Id not provided.
400	ExceededMaxAssetCount	Max asset count exceeded. The maximum number of assets is 500.
400	InvalidAssets	Assets belong to multiple workspaces.
409	BulkOperationFailed	The bulk operation failed. See the errors array for more information.	This message appears if there were no transfers initiated.

Errors represented in errors array

Error Code	Message
AssetNotFound	Asset not found.
AssetDeleted	Asset is deleted.
AssetTrashed	Asset is trashed.
InvalidAssetState	Asset has not been uploaded. Please try again once the asset is uploaded.
InvalidAssetState	Asset is currently being archived and cannot be transferred. The asset archive operation must complete and the Asset must be restored before it can be transferred.
InvalidAssetState	Asset is currently being restored and cannot be transferred. The asset restore operation must complete before it can be transferred.
InvalidAssetState	Asset is archived and cannot be transferred. The asset must be restored before it can be transferred.

Aspera Push Transfer ¶

Aspera push transfer enables file delivery from Ci to external Aspera servers.

Create Aspera Push Transfer ¶

POST https://api.cimediacloud.com/transfer/aspera

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "host": "apod.cimediacloud.com",
  "user": "exampleuser",
  "password": "password",
  "token": "6b9i17kcyci4e46k",
  "sshPrivateKey": "-----BEGIN RSA PRIVATE KEY-----MIIEowIBAAKCAQEAzrWZ4yVgCUlhaJXgBKJLxIy9kJAzTKg0i/uZqFE8uzfKTCt8-----END RSA PRIVATE KEY-----",
  "destinationRoot": "/path",
  "sshPort": 33001,
  "faspPort": 33001,
  "targetRate": 20480,
  "assets": [
    {
      "id": "moqxhkej4epvgrwz",
      "destinationPath": "/subdirectory",
      "transferSourceFile": true,
      "elements": [
        {
          "id": "9buxd3oqybkvqxtv",
          "destinationPath": "/subdirectory"
        }
      ],
      "proxies": [
        {
          "type": "video-hd",
          "destinationPath": "/subdirectory"
        }
      ],
      "thumbnails": [
        {
          "type": "large",
          "destinationPath": "/subdirectory"
        }
      ]
    }
  ],
  "folders": [
    {
      "id": "moqxhkej4epvgrwz",
      "destinationPath": "/subdirectory"
    }
  ]
}

Property name	Type	Description
host	`string` (required)	The target host for the Aspera push transfer.
user	`string` (required)	The target host’s transfer user.
password	`string` (required)	If using Aspera username and password, the password must be supplied in this property.
token	`string` (required)	If using Aspera token authentication, the token must be supplied in this property.
sshPrivateKey	`string` (required)	If using Aspera SSH key authentication, the private key must be supplied in this property. Newlines can be inserted using ‘\n’.
destinationRoot	`string` (required)	The destination root in the target environment. All paths must start with ``.
sshPort	`number`	The authentication port on the target Aspera server. Defaults to 33001.
faspPort	`number`	The fasp transfer port on the target Aspera server. Defaults to 33001.
targetRate	`number`	The target rate, in kbps, of the transfer. Defaults to 20480 kpbs.
assets	`array` (required)	The list of assets to transfer.
assets[].id	`string` (required)	The unique identifier of the asset to transfer.
assets[].destinationPath	`string`	The path on the remote Aspera instance where the file will be transferred.
assets[].transferSourceFile	`boolean`	Indicates if the asset’s source file should be transferred. Defaults to true.
assets[].elements	`array`	The list of asset elements that should be transferred with this request.
assets[].elements[].id	`string`	The unique identifer for the element to transfer. Invalid element ids will be ignored.
assets[].elements[].destinationPath	`string`	The path on the remote Aspera instance where the file will be transferred.
assets[].proxies	`array`	The list of of asset proxies that should be transferred with this request.
assets[].proxies[].type	`string`	The type of proxy to transfer. If `all` is provided all proxies will be transferred. Invalid proxy types will be ignored. Check the Previews section for available proxy types.
assets[].proxies[].destinationPath	`string`	The path on the remote Aspera instance where the file will be transferred.
assets[].thumbnails	`array`	The list of asset thumbnails that should be transferred with this request.
assets[].thumbnails[].type	`string`	The type of thumbnail to transfer. If `all` is provided all thumbnails will be transferred. Invalid thumbnails types will be ignored. Check the Previews section for available thumbnail types.
assets[].thumbnails[].destinationPath	`string`	The path on the remote Aspera instance where the file will be transferred.
folders	`array`	The list of folders that should be transferred with this request.
folders[].id	`string` (required)	The unique identifier of the folder to transfer.
folders[].destinationPath	`string`	The path on the remote Aspera instance where the folder will be transferred.

Responses200409

Headers

Content-Type: application/json

Body

{
  "count": 1,
  "errorCount": 1,
  "errors": [
    {
      "name": "Item name",
      "kind": "Item",
      "errorCode": "ItemNotFound",
      "errorMessage": "Item not found.",
      "id": "ad9289a2019a4e07a08eca9459ef1091"
    }
  ],
  "items": [
    {
      "id": "moqxhkej4epvgrwz",
      "assetId": "",
      "name": "Movie.mov",
      "kind": "Asset",
      "type": "",
      "transferSessionId": "lj6u9aeqj8m3xkx7"
    },
    {
      "id": "",
      "assetId": "6b9i17kcyci4e46k",
      "name": "Movie.mov",
      "kind": "Proxy",
      "type": "video-hd",
      "transferSessionId": "lj6u9aeqj8m3xkx7"
    }
  ],
  "transferSessions": [
    {
      "id": "lj6u9aeqj8m3xkx7",
      "assetIds": [
        "moqxhkej4epvgrwz"
      ],
      "folderIds": [
        "6b9i17kcyci4e46k"
      ]
    }
  ]
}

Property name	Type	Description
count	`number`	The number of items.
errorCount	`number`	The number of invalid items.
errors	`array`	An array containing information for each error item.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].id	`string`	The unique identifier for the item.
items	`array` (required)	An array containing information about each asset or folder being transferred.
items[].id	`string` (required)	If available, the unique identifier for the asset, element, or folder transferred. This property will not be returned for proxies and thumbnails.
items[].assetId	`string` (required)	If available, the unique identifier for the element, proxy, or thumbnail’s parent asset id. This property will not be returned for assets or folders.
items[].name	`string` (required)	The name of the item being transferred.
items[].kind	`string` (required)	The kind of item being transferred. Can be ‘Asset’, ‘Element’, ‘Proxy’, ‘Thumbnail’, or ‘Folder’ for this resource.
items[].type	`string` (required)	If the item kind is ‘Proxy’ or ‘Thumbnail’, this property indicates the type of proxy or thumbnail returned. Will not be returned for ‘Asset’, ‘Element’, or ‘Folder’ kinds.
items[].transferSessionId	`string` (required)	If available, The transfer session id used to transfer this asset. This value is not returned for folders being transferred.
transferSessions	`array`	An array containing information about each Aspera transfer session. At most there will be two transfer sessions; one for active (non-archived files) and one for any archived and restored files.
transferSessions[].id	`string`	The unique identifier for the transfer session.
transferSessions[].assetIds	`array`	An array containing all asset ids involved in the Aspera transfer session.
transferSessions[].folderIds	`array`	An array containing all folder ids involved in the Aspera transfer session.

Headers

Content-Type: application/json

Body

{
  "count": 0,
  "errorCount": 1,
  "errors": [
    {
      "name": "Item name",
      "kind": "Item",
      "errorCode": "ItemNotFound",
      "errorMessage": "Item not found.",
      "id": "ad9289a2019a4e07a08eca9459ef1091"
    }
  ]
}

Property name	Type	Description
count	`number`	The number of successful items.
errorCount	`number`	The number of invalid items.
errors	`array`	An array containing information for each error item.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].id	`string`	The unique identifier for the item.

Create Aspera Push Transfer
POST`/transfer/aspera`

Description

Initiates an Aspera push transfer.

500 is the maximum number of individual assets that can be transferred in a single operation.

20,000 is the maximum number of folder assets that can be transferred in a single operation.

Only assets from a single Workspace can be sent during a transfer operation.

Folders transfers and individual asset transfers cannot be sent in the same request. You must declare one or the other.

Errors

Status Code	Error Code	Message	Notes
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	InvalidRequest	Invalid Aspera transfer configuration. Please supply all required properties for the Aspera transfer.
400	InvalidRequest	This operation cannot be invoked on assets and folders in the same request.
400	AssetIdNotProvided	Asset Id not provided.
400	ExceededMaxAssetCount	Max asset count exceeded. The maximum number of assets is 500.
400	ExceededMaxAssetCount	Max asset count exceeded for the Aspera transfer request. The maximum number of assets is 20000.
400	InvalidAssets	Assets belong to multiple workspaces.
409	EntitlementRequired	Workspace does not have Aspera enabled.
409	BulkOperationFailed	The bulk operation failed. See the errors array for more information.	This message appears if there were no transfers initiated.

Errors represented in errors array

Error Code	Message
AssetNotFound	Asset not found.
AssetDeleted	Asset is deleted.
AssetTrashed	Asset is trashed.
FolderNotFound	Folder not found.
FolderDeleted	Folder is deleted.
FolderTrashed	Folder is trashed.
InvalidAssetState	Asset has not been uploaded. Please try again once the asset is uploaded.
InvalidAssetState	Asset is currently being archived and cannot be transferred using Aspera. The asset archive operation must complete and the Asset must be restored before it can be transferred.
InvalidAssetState	Asset is currently being restored and cannot be transferred using Aspera. The asset restore operation must complete before it can be transferred.
InvalidAssetState	Asset is archived and cannot be transferred using Aspera. The asset must be restored before it can be transferred.

Get Aspera Push Transfer Status ¶

GET https://api.cimediacloud.com/transfers/lj6u9aeqj8m3xkx7

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200409

Headers

Content-Type: application/json

Body

{
  "bytesWritten": 2048,
  "count": 2,
  "elapsed": 1000,
  "errorMessage": "",
  "status": "Completed",
  "items": [
    {
      "id": "moqxhkej4epvgrwz",
      "assetId": "",
      "name": "Movie.mov",
      "kind": "Asset",
      "type": "",
      "status": "Completed",
      "bytesWritten": 2048,
      "size": 2048,
      "errorMessage": ""
    },
    {
      "id": "",
      "assetId": "6b9i17kcyci4e46k",
      "name": "Movie.mov",
      "kind": "Proxy",
      "type": "video-hd",
      "status": "Completed",
      "bytesWritten": 2048,
      "size": 2048,
      "errorMessage": ""
    },
    {
      "id": "moqxhkej4epvgrwz",
      "name": "Folder Name",
      "kind": "Folder"
    }
  ]
}

Property name	Type	Description
bytesWritten	`number`	If available, number of bytes written to disk for the entire transfer session.
count	`number`	The number of assets, elements, proxies, thumbnails, or folders to be transferred.
elapsed	`number`	If available, number of microseconds since the transfer session was initiated.
errorMessage	`string`	If available, a description of any error encountered.
status	`string`	The status of the transfer. Valid values are ‘Waiting’, ‘Completed’, ‘Running’, ‘Paused’, ‘Cancelled’, ‘Error’.
items	`array` (required)	Information about each item that will be transferred.
items[].id	`string` (required)	If available, the unique identifier for the asset, element, or folder being transferred. This property will not be returned for proxies and thumbnails.
items[].assetId	`string` (required)	If available, the unique identifier for the element, proxy, or thumbnail’s parent asset id. This property will not be returned for assets or folders.
items[].name	`string` (required)	The name of the item.
items[].kind	`string` (required)	The kind of item returned. Can be ‘Asset’, ‘Element’, ‘Proxy’, ‘Thumbnail’, or ‘Folder’ for this resource.
items[].type	`string` (required)	If the item kind is ‘Proxy’ or ‘Thumbnail’, this property indicates the type of proxy or thumbnail returned. Will not be returned for ‘Asset’, ‘Element’, and ‘Folder’ kinds.
items[].status	`string` (required)	If available, the status of the asset transfer. Valid values are ‘Waiting’, ‘Completed’, ‘Running’, ‘Paused’, ‘Cancelled’, ‘Error’. Will not be returned for folder transfers.
items[].bytesWritten	`number` (required)	If available, the number of bytes written to disk for this asset. Will not be returned for folder transfers.
items[].size	`number` (required)	If available, the size of the asset, in bytes. Will not be returned for folder transfers.
items[].errorMessage	`string` (required)	If available, a description of any error encountered. Will not be returned for folder transfers.

Headers

Content-Type: application/json

Body

{
  "code": "InvalidRequest",
  "message": "Invalid request. Check the request body format and verify the right Content-Type header value is being sent."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Get Aspera Push Transfer Status
GET`/transfers/{transferSessionId}`

URI Parameters

HideShow

transferSessionId: string (required)
The unique identifier for the Aspera push transfer session.

Description

Gets the transfer status for an Aspera transfer session.

Errors

Status Code	Error Code	Message
404	TransferSessionNotFound	Transfer session not found.

Archive and Restore ¶

Ci API allows for asset source files to be archived to low cost, highly durable storage. This is perfect for source files that don’t need to be accessed often or where a 3-6 hour delay for retrieval can be accommodated. Asset proxies, elements, and thumbnails remain available if an asset’s source file is archived.

We find customers using this feature once they’ve completed a project and no longer require instant access to the files but want to keep them stored securely and cheaply. Others use it as a scalable and reliable off-site disaster recovery location.

Assets that have had their source files archived can be permanently restored or temporarily restored (for a time-period of your choosing). The restore process typically completes in 3-6 hours.

You can check on the archive status, restore status, or restore expiration at any time by calling Get asset details. Additionally, you can receiving a webhook message when the archive status or restore status is changed.

Archive Details

While the archive request is immediate, the archival process takes time (typically between 24 and 48 hours but could take longer). During the archive process, the asset’s ArchiveStatus changes from ‘Not archived’ to ‘Archive in progress’. Once the process is complete, the asset’s ArchiveStatus changes from ‘Archive in progress’ to ‘Archived’ and its source file is no longer available for download.

The asset must be restored using the Restore operation prior to becoming downloadable again.

Cancel Asset Archive

Canceling an asset archive operation will stop the archive process and make the asset available for download immediately. This operation can only be performed on assets that are currently archiving (ArchiveStatus = ‘Archive in progress’). If the archive operation has completed you cannot cancel an archive, you must restore it in order to download the original source file.

Restore Details

Assets can be permanently restored or temporarily restored (for a specific number of days). The restore operation may take up to 6 hours to complete.

Temporary Restores

When a temporary restore is requested the RestoreStatus changes from ‘Not restored’ to ‘Restore in progress’. Once the restore process completes, the asset’s RestoreStatus changes from ‘Restore in progress’ to ‘Restored’. After the asset is restored its source file can be accessed just like any other non-archived asset.

You can set the expiration of the temporary restore using a specific number of days. After the restored copy expires, it is automatically deleted from the temporary location and its’ RestoreStatus switches back from ‘Restored’ to ‘Not restored’.

If you need to extend the availability of an asset’s restored source file beyond the scheduled ‘restoreExpirationDate’ simply call the Restore resource again and specify the number of days that you would like to keep the asset’s source file available.

Temporarily restored assets cannot be immediately expired by setting a 0 day expiration. The lowest expiration value allowed is 1.

Temporarily restored assets will expire at 12:00 AM of the day following expiration date. So, in other words, it is available the entire day it expires. Additionally, the restore expiration day count begins after the asset is restored (not when the restore is requested).

Permanent Restores

When a permanent restore is requested the RestoreStatus changes from ‘Not restored’ to ‘Restore in progress’. Once the restore process completes, the asset’s RestoreStatus changes from ‘Restore in progress’ to ‘Not restored’ and its’ ArchiveStatus changes from ‘Archived’ to ‘Not archived’. The asset can be re-archived at a later date.

Archive an Asset ¶

POST https://api.cimediacloud.com/assets/83c2f12a6d794c8c9c49530a6e18b3d7/archive

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "archiveType": "Standard"
}

Property name	Type	Description
archiveType	`string`	The kind of archive to be used. Can only be `Standard` or `Deep`.

Responses200404

Headers

Content-Type: application/json

Body

{
  "message": "Asset archive has started."
}

Property name	Type	Description
message	`string`	Indicates the asset archive process has started.

Headers

Content-Type: application/json

Body

{
  "code": "AssetNotFound",
  "message": "Asset not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Archive an Asset
POST`/assets/{assetId}/archive`

URI Parameters

HideShow

assetId: string (required)
The unique identifier of the asset.

Description

Archives a single asset.

Errors

Status Code	Error Code	Message
400	InvalidArchiveType	Invalid archive type. The allowed values are ‘Standard’ or ‘Deep’.
404	AssetNotFound	Asset not found.
404	AssetDeleted	Asset is deleted.
409	InvalidAssetState	Asset is already being archived.
409	InvalidAssetState	Asset has already been archived.
409	InvalidAssetState	Asset was not uploaded. The asset must be uploaded before the archive process can begin.
409	InvalidAssetState	Asset archive is being canceled. Archive and restore operations are not available until the previous archive is canceled.

Archive Multiple Assets ¶

POST https://api.cimediacloud.com/assets/archive

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "assetIds": [
    "83c2f12a6d794c8c9c49530a6e18b3d7"
  ],
  "archiveType": "Standard"
}

Property name	Type	Description
assetIds	`array`	The unique identifiers for all assets.
archiveType	`string`	The kind of archive to be used. Can only be `Standard` or `Deep`.

Responses200409

Headers

Content-Type: application/json

Body

{
  "completeCount": 1,
  "errorCount": 1,
  "errors": [
    {
      "name": "Item name",
      "kind": "Item",
      "errorCode": "ItemNotFound",
      "errorMessage": "Item not found.",
      "id": "ad9289a2019a4e07a08eca9459ef1091"
    }
  ],
  "complete": [
    {
      "id": "d9bf018c804a4e78b775b8dc2f242071",
      "name": "Movie.mov",
      "kind": "Asset"
    }
  ]
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors	`array`	An array containing information about each failed item.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].id	`string`	The unique identifier for the item.
complete	`array`	An array containing information about each completed item.
complete[].id	`string`	The unique identifier of the asset.
complete[].name	`string`	The name of asset and its extension.
complete[].kind	`string`	The kind of item returned. Will be ‘Asset’ for assets.

Headers

Content-Type: application/json

Body

{
  "completeCount": 0,
  "errorCount": 1,
  "errors": [
    {
      "name": "Item name",
      "kind": "Item",
      "errorCode": "ItemNotFound",
      "errorMessage": "Item not found.",
      "id": "ad9289a2019a4e07a08eca9459ef1091"
    }
  ]
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors	`array`	An array containing information about each failed item.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].id	`string`	The unique identifier for the item.

Archive Multiple Assets
POST`/assets/archive`

Description

Archives multiple assets in a single operation.

500 is the maximum number of assets that can be archived in a single operation.

Errors

Status Code	Error Code	Message	Notes
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	AssetIdNotProvided	Asset Id not provided.
400	ExceededMaxAssetCount	Max asset count exceeded. The maximum number of assets is 500.
400	InvalidArchiveType	Invalid archive type. The allowed values are ‘Standard’ or ‘Deep’.
409	BulkOperationFailed	The bulk operation failed. See the errors array for more information.	This message appears if there were no successfully archived assets.

Errors represented in errors array

Error Code	Message
AssetNotFound	Asset not found.
AssetDeleted	Asset is deleted.
InvalidAssetState	Asset is already being archived.
InvalidAssetState	Asset has already been archived.
InvalidAssetState	Asset was not uploaded. The asset must be uploaded before the archive process can begin.
InvalidAssetState	Asset archive is being canceled. Archive and restore operations are not available until the previous archive is canceled.

Archive a Folder ¶

POST https://api.cimediacloud.com/folders/4361adc11af74744b6e7bc6b1194929c/archive

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "archiveType": "Standard"
}

Property name	Type	Description
archiveType	`string`	The kind of archive to be used. Can only be `Standard` or `Deep`.

Responses200404

Headers

Content-Type: application/json

Body

{
  "message": "Folder archive has started."
}

Property name	Type	Description
message	`string`	Indicates the folder archive process has started.

Headers

Content-Type: application/json

Body

{
  "code": "FolderNotFound",
  "message": "Folder not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Archive a Folder
POST`/folders/{folderId}/archive`

URI Parameters

HideShow

folderId: string (required)
The unique identifier of the folder.

Description

Archives all assets in the folder and its sub-folders. To be considered for archive an asset must be fully uploaded and not be archived, currently archiving, trashed or deleted.

Archiving a folder only archives the existing assets contained within it. Assets added at a later date will not be automatically archived. The archive operation can be used each time content is added to a folder to ensure all assets that are in the folder, and not archived, will start the archive process.

Errors

Status Code	Error Code	Message
400	InvalidArchiveType	Invalid archive type. The allowed values are ‘Standard’ or ‘Deep’.
404	FolderNotFound	Folder not found.
404	FolderDeleted	Folder is deleted.
409	FolderTrashed	Folder is trashed.

Archive Multiple Folders ¶

POST https://api.cimediacloud.com/folders/archive

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "folderIds": [
    "83c2f12a6d794c8c9c49530a6e18b3d7"
  ],
  "archiveType": "Standard"
}

Property name	Type	Description
folderIds	`array`	The unique identifiers for all folders.
archiveType	`string`	The kind of archive to be used. Can only be `Standard` or `Deep`.

Responses200409

Headers

Content-Type: application/json

Body

{
  "completeCount": 1,
  "errorCount": 1,
  "errors": [
    {
      "name": "Item name",
      "kind": "Item",
      "errorCode": "ItemNotFound",
      "errorMessage": "Item not found.",
      "id": "ad9289a2019a4e07a08eca9459ef1091"
    }
  ],
  "complete": [
    {
      "id": "9b639e12a82f4b0483f512b474dc052ci",
      "name": "Folder Name",
      "kind": "Folder"
    }
  ]
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors	`array`	An array containing information about each failed item.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].id	`string`	The unique identifier for the item.
complete	`array`	An array containing information about each completed item.
complete[].id	`string`	The unique identifier of the folder.
complete[].name	`string`	The name of folder.
complete[].kind	`string`	The kind of item returned. Will be ‘Folder’ for folders.

Headers

Content-Type: application/json

Body

{
  "completeCount": 0,
  "errorCount": 1,
  "errors": [
    {
      "name": "Item name",
      "kind": "Item",
      "errorCode": "ItemNotFound",
      "errorMessage": "Item not found.",
      "id": "ad9289a2019a4e07a08eca9459ef1091"
    }
  ]
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors	`array`	An array containing information about each failed item.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].id	`string`	The unique identifier for the item.

Archive Multiple Folders
POST`/folders/archive`

Description

Archives multiple folders in a single operation.

500 is the maximum number of folders that can be archived in a single operation.

Errors

Status Code	Error Code	Message	Notes
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	FolderIdNotProvided	Folder Id not provided.
400	ExceededMaxFolderCount	Max folder count exceeded. The maximum number of folders is 500.
400	InvalidArchiveType	Invalid archive type. The allowed values are ‘Standard’ or ‘Deep’.
409	BulkOperationFailed	The bulk operation failed. See the errors array for more information.	This message appears if there were no successfully archived folders.

Errors represented in errors array

Error Code	Message
FolderNotFound	Folder not found.

Cancel Archive ¶

POST https://api.cimediacloud.com/assets/83c2f12a6d794c8c9c49530a6e18b3d7/archive/cancel

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200404

Headers

Content-Type: application/json

Body

{
  "message": "Asset archive was canceled."
}

Property name	Type	Description
message	`string`	Indicates the asset archive process was canceled.

Headers

Content-Type: application/json

Body

{
  "code": "AssetNotFound",
  "message": "Asset not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Cancel Archive
POST`/assets/{assetId}/archive/cancel`

URI Parameters

HideShow

assetId: string (required)
The unique identifier of the asset.

Description

Cancels the archive operation for an asset.

Errors

Status Code	Error Code	Message
404	AssetNotFound	Asset not found.
404	AssetDeleted	Asset is deleted.
409	InvalidAssetState	Asset archive has already completed and cannot be canceled after completion.
409	InvalidAssetState	Asset archive has not been initiated. There must be an active archive in progress in order for cancelation to succeed.

Cancel Multiple Archives ¶

POST https://api.cimediacloud.com/assets/archive/cancel

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "assetIds": [
    "83c2f12a6d794c8c9c49530a6e18b3d7"
  ]
}

Property name	Type	Description
assetIds	`array`	The unique identifiers for all assets.

Responses200409

Headers

Content-Type: application/json

Body

{
  "completeCount": 1,
  "errorCount": 1,
  "errors": [
    {
      "name": "Item name",
      "kind": "Item",
      "errorCode": "ItemNotFound",
      "errorMessage": "Item not found.",
      "id": "ad9289a2019a4e07a08eca9459ef1091"
    }
  ],
  "complete": [
    {
      "id": "d9bf018c804a4e78b775b8dc2f242071",
      "name": "Movie.mov",
      "kind": "Asset"
    }
  ]
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors	`array`	An array containing information about each failed item.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].id	`string`	The unique identifier for the item.
complete	`array`	An array containing information about each completed item.
complete[].id	`string`	The unique identifier of the asset.
complete[].name	`string`	The name of asset and its extension.
complete[].kind	`string`	The kind of item returned. Will be ‘Asset’ for assets.

Headers

Content-Type: application/json

Body

{
  "completeCount": 0,
  "errorCount": 1,
  "errors": [
    {
      "name": "Item name",
      "kind": "Item",
      "errorCode": "ItemNotFound",
      "errorMessage": "Item not found.",
      "id": "ad9289a2019a4e07a08eca9459ef1091"
    }
  ]
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors	`array`	An array containing information about each failed item.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].id	`string`	The unique identifier for the item.

Cancel Multiple Archives
POST`/assets/archive/cancel`

Cancels archive for multiple assets in a single operation.

500 is the maximum number of assets archives that can be cancelled in a single operation.

Errors

Status Code	Error Code	Message	Notes
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	AssetIdNotProvided	Asset Id not provided.
400	ExceededMaxAssetCount	Max asset count exceeded. The maximum number of assets is 500.
409	BulkOperationFailed	The bulk operation failed. See the errors array for more information.	This message appears if there were no successfully cancelled assets.

Errors represented in errors array

Error Code	Message
AssetNotFound	Asset not found.
AssetDeleted	Asset is deleted.
InvalidAssetState	Asset archive has already completed and cannot be canceled after completion.
InvalidAssetState	Asset archive has not been initiated. There must be an active archive in progress in order for cancelation to succeed.

Restore an Asset ¶

POST https://api.cimediacloud.com/assets/83c2f12a6d794c8c9c49530a6e18b3d7/restore

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "permanent": true,
  "expiryDays": 365
}

Property name	Type	Description
permanent	`boolean`	Indicates if the restore should be permanent or temporary. Defaults to false (temporary).
expiryDays	`number`	If temporary, indicates the number of the days the restored copy should be available. Default is 2 days.

Responses200404

Headers

Content-Type: application/json

Body

{
  "message": "Asset restore has started."
}

Property name	Type	Description
message	`string`	Indicates the asset archive process has started or was extended.

Headers

Content-Type: application/json

Body

{
  "code": "AssetNotFound",
  "message": "Asset not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Restore an Asset
POST`/assets/{assetId}/restore`

URI Parameters

HideShow

assetId: string (required)
The unique identifier of the asset.

Description

Restores a single asset.

Errors

Status Code	Error Code	Message
400	InvalidRestoreExpiryDays	Invalid expiry days - must be positive number greater than 0.
400	InvalidRestoreRequest	If ‘Permanent’ is ‘true’, ‘ExpiryDays’ must not be set.
404	AssetNotFound	Asset not found.
404	AssetDeleted	Asset is deleted.
409	AssetTrashed	Asset is trashed.
409	InvalidAssetState	Asset is currently being archived. Please try again once the archive operation is complete.
409	InvalidAssetState	Asset is already being restored.
409	InvalidAssetState	Asset is not archived. The file is already accessible.

Restore Multiple Assets ¶

POST https://api.cimediacloud.com/assets/restore

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "assetIds": [
    "83c2f12a6d794c8c9c49530a6e18b3d7"
  ],
  "permanent": true,
  "expiryDays": 365
}

Property name	Type	Description
assetIds	`array`	The unique identifiers for all assets.
permanent	`boolean`	Indicates if the restore should be permanent or temporary. Defaults to false (temporary).
expiryDays	`number`	If temporary, indicates the number of the days the restored copy should be available. Default is 2 days.

Responses200409

Headers

Content-Type: application/json

Body

{
  "completeCount": 1,
  "errorCount": 1,
  "errors": [
    {
      "name": "Item name",
      "kind": "Item",
      "errorCode": "ItemNotFound",
      "errorMessage": "Item not found.",
      "id": "ad9289a2019a4e07a08eca9459ef1091"
    }
  ],
  "complete": [
    {
      "id": "d9bf018c804a4e78b775b8dc2f242071",
      "name": "Movie.mov",
      "kind": "Asset"
    }
  ]
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors	`array`	An array containing information about each failed item.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].id	`string`	The unique identifier for the item.
complete	`array`	An array containing information about each completed item.
complete[].id	`string`	The unique identifier of the asset.
complete[].name	`string`	The name of asset and its extension.
complete[].kind	`string`	The kind of item returned. Will be ‘Asset’ for assets.

Headers

Content-Type: application/json

Body

{
  "completeCount": 0,
  "errorCount": 1,
  "errors": [
    {
      "name": "Item name",
      "kind": "Item",
      "errorCode": "ItemNotFound",
      "errorMessage": "Item not found.",
      "id": "ad9289a2019a4e07a08eca9459ef1091"
    }
  ]
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors	`array`	An array containing information about each failed item.
errors[].name	`string`	The name of the failed item.
errors[].kind	`string`	The kind of the failed item.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
errors[].id	`string`	The unique identifier for the item.

Restore Multiple Assets
POST`/assets/restore`

Description

Restores multiple assets in a single operation.

500 is the maximum number of assets that can be restored in a single operation.

Status Code	Error Code	Message	Notes
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	AssetIdNotProvided	Asset Id not provided.
400	ExceededMaxAssetCount	Max asset count exceeded. The maximum number of assets is 500.
400	InvalidRestoreExpiryDays	Invalid expiry days - must be positive number greater than 0.
400	InvalidRestoreRequest	If ‘Permanent’ is ‘true’, ‘ExpiryDays’ must not be set.
409	BulkOperationFailed	The bulk operation failed. See the errors array for more information.	This message appears if there were no successfully restored assets.

Errors represented in errors array

Error Code	Message
AssetNotFound	Asset not found.
AssetDeleted	Asset is deleted.
AssetTrashed	Asset is trashed.
InvalidAssetState	Asset is currently being archived. Please try again once the archive operation is complete.
InvalidAssetState	Asset is already being restored.
InvalidAssetState	Asset is not archived. The file is already accessible.

Restore a Folder ¶

POST https://api.cimediacloud.com/folders/4361adc11af74744b6e7bc6b1194929c/restore

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "permanent": true,
  "expiryDays": 365
}

Property name	Type	Description
permanent	`boolean`	Indicates if the restore should be permanent or temporary. Defaults to false (temporary).
expiryDays	`number`	If temporary, indicates the number of the days the restored copy should be available. Default is 2 days.

Responses200404

Headers

Content-Type: application/json

Body

{
  "message": "Folder restore has started."
}

Property name	Type	Description
message	`string`	Indicates the folder restore process has started.

Headers

Content-Type: application/json

Body

{
  "code": "FolderNotFound",
  "message": "Folder not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Restore a Folder
POST`/folders/{folderId}/restore`

URI Parameters

HideShow

folderId: string (required)
The unique identifier of the folder.

Description

Restores all assets in the folder and its sub-folders. Only archived assets will be restored, the rest will be skipped.

Errors

Status Code	Error Code	Message
400	InvalidRestoreExpiryDays	Invalid expiry days - must be positive number greater than 0.
400	InvalidRestoreRequest	If ‘Permanent’ is ‘true’, ‘ExpiryDays’ must not be set.
404	FolderNotFound	Folder not found.
404	FolderDeleted	Folder is deleted.
409	FolderTrashed	Folder is trashed.

Webhooks ¶

Webhooks allow you to be notified about events that occur within Ci. With webhooks your application doesn’t have to periodically poll Ci to determine whether changes have occurred.

Event notifications are delivered using a POST request to a specified callback URL. To acknowledge receipt of a notification, the specified HTTP endpoint should return an HTTP status code in the range of 200-299. If the returned status code is not in that range, we will continue to retry for 2 hours. Attempts will timeout after 5 seconds. Webhooks are asynchronous in nature and the order is not guaranteed. Also, it is possible (although very rare) that the same notification is delivered more than once.

Some of these events are also available by querying List Workspace Events.

The API user must be a Network Admin in the Company Network in order to create / update webhooks.

Although it is possible to use an HTTP URL for webhook endpoints, we strongly recommend using HTTPS, as it significantly reduces the risk to you or your customers of being exposed to a man-in-the-middle attack. There is sensitive data that may appear in a webhook message including ids, names, emails and others.

If you use HTTPS for your webhook endpoint, your server must be correctly configured to support HTTPS with a valid server certificate, issued by a pertinent certificate authority. Self-signed server certificates are not supported.

For development and testing environments there are a couple options for testing webhooks with HTTPS enabled endpoints:

Use a free certificate authority such as Let’s Encrypt.
Configure a webhook endpoint hosted by an external service such as ngrok.

The following event types can be used when filtering for Workspace events:

MoveAsset - Asset was moved to a different folder.
CopyAsset - Asset was copied into the Workspace.
TrashAsset - Asset is trashed.
DeleteAsset - Asset is deleted.
DeleteElement - Element is deleted.
JobStatusChange - A media service job’s status has changed.
AssetProcessingFinished - Asset is done processing (please note: the result of that processing activity could have the following asset statuses - Complete, Limited, VirusDetected, ExecutableDetected).
ElementProcessingFinished - Element is done processing.
AssetArchiveStatusChange - The archive status of an asset changed.
AssetRestoreStatusChange - The restore status of an asset changed.
LockElement - Element is locked.
UnlockElement - Element is unlocked.
CopyAssetsToWorkspace - Asset is copied to a Workspace.
CopyAssetsToCatalog - Asset is copied to a Workspace.
AssetMetadataChange - Asset’s metadata has been updated.
ElementMetadataChange - Element’s metadata has been updated.

Webhook Event Example ¶

POST /customer-provided-url/webhooks

RequestsBasic Asset EventBasic Element EventAsset Restore EventJob Status Change Event

Headers

Content-Type: application/json

Body

{
  "id": "6vzdrfgzff0teglw",
  "type": "AssetProcessingFinished",
  "createdOn": "2017-01-02T00:00:00.000Z",
  "createdBy": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith",
    "email": "johnsmith@example.com"
  },
  "assets": [
    {
      "id": "kayc4skb5dkk49k7",
      "name": "Movie.mov"
    }
  ]
}

Property name	Type	Description
id	`string`	The unique identifier of the event.
type	`string`	The type of the event.
createdOn	`string`	The datetime the event occurred.
createdBy	`object`	Information about the account that created the event.
createdBy.id	`string`	The unique identifier of the user.
createdBy.name	`string`	The full name of the user.
createdBy.email	`string`	The email of the user.
assets	`array` (required)	If available, the set of Asset involved in the event.
assets[].id	`string` (required)	The unique identifier of the Asset.
assets[].name	`string` (required)	The name of the Asset.

Responses200

Headers

Content-Type: application/json

Body

{
  "message": "Webhook event received."
}

Property name	Type	Description
message	`string`	Example response from customer provided endpoint.

Headers

Content-Type: application/json

Body

{
  "id": "6vzdrfgzff0teglw",
  "type": "AssetProcessingFinished",
  "createdOn": "2017-01-02T00:00:00.000Z",
  "createdBy": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith",
    "email": "johnsmith@example.com"
  },
  "elements": [
    {
      "id": "kayc4skb5dkk49k7",
      "name": "Movie.mov"
    }
  ]
}

Property name	Type	Description
id	`string`	The unique identifier of the event.
type	`string`	The type of the event.
createdOn	`string`	The datetime the event occurred.
createdBy	`object`	Information about the account that created the event.
createdBy.id	`string`	The unique identifier of the user.
createdBy.name	`string`	The full name of the user.
createdBy.email	`string`	The email of the user.
elements	`array` (required)	If available, the set of Elements involved in the event.
elements[].id	`string` (required)	The unique identifier of the Element.
elements[].name	`string` (required)	The name of the Element.

Responses200

Headers

Content-Type: application/json

Body

{
  "message": "Webhook event received."
}

Property name	Type	Description
message	`string`	Example response from customer provided endpoint.

Headers

Content-Type: application/json

Body

{
  "id": "6vzdrfgzff0teglw",
  "type": "AssetRestoreStatusChange",
  "createdOn": "2017-01-02T00:00:00.000Z",
  "createdBy": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith",
    "email": "johnsmith@example.com"
  },
  "assets": [
    {
      "id": "kayc4skb5dkk49k7",
      "name": "Movie.mov",
      "archiveStatus": "Archived",
      "previousArchiveStatus": "Archived",
      "restoreStatus": "Restore",
      "previousRestoreStatus": "Restore in progress"
    }
  ]
}

Property name	Type	Description
id	`string`	The unique identifier of the event.
type	`string`	The type of the event.
createdOn	`string`	The datetime the event occurred.
createdBy	`object`	Information about the account that created the event.
createdBy.id	`string`	The unique identifier of the user.
createdBy.name	`string`	The full name of the user.
createdBy.email	`string`	The email of the user.
assets	`array` (required)	If available, the set of Assets involved in the event.
assets[].id	`string` (required)	The unique identifier of the Asset.
assets[].name	`string` (required)	The name of the Asset.
assets[].archiveStatus	`string` (required)	If available, indicates the archive status that triggered the event.
assets[].previousArchiveStatus	`string` (required)	If available, indicates the previous archive status of the Asset.
assets[].restoreStatus	`string` (required)	If available, indicates the restore status that triggered the event.
assets[].previousRestoreStatus	`string` (required)	If available, indicates the previous restore status of the Asset.

Responses200

Headers

Content-Type: application/json

Body

{
  "message": "Webhook event received."
}

Property name	Type	Description
message	`string`	Example response from customer provided endpoint.

Headers

Content-Type: application/json

Body

{
  "id": "6vzdrfgzff0teglw",
  "type": "JobStatusChange",
  "createdOn": "2017-01-02T00:00:00.000Z",
  "createdBy": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith",
    "email": "johnsmith@example.com"
  },
  "elements": [
    {
      "id": "pedm8sg1mbu96sld",
      "assetId": "kayc4skb5dkk49k7"
    }
  ],
  "job": {
    "id": "dylj3rn0w7oyrvf3",
    "status": "Complete",
    "previousStatus": "Processing",
    "type": "exampletype",
    "kind": "examplekind"
  }
}

Property name	Type	Description
id	`string`	The unique identifier of the event.
type	`string`	The type of the event.
createdOn	`string`	The datetime the event occurred.
createdBy	`object`	Information about the account that created the event.
createdBy.id	`string`	The unique identifier of the user.
createdBy.name	`string`	The full name of the user.
createdBy.email	`string`	The email of the user.
elements	`array` (required)	If available, the set of elements involved in the event.
elements[].id	`string` (required)	The unique identifier of the Element.
elements[].assetId	`string` (required)	The unique identifier of the Element’s parent asset.
job	`object`	If available, the job involved in the event.
job.id	`string`	The unique identifier of the job.
job.status	`string`	Indicates the processing status of the job. Returned values include ‘Waiting’, ‘Processing’, ‘Complete’ or ‘Failed’.
job.previousStatus	`string`	If available, indicates the previous processing status of the job.
job.type	`string`	The type of the job that was requested.
job.kind	`string`	Indicates the kind of specifications were provided. This value will be ‘Proxy’ for proxies and ‘General’ for general jobs.

Responses200

Headers

Content-Type: application/json

Body

{
  "message": "Webhook event received."
}

Property name	Type	Description
message	`string`	Example response from customer provided endpoint.

Webhook Event Example
POST`/customer-provided-url/webhooks`

Description

This is an example webhook POST from Ci to a customer provided endpoint.

Create Webhook ¶

POST https://api.cimediacloud.com/networks/moqxhkej4epvgrwz/webhooks

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "url": "https://example.com/webhooks",
  "events": [
    "AssetProcessingFinished"
  ],
  "name": "Webhook name",
  "workspaceIds": [
    "iugfe0x98bfwyhfr"
  ],
  "credentials": {
    "username": "username",
    "password": "password"
  }
}

Property name	Type	Description
url	`string` (required)	The URL where the webhook should send the POST request when the event occurs. Its scheme must be HTTP or HTTPS.
events	`array` (required)	The type of events that will trigger the webhook. Currently, the supported values are ‘AssetProcessingFinished’, ‘TrashAsset’, ‘DeleteAsset’, ‘JobStatusChange’, ‘AssetArchiveStatusChange’ and ‘AssetRestoreStatusChange’.
name	`string`	An optional friendly name, for reference.
workspaceIds	`array`	A list of workspace ids, which will narrow the scope of the subscription. Only events that belong to those workspace will trigger the webhook. If no workspace ids are specified then all workspaces in the network will be subscribed.
credentials	`object`	Basic authorization credentials used to connect to the webhook. Ci will send these credentials in the Authorization header using the basic format.
credentials.username	`string`	Username used to connect to the webhook endpoint
credentials.password	`string`	Password used to connect to the webhook endpoint

Responses200404

Headers

Content-Type: application/json

Body

{
  "id": "d6967q5p2l8sk898",
  "url": "https://example.com/webhooks",
  "events": "JobStatusChange x",
  "name": "Webhook name",
  "createdOn": "2017-01-02T00:00:00.000Z",
  "workspaces": [
    {
      "id": "gb5ehomv0iv71swg",
      "name": "Workspace Name",
      "class": "Enterprise"
    }
  ],
  "createdBy": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith",
    "email": "johnsmith@example.com"
  }
}

Property name	Type	Description
id	`string`	The unique identifier of the webhook.
url	`string`	The registered callback URL.
events	`string`	The list of events that the webhook handles.
name	`string`	The friendly name, if any.
createdOn	`string`	The datetime the webhook was created.
workspaces	`array`	Set of workspaces associated with the webhook.
workspaces[].id	`string`	The unique identifier of the Workspace.
workspaces[].name	`string`	The name of the Workspace.
workspaces[].class	`string`	Indicates if the Workspace is a ‘Personal’ or ‘Team’ Workspace.
createdBy	`object`	Information about the webhook creator.
createdBy.id	`string`	The unique identifier of the user.
createdBy.name	`string`	The full name of the user.
createdBy.email	`string`	The email of the user.

Headers

Content-Type: application/json

Body

{
  "code": "NetworkNotFound",
  "message": "Network not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Create Webhook
POST`/networks/{networkId}/webhooks`

URI Parameters

HideShow

networkId: string (required)
The unique identifier of the webhook’s parent network.

Description

Creates a webhook subscription for one or more workspaces in a network.

Errors

Status Code	Error Code	Message
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	WorkspaceNotFound	Workspace not found.
400	InvalidWorkspaces	Workspaces belong to multiple networks.
400	InvalidEvents	Invalid events. At least one event must be provided and all provided events must be supported. Please review API documentation for supported event types.
400	InvalidUrl	Invalid url.
404	NetworkNotFound	Network not found.

Webhooks ¶

GET https://api.cimediacloud.com/webhooks/moqxhkej4epvgrwz

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200404

Headers

Content-Type: application/json

Body

{
  "id": "d6967q5p2l8sk898",
  "url": "https://example.com/webhooks",
  "events": "JobStatusChange x",
  "name": "Webhook name",
  "createdOn": "2017-01-02T00:00:00.000Z",
  "workspaces": [
    {
      "id": "gb5ehomv0iv71swg",
      "name": "Workspace Name",
      "class": "Enterprise"
    }
  ],
  "createdBy": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith",
    "email": "johnsmith@example.com"
  }
}

Property name	Type	Description
id	`string`	The unique identifier of the webhook.
url	`string`	The registered callback URL.
events	`string`	The list of events that the webhook handles.
name	`string`	The friendly name, if any.
createdOn	`string`	The datetime the webhook was created.
workspaces	`array`	Set of workspaces associated with the webhook.
workspaces[].id	`string`	The unique identifier of the Workspace.
workspaces[].name	`string`	The name of the Workspace.
workspaces[].class	`string`	Indicates if the Workspace is a ‘Personal’ or ‘Team’ Workspace.
createdBy	`object`	Information about the webhook creator.
createdBy.id	`string`	The unique identifier of the user.
createdBy.name	`string`	The full name of the user.
createdBy.email	`string`	The email of the user.

Headers

Content-Type: application/json

Body

{
  "code": "WebhookNotFound",
  "message": "Webhook not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Get Webhook Details
GET`/webhooks/{webhookId}`

URI Parameters

HideShow

webhookId: string (required)
The unique identifier of the webhook.

Description

Retrieves the settings of the given webhook subscription.

Errors

Status Code	Error Code	Message
404	WebhookNotFound	Webhook not found.

PUT https://api.cimediacloud.com/webhooks/moqxhkej4epvgrwz

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "url": "https://example.com/webhooks",
  "events": [
    "AssetProcessingFinished"
  ],
  "name": "Webhook name",
  "workspaceIds": [
    "iugfe0x98bfwyhfr"
  ],
  "credentials": {
    "username": "username",
    "password": "password"
  }
}

Property name	Type	Description
url	`string` (required)	The URL where the webhook should send the POST request when the event occurs. Its scheme must be HTTPS.
events	`array` (required)	The type of events that will trigger the webhook. Currently, the supported values are ‘AssetProcessingFinished’, ‘TrashAsset’, ‘DeleteAsset’, ‘JobStatusChange’, ‘AssetArchiveStatusChange’ and ‘AssetRestoreStatusChange’.
name	`string`	An optional friendly name, for reference.
workspaceIds	`array`	A list of workspace ids, which will narrow the scope of the subscription. Only events that belong to those workspace will trigger the webhook. If no workspace ids are specified then all workspaces in the network will be subscribed.
credentials	`object`	Basic authorization credentials used to connect to the webhook. Ci will send these credentials in the Authorization header using the basic format.
credentials.username	`string`	Username used to connect to the webhook endpoint
credentials.password	`string`	Password used to connect to the webhook endpoint

Responses200404

Headers

Content-Type: application/json

Body

{
  "id": "d6967q5p2l8sk898",
  "url": "https://example.com/webhooks",
  "events": "JobStatusChange x",
  "name": "Webhook name",
  "createdOn": "2017-01-02T00:00:00.000Z",
  "workspaces": [
    {
      "id": "gb5ehomv0iv71swg",
      "name": "Workspace Name",
      "class": "Enterprise"
    }
  ],
  "createdBy": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith",
    "email": "johnsmith@example.com"
  }
}

Property name	Type	Description
id	`string`	The unique identifier of the webhook.
url	`string`	The registered callback URL.
events	`string`	The list of events that the webhook handles.
name	`string`	The friendly name, if any.
createdOn	`string`	The datetime the webhook was created.
workspaces	`array`	Set of workspaces associated with the webhook.
workspaces[].id	`string`	The unique identifier of the Workspace.
workspaces[].name	`string`	The name of the Workspace.
workspaces[].class	`string`	Indicates if the Workspace is a ‘Personal’ or ‘Team’ Workspace.
createdBy	`object`	Information about the webhook creator.
createdBy.id	`string`	The unique identifier of the user.
createdBy.name	`string`	The full name of the user.
createdBy.email	`string`	The email of the user.

Headers

Content-Type: application/json

Body

{
  "code": "WebhookNotFound",
  "message": "Webhook not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Update Webhook
PUT`/webhooks/{webhookId}`

URI Parameters

HideShow

webhookId: string (required)
The unique identifier of the webhook.

Description

Updates a webhook subscription.

Errors

Status Code	Error Code	Message
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	WorkspaceNotFound	Workspace not found.
400	InvalidWorkspaces	Workspaces belong to multiple networks.
400	InvalidEvents	Invalid events. At least one event must be provided. The supported events are ‘AssetProcessingFinished’, ‘TrashAsset’ and ‘DeleteAsset’.
400	InvalidUrl	Invalid url.
404	WebhookNotFound	Webhook not found.

DELETE https://api.cimediacloud.com/webhooks/moqxhkej4epvgrwz

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200404

Headers

Content-Type: application/json

Body

{
  "messages": "Webhook deleted"
}

Property name	Type	Description
messages	`string`	Indicates the webhook was deleted.

Headers

Content-Type: application/json

Body

{
  "code": "WebhookNotFound",
  "message": "Webhook not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Delete Webhook
DELETE`/webhooks/{webhookId}`

URI Parameters

HideShow

webhookId: string (required)
The unique identifier of the webhook.

Description

Deletes a webhook subscription.

Errors

Status Code	Error Code	Message
404	WebhookNotFound	Webhook not found.

List Webhooks for Network ¶

GET https://api.cimediacloud.com/networks/moqxhkej4epvgrwz/webhooks?limit=1&offset=0

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200404

Headers

Content-Type: application/json

Body

{
  "limit": 1,
  "offset": 0,
  "count": 1,
  "items": [
    {
      "id": "d6967q5p2l8sk898",
      "url": "https://example.com/webhooks",
      "events": "JobStatusChange x",
      "name": "Webhook name",
      "createdOn": "2017-01-02T00:00:00.000Z",
      "workspaces": [
        {
          "id": "gb5ehomv0iv71swg",
          "name": "Workspace Name",
          "class": "Enterprise"
        }
      ],
      "createdBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      }
    }
  ]
}

Property name	Type	Description
limit	`number`	The limit used for the query.
offset	`number`	The offset used for the query.
count	`number`	The total count of webhooks.
items	`array`	The webhooks returned.
items[].id	`string`	The unique identifier of the webhook.
items[].url	`string`	The registered callback URL.
items[].events	`string`	The list of events that the webhook handles.
items[].name	`string`	The friendly name, if any.
items[].createdOn	`string`	The datetime the webhook was created.
items[].workspaces	`array`	Set of workspaces associated with the webhook.
items[].workspaces[].id	`string`	The unique identifier of the Workspace.
items[].workspaces[].name	`string`	The name of the Workspace.
items[].workspaces[].class	`string`	Indicates if the Workspace is a ‘Personal’ or ‘Team’ Workspace.
items[].createdBy	`object`	Information about the webhook creator.
items[].createdBy.id	`string`	The unique identifier of the user.
items[].createdBy.name	`string`	The full name of the user.
items[].createdBy.email	`string`	The email of the user.

Headers

Content-Type: application/json

Body

{
  "code": "NetworkNotFound",
  "message": "Network not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

List Webhooks for Network
GET`/networks/{networkId}/webhooks{?limit,offset}`

URI Parameters

HideShow

networkId: string (required)
The unique identifier of the network.
limit: number (optional) Default: 50
The number of items to return. The maximum is 100.
offset: number (optional) Default: 0
The item at which to begin the response.

Description

List the webhooks belonging to a specified network.

Errors

Status Code	Error Code	Message
400	InvalidLimitOrOffset	Invalid limit or offset value. Limit must be a number between 1 and 100. Offset must be greater than or equal to 0.
404	NetworkNotFound	Network not found.

Custom Actions ¶

The Custom Actions feature allows admins to define end user initiated actions that can trigger external workflows by opening a custom URL with query string parameters provided by Ci. Custom Actions are initiated by Ci Workspace users who can select files and/or folders and then, using action bar or right click, select a specific action which will open a new tab with the specified URL automatically appending the selected file Id(s), folder Id(s), and user’s email as query string parameters. The URL that is opened can then read those query string parameters and do something with the files and folders the user selected - for example they could be sent to YouTube or start an approval workflow.

In the very near future, Custom Actions will be configurable to POST requests to an API. You could think of this as a user initiated webhook request.

How Custom Actions Works

Enterprise Network Admins configure Custom Actions in Account Settings and assign Custom Actions to Company Networks and Catalogs. The URL for the Custom Action will be a customer owned application that is built to accept query string parameters for asset Id(s), folder Id(s), and user email.
Company Network Admins configure which Workspaces can use the specified Custom Actions. Catalog Admins can define which Catalog Roles can use the Custom Actions.
Workspace and Catalog users can initiate a Custom Action by selecting file(s) and/or folder(s) and selecting a Custom Action. Upon selection, the configured URL opens in a new browser tab with the following query string parameters:
- assetids: The unique identifier of the selected file(s) (if applicable). If multiple files are selected this will be a comma separated list of IDs.
- folderids: The unique identifier of the selected folder (if applicable). If multiple folders are selected this will be a comma separated list of IDs.
- useremail: The email address of the authenticated user performing the action.
- Example URL requests
The external application can then extract these parameters to call Ci public APIs and retrieve detailed information about the file(s) and/or folder(s)
- For example you could use the Get Asset Details API to retrieve a specific proxy for playback or delivery to another system (see example below).
- Or you could use Get Folder Details API to get the folder name for a specific folder that was provided (see example below)
- Note: Ci does not pass any authentication information in the URL. In order to authenticate with our APIs users must still have a Ci user account with client credentials.

Example to get a specific proxy from the Get Asset Details API

import requests
client_id = "" # Add Ci Client ID
client_secret = "" # Add Ci Client Secret
encoded_credentials = "" # Add Base64 encoded Ci Credentials
proxy_type = "video-3g" # Edit for different proxy

baseUrl = "https://api.cimediacloud.com"

auth_response = requests.post(
    baseUrl + "/oauth2/token",
    data={
        "client_id": client_id,
        "client_secret": client_secret,
        "grant_type": "password",
    },
    headers={"Authorization": encoded_credentials},
)

token = auth_response.json()["access_token"]
headers = {"Authorization": "Bearer " + token}

download_response = requests.get(baseUrl + "/assets/{asset-id-from-querystring}/asset", headers=headers)
proxies = download_response["proxies"]
proxy = next(proxy for proxy in proxies if proxy["type"] == proxy_type)

return proxy["location"]

Example to get a folder name from the Get Folder Details API

import requests
client_id = "" # Add Ci Client ID
client_secret = "" # Add Ci Client Secret
encoded_credentials = "" # Add Base64 encoded Ci Credentials
proxy_type = "video-3g" # Edit for different proxy

baseUrl = "https://api.cimediacloud.com"

auth_response = requests.post(
    baseUrl + "/oauth2/token",
    data={
        "client_id": client_id,
        "client_secret": client_secret,
        "grant_type": "password",
    },
    headers={"Authorization": encoded_credentials},
)

token = auth_response.json()["access_token"]
headers = {"Authorization": "Bearer " + token}

download_response = requests.get(baseUrl + "/folders/{folder-id-from-querystring}/folder", headers=headers)

return download_response["name"]

MediaLogs ¶

Enrich videos with time-based metadata using the MediaLog WorkSession app. Note, you will need to create a new MediaLog WorkSession for this functionality to work.

WorkSession Media Logs ¶

GET https://api.cimediacloud.com/worksessions/2584c233d9884d1ea06ea438f399e751/assets/cefe26bf4efc47b5ab36318ce9323739/logs?limit=1&offset=0&orderBy=markIn&orderDirection=asc

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200

Headers

Content-Type: application/json

Body

{
  "limit": 1,
  "offset": 0,
  "count": 10,
  "order": {
    "by": "Name",
    "direction": "asc"
  },
  "items": [
    {
      "name": "Penalty Kick scene",
      "markIn": {
        "value": 5000,
        "unit": "milliseconds"
      },
      "markOut": {
        "value": 60000,
        "unit": "milliseconds"
      },
      "id": "abcy3lrs45m0qouy",
      "asset": {
        "id": "d9bf018c804a4e78b775b8dc2f242071",
        "name": "Movie.mov"
      },
      "type": "text",
      "text": "Penalty kick for the host team",
      "labels": [
        {
          "name": "attack"
        }
      ],
      "allowedValues": [
        "goal",
        "intercepted",
        "deflected"
      ],
      "values": [
        "goal"
      ],
      "color": "#FF00FF",
      "parent": {
        "id": "jh473sgj239e334",
        "name": "landscape scene",
        "type": "text"
      },
      "termId": "as34dr3426ewrt",
      "isPublished": true,
      "group": {
        "id": "grouping",
        "name": "Log group for the penalty kick scene"
      },
      "createdOn": "2018-01-02T00:00:00.000Z",
      "createdBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "modifiedOn": "2018-01-03T00:00:00.000Z",
      "workSession": {
        "id": "oj7mx3vlb2srei89",
        "name": "WorkSession name"
      }
    }
  ]
}

Property name	Type	Description
limit	`number`	The limit used for the query.
offset	`number`	The offset used for the query.
count	`number`	The total count of items available.
order	`object`	Information about the ordering of the results.
order.by	`string`	Indicates the field used to sort the results.
order.direction	`string`	Indicates the direction used to sort the results.
items	`array`	The media logs returned.
items[].name	`string` (required)	The name of the log.
items[].markIn	`object` (required)	Information about the start point of the log.
items[].markIn.value	`number` (required)	The time value that represents the start point of this log.
items[].markIn.unit	`string`	The unit of time that represents the log’s mark in start point. For now, this value can only be `milliseconds`. If omitted, defaults to `milliseconds`.
items[].markOut	`object` (required)	Information about the end point of the log.
items[].markOut.value	`number` (required)	The time value that represents the end point of this log.
items[].markOut.unit	`string`	The unit of time that represents the log’s mark out end point. For now, this value can only be `milliseconds`. If omitted, defaults to `milliseconds`.
items[].id	`string`	The unique identifier of the media log.
items[].asset	`object`	Information about the media log’s asset.
items[].asset.id	`string`	The unique identifier of the asset.
items[].asset.name	`string`	The name of asset and its extension.
items[].type	`string`	Type of the log. Valid values are `text` (used for regular strings of text), `single-select` (used for selecting one value out of multiple options) and `multi-select` (used for selecting multiple values out of multiple options).
items[].text	`string`	Descriptive text for the log when using the type of `text`.
items[].labels	`array`	An array of labels for the log.
items[].labels[].name	`string` (required)	Name of the label.
items[].allowedValues	`array`	An array of allowed values for the log. Is required for both `single-select` and `multi-select` term types. For `text` terms, this field will be discarded.
items[].values	`array`	An array of values for the log, only used for `single-select` and `multi-select` log types. These values should be contained in the allowedValues array.
items[].color	`string`	The log’s color to use in UI elements.
items[].parent	`object`	Information about the parent log of this log.
items[].parent.id	`string`	The unique identifier of the media log.
items[].parent.name	`string`	The name of the log.
items[].parent.type	`string`	Type of the log.
items[].termId	`string`	Identifier of the term used to create the log.
items[].isPublished	`boolean`	Indicates if the log data is published to the search index for visibility from search results.
items[].group	`object`	Information that can be used to group multiple logs together.
items[].group.id	`string`	1 (string) - Identifier for the group.
items[].group.name	`string`	Descriptive name for the group.
items[].createdOn	`string`	The datetime the media log was created.
items[].createdBy	`object`	Information about the creator of the media log.
items[].createdBy.id	`string`	The unique identifier of the user.
items[].createdBy.name	`string`	The full name of the user.
items[].createdBy.email	`string`	The email of the user.
items[].modifiedOn	`string`	The datetime the media log record was last modified.
items[].workSession	`object`	Information about the media log’s work session.
items[].workSession.id	`string`	The unique identifier for the WorkSession.
items[].workSession.name	`string` (required)	The name of the WorkSession.

List Media Logs
GET`/worksessions/{workSessionId}/assets/{assetId}/logs{?limit,offset,orderBy,orderDirection}`

URI Parameters

HideShow

workSessionId

string (required)

Identifier of the MediaLog WorkSession.

assetId

string (required)

Identifier of the Asset.

limit

number (optional) Default: 50

The number of logs to return. The maximum is 50.

offset

number (optional) Default: 0

The item at which to begin the response.

orderBy

string (optional) Default: markIn

The field to sort the items by.

Choices: createdOn name createdBy markIn

orderDirection

string (optional) Default: asc

The order direction the items should be returned.

Choices: asc desc

Description

Retrieves the logs recorded against an asset in a given MediaLog WorkSession.

Status Code	Error Code	Message
400	InvalidLimitOrOffset	Invalid limit or offset value. Limit must be a number between 1 and 50. Offset must be greater than or equal to 0.
400	InvalidQueryOrderField	Invalid order field. It must be either ‘CreatedOn’, ‘Name’, ‘CreatedBy’ or ‘MarkIn’.
400	InvalidQueryOrderDirection	Invalid order direction. It must be either ‘Asc’ or ‘Desc’.
404	WorkSessionNotFound	Work Session not found.
404	AssetNotFound	Asset not found.

POST https://api.cimediacloud.com/worksessions/2584c233d9884d1ea06ea438f399e751/assets/cefe26bf4efc47b5ab36318ce9323739/logs

Requestsfull example

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "name": "Penalty Kick scene",
  "markIn": {
    "value": 5000,
    "unit": "milliseconds"
  },
  "markOut": {
    "value": 60000,
    "unit": "milliseconds"
  },
  "type": "single-select",
  "text": "Penalty kick for the host team",
  "labels": [
    {
      "name": "attack"
    }
  ],
  "allowedValues": [
    "goal",
    "intercepted",
    "deflected"
  ],
  "values": [
    "goal"
  ],
  "color": "#FF00FF",
  "parentId": "Hello, world!",
  "termId": "as34dr3426ewrt",
  "group": {
    "id": "grouping1",
    "name": "Log group for the penalty kick scene"
  }
}

Property name	Type	Description
name	`string` (required)	The name of the log.
markIn	`object` (required)	Information about the start point of the log.
markIn.value	`number` (required)	The time value that represents the start point of this log.
markIn.unit	`string`	The unit of time that represents the log’s mark in start point. For now, this value can only be `milliseconds`. If omitted, defaults to `milliseconds`.
markOut	`object` (required)	Information about the end point of the log.
markOut.value	`number` (required)	The time value that represents the end point of this log.
markOut.unit	`string`	The unit of time that represents the log’s mark out end point. For now, this value can only be `milliseconds`. If omitted, defaults to `milliseconds`.
type	`string`	Type of the log. Valid values are ‘text’, ‘single-select’ and ‘multi-select’.
text	`string`	Descriptive text for the log.
labels	`array`	An array of labels for the log.
labels[].name	`string` (required)	Name of the label.
allowedValues	`array`	An array of allowed values for the log. Is required for both ‘single-select’ and ‘multi-select’ term types. For ‘text’ terms, this field will be discarded.
values	`array`	An array of values for the log, for ‘single-select’ and ‘multi-select’ log types. These values should be contained in the allowedValues array.
color	`string`	The log’s color to use in UI elements.
parentId	`string`	Unique identifier of the parent log for this log.
termId	`string`	Unique identifier of the term used to create the log, if any.
group	`object`	Information that can be used to group multiple logs together.
group.id	`string`	Identifier for the group.
group.name	`string`	Descriptive name for the group.

Responses200400

Headers

Content-Type: application/json

Body

{
  "name": "Penalty Kick scene",
  "markIn": {
    "value": 5000,
    "unit": "milliseconds"
  },
  "markOut": {
    "value": 60000,
    "unit": "milliseconds"
  },
  "id": "abcy3lrs45m0qouy",
  "asset": {
    "id": "d9bf018c804a4e78b775b8dc2f242071",
    "name": "Movie.mov"
  },
  "type": "text",
  "text": "Penalty kick for the host team",
  "labels": [
    {
      "name": "attack"
    }
  ],
  "allowedValues": [
    "goal",
    "intercepted",
    "deflected"
  ],
  "values": [
    "goal"
  ],
  "color": "#FF00FF",
  "parent": {
    "id": "jh473sgj239e334",
    "name": "landscape scene",
    "type": "text"
  },
  "termId": "as34dr3426ewrt",
  "isPublished": true,
  "group": {
    "id": "grouping",
    "name": "Log group for the penalty kick scene"
  },
  "createdOn": "2018-01-02T00:00:00.000Z",
  "createdBy": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith",
    "email": "johnsmith@example.com"
  },
  "modifiedOn": "2018-01-03T00:00:00.000Z",
  "workSession": {
    "id": "oj7mx3vlb2srei89",
    "name": "WorkSession name"
  }
}

Property name	Type	Description
name	`string` (required)	The name of the log.
markIn	`object` (required)	Information about the start point of the log.
markIn.value	`number` (required)	The time value that represents the start point of this log.
markIn.unit	`string`	The unit of time that represents the log’s mark in start point. For now, this value can only be `milliseconds`. If omitted, defaults to `milliseconds`.
markOut	`object` (required)	Information about the end point of the log.
markOut.value	`number` (required)	The time value that represents the end point of this log.
markOut.unit	`string`	The unit of time that represents the log’s mark out end point. For now, this value can only be `milliseconds`. If omitted, defaults to `milliseconds`.
id	`string`	The unique identifier of the media log.
asset	`object`	Information about the media log’s asset.
asset.id	`string`	The unique identifier of the asset.
asset.name	`string`	The name of asset and its extension.
type	`string`	Type of the log. Valid values are `text` (used for regular strings of text), `single-select` (used for selecting one value out of multiple options) and `multi-select` (used for selecting multiple values out of multiple options).
text	`string`	Descriptive text for the log when using the type of `text`.
labels	`array`	An array of labels for the log.
labels[].name	`string` (required)	Name of the label.
allowedValues	`array`	An array of allowed values for the log. Is required for both `single-select` and `multi-select` term types. For `text` terms, this field will be discarded.
values	`array`	An array of values for the log, only used for `single-select` and `multi-select` log types. These values should be contained in the allowedValues array.
color	`string`	The log’s color to use in UI elements.
parent	`object`	Information about the parent log of this log.
parent.id	`string`	The unique identifier of the media log.
parent.name	`string`	The name of the log.
parent.type	`string`	Type of the log.
termId	`string`	Identifier of the term used to create the log.
isPublished	`boolean`	Indicates if the log data is published to the search index for visibility from search results.
group	`object`	Information that can be used to group multiple logs together.
group.id	`string`	1 (string) - Identifier for the group.
group.name	`string`	Descriptive name for the group.
createdOn	`string`	The datetime the media log was created.
createdBy	`object`	Information about the creator of the media log.
createdBy.id	`string`	The unique identifier of the user.
createdBy.name	`string`	The full name of the user.
createdBy.email	`string`	The email of the user.
modifiedOn	`string`	The datetime the media log record was last modified.
workSession	`object`	Information about the media log’s work session.
workSession.id	`string`	The unique identifier for the WorkSession.
workSession.name	`string` (required)	The name of the WorkSession.

Headers

Content-Type: application/json

Body

{
  "code": "InvalidMediaLog",
  "message": "Invalid Media Log. Media Log's name, work session, asset, mark in, mark out must be provided and all fields supported. Please review Ci API documentation for valid media log requirements."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Create a Media Log
POST`/worksessions/{workSessionId}/assets/{assetId}/logs`

URI Parameters

HideShow

workSessionId: string (required)
Identifier of the MediaLog WorkSession.
assetId: string (required)
Identifier of the asset.

Description

Creates a new media log for a given asset in a MediaLog WorkSession.

Errors

Status Code	Error Code	Message
400	InvalidMediaLogType	Invalid Media Log type. Please review Ci API documentation for valid log types.
400	InvalidMediaLogValues	Invalid values provided for the Media Log. The values must be compatible with the type provided, and should be included in the allowed values for the Media Log.
400	MissingMediaLogAllowedValues	Allowed values were not provided for the Media Log. The Media Log type specified requires allowed values to be defined.
400	InvalidMediaLogMarks	Invalid mark in / mark out for the Media Log. Both marks should be provided, units should be supported, and mark out should be greatear than mark in.
400	InvalidMediaLog	Invalid Media Log. Media Log’s name, work session, asset, mark in, mark out must be provided and all fields supported. Please review Ci API documentation for valid media log requirements.
404	WorkSessionNotFound	Work Session not found.
404	AssetNotFound	Asset not found.

Asset Media Logs ¶

GET https://api.cimediacloud.com/assets/cefe26bf4efc47b5ab36318ce9323739/logs?limit=1&offset=0&orderBy=markIn&orderDirection=asc

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200

Headers

Content-Type: application/json

Body

{
  "limit": 1,
  "offset": 0,
  "count": 10,
  "order": {
    "by": "Name",
    "direction": "asc"
  },
  "items": [
    {
      "name": "Penalty Kick scene",
      "markIn": {
        "value": 5000,
        "unit": "milliseconds"
      },
      "markOut": {
        "value": 60000,
        "unit": "milliseconds"
      },
      "id": "abcy3lrs45m0qouy",
      "asset": {
        "id": "d9bf018c804a4e78b775b8dc2f242071",
        "name": "Movie.mov"
      },
      "type": "text",
      "text": "Penalty kick for the host team",
      "labels": [
        {
          "name": "attack"
        }
      ],
      "allowedValues": [
        "goal",
        "intercepted",
        "deflected"
      ],
      "values": [
        "goal"
      ],
      "color": "#FF00FF",
      "parent": {
        "id": "jh473sgj239e334",
        "name": "landscape scene",
        "type": "text"
      },
      "termId": "as34dr3426ewrt",
      "isPublished": true,
      "group": {
        "id": "grouping",
        "name": "Log group for the penalty kick scene"
      },
      "createdOn": "2018-01-02T00:00:00.000Z",
      "createdBy": {
        "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
        "name": "John Smith",
        "email": "johnsmith@example.com"
      },
      "modifiedOn": "2018-01-03T00:00:00.000Z"
    }
  ]
}

Property name	Type	Description
limit	`number`	The limit used for the query.
offset	`number`	The offset used for the query.
count	`number`	The total count of items available.
order	`object`	Information about the ordering of the results.
order.by	`string`	Indicates the field used to sort the results.
order.direction	`string`	Indicates the direction used to sort the results.
items	`array`	The media logs returned.
items[].name	`string` (required)	The name of the log.
items[].markIn	`object` (required)	Information about the start point of the log.
items[].markIn.value	`number` (required)	The time value that represents the start point of this log.
items[].markIn.unit	`string`	The unit of time that represents the log’s mark in start point. For now, this value can only be `milliseconds`. If omitted, defaults to `milliseconds`.
items[].markOut	`object` (required)	Information about the end point of the log.
items[].markOut.value	`number` (required)	The time value that represents the end point of this log.
items[].markOut.unit	`string`	The unit of time that represents the log’s mark out end point. For now, this value can only be `milliseconds`. If omitted, defaults to `milliseconds`.
items[].id	`string`	The unique identifier of the media log.
items[].asset	`object`	Information about the media log’s asset.
items[].asset.id	`string`	The unique identifier of the asset.
items[].asset.name	`string`	The name of asset and its extension.
items[].type	`string`	Type of the log. Valid values are `text` (used for regular strings of text), `single-select` (used for selecting one value out of multiple options) and `multi-select` (used for selecting multiple values out of multiple options).
items[].text	`string`	Descriptive text for the log when using the type of `text`.
items[].labels	`array`	An array of labels for the log.
items[].labels[].name	`string` (required)	Name of the label.
items[].allowedValues	`array`	An array of allowed values for the log. Is required for both `single-select` and `multi-select` term types. For `text` terms, this field will be discarded.
items[].values	`array`	An array of values for the log, only used for `single-select` and `multi-select` log types. These values should be contained in the allowedValues array.
items[].color	`string`	The log’s color to use in UI elements.
items[].parent	`object`	Information about the parent log of this log.
items[].parent.id	`string`	The unique identifier of the media log.
items[].parent.name	`string`	The name of the log.
items[].parent.type	`string`	Type of the log.
items[].termId	`string`	Identifier of the term used to create the log.
items[].isPublished	`boolean`	Indicates if the log data is published to the search index for visibility from search results.
items[].group	`object`	Information that can be used to group multiple logs together.
items[].group.id	`string`	1 (string) - Identifier for the group.
items[].group.name	`string`	Descriptive name for the group.
items[].createdOn	`string`	The datetime the media log was created.
items[].createdBy	`object`	Information about the creator of the media log.
items[].createdBy.id	`string`	The unique identifier of the user.
items[].createdBy.name	`string`	The full name of the user.
items[].createdBy.email	`string`	The email of the user.
items[].modifiedOn	`string`	The datetime the media log record was last modified.

List Asset Media Logs
GET`/assets/{assetId}/logs{?limit,offset,orderBy,orderDirection}`

URI Parameters

HideShow

assetId

string (required)

Identifier of the asset.

limit

number (optional) Default: 50

The number of logs to return. The maximum is 50.

offset

number (optional) Default: 0

The item at which to begin the response.

orderBy

string (optional) Default: markIn

The field to sort the items by.

Choices: createdOn name createdBy markIn

orderDirection

string (optional) Default: asc

The order direction the items should be returned.

Choices: asc desc

Description

Retrieves the published media log entries recorded against the given asset across all MediaLog WorkSessions the asset is part of.

Status Code	Error Code	Message
400	InvalidLimitOrOffset	Invalid limit or offset value. Limit must be a number between 1 and 50. Offset must be greater than or equal to 0.
400	InvalidQueryOrderField	Invalid order field. It must be either `CreatedOn`, `Name`, `CreatedBy` or `MarkIn`.
400	InvalidQueryOrderDirection	Invalid order direction. It must be either `Asc` or `Desc`.
403	InsufficientPermissions	Insufficient permissions for listing logs.
404	AssetNotFound	Asset not found.

Media Log ¶

GET https://api.cimediacloud.com/media-logs/sdfg39ersd4t3r44

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200404

Headers

Content-Type: application/json

Body

{
  "name": "Penalty Kick scene",
  "markIn": {
    "value": 5000,
    "unit": "milliseconds"
  },
  "markOut": {
    "value": 60000,
    "unit": "milliseconds"
  },
  "id": "abcy3lrs45m0qouy",
  "asset": {
    "id": "d9bf018c804a4e78b775b8dc2f242071",
    "name": "Movie.mov"
  },
  "type": "text",
  "text": "Penalty kick for the host team",
  "labels": [
    {
      "name": "attack"
    }
  ],
  "allowedValues": [
    "goal",
    "intercepted",
    "deflected"
  ],
  "values": [
    "goal"
  ],
  "color": "#FF00FF",
  "parent": {
    "id": "jh473sgj239e334",
    "name": "landscape scene",
    "type": "text"
  },
  "termId": "as34dr3426ewrt",
  "isPublished": true,
  "group": {
    "id": "grouping",
    "name": "Log group for the penalty kick scene"
  },
  "createdOn": "2018-01-02T00:00:00.000Z",
  "createdBy": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith",
    "email": "johnsmith@example.com"
  },
  "modifiedOn": "2018-01-03T00:00:00.000Z",
  "workSession": {
    "id": "oj7mx3vlb2srei89",
    "name": "WorkSession name"
  }
}

Property name	Type	Description
name	`string` (required)	The name of the log.
markIn	`object` (required)	Information about the start point of the log.
markIn.value	`number` (required)	The time value that represents the start point of this log.
markIn.unit	`string`	The unit of time that represents the log’s mark in start point. For now, this value can only be `milliseconds`. If omitted, defaults to `milliseconds`.
markOut	`object` (required)	Information about the end point of the log.
markOut.value	`number` (required)	The time value that represents the end point of this log.
markOut.unit	`string`	The unit of time that represents the log’s mark out end point. For now, this value can only be `milliseconds`. If omitted, defaults to `milliseconds`.
id	`string`	The unique identifier of the media log.
asset	`object`	Information about the media log’s asset.
asset.id	`string`	The unique identifier of the asset.
asset.name	`string`	The name of asset and its extension.
type	`string`	Type of the log. Valid values are `text` (used for regular strings of text), `single-select` (used for selecting one value out of multiple options) and `multi-select` (used for selecting multiple values out of multiple options).
text	`string`	Descriptive text for the log when using the type of `text`.
labels	`array`	An array of labels for the log.
labels[].name	`string` (required)	Name of the label.
allowedValues	`array`	An array of allowed values for the log. Is required for both `single-select` and `multi-select` term types. For `text` terms, this field will be discarded.
values	`array`	An array of values for the log, only used for `single-select` and `multi-select` log types. These values should be contained in the allowedValues array.
color	`string`	The log’s color to use in UI elements.
parent	`object`	Information about the parent log of this log.
parent.id	`string`	The unique identifier of the media log.
parent.name	`string`	The name of the log.
parent.type	`string`	Type of the log.
termId	`string`	Identifier of the term used to create the log.
isPublished	`boolean`	Indicates if the log data is published to the search index for visibility from search results.
group	`object`	Information that can be used to group multiple logs together.
group.id	`string`	1 (string) - Identifier for the group.
group.name	`string`	Descriptive name for the group.
createdOn	`string`	The datetime the media log was created.
createdBy	`object`	Information about the creator of the media log.
createdBy.id	`string`	The unique identifier of the user.
createdBy.name	`string`	The full name of the user.
createdBy.email	`string`	The email of the user.
modifiedOn	`string`	The datetime the media log record was last modified.
workSession	`object`	Information about the media log’s work session.
workSession.id	`string`	The unique identifier for the WorkSession.
workSession.name	`string` (required)	The name of the WorkSession.

Headers

Content-Type: application/json

Body

{
  "code": "MediaLogNotFound",
  "message": "Media Log not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Get a Media Log
GET`/media-logs/{mediaLogId}`

URI Parameters

HideShow

mediaLogId: string (required)
The unique identifier of the log.

Description

Retrieves information about a log.

Errors

Status Code	Error Code	Message
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
404	MediaLogNotFound	Media Log not found.

PUT https://api.cimediacloud.com/media-logs/sdfg39ersd4t3r44

Requestsfull example

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "name": "Penalty Kick scene",
  "markIn": {
    "value": 5000,
    "unit": "milliseconds"
  },
  "markOut": {
    "value": 60000,
    "unit": "milliseconds"
  },
  "type": "single-select",
  "text": "Penalty kick for the host team",
  "labels": [
    {
      "name": "attack"
    }
  ],
  "allowedValues": [
    "goal",
    "intercepted",
    "deflected"
  ],
  "values": [
    "goal"
  ],
  "color": "#FF00FF",
  "parentId": "Hello, world!",
  "termId": "as34dr3426ewrt",
  "group": {
    "id": "grouping1",
    "name": "Log group for the penalty kick scene"
  }
}

Property name	Type	Description
name	`string` (required)	The name of the log.
markIn	`object` (required)	Information about the start point of the log.
markIn.value	`number` (required)	The time value that represents the start point of this log.
markIn.unit	`string`	The unit of time that represents the log’s mark in start point. For now, this value can only be `milliseconds`. If omitted, defaults to `milliseconds`.
markOut	`object` (required)	Information about the end point of the log.
markOut.value	`number` (required)	The time value that represents the end point of this log.
markOut.unit	`string`	The unit of time that represents the log’s mark out end point. For now, this value can only be `milliseconds`. If omitted, defaults to `milliseconds`.
type	`string`	Type of the log. Valid values are ‘text’, ‘single-select’ and ‘multi-select’.
text	`string`	Descriptive text for the log.
labels	`array`	An array of labels for the log.
labels[].name	`string` (required)	Name of the label.
allowedValues	`array`	An array of allowed values for the log. Is required for both ‘single-select’ and ‘multi-select’ term types. For ‘text’ terms, this field will be discarded.
values	`array`	An array of values for the log, for ‘single-select’ and ‘multi-select’ log types. These values should be contained in the allowedValues array.
color	`string`	The log’s color to use in UI elements.
parentId	`string`	Unique identifier of the parent log for this log.
termId	`string`	Unique identifier of the term used to create the log, if any.
group	`object`	Information that can be used to group multiple logs together.
group.id	`string`	Identifier for the group.
group.name	`string`	Descriptive name for the group.

Responses200400

Headers

Content-Type: application/json

Body

{
  "name": "Penalty Kick scene",
  "markIn": {
    "value": 5000,
    "unit": "milliseconds"
  },
  "markOut": {
    "value": 60000,
    "unit": "milliseconds"
  },
  "id": "abcy3lrs45m0qouy",
  "asset": {
    "id": "d9bf018c804a4e78b775b8dc2f242071",
    "name": "Movie.mov"
  },
  "type": "text",
  "text": "Penalty kick for the host team",
  "labels": [
    {
      "name": "attack"
    }
  ],
  "allowedValues": [
    "goal",
    "intercepted",
    "deflected"
  ],
  "values": [
    "goal"
  ],
  "color": "#FF00FF",
  "parent": {
    "id": "jh473sgj239e334",
    "name": "landscape scene",
    "type": "text"
  },
  "termId": "as34dr3426ewrt",
  "isPublished": true,
  "group": {
    "id": "grouping",
    "name": "Log group for the penalty kick scene"
  },
  "createdOn": "2018-01-02T00:00:00.000Z",
  "createdBy": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith",
    "email": "johnsmith@example.com"
  },
  "modifiedOn": "2018-01-03T00:00:00.000Z",
  "workSession": {
    "id": "oj7mx3vlb2srei89",
    "name": "WorkSession name"
  }
}

Property name	Type	Description
name	`string` (required)	The name of the log.
markIn	`object` (required)	Information about the start point of the log.
markIn.value	`number` (required)	The time value that represents the start point of this log.
markIn.unit	`string`	The unit of time that represents the log’s mark in start point. For now, this value can only be `milliseconds`. If omitted, defaults to `milliseconds`.
markOut	`object` (required)	Information about the end point of the log.
markOut.value	`number` (required)	The time value that represents the end point of this log.
markOut.unit	`string`	The unit of time that represents the log’s mark out end point. For now, this value can only be `milliseconds`. If omitted, defaults to `milliseconds`.
id	`string`	The unique identifier of the media log.
asset	`object`	Information about the media log’s asset.
asset.id	`string`	The unique identifier of the asset.
asset.name	`string`	The name of asset and its extension.
type	`string`	Type of the log. Valid values are `text` (used for regular strings of text), `single-select` (used for selecting one value out of multiple options) and `multi-select` (used for selecting multiple values out of multiple options).
text	`string`	Descriptive text for the log when using the type of `text`.
labels	`array`	An array of labels for the log.
labels[].name	`string` (required)	Name of the label.
allowedValues	`array`	An array of allowed values for the log. Is required for both `single-select` and `multi-select` term types. For `text` terms, this field will be discarded.
values	`array`	An array of values for the log, only used for `single-select` and `multi-select` log types. These values should be contained in the allowedValues array.
color	`string`	The log’s color to use in UI elements.
parent	`object`	Information about the parent log of this log.
parent.id	`string`	The unique identifier of the media log.
parent.name	`string`	The name of the log.
parent.type	`string`	Type of the log.
termId	`string`	Identifier of the term used to create the log.
isPublished	`boolean`	Indicates if the log data is published to the search index for visibility from search results.
group	`object`	Information that can be used to group multiple logs together.
group.id	`string`	1 (string) - Identifier for the group.
group.name	`string`	Descriptive name for the group.
createdOn	`string`	The datetime the media log was created.
createdBy	`object`	Information about the creator of the media log.
createdBy.id	`string`	The unique identifier of the user.
createdBy.name	`string`	The full name of the user.
createdBy.email	`string`	The email of the user.
modifiedOn	`string`	The datetime the media log record was last modified.
workSession	`object`	Information about the media log’s work session.
workSession.id	`string`	The unique identifier for the WorkSession.
workSession.name	`string` (required)	The name of the WorkSession.

Headers

Content-Type: application/json

Body

{
  "code": "InvalidMediaLog",
  "message": "Invalid Media Log. Media Log's name, work session, asset, mark in, mark out must be provided and all fields supported. Please review Ci API documentation for valid media log requirements."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Update a Media Log
PUT`/media-logs/{mediaLogId}`

URI Parameters

HideShow

mediaLogId: string (required)
The unique identifier of the log.

Description

Updates a log.

Errors

Status Code	Error Code	Message
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	InvalidMediaLogTemplate	Invalid template. Template name and network must be provided and all provided terms must be supported. Please review Ci API documentation for valid template and terms requirements.
404	MediaLogNotFound	Media Log not found.
404	WorkSessionNotFound	Work Session not found.

DELETE https://api.cimediacloud.com/media-logs/sdfg39ersd4t3r44

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200404

Headers

Content-Type: application/json

Body

{
  "name": "Penalty Kick scene",
  "markIn": {
    "value": 5000,
    "unit": "milliseconds"
  },
  "markOut": {
    "value": 60000,
    "unit": "milliseconds"
  },
  "id": "abcy3lrs45m0qouy",
  "asset": {
    "id": "d9bf018c804a4e78b775b8dc2f242071",
    "name": "Movie.mov"
  },
  "type": "text",
  "text": "Penalty kick for the host team",
  "labels": [
    {
      "name": "attack"
    }
  ],
  "allowedValues": [
    "goal",
    "intercepted",
    "deflected"
  ],
  "values": [
    "goal"
  ],
  "color": "#FF00FF",
  "parent": {
    "id": "jh473sgj239e334",
    "name": "landscape scene",
    "type": "text"
  },
  "termId": "as34dr3426ewrt",
  "isPublished": true,
  "group": {
    "id": "grouping",
    "name": "Log group for the penalty kick scene"
  },
  "createdOn": "2018-01-02T00:00:00.000Z",
  "createdBy": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith",
    "email": "johnsmith@example.com"
  },
  "modifiedOn": "2018-01-03T00:00:00.000Z",
  "workSession": {
    "id": "oj7mx3vlb2srei89",
    "name": "WorkSession name"
  }
}

Property name	Type	Description
name	`string` (required)	The name of the log.
markIn	`object` (required)	Information about the start point of the log.
markIn.value	`number` (required)	The time value that represents the start point of this log.
markIn.unit	`string`	The unit of time that represents the log’s mark in start point. For now, this value can only be `milliseconds`. If omitted, defaults to `milliseconds`.
markOut	`object` (required)	Information about the end point of the log.
markOut.value	`number` (required)	The time value that represents the end point of this log.
markOut.unit	`string`	The unit of time that represents the log’s mark out end point. For now, this value can only be `milliseconds`. If omitted, defaults to `milliseconds`.
id	`string`	The unique identifier of the media log.
asset	`object`	Information about the media log’s asset.
asset.id	`string`	The unique identifier of the asset.
asset.name	`string`	The name of asset and its extension.
type	`string`	Type of the log. Valid values are `text` (used for regular strings of text), `single-select` (used for selecting one value out of multiple options) and `multi-select` (used for selecting multiple values out of multiple options).
text	`string`	Descriptive text for the log when using the type of `text`.
labels	`array`	An array of labels for the log.
labels[].name	`string` (required)	Name of the label.
allowedValues	`array`	An array of allowed values for the log. Is required for both `single-select` and `multi-select` term types. For `text` terms, this field will be discarded.
values	`array`	An array of values for the log, only used for `single-select` and `multi-select` log types. These values should be contained in the allowedValues array.
color	`string`	The log’s color to use in UI elements.
parent	`object`	Information about the parent log of this log.
parent.id	`string`	The unique identifier of the media log.
parent.name	`string`	The name of the log.
parent.type	`string`	Type of the log.
termId	`string`	Identifier of the term used to create the log.
isPublished	`boolean`	Indicates if the log data is published to the search index for visibility from search results.
group	`object`	Information that can be used to group multiple logs together.
group.id	`string`	1 (string) - Identifier for the group.
group.name	`string`	Descriptive name for the group.
createdOn	`string`	The datetime the media log was created.
createdBy	`object`	Information about the creator of the media log.
createdBy.id	`string`	The unique identifier of the user.
createdBy.name	`string`	The full name of the user.
createdBy.email	`string`	The email of the user.
modifiedOn	`string`	The datetime the media log record was last modified.
workSession	`object`	Information about the media log’s work session.
workSession.id	`string`	The unique identifier for the WorkSession.
workSession.name	`string` (required)	The name of the WorkSession.

Headers

Content-Type: application/json

Body

{
  "code": "MediaLogNotFound",
  "message": "Media Log not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

Delete a Media Log
DELETE`/media-logs/{mediaLogId}`

URI Parameters

HideShow

mediaLogId: string (required)
The unique identifier of the log.

Description

Deletes a log.

Errors

Status Code	Error Code	Message
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
404	MediaLogNotFound	Media Log not found.

Create Multiple Media Logs ¶

POST https://api.cimediacloud.com/media-logs

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Body

{
  "logs": [
    {
      "name": "Penalty Kick scene",
      "markIn": {
        "value": 5000,
        "unit": "milliseconds"
      },
      "markOut": {
        "value": 60000,
        "unit": "milliseconds"
      },
      "type": "single-select",
      "text": "Penalty kick for the host team",
      "labels": [
        {
          "name": "attack"
        }
      ],
      "allowedValues": [
        "goal",
        "intercepted",
        "deflected"
      ],
      "values": [
        {
          "key": "",
          "value": ""
        }
      ],
      "color": "#FF00FF",
      "termId": "as34dr3426ewrt",
      "group": {
        "id": "grouping1",
        "name": "Log group for the penalty kick scene"
      },
      "workSessionId": "2584c233d9884d1ea06ea438f399e751",
      "assetId": "cefe26bf4efc47b5ab36318ce9323739"
    }
  ]
}

Property name	Type	Description
logs	`array` (required)	The specifications for the Media Logs.
logs[].name	`string` (required)	The name of the log.
logs[].markIn	`object` (required)	Information about the start point of the log.
logs[].markIn.value	`number` (required)	The time value that represents the start point of this log.
logs[].markIn.unit	`string`	The unit of time that represents the log’s mark in start point. For now, this value can only be `milliseconds`. If omitted, defaults to `milliseconds`.
logs[].markOut	`object` (required)	Information about the end point of the log.
logs[].markOut.value	`number` (required)	The time value that represents the end point of this log.
logs[].markOut.unit	`string`	The unit of time that represents the log’s mark out end point. For now, this value can only be `milliseconds`. If omitted, defaults to `milliseconds`.
logs[].type	`string`	Type of the log. Valid values are ‘text’, ‘single-select’ and ‘multi-select’.
logs[].text	`string`	Descriptive text for the log.
logs[].labels	`array`	An array of labels for the log.
logs[].labels[].name	`string` (required)	Name of the label.
logs[].allowedValues	`array`	An array of allowed values for the log. Is required for both ‘single-select’ and ‘multi-select’ term types. For ‘text’ terms, this field will be discarded.
logs[].values	`array`	Can be either an array of values for the log (for ‘single-select’ and ‘multi-select’ log types) in which case they should be contained in the allowedValues array, or an array of key-value pairs (for ‘key-value-pair’ log type).
logs[].values[].key	`string`	The key of the item.
logs[].values[].value	`string`	The value of the item.
logs[].color	`string`	The log’s color to use in UI elements.
logs[].parentId	`string`	Unique identifier of the parent log for this log.
logs[].termId	`string`	Unique identifier of the term used to create the log, if any.
logs[].group	`object`	Information that can be used to group multiple logs together.
logs[].group.id	`string`	Identifier for the group.
logs[].group.name	`string`	Descriptive name for the group.
logs[].workSessionId	`string` (required)	Identifier of the MediaLog work session.
logs[].assetId	`string` (required)	Identifier of the asset.

Responses200409

Headers

Content-Type: application/json

Body

{
  "completeCount": 1,
  "errorCount": 0,
  "errors": [],
  "complete": [
    {
      "name": "Penalty Kick scene",
      "markIn": {
        "value": 5000,
        "unit": "milliseconds"
      },
      "markOut": {
        "value": 60000,
        "unit": "milliseconds"
      },
      "workSession": {
        "id": "oj7mx3vlb2srei89",
        "name": "WorkSession name"
      },
      "asset": {
        "id": "d9bf018c804a4e78b775b8dc2f242071",
        "name": "Movie.mov"
      }
    }
  ]
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors		An array containing information about each failed item.
complete	`array`	An array containing information about each successfully created Media Log.
complete[].name	`string` (required)	The name of the log.
complete[].markIn	`object` (required)	Information about the start point of the log.
complete[].markIn.value	`number` (required)	The time value that represents the start point of this log.
complete[].markIn.unit	`string`	The unit of time that represents the log’s mark in start point. For now, this value can only be `milliseconds`. If omitted, defaults to `milliseconds`.
complete[].markOut	`object` (required)	Information about the end point of the log.
complete[].markOut.value	`number` (required)	The time value that represents the end point of this log.
complete[].markOut.unit	`string`	The unit of time that represents the log’s mark out end point. For now, this value can only be `milliseconds`. If omitted, defaults to `milliseconds`.
complete[].workSession	`object`	Information about the media log’s work session.
complete[].workSession.id	`string`	The unique identifier for the WorkSession.
complete[].workSession.name	`string` (required)	The name of the WorkSession.
complete[].asset	`object`	Information about the media log’s asset.
complete[].asset.id	`string`	The unique identifier of the asset.
complete[].asset.name	`string`	The name of asset and its extension.

Headers

Content-Type: application/json

Body

{
  "completeCount": 0,
  "errorCount": 1,
  "errors": [
    {
      "name": "Penalty Kick scene",
      "markIn": {
        "value": 5000,
        "unit": "milliseconds"
      },
      "markOut": {
        "value": 60000,
        "unit": "milliseconds"
      },
      "workSession": {
        "id": "oj7mx3vlb2srei89",
        "name": "WorkSession name"
      },
      "asset": {
        "id": "d9bf018c804a4e78b775b8dc2f242071",
        "name": "Movie.mov"
      },
      "errorCode": "WorkSessionNotFound",
      "errorMessage": "Work session not found."
    }
  ],
  "code": "BulkOperationFailed",
  "message": "The bulk operation failed. See the errors array for more information."
}

Property name	Type	Description
completeCount	`number`	The number of successful items.
errorCount	`number`	The number of failed items.
errors	`array`	An array containing information about each Media Log request.
errors[].name	`string` (required)	The name of the log.
errors[].markIn	`object` (required)	Information about the start point of the log.
errors[].markIn.value	`number` (required)	The time value that represents the start point of this log.
errors[].markIn.unit	`string`	The unit of time that represents the log’s mark in start point. For now, this value can only be `milliseconds`. If omitted, defaults to `milliseconds`.
errors[].markOut	`object` (required)	Information about the end point of the log.
errors[].markOut.value	`number` (required)	The time value that represents the end point of this log.
errors[].markOut.unit	`string`	The unit of time that represents the log’s mark out end point. For now, this value can only be `milliseconds`. If omitted, defaults to `milliseconds`.
errors[].workSession	`object`	Information about the media log’s work session.
errors[].workSession.id	`string`	The unique identifier for the WorkSession.
errors[].workSession.name	`string` (required)	The name of the WorkSession.
errors[].asset	`object`	Information about the media log’s asset.
errors[].asset.id	`string`	The unique identifier of the asset.
errors[].asset.name	`string`	The name of asset and its extension.
errors[].errorCode	`string`	The machine readable error code for the specific failure.
errors[].errorMessage	`string`	A description of the error for the specific failure.
code	`string`
message	`string`

Create Multiple Media Logs
POST`/media-logs`

Creates multiple log records in a single operation.

The maximum number of Media Logs for bulk create is 500.

This resource will return a failure response if any of the provided log information is invalid.

Errors

Status Code	Error Code	Message
400	InvalidRequest	Invalid request. Check the request body format and verify the right Content-Type header value is being sent.
400	ExceededMaxMediaLogCount	Max media log count exceeded. The maximum number of media logs is 500.
409	BulkOperationFailed	The bulk operation failed. See the errors array for more information.

Errors represented in errors array

Error Code	Message
WorkSessionNotFound	Work Session not found.
AssetNotFound	Asset not found.
WorkSessionIdNotProvided	Work Session Id not provided.
AssetIdNotProvided	Asset Id not provided.
InvalidMediaLogType	Invalid Media Log type. Please review Ci API documentation for valid media log types.
InvalidMediaLogValues	Invalid values provided for the Media Log. The values must be compatible with the type provided, and should be included in the allowed values for the Media Log.
MissingMediaLogAllowedValues	Allowed values were not provided for the Media Log. The Media Log type specified requires allowed values to be defined.
InvalidMediaLogMarks	Invalid mark in / mark out for the Media Log. Both marks should be provided, units should be supported, and mark out should be greatear than mark in.
InvalidMediaLog	Invalid Media Log. Media Log’s name, work session, asset, mark in, mark out must be provided and all fields supported. Please review Ci API documentation for valid media log requirements.

Metadata Templates ¶

List Metadata Templates ¶

POST https://api.cimediacloud.com/workspaces/26a974d1a2334d0a800fb918173a082b/metadata-templates

Requestsexample

Headers

Content-Type: application/json
Authorization: Bearer [bearer token]

Responses200404

Headers

Content-Type: application/json

Body

{
  "id": "192ffcb211f44989a133c4492bcbb363",
  "name": "Template",
  "fields": [
    {
      "name": "Field Name",
      "type": "input",
      "values": [
        "Option 1"
      ],
      "dictionaryId": "680657501ed1452bafa92ef568457a61",
      "section": "First Section",
      "when": {
        "name": "Single Select",
        "type": "input",
        "values": [
          "Option C"
        ]
      }
    }
  ],
  "sections": [
    {
      "name": "Section Name"
    }
  ],
  "createdOn": "2017-01-02T00:00:00.000Z",
  "createdBy": {
    "id": "c460dfc1447f4240b14b2f32ce8d4a5f",
    "name": "John Smith"
  },
  "modifiedOn": "2017-01-02T00:00:00.000Z",
  "appliestTo": [
    "Asset"
  ]
}

Property name	Type	Description
id	`string`	The unique identifier of the template.
name	`string`	The name of the template.
fields	`array`	The fields of the template.
sections	`array`	The sections of the template.
createdOn	`string`	The datetime the template was created.
createdBy	`object`	The creator of the template.
createdBy.id	`string`	The unique identifier of the user.
createdBy.name	`string`	The full name of the user.
modifiedOn	`string`	The datetime the template was modified.
appliestTo	`array`	The target which the template applies to. Can only be (`Asset`, `Element` or `Folder`).

Headers

Content-Type: application/json

Body

{
  "code": "WorkspaceNotFound",
  "message": "Workspace not found."
}

Property name	Type	Description
code	`string`	Machine readable error code
message	`string`	Error message

List Metadata Templates
POST`/workspaces/{workspaceId}/metadata-templates`

URI Parameters

HideShow

workspaceId: string (required)
The unique identifier of the Workspace.

Description

List metadata templates defined within the workspace’s network.

Errors

Status Code	Error Code	Message	Notes
404	WorkspaceNotFound	WorkspaceNotFound not found.

API Endpoint

Security ¶

IP Restrictions ¶

API Update Guidelines ¶

Developer Keys ¶

Change Log ¶

Errors ¶

Rate Limiting ¶

Authentication ¶

Using Ci User Credentials

Using a Refresh Token

Using a Delegate Token

Generate Access Token ¶

Headers

Body

Headers

Body

Headers

Body

Headers

Body

Headers

Body

Headers

Body

Headers

Body

Headers

Body

Headers

Body

Generate Access TokenPOST/oauth2/token

Description ¶

Errors ¶

Networks ¶

List Events ¶

Headers

Headers

Body

Headers

Body

List EventsGET/networks/{networkId}/events{?since,type,limit,offset,orderDirection}

Description ¶

Errors ¶

Workspaces ¶

Create Workspace ¶

Headers

Body

Headers

Body

Headers

Body

Create WorkspacePOST/networks/{networkId}/workspaces

Description ¶

Errors ¶

Workspace ¶

Headers

Headers

Body

Headers

Body

Get Workspace DetailsGET/workspaces/{workspaceId}{?extraFields}

Description ¶

Errors ¶

Headers

Body

Headers

Body

Headers

Body

Update WorkspacePUT/workspaces/{workspaceId}

Description ¶

Errors ¶

Headers

Headers

Headers

Body

Delete WorkspaceDELETE/workspaces/{workspaceId}

Description ¶

Errors ¶

Security

IP Restrictions

API Update Guidelines

Developer Keys

Change Log

Errors

Rate Limiting

Generate Access Token
POST`/oauth2/token`

Description

Errors

List Events
GET`/networks/{networkId}/events{?since,type,limit,offset,orderDirection}`

Description

Errors

Create Workspace
POST`/networks/{networkId}/workspaces`

Description

Errors

Get Workspace Details
GET`/workspaces/{workspaceId}{?extraFields}`

Description

Errors

Update Workspace
PUT`/workspaces/{workspaceId}`

Description

Errors

Delete Workspace
DELETE`/workspaces/{workspaceId}`

Description

Errors

List User Workspaces
GET`/workspaces{?limit,offset,orderBy,orderDirection,fields,extraFields}`

Description

Errors

List Workspace Contents
GET`/workspaces/{workspaceId}/contents{?kind,type,limit,offset,orderBy,orderDirection,fields,extraFields}`

Description

Errors

List Trash Bin Contents
GET`/workspaces/{workspaceId}/trashbin{?kind,limit,offset,orderBy,orderDirection,fields}`

Description

Errors

Search Workspace Contents
GET`/workspaces/{workspaceId}/search{?query,kind,limit,offset,orderBy,orderDirection,fields}`

Description

Errors

Purge Trash
POST`/workspaces/{workspaceId}/purgetrash`

Description

Errors