Breadcrumbs

Iconikconnector v1

Version 1

Connector Overview: This page documents all 196 actions for the Iconikconnector v1.

General (196)

POST Add a member to a project

/v1/projects/{project_id}/members/

Required roles:

  • can_add_project_members

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Project Id

N/A

Response Type

N/A
Options (6)

Option Name

Description

Created By User

N/A

Date Created

N/A

Date Modified

N/A

Id

User ID in iconik

Project Id

N/A

System Domain Id

N/A

POST Add a new share_user to a share

/v1/{object_type}/{object_id}/shares/{share_id}/users/

Required roles:

  • can_write_shares

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Object Type

N/A

Object Id

N/A

Share Id

N/A

Response Type

N/A
Options (14)

Option Name

Description

Access Count

N/A

Email

N/A

First Name

N/A

Id

N/A

Internal User Id

N/A

Last Access Date

N/A

Last Name

N/A

Object Id

N/A

Object Type

N/A

Password

N/A

Photo

N/A

Photo Big

N/A

Photo Small

N/A

Share Id

N/A

POST Add a new transcription properties

/v1/assets/{asset_id}/versions/{version_id}/transcriptions/properties/

Required roles:

  • can_write_transcriptions

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

Version Id

N/A

Response Type

N/A
Options (5)

Option Name

Description

Asset Id

N/A

Id

N/A

Language

N/A

System Domain Id

N/A

Version Id

N/A

POST Add a new transcription properties

/v1/assets/{asset_id}/versions/{version_id}/transcriptions/subtitles/

Required roles:

  • can_write_transcriptions

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

Version Id

N/A

Response Type

N/A
Options (5)

Option Name

Description

Content

N/A

Delete Old Transcriptions

N/A

Format

N/A

Language

N/A

Source Subtitle Id

Set to source subtitle_id or do not set and use the content fields instead

POST Add an item to a playlist

/v1/playlists/{playlist_id}/items/

Required roles:

  • can_add_playlist_items

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Playlist Id

N/A

Response Type

N/A
Options (6)

Option Name

Description

Id

N/A

Object Id

N/A

Object Type

N/A

Time End Milliseconds

N/A

Time Start Milliseconds

N/A

Version Id

N/A

POST Add an item to a sequence

/v1/sequences/{sequence_id}/items/

Required roles:

  • can_add_sequence_items

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Sequence Id

N/A

Response Type

N/A
Options (5)

Option Name

Description

Id

N/A

Object Id

N/A

Object Type

N/A

Position

Position of the item in the sequence.If not provided, the item will be appended to the end of the sequence

Version Id

N/A

POST Add an object to a collection

/v1/collections/{collection_id}/contents/

Required roles:

  • can_write_collections

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Collection Id

N/A

Response Type

N/A
Options (4)

Option Name

Description

Collection Id

N/A

Date Created

N/A

Object Id

N/A

Object Type

N/A

POST Add asset version

/v1/assets/{asset_id}/versions/

Required roles:

  • can_write_versions

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

Response Type

N/A
Options (6)

Option Name

Description

Copy Metadata

N/A

Copy Persons

N/A

Copy Segments

N/A

Include Segment Types

N/A

Source Version Id

N/A

System Domain Id

N/A

POST Add assets to a delete queue (Mark assets as deleted)

/v1/delete_queue/assets/

Required roles:

  • can_delete_assets

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Response Type

N/A
Options (1)

Option Name

Description

Ids

N/A

POST Add collections to a delete queue (Mark collections as deleted)

/v1/delete_queue/collections/

Required roles:

  • can_delete_collections

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Response Type

N/A
Options (1)

Option Name

Description

Ids

N/A

POST Adds multiple objects to a list of favorites

/v1/favorites/

Required roles:

  • can_write_favorites

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Response Type

N/A
Options (2)

Option Name

Description

Object Ids

N/A

Object Type

N/A

PUT Adds the approval by user and returns an objects approval status

/v1/{object_type}/{object_id}/approvals/

Required roles:

  • can_write_approval_status

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Object Id

N/A

Object Type

N/A

Response Type

N/A
Options (7)

Option Name

Description

Change Date

N/A

External

N/A

Object Id

N/A

Object Type

N/A

Status

N/A

User

N/A

Version Id

N/A

POST Bulk delete objects

/v1/delete_queue/bulk/

Required roles:

  • can_delete_assets

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Response Type

N/A
Options (3)

Option Name

Description

Content Only

If set to False, will also delete entities of type object_type specified in object_ids.

Object Ids

N/A

Object Type

N/A

PATCH Bulk update assets

/v1/assets/

Required roles:

  • can_write_assets

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Response Type

N/A

PUT Bulk update assets

/v1/assets/

Required roles:

  • can_write_assets

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Response Type

N/A

GET Check if a token is valid

/v1/shares/auth/token/

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Share-auth-token

N/A

Response Type

N/A

POST Copy a collection (recursively) in to another collection

/v1/collections/{collection_id}/subcollections/

Required roles:

  • can_write_collections

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Collection Id

N/A

Copy Acl

Copy collection acls.

Copy Keyframes

Copy collection keyframes.

Response Type

N/A
Options (4)

Option Name

Description

Collection Id

N/A

Date Created

N/A

Object Id

N/A

Object Type

N/A

POST Create a job for bulk approval status removal

/v1/approvals/bulk_remove/

Required roles:

  • can_write_approval_status_in_bulk

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Auth-token

N/A

App-id

N/A

Response Type

N/A
Options (2)

Option Name

Description

Object Ids

N/A

Object Type

N/A

POST Create a job for bulk reindexing of assets

/v1/reindex/bulk/

Required roles:

  • can_reindex_assets

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Auth-token

N/A

App-id

N/A

Response Type

N/A
Options (6)

Option Name

Description

Include Assets

N/A

Include Collections

N/A

Object Ids

N/A

Object Type

N/A

Realms

N/A

Sync To Another Dc

N/A

POST Create a job for bulk request & set approval

/v1/approvals/bulk/

Required roles:

  • can_write_approval_status_in_bulk

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Auth-token

N/A

App-id

N/A

Response Type

N/A
Options (3)

Option Name

Description

Object Ids

N/A

Object Type

N/A

Status

N/A

POST Create a new asset

/v1/assets/

Required roles:

  • can_create_assets

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Apply Default Acls

Adds default ACLs to an asset

Apply Collection Acls

Adds containing collection's ACLs to an asset

Assign To Collection

Adds the asset to the collection specified in the body

Generate Subclip Keyframes

If the asset is a subclip, generate keyframes for it

Response Type

N/A
Options (35)

Option Name

Description

Analyze Status

N/A

Archive Status

N/A

Category

N/A

Collection Id

N/A

Created By User

N/A

Custom Keyframe

N/A

Custom Poster

N/A

Date Created

N/A

Date Deleted

N/A

Date Imported

N/A

Date Modified

N/A

Date Viewed

N/A

Deleted By User

N/A

External Id

N/A

External Link

N/A

Face Recognition Status

N/A

Favoured

N/A

Has Unconfirmed Persons

N/A

Id

N/A

Is Blocked

N/A

Is Online

N/A

Last Archive Restore Date

N/A

Limit Download To Groups

N/A

Original Asset Id

N/A

Original Segment Id

N/A

Original Version Id

N/A

Person Ids

N/A

Site Name

N/A

Status

N/A

Time End Milliseconds

N/A

Time Start Milliseconds

N/A

Title

N/A

Type

N/A

Updated By User

N/A

Warning

N/A

POST Create a new asset relation

/v1/assets/{asset_id}/relations/

Required roles:

  • can_create_asset_relations

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

Response Type

N/A
Options (7)

Option Name

Description

Asset Id

N/A

Date Created

N/A

Date Modified

N/A

Description

N/A

Id

N/A

Related To Asset Id

N/A

Relation Type

N/A

POST Create a new asset relation

/v1/assets/{asset_id}/relations/{relation_type}/{related_to_asset_id}/

Required roles:

  • can_create_asset_relations

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

Relation Type

N/A

Related To Asset Id

N/A

Response Type

N/A
Options (7)

Option Name

Description

Asset Id

N/A

Date Created

N/A

Date Modified

N/A

Description

N/A

Id

N/A

Related To Asset Id

N/A

Relation Type

N/A

GET Create a new asset relation type

/v1/assets/relation_types/

Required roles:

  • can_read_asset_relations

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Response Type

N/A

POST Create a new asset relation type

/v1/assets/relation_types/

Required roles:

  • can_write_asset_relation_types

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Response Type

N/A
Options (8)

Option Name

Description

Date Created

N/A

Date Modified

N/A

Description

N/A

Destination Label

N/A

Is Directional

N/A

Is System

N/A

Name

N/A

Source Label

N/A

POST Create a new asset's version from another asset

/v1/assets/{asset_id}/versions/from/assets/{source_asset_id}/

Required roles:

  • can_write_versions

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

Source Asset Id

N/A

Response Type

N/A
Options (5)

Option Name

Description

Copy Previous Version Persons

N/A

Copy Previous Version Segments

N/A

Include Segment Types

N/A

Source Metadata Asset Id

N/A

System Domain Id

N/A

POST Create a new asset's version from another version

/v1/assets/{asset_id}/versions/from/versions/{source_version_id}/

Required roles:

  • can_write_versions

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

Source Version Id

N/A

Response Type

N/A
Options (6)

Option Name

Description

Copy Previous Version Persons

N/A

Copy Previous Version Segments

N/A

Exclude Format Ids

N/A

Include Segment Types

N/A

Source Metadata Asset Id

N/A

System Domain Id

N/A

POST Create a new collection

/v1/collections/

Required roles:

  • can_create_collections

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Apply Default Acls

Adds default ACLs to a collection

Apply Collection Acls

Adds containing collection's ACLs to a collection

Restrict Collection Acls

Restricts ACLS to containing collection's ACLs

Response Type

N/A
Options (11)

Option Name

Description

Category

N/A

Custom Keyframe

N/A

Custom Poster

N/A

Date Created

N/A

External Id

N/A

Is Root

N/A

Keyframe Asset Ids

N/A

Parent Id

N/A

Status

N/A

Storage Id

N/A

Title

N/A

POST Create a new playlist

/v1/playlists/

Required roles:

  • can_create_playlists

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Response Type

N/A
Options (8)

Option Name

Description

Created By User

N/A

Date Created

N/A

Date Modified

N/A

Id

N/A

Name

N/A

Project Id

N/A

Status

N/A

System Domain Id

N/A

POST Create a new project

/v1/projects/

Required roles:

  • can_create_projects

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Response Type

N/A
Options (10)

Option Name

Description

Collection Id

ID of a collection that will become a project collection

Collection Parent Id

ID of a collection that the project should be a child of

Created By User

N/A

Date Created

N/A

Date Modified

N/A

Id

N/A

Name

N/A

Status

N/A

Storage Id

N/A

System Domain Id

N/A

POST Create a new segment

/v1/assets/{asset_id}/segments/

Required roles:

  • can_create_segments

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Share-user-email

This header is used for shares by URL to identify user. Only valid emails are allowed.

Asset Id

N/A

Response Type

N/A
Options (32)

Option Name

Description

Asset Id

N/A

Date Created

N/A

Date Modified

N/A

External Id

N/A

Has Drawing

N/A

Id

N/A

Is Internal

If set to true, the segment is only visible to internal iconik users

Keyframe Id

N/A

Metadata

N/A

Metadata View Id

N/A

Parent Id

N/A

Path

N/A

Person Id

N/A

Project Id

ID of a project if the segment is created from a project

Segment Checked

N/A

Segment Color

N/A

Segment Text

N/A

Segment Track

N/A

Segment Type

N/A

Share Id

ID of a share if the segment is created from a share

Share User Email

N/A

Status

N/A

Subclip Id

N/A

Time End Milliseconds

N/A

Time Start Milliseconds

N/A

Top Level

N/A

Transcription Id

N/A

User First Name

N/A

User Id

N/A

User Last Name

N/A

User Photo

N/A

Version Id

N/A

POST Create a new sequence

/v1/sequences/

Required roles:

  • can_create_sequences

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Response Type

N/A
Options (6)

Option Name

Description

Created By User

N/A

Date Created

N/A

Date Modified

N/A

Id

N/A

Name

N/A

System Domain Id

N/A

POST Create a new share of multiple objects (currently only assets are supported)

/v1/share/{object_type}/

Required roles:

  • can_write_shares

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Object Type

N/A

Response Type

N/A
Options (26)

Option Name

Description

Allow Approving Comments

N/A

Allow Comments

N/A

Allow Custom Actions

N/A

Allow Download

N/A

Allow Download Proxy

N/A

Allow Setting Approve Status

N/A

Allow Upload

N/A

Allow User Search For Mentions

N/A

Allow View Transcriptions

N/A

Allow View Versions

N/A

Emails

N/A

Expires

N/A

Id

N/A

Is Approval

N/A

Message

N/A

Metadata Views

N/A

Object Ids

N/A

Object Type

N/A

Owner Id

N/A

Password

N/A

Review Experience Public Beta

N/A

Share By Url

N/A

Show Watermark

N/A

System Domain Id

N/A

Title

N/A

Upload Storage Id

N/A

POST Create a new share.

/v1/{object_type}/{object_id}/shares/

Required roles:

  • can_write_shares

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Object Type

N/A

Object Id

N/A

Response Type

N/A
Options (26)

Option Name

Description

Allow Approving Comments

N/A

Allow Comments

N/A

Allow Custom Actions

N/A

Allow Download

N/A

Allow Download Proxy

N/A

Allow Setting Approve Status

N/A

Allow Upload

N/A

Allow User Search For Mentions

N/A

Allow View Transcriptions

N/A

Allow View Versions

N/A

Emails

N/A

Expires

N/A

Id

N/A

Is Approval

N/A

Message

N/A

Metadata Views

N/A

Object Id

N/A

Object Type

N/A

Owner Id

N/A

Password

N/A

Project Id

Project ID if the share is created from a project

Review Experience Public Beta

N/A

Show Watermark

N/A

System Domain Id

N/A

Title

N/A

Upload Storage Id

N/A

POST Create a new sync session

/v1/sync/sessions/

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Response Type

N/A
Options (6)

Option Name

Description

Current Dc Url

N/A

Date Created

N/A

Date Modified

N/A

Dc Url

N/A

Id

N/A

Node

N/A

POST Create an asset history entity

/v1/assets/{asset_id}/history/

Required roles:

  • can_write_assets_history

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

Response Type

N/A
Options (12)

Option Name

Description

Asset Id

N/A

Date Created

N/A

Date Modified

N/A

Id

N/A

Job Id

N/A

Operation Description

N/A

Operation Type

N/A

Share Id

N/A

Share User Id

N/A

System Domain Id

N/A

User Id

N/A

Version Id

N/A

POST Create an custom action

/v1/custom_actions/{context}/

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Context

N/A

Response Type

N/A
Options (14)

Option Name

Description

App Id

N/A

Context

N/A

Date Created

N/A

Date Modified

N/A

Disabled

N/A

Id

N/A

Last Error

N/A

Last Error Date

N/A

Metadata View

N/A

Status

N/A

System Domain Id

N/A

Title

N/A

Type

N/A

Url

N/A

POST Create multiple new segments for a single asset

/v1/assets/{asset_id}/segments/bulk/

Required roles:

  • can_create_segments

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

Response Type

N/A

POST Creates an objects approval request

/v1/{object_type}/{object_id}/approvals/request/

Required roles:

  • can_write_approval_request

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Object Id

N/A

Object Type

N/A

Response Type

N/A
Options (13)

Option Name

Description

Change Date

N/A

Externals

N/A

Groups

N/A

Min Number

N/A

Object Id

N/A

Object Type

N/A

Request Date

N/A

Requested By

N/A

Share Id

N/A

Status

N/A

User Status

N/A

Users

N/A

Version Id

N/A

DELETE Delete a particular asset by id

/v1/assets/{asset_id}/

Required roles:

  • can_delete_assets

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

Response Type

N/A

DELETE Delete a particular asset by id

/v1/assets/{asset_id}/relations/{relation_type}/{related_to_asset_id}/

Required roles:

  • can_delete_asset_relations

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

Relation Type

N/A

Related To Asset Id

N/A

Response Type

N/A

DELETE Delete a particular asset by id on failed uplaod

/v1/assets/{asset_id}/uploads/

Required roles:

  • can_create_assets

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

Response Type

N/A

DELETE Delete a particular asset version by id

/v1/assets/{asset_id}/versions/{version_id}/

Required roles:

  • can_delete_versions

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

Version Id

N/A

Hard Delete

completely remove the version

Response Type

N/A

DELETE Delete a particular collection by id

/v1/collections/{collection_id}/

Required roles:

  • can_delete_collections

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Collection Id

N/A

Response Type

N/A

DELETE Delete a particular content object in a collection by id

/v1/collections/{collection_id}/contents/{object_type}/{object_id}/

Required roles:

  • can_write_collections

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Collection Id

N/A

Object Type

N/A

Object Id

N/A

Response Type

N/A

DELETE Delete a particular playlist by id

/v1/playlists/{playlist_id}/

Required roles:

  • can_delete_playlists

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Playlist Id

N/A

Response Type

N/A

DELETE Delete a particular playlist item by id

/v1/playlists/{playlist_id}/items/{item_id}/

Required roles:

  • can_delete_playlist_items

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Playlist Id

N/A

Item Id

N/A

Response Type

N/A

DELETE Delete a particular project by id

/v1/projects/{project_id}/

Required roles:

  • can_delete_projects

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Project Id

N/A

Response Type

N/A

DELETE Delete a particular project member by id

/v1/projects/{project_id}/members/{member_id}/

Required roles:

  • can_delete_project_members

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Project Id

N/A

Member Id

N/A

Response Type

N/A

DELETE Delete a particular segment from an asset by id

/v1/assets/{asset_id}/segments/{segment_id}/

Required roles:

  • can_delete_segments

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

Segment Id

N/A

Soft Delete

N/A

Response Type

N/A

DELETE Delete a particular sequence by id

/v1/sequences/{sequence_id}/

Required roles:

  • can_delete_sequences

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Sequence Id

N/A

Response Type

N/A

DELETE Delete a particular sequence item by id

/v1/sequences/{sequence_id}/items/{item_id}/

Required roles:

  • can_delete_sequence_items

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Sequence Id

N/A

Item Id

N/A

Response Type

N/A

DELETE Delete a particular share by id

/v1/{object_type}/{object_id}/shares/{share_id}/

Required roles:

  • can_delete_object_shares

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Object Type

N/A

Object Id

N/A

Share Id

N/A

Response Type

N/A

DELETE Delete a particular share_user user by id

/v1/{object_type}/{object_id}/shares/{share_id}/users/{share_user_id}/

Required roles:

  • can_write_shares

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Object Type

N/A

Object Id

N/A

Share Id

N/A

Share User Id

N/A

Response Type

N/A

DELETE Delete a particular sync session by id

/v1/sync/sessions/{sync_session_id}/

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Sync Session Id

N/A

Response Type

N/A

DELETE Delete all asset versions except the latest one

/v1/assets/{asset_id}/versions/old/

Required roles:

  • can_delete_versions

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

Response Type

N/A

DELETE Delete an asset relation type

/v1/assets/relation_types/{relation_type}/

Required roles:

  • can_delete_asset_relation_types

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Relation Type

N/A

Response Type

N/A

DELETE Delete assets from delete queue (Mark assets as active again)

/v1/delete_queue/assets/

Required roles:

  • can_write_assets

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Response Type

N/A
Options (1)

Option Name

Description

Ids

N/A

DELETE Delete collections from delete queue (Mark collections as active again)

/v1/delete_queue/collections/

Required roles:

  • can_write_collections

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Response Type

N/A
Options (1)

Option Name

Description

Ids

N/A

DELETE Delete current user's multiple shares by ids

/v1/shares/bulk/

Required roles:

  • can_manage_shares

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Response Type

N/A
Options (1)

Option Name

Description

Share Ids

N/A

DELETE Delete multiple shares by ids

/v1/shares/bulk/all/

Required roles:

  • can_manage_all_shares

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Response Type

N/A
Options (1)

Option Name

Description

Share Ids

N/A

DELETE Delete segments with either ids or by type

/v1/assets/{asset_id}/segments/bulk/

Required roles:

  • can_delete_segments

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

Immediately

If false, delete segments asynchronously

Ignore Reindexing

If false, reindex

Response Type

N/A
Options (3)

Option Name

Description

Segment Ids

N/A

Segment Type

N/A

Version Id

N/A

DELETE Delete transcription properties by ID

/v1/assets/{asset_id}/versions/{version_id}/transcriptions/{transcription_id}/properties/

Required roles:

  • can_delete_transcriptions

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

Version Id

N/A

Transcription Id

N/A

Response Type

N/A

DELETE Deletes an asset history entity

/v1/assets/{asset_id}/history/{history_entity_id}/

Required roles:

  • can_delete_assets_history

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

History Entity Id

N/A

Response Type

N/A

DELETE Deletes an custom action

/v1/custom_actions/{context}/{action_id}/

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Context

N/A

Action Id

N/A

Response Type

N/A

DELETE Deletes an objects approval request

/v1/{object_type}/{object_id}/approvals/request/

Required roles:

  • can_delete_approval_request

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Object Id

N/A

Object Type

N/A

Response Type

N/A

DELETE Deletes an objects approval status

/v1/{object_type}/{object_id}/approvals/

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Object Id

N/A

Object Type

N/A

Response Type

N/A

DELETE Deletes an objects approval status by user_id

/v1/{object_type}/{object_id}/approvals/external/{email}/

Required roles:

  • can_delete_approval_status

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Object Id

N/A

Object Type

N/A

Email

N/A

Response Type

N/A

DELETE Deletes an objects approval status by user_id

/v1/{object_type}/{object_id}/approvals/user/{user_id}/

Required roles:

  • can_delete_approval_status

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Object Id

N/A

Object Type

N/A

User Id

N/A

Response Type

N/A

DELETE Deletes objects items from a list of favorites

/v1/favorites/

Required roles:

  • can_delete_favorites

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Response Type

N/A
Options (2)

Option Name

Description

Object Ids

N/A

Object Type

N/A

DELETE Disable custom ordering for a collection's content

/v1/collections/{collection_id}/contents/ordering/custom/

Required roles:

  • can_write_collections

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Collection Id

N/A

Response Type

N/A

PATCH Edit a sync session. If the session doesn't exist, a new one is created

/v1/sync/sessions/{sync_session_id}/

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Sync Session Id

N/A

Update If None

Update only if the field is not set (set to None) in the database

Response Type

N/A
Options (6)

Option Name

Description

Current Dc Url

N/A

Date Created

N/A

Date Modified

N/A

Dc Url

N/A

Id

N/A

Node

N/A

PUT Edit a sync session. If the session doesn't exist, a new one is created

/v1/sync/sessions/{sync_session_id}/

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Sync Session Id

N/A

Update If None

Update only if the field is not set (set to None) in the database

Response Type

N/A
Options (6)

Option Name

Description

Current Dc Url

N/A

Date Created

N/A

Date Modified

N/A

Dc Url

N/A

Id

N/A

Node

N/A

PATCH Edit asset version

/v1/assets/{asset_id}/versions/{version_id}/

Required roles:

  • can_write_versions

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

Version Id

N/A

Response Type

N/A
Options (13)

Option Name

Description

Analyze Status

N/A

Archive Status

N/A

Created By User

N/A

Date Created

N/A

Face Recognition Status

N/A

Has Unconfirmed Persons

N/A

Id

N/A

Is Online

N/A

Person Ids

N/A

Status

N/A

Transcribe Status

N/A

Transcribed Languages

N/A

Version Number

N/A

PUT Edit asset version

/v1/assets/{asset_id}/versions/{version_id}/

Required roles:

  • can_write_versions

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

Version Id

N/A

Response Type

N/A
Options (13)

Option Name

Description

Analyze Status

N/A

Archive Status

N/A

Created By User

N/A

Date Created

N/A

Face Recognition Status

N/A

Has Unconfirmed Persons

N/A

Id

N/A

Is Online

N/A

Person Ids

N/A

Status

N/A

Transcribe Status

N/A

Transcribed Languages

N/A

Version Number

N/A

PUT Edit multiple asset segments

/v1/assets/{asset_id}/segments/bulk/

Required roles:

  • can_write_segments

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

Generate Subclip Keyframes

If the segment is a subclip, generate keyframes for it

Response Type

N/A

PATCH Edits an approval request

/v1/{object_type}/{object_id}/approvals/request/

Required roles:

  • can_write_approval_request

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Object Id

N/A

Object Type

N/A

Response Type

N/A
Options (13)

Option Name

Description

Change Date

N/A

Externals

N/A

Groups

N/A

Min Number

N/A

Object Id

N/A

Object Type

N/A

Request Date

N/A

Requested By

N/A

Share Id

N/A

Status

N/A

User Status

N/A

Users

N/A

Version Id

N/A

PUT Edits an approval request

/v1/{object_type}/{object_id}/approvals/request/

Required roles:

  • can_write_approval_request

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Object Id

N/A

Object Type

N/A

Response Type

N/A
Options (13)

Option Name

Description

Change Date

N/A

Externals

N/A

Groups

N/A

Min Number

N/A

Object Id

N/A

Object Type

N/A

Request Date

N/A

Requested By

N/A

Share Id

N/A

Status

N/A

User Status

N/A

Users

N/A

Version Id

N/A

POST Enable custom ordering for a collection's content

/v1/collections/{collection_id}/contents/ordering/custom/

Required roles:

  • can_write_collections

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Collection Id

N/A

Response Type

N/A
Options (1)

Option Name

Description

Custom Order Sort

Initial sort order for an ordered collection. Specified as a comma separated list of fieldnames with direction. For example - date_created,asc;status,desc

POST Generates a URL for the shared object

/v1/{object_type}/{object_id}/shares/url/

Required roles:

  • can_write_shares

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Object Type

N/A

Object Id

N/A

Response Type

N/A
Options (22)

Option Name

Description

Allow Approving Comments

N/A

Allow Comments

N/A

Allow Custom Actions

N/A

Allow Download

N/A

Allow Download Proxy

N/A

Allow Setting Approve Status

N/A

Allow Upload

N/A

Allow User Search For Mentions

N/A

Allow View Transcriptions

N/A

Allow View Versions

N/A

Expires

N/A

Is Approval

N/A

Metadata Views

N/A

Object Id

N/A

Object Type

N/A

Owner Id

N/A

Password

N/A

Review Experience Public Beta

N/A

Show Watermark

N/A

System Domain Id

N/A

Title

N/A

Upload Storage Id

N/A

GET Get a list of all domain shares

/v1/shares/all/

Required roles:

  • can_manage_all_shares

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Title

Filter by title

Object Type

Filter by object_type

Object Id

Filter by object_id

Owner Id

Filter by owner_id

Member Id

Filter by member_id

Ids

Filter list of id:s (comma separated)

Query

Filter by other parameter with wildcard support

Exists

Filter shares that have all fields specified in _exists_ (comma separated)

Date Created

Filter by date_created. Can either be a single ISO8601 timestamp or two timestamps separated by a semicolon ;. The timestamp can also be expressed as number of milliseconds since Jan 1 1970 (epoch). Either timestamp can also be replaced with an asterisk * to make the query open ended.
For example: 2018-01-01T10:00:00Z;2018-01-01T15:00:00Z

Date Modified

Filter by date_modified Can either be a single ISO8601 timestamp or two timestamps separated by a semicolon ;. The timestamp can also be expressed as number of milliseconds since Jan 1 1970 (epoch). Either timestamp can also be replaced with an asterisk `` to make the query open ended.
For example: ;1544450400

Expires

Filter by expires Can either be a single ISO8601 timestamp or two timestamps separated by a semicolon ;. The timestamp can also be expressed as number of milliseconds since Jan 1 1970 (epoch). Either timestamp can also be replaced with an asterisk `` to make the query open ended.
For example: ;1544450400

Page

Which page number to fetch

Per Page

The number of items for each page

Scroll

If true passed then uses scroll pagination instead of default one

Scroll Id

In order to get next batch of results using scroll pagination the scroll_id is required

Sort

A comma separated list of fieldnames with order. For example - title,asc;object_type,desc

Response Type

N/A

GET Get a list of transcription properties

/v1/assets/{asset_id}/versions/{version_id}/transcriptions/properties/

Required roles:

  • can_read_transcriptions

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

Version Id

N/A

Response Type

N/A

GET Get a list of user's shares

/v1/shares/

Required roles:

  • can_manage_shares

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Title

Filter by title

Object Type

Filter by object_type

Object Id

Filter by object_id

Ids

Filter list of id:s (comma separated)

Query

Filter by title with wildcard support

Exists

Filter shares that have all fields specified in _exists_ (comma separated)

Date Created

Filter by date_created. Can either be a single ISO8601 timestamp or two timestamps separated by a semicolon ;. The timestamp can also be expressed as number of milliseconds since Jan 1 1970 (epoch). Either timestamp can also be replaced with an asterisk * to make the query open ended.
For example: 2018-01-01T10:00:00Z;2018-01-01T15:00:00Z

Date Modified

Filter by date_modified Can either be a single ISO8601 timestamp or two timestamps separated by a semicolon ;. The timestamp can also be expressed as number of milliseconds since Jan 1 1970 (epoch). Either timestamp can also be replaced with an asterisk `` to make the query open ended.
For example: ;1544450400

Expires

Filter by expires Can either be a single ISO8601 timestamp or two timestamps separated by a semicolon ;. The timestamp can also be expressed as number of milliseconds since Jan 1 1970 (epoch). Either timestamp can also be replaced with an asterisk `` to make the query open ended.
For example: ;1544450400

Include Member Of

Include shares where the current user is a member of the share

Page

Which page number to fetch

Per Page

The number of items for each page

Scroll

If true passed then uses scroll pagination instead of default one

Scroll Id

In order to get next batch of results using scroll pagination the scroll_id is required

Sort

A comma separated list of fieldnames with order. For example - title,asc;object_type,desc

Response Type

N/A

GET Get a relation type

/v1/assets/relation_types/{relation_type}/

Required roles:

  • can_read_asset_relations

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Relation Type

N/A

Response Type

N/A

GET Get a segment by ID

/v1/assets/{asset_id}/segments/{segment_id}/

Required roles:

  • can_read_segments

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

Segment Id

N/A

Scroll

If true passed then uses scroll pagination instead of default one

Scroll Id

In order to get next batch of results using scroll pagination the scroll_id is required

Response Type

N/A

GET Get a transcription properties by ID

/v1/assets/{asset_id}/versions/{version_id}/transcriptions/{transcription_id}/properties/

Required roles:

  • can_read_transcriptions

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

Version Id

N/A

Transcription Id

N/A

Response Type

N/A

GET Get aggregated information about collection

/v1/collections/{collection_id}/content/info/


The returned information includes count of assets and sub-collections,
total size of all assets (in bytes) and total duration of video and audio assets (in milliseconds).
The returned information includes count of assets and sub-collections,
total size of all assets (in bytes) and total duration of video and audio assets (in milliseconds).
Required roles:

  • can_read_collections

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Collection Id

N/A

Only Active

If false, include all the contents

Include Subcollections

Compute total stats including assets from sub-collections

Format Name

Compute total size only for files with the specified format name (default - ORIGINAL)

By Storage Id

Group results by storage_id / storage_method

Response Type

N/A

GET Get all assets containing a person_id or specific versions of an asset containing a person_id

/v1/persons/{person_id}/

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Person Id

N/A

Page

N/A

Per Page

N/A

Asset Id

N/A

Response Type

N/A

GET Get an asset custom action

/v1/custom_actions/{context}/{action_id}/

Required roles:

  • can_read_custom_actions

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Context

N/A

Action Id

N/A

Response Type

N/A

GET Get an asset history entity

/v1/assets/{asset_id}/history/{history_entity_id}/

Required roles:

  • can_read_assets_history

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

History Entity Id

N/A

Response Type

N/A

GET Get deleted objects

/v1/delete_queue/assets/

Required roles:

  • can_read_assets

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Per Page

The number of items for each page

Page

Which page number to fetch

Sort

A comma separated list of fieldnames with order. For example - first_name,asc;last_name,desc

Filter

A comma separated list of fieldnames with order For example - first_name,eq,Vlad;last_name,eq,Gudkov

Response Type

N/A

GET Get list of asset's shares including all direct and indirect shares that were made by sharing

/v1/assets/{asset_id}/shares/all/

collections and playlists that contain the assetcollections and playlists that contain the asset
Required roles:

  • can_read_shares

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

Response Type

N/A

GET Get list of assets

/v1/assets/

Required roles:

  • can_read_assets

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Per Page

The number of items for each page

Page

Which page number to fetch

Scroll

If true passed then uses scroll pagination instead of default one

Scroll Id

In order to get next batch of results using scroll pagination the scroll_id is required

Sort

A comma separated list of fieldnames with order. For example - first_name,asc;last_name,desc

Field Name

filter by field_name

Response Type

N/A

GET Get list of collection's shares including all direct and indirect shares that were made by

/v1/collections/{collection_id}/shares/all/

sharing collections that contain the collectionsharing collections that contain the collection
Required roles:

  • can_read_shares

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Collection Id

N/A

Response Type

N/A

GET Get list of collections

/v1/collections/

Required roles:

  • can_read_collections

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Per Page

The number of items for each page

Page

Which page number to fetch

Scroll

If true passed then uses scroll pagination instead of default one

Scroll Id

In order to get next batch of results using scroll pagination the scroll_id is required

Sort

A comma separated list of fieldnames with order. For example - title,asc;is_root,desc

Is Root

Filter by is_root

Status

Filter by status

Response Type

N/A

GET Get list of collections

/v1/delete_queue/collections/

Required roles:

  • can_read_collections

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Per Page

The number of items for each page

Page

Which page number to fetch

Sort

A comma separated list of fieldnames with order. For example - first_name,asc;last_name,desc

Filter

A comma separated list of fieldnames with order For example - first_name,eq,Vlad;last_name,eq,Gudkov

Response Type

N/A

GET Get list of custom actions

/v1/custom_actions/

Required roles:

  • can_read_custom_actions

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Response Type

N/A

GET Get list of custom actions by context

/v1/custom_actions/{context}/

Required roles:

  • can_read_custom_actions

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Context

N/A

Response Type

N/A

GET Get list of favorite objects

/v1/favorites/

Required roles:

  • can_read_assets

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Per Page

The number of objects for each page

Page

Which page number to fetch

Sort

A comma separated list of fieldnames with order. For example - title,asc;date_created,desc

Response Type

N/A

GET Get list of history entities for asset

/v1/assets/{asset_id}/history/

Required roles:

  • can_read_assets_history

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

Per Page

The number of items for each page

Page

Which page number to fetch

Sort

A comma separated list of fieldnames with order. For example - first_name,asc;last_name,desc

Filter

A comma separated list of fieldnames with order For example - first_name,eq,Vlad;last_name,eq,Gudkov

Response Type

N/A

GET Get list of object shares

/v1/{object_type}/{object_id}/shares/

Required roles:

  • can_read_shares

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Object Type

N/A

Object Id

N/A

Per Page

The number of items for each page

Last Id

N/A

Response Type

N/A

GET Get list of playlist's items

/v1/playlists/{playlist_id}/items/

Required roles:

  • can_read_playlists

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Playlist Id

N/A

Per Page

The number of items for each page

Ids

Filter list of id:s (comma separated)

Page

Which page number to fetch

Response Type

N/A

GET Get list of playlists

/v1/playlists/

Required roles:

  • can_read_playlists

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Per Page

The number of items for each page

Page

Which page number to fetch

Scroll

If true passed then uses scroll pagination instead of default one

Scroll Id

In order to get next batch of results using scroll pagination the scroll_id is required

Sort

A comma separated list of fieldnames with order. For example - title,asc;date_created,desc

Status

Filter by status

Response Type

N/A

GET Get list of project's members

/v1/projects/{project_id}/members/

Required roles:

  • can_read_projects

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Project Id

N/A

Response Type

N/A

GET Get list of projects

/v1/projects/

Required roles:

  • can_read_projects

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Per Page

The number of items for each page

Page

Which page number to fetch

Scroll

If true passed then uses scroll pagination instead of default one

Scroll Id

In order to get next batch of results using scroll pagination the scroll_id is required

Sort

A comma separated list of fieldnames with order. For example - title,asc;date_created,desc

Status

Filter by status

Response Type

N/A

GET Get list of sequence's items

/v1/sequences/{sequence_id}/items/

Required roles:

  • can_read_sequences

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Sequence Id

N/A

Per Page

The number of items for each page

Page

Which page number to fetch

Response Type

N/A

GET Get list of sequences

/v1/sequences/

Required roles:

  • can_read_sequences

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Per Page

The number of items for each page

Page

Which page number to fetch

Scroll

If true passed then uses scroll pagination instead of default one

Scroll Id

In order to get next batch of results using scroll pagination the scroll_id is required

Sort

A comma separated list of fieldnames with order. For example - title,asc;date_created,desc

Status

Filter by status

Response Type

N/A

GET Get list of share users

/v1/{object_type}/{object_id}/shares/{share_id}/users/

Required roles:

  • can_read_shares

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Object Type

N/A

Object Id

N/A

Share Id

N/A

Per Page

The number of items for each page

Last Id

N/A

Response Type

N/A

GET Gets the full path of the collection

/v1/collections/{collection_id}/full/path/

Required roles:

  • can_read_collections

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Collection Id

N/A

Get Upload Path

Use to get the upload path instead of the full path

Response Type

N/A

GET List of segments

/v1/assets/{asset_id}/segments/

Required roles:

  • can_read_segments

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

Sort

Sort on field (Comma separated)

Ids

Only include these segments (Comma separated)

Query

Search using query

Includes

Only include fields (Comma separated)

Per Page

The number of items for each page

Page

Which page number to fetch

Scroll

If true passed then uses scroll pagination instead of default one

Scroll Id

In order to get next batch of results using scroll pagination the scroll_id is required

Transcription Id

Filter segments by transcription_id

Version Id

Filter segments by version_id

Segment Type

Filter segments by segment_type

Segment Color

Filter segments by segment_color

Time Start Milliseconds

Filter segments by time_start_milliseconds

Time End Milliseconds

Filter segments by time_end_milliseconds

Time Start Milliseconds Gte

Get segments with start time greater than or equal to time_start_milliseconds__gte

Time End Milliseconds Lte

Get segments with end time less than or equal to time_end_milliseconds__lte

Status

Filter segments by status

Person Id

Filter segments by person_id

Share Id

Filter segments by share_id

Project Id

Filter segments by project_id

Include Users

Include segment's authors info

Include All Versions

If true return asset's segments for all versions

Response Type

N/A

GET List of segments

/v1/assets/{asset_id}/segments/{segment_type}/

Required roles:

  • can_read_segments

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

Segment Type

N/A

Sort

Sort on field (Comma separated)

Ids

Only include these segments (Comma separated)

Query

Search using query

Includes

Only include fields (Comma separated)

Per Page

The number of items for each page

Page

Which page number to fetch

Scroll

If true passed then uses scroll pagination instead of default one

Scroll Id

In order to get next batch of results using scroll pagination the scroll_id is required

Time Start Milliseconds

Filter segments by time_start_milliseconds

Time End Milliseconds

Filter segments by time_end_milliseconds

Time Start Milliseconds Gte

Get segments with start time greater than or equal to time_start_milliseconds__gte

Time End Milliseconds Lte

Get segments with end time less than or equal to time_end_milliseconds__lte

Response Type

N/A

GET List of segments as CSV file

/v1/assets/{asset_id}/segments/csv/

Required roles:

  • can_read_segments

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

Ids

Only include these segments (Comma separated)

Query

Search using query

Transcription Id

Filter segments by transcription_id

Version Id

Filter segments by version_id

Segment Type

Filter segments by segment_type

Segment Color

Filter segments by segment_color

Response Type

N/A

GET List of segments as SRT file

/v1/assets/{asset_id}/segments/srt/

Required roles:

  • can_read_segments

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

Ids

Only include these segments (Comma separated)

Query

Search using query

Transcription Id

Filter segments by transcription_id

Version Id

Filter segments by version_id

Segment Type

Filter segments by segment_type

Segment Color

Filter segments by segment_color

Words Per Line

Limit the number of words per subtitle line

Response Type

N/A

GET List of segments as WebVTT file

/v1/assets/{asset_id}/segments/vtt/

Required roles:

  • can_read_segments

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

Ids

Only include these segments (Comma separated)

Query

Search using query

Transcription Id

Filter segments by transcription_id

Version Id

Filter segments by version_id

Segment Type

Filter segments by segment_type

Segment Color

Filter segments by segment_color

Words Per Line

Limit the number of words per subtitle line

Response Type

N/A

POST Login for share

/v1/shares/auth/login/

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Response Type

N/A
Options (6)

Option Name

Description

App Id

N/A

Hash

N/A

Object Id

N/A

Object Type

N/A

Password

N/A

Token

N/A

POST Mark asset as viewed

/v1/assets/{asset_id}/views/

Required roles:

  • can_read_assets

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

Response Type

N/A

POST Pick up to three asset_ids for collection keyframes

/v1/collections/{collection_id}/keyframes/

Required roles:

  • can_reindex_collections

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Collection Id

N/A

Response Type

N/A
Options (1)

Option Name

Description

Asset Ids

N/A

PUT Promote a particular asset version to a latest version

/v1/assets/{asset_id}/versions/{version_id}/promote/

Required roles:

  • can_write_versions

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

Version Id

N/A

Response Type

N/A

POST Purge all assets and collections from delete queue (Permanently delete)

/v1/delete_queue/purge/all/

Required roles:

  • can_purge_assets

  • can_purge_collections

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Response Type

N/A

POST Purge all assets from delete queue (Permanently delete)

/v1/delete_queue/assets/purge/all/

Required roles:

  • can_purge_assets

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Response Type

N/A

POST Purge all collections from delete queue (Permanently delete)

/v1/delete_queue/collections/purge/all/

Required roles:

  • can_purge_collections

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Response Type

N/A

POST Purge assets from delete queue (Permanently delete)

/v1/delete_queue/assets/purge/

Required roles:

  • can_purge_assets

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Response Type

N/A
Options (1)

Option Name

Description

Ids

N/A

POST Purge collections from delete queue (Permanently delete)

/v1/delete_queue/collections/purge/

Required roles:

  • can_purge_collections

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Response Type

N/A
Options (1)

Option Name

Description

Ids

N/A

DELETE Purges a particular asset by id immediately

/v1/assets/{asset_id}/purge/

Required roles:

  • can_purge_assets

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

Response Type

N/A

DELETE Purges deleted collection by id immediately

/v1/collections/{collection_id}/purge/

Required roles:

  • can_purge_collections

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Collection Id

N/A

Response Type

N/A

PUT Refreshes a token for share

/v1/shares/auth/token/

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Share-auth-token

N/A

Response Type

N/A

POST Reindex asset

/v1/assets/{asset_id}/reindex/

Required roles:

  • can_reindex_assets

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

Response Type

N/A
Options (2)

Option Name

Description

Realms

N/A

Sync To Another Dc

N/A

POST Reindex asset history entity

/v1/assets/{asset_id}/history/{history_entity_id}/reindex/

Required roles:

  • can_reindex_assets_history

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

History Entity Id

N/A

Response Type

N/A

POST Reindex assets segment

/v1/assets/{asset_id}/segments/{segment_id}/reindex/

Required roles:

  • can_reindex_segments

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

Segment Id

N/A

Response Type

N/A
Options (3)

Option Name

Description

Ignore Comments

N/A

Realms

N/A

Sync To Another Dc

N/A

POST Reindex assets segments

/v1/assets/{asset_id}/segments/reindex/

Required roles:

  • can_reindex_segments

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

Response Type

N/A
Options (3)

Option Name

Description

Ignore Comments

N/A

Realms

N/A

Sync To Another Dc

N/A

POST Reindex collection

/v1/collections/{collection_id}/reindex/

Required roles:

  • can_reindex_collections

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Collection Id

N/A

Response Type

N/A
Options (2)

Option Name

Description

Realms

N/A

Sync To Another Dc

N/A

POST Reindex collection and its content

/v1/collections/{collection_id}/reindex/contents/

Required roles:

  • can_reindex_collections

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Collection Id

N/A

Response Type

N/A

POST Reindex collection content

/v1/collections/{collection_id}/contents/{object_type}/{object_id}/reindex/

Required roles:

  • can_reindex_collections

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Collection Id

N/A

Object Type

N/A

Object Id

N/A

Response Type

N/A
Options (1)

Option Name

Description

Sync To Another Dc

N/A

POST Reindex the playlist

/v1/playlists/{playlist_id}/reindex/

Required roles:

  • can_reindex_playlists

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Playlist Id

N/A

Response Type

N/A
Options (1)

Option Name

Description

Sync To Another Dc

N/A

POST Reindex the project

/v1/projects/{project_id}/reindex/

Required roles:

  • can_reindex_projects

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Project Id

N/A

Response Type

N/A
Options (1)

Option Name

Description

Sync To Another Dc

N/A

POST Reindex the sequence

/v1/sequences/{sequence_id}/reindex/

Required roles:

  • can_reindex_sequences

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Sequence Id

N/A

Response Type

N/A
Options (1)

Option Name

Description

Sync To Another Dc

N/A

POST Reindex the share

/v1/{object_type}/{object_id}/shares/{share_id}/reindex/

Required roles:

  • can_reindex_shares

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Object Type

N/A

Object Id

N/A

Share Id

N/A

Response Type

N/A
Options (1)

Option Name

Description

Sync To Another Dc

N/A

DELETE Removes all assets/collections from the list of favourites

/v1/favorites/all/

Required roles:

  • can_delete_favorites

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Response Type

N/A

DELETE Removes all assets/collections from the list of favourites

/v1/favourites/all/

Required roles:

  • can_delete_favorites

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Response Type

N/A

POST Restore all assets from delete queue

/v1/delete_queue/assets/restore/all/

Required roles:

  • can_write_assets

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Response Type

N/A

POST Restore all collections from delete queue

/v1/delete_queue/collections/restore/all/

Required roles:

  • can_write_collections

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Response Type

N/A

PUT Restore deleted asset by id

/v1/assets/{asset_id}/restore/

Required roles:

  • can_write_assets

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

Response Type

N/A

PUT Restore deleted collection by id

/v1/collections/{collection_id}/restore/

Required roles:

  • can_write_collections

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Collection Id

N/A

Response Type

N/A

GET Returns a particular asset by id

/v1/assets/{asset_id}/

Required roles:

  • can_read_assets

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

Include Collections

include collection membership

Include Users

include info about the users who have interacted with this asset

Response Type

N/A

GET Returns a particular collection by id

/v1/collections/{collection_id}/

Required roles:

  • can_read_collections

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Collection Id

N/A

Response Type

N/A

GET Returns a particular playlist by id

/v1/playlists/{playlist_id}/

Required roles:

  • can_read_playlists

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Playlist Id

N/A

Response Type

N/A

GET Returns a particular project by id

/v1/projects/{project_id}/

Required roles:

  • can_read_projects

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Project Id

N/A

Include Users

include info about the users who have interacted with this project

Response Type

N/A

GET Returns a particular project member by id

/v1/projects/{project_id}/members/{member_id}/

Required roles:

  • can_read_projects

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Project Id

N/A

Member Id

N/A

Response Type

N/A

GET Returns a particular sequence by id

/v1/sequences/{sequence_id}/

Required roles:

  • can_read_sequences

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Sequence Id

N/A

Response Type

N/A

GET Returns a particular share by id

/v1/{object_type}/{object_id}/shares/{share_id}/

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Object Type

N/A

Object Id

N/A

Share Id

N/A

Response Type

N/A

GET Returns a particular share user by id

/v1/{object_type}/{object_id}/shares/{share_id}/users/{share_user_id}/

Required roles:

  • can_read_shares

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Object Type

N/A

Object Id

N/A

Share Id

N/A

Share User Id

N/A

Response Type

N/A

GET Returns a particular sync session by id. If a session with such id doesn't exist,

/v1/sync/sessions/{sync_session_id}/

a new one is created

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Sync Session Id

N/A

Response Type

N/A

GET Returns an assets relations

/v1/assets/{asset_id}/relations/

Required roles:

  • can_read_asset_relations

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

Include Deleted

Also show assets from recycle bin in relations

Per Page

The number of items for each page

Page

Which page number to fetch

Sort

A comma separated list of fieldnames with order. For example - first_name,asc;last_name,desc

Response Type

N/A

GET Returns an objects approval request

/v1/{object_type}/{object_id}/approvals/

Required roles:

  • can_read_approval_request

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Object Id

N/A

Object Type

N/A

Response Type

N/A

GET Returns an objects approval request

/v1/{object_type}/{object_id}/approvals/request/

Required roles:

  • can_read_approval_request

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Object Id

N/A

Object Type

N/A

Response Type

N/A

GET Returns an objects approval request by version

/v1/{object_type}/{object_id}/versions/{version_id}/approvals/

Required roles:

  • can_read_approval_request

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Object Type

N/A

Object Id

N/A

Version Id

N/A

Response Type

N/A

GET Returns an objects approval request by version

/v1/{object_type}/{object_id}/versions/{version_id}/approvals/request/

Required roles:

  • can_read_approval_request

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Object Type

N/A

Object Id

N/A

Version Id

N/A

Response Type

N/A

GET Returns assets that has a relation to this asset

/v1/assets/{asset_id}/relations/{relation_type}/

Required roles:

  • can_read_asset_relations

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

Relation Type

N/A

Include Deleted

Also show assets from recycle bin in relations

Response Type

N/A

GET Returns contents of a collection by id

/v1/collections/{collection_id}/contents/

Required roles:

  • can_read_collections

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Collection Id

N/A

Object Types

Comma separated list of content types. Example - assets,collections

Object Ids

Comma separated list of content ids.

External Id

N/A

Per Page

The number of items for each page

Page

Which page number to fetch

Sort

A comma separated list of fieldnames with order. For example - first_name,asc;last_name,desc

Filter

A comma separated list of fieldnames with order For example - first_name,eq,Vlad;last_name,eq,Gudkov

Response Type

N/A

GET Returns list of ancestors of a collection

/v1/collections/{collection_id}/ancestors/

Required roles:

  • can_read_collections

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Collection Id

N/A

Response Type

N/A

GET Returns the size of all the collection's assets in bytes

/v1/collections/{collection_id}/size/

Required roles:

  • can_read_collections

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Collection Id

N/A

Format Name

Compute total size only for files with the specified format name

Include Subcollections

Compute total size for all files including sub_collections' assets

Response Type

N/A

POST Reverse a particular asset's relation

/v1/assets/{asset_id}/relations/{relation_type}/{related_to_asset_id}/reverse/

Required roles:

  • can_create_asset_relations

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

Relation Type

N/A

Related To Asset Id

N/A

Response Type

N/A

POST Schedules a celery task that will call custom action

/v1/custom_actions/{context}/{action_id}/callback/

Required roles:

  • can_read_custom_actions

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Context

N/A

Action Id

N/A

Response Type

N/A
Options (5)

Option Name

Description

Asset Ids

N/A

Collection Ids

N/A

From Collection Id

ID of a collection that the custom action was triggered from

Metadata View Id

N/A

Saved Search Ids

N/A

POST Schedules a celery task that will call custom action on shares

/v1/custom_actions/shared/{context}/{action_id}/callback/

Required roles:

  • can_read_custom_actions

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Context

N/A

Action Id

N/A

Response Type

N/A
Options (5)

Option Name

Description

Asset Ids

N/A

Collection Ids

N/A

From Collection Id

ID of a collection that the custom action was triggered from

Metadata View Id

N/A

Saved Search Ids

N/A

POST Trigger reindexing of all assets

/v1/assets/reindex/

Required roles:

  • can_reindex_assets

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Response Type

N/A
Options (3)

Option Name

Description

Asset Ids

N/A

Realms

N/A

Sync To Another Dc

N/A

POST Trigger reindexing of all collections

/v1/collections/reindex/

Required roles:

  • can_reindex_collections

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Response Type

N/A
Options (2)

Option Name

Description

Collection Ids

N/A

Realms

N/A

POST Trigger reindexing of all segments

/v1/assets/segments/reindex/

Required roles:

  • can_reindex_segments

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Response Type

N/A
Options (4)

Option Name

Description

Asset Ids

N/A

Ignore Comments

N/A

Realms

N/A

Sync To Another Dc

N/A

POST Trigger reindexing of specific segment ids

/v1/segments/reindex/

Required roles:

  • can_reindex_segments

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Response Type

N/A
Options (4)

Option Name

Description

Ignore Comments

N/A

Realms

N/A

Segment Ids

N/A

Sync To Another Dc

N/A

PATCH Update a playlist

/v1/playlists/{playlist_id}/

Required roles:

  • can_write_playlists

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Playlist Id

N/A

Response Type

N/A
Options (9)

Option Name

Description

Created By User

N/A

Date Created

N/A

Date Modified

N/A

Id

N/A

Item Count

N/A

Name

N/A

Project Id

N/A

Status

N/A

System Domain Id

N/A

PUT Update a playlist

/v1/playlists/{playlist_id}/

Required roles:

  • can_write_playlists

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Playlist Id

N/A

Response Type

N/A
Options (9)

Option Name

Description

Created By User

N/A

Date Created

N/A

Date Modified

N/A

Id

N/A

Item Count

N/A

Name

N/A

Project Id

N/A

Status

N/A

System Domain Id

N/A

PATCH Update a playlist item

/v1/playlists/{playlist_id}/items/{item_id}/

Required roles:

  • can_update_playlist_items

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Playlist Id

N/A

Item Id

N/A

Response Type

N/A
Options (6)

Option Name

Description

Id

N/A

Object Id

N/A

Object Type

N/A

Time End Milliseconds

N/A

Time Start Milliseconds

N/A

Version Id

N/A

PUT Update a playlist item

/v1/playlists/{playlist_id}/items/{item_id}/

Required roles:

  • can_update_playlist_items

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Playlist Id

N/A

Item Id

N/A

Response Type

N/A
Options (6)

Option Name

Description

Id

N/A

Object Id

N/A

Object Type

N/A

Time End Milliseconds

N/A

Time Start Milliseconds

N/A

Version Id

N/A

PUT Update a playlist item position

/v1/playlists/{playlist_id}/items/{item_id}/position/

Required roles:

  • can_update_playlist_items_position

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Playlist Id

N/A

Item Id

N/A

Response Type

N/A
Options (1)

Option Name

Description

Position

New position of the item in the playlist.If not provided, the item will be appended to the end of the playlist

PATCH Update a sequence

/v1/sequences/{sequence_id}/

Required roles:

  • can_write_sequences

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Sequence Id

N/A

Response Type

N/A
Options (6)

Option Name

Description

Created By User

N/A

Date Created

N/A

Date Modified

N/A

Id

N/A

Name

N/A

System Domain Id

N/A

PUT Update a sequence

/v1/sequences/{sequence_id}/

Required roles:

  • can_write_sequences

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Sequence Id

N/A

Response Type

N/A
Options (6)

Option Name

Description

Created By User

N/A

Date Created

N/A

Date Modified

N/A

Id

N/A

Name

N/A

System Domain Id

N/A

PUT Update a sequence item position

/v1/sequences/{sequence_id}/items/{item_id}/position/

Required roles:

  • can_add_sequence_items

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Sequence Id

N/A

Item Id

N/A

Response Type

N/A
Options (1)

Option Name

Description

Position

New position of the item in the sequence.If not provided, the item will be appended to the end of the sequence

PATCH Update an asset relation type

/v1/assets/relation_types/{relation_type}/

Required roles:

  • can_write_asset_relation_types

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Relation Type

N/A

Response Type

N/A
Options (8)

Option Name

Description

Date Created

N/A

Date Modified

N/A

Description

N/A

Destination Label

N/A

Is Directional

N/A

Is System

N/A

Name

N/A

Source Label

N/A

PUT Update an asset relation type

/v1/assets/relation_types/{relation_type}/

Required roles:

  • can_write_asset_relation_types

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Relation Type

N/A

Response Type

N/A
Options (8)

Option Name

Description

Date Created

N/A

Date Modified

N/A

Description

N/A

Destination Label

N/A

Is Directional

N/A

Is System

N/A

Name

N/A

Source Label

N/A

PATCH Update an custom action

/v1/custom_actions/{context}/{action_id}/

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Context

N/A

Action Id

N/A

Response Type

N/A
Options (14)

Option Name

Description

App Id

N/A

Context

N/A

Date Created

N/A

Date Modified

N/A

Disabled

N/A

Id

N/A

Last Error

N/A

Last Error Date

N/A

Metadata View

N/A

Status

N/A

System Domain Id

N/A

Title

N/A

Type

N/A

Url

N/A

PUT Update an custom action

/v1/custom_actions/{context}/{action_id}/

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Context

N/A

Action Id

N/A

Response Type

N/A
Options (14)

Option Name

Description

App Id

N/A

Context

N/A

Date Created

N/A

Date Modified

N/A

Disabled

N/A

Id

N/A

Last Error

N/A

Last Error Date

N/A

Metadata View

N/A

Status

N/A

System Domain Id

N/A

Title

N/A

Type

N/A

Url

N/A

PUT Update an order of a particular content object in a collection

/v1/collections/{collection_id}/contents/{object_type}/{object_id}/

Required roles:

  • can_write_collections

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Collection Id

N/A

Object Type

N/A

Object Id

N/A

Response Type

N/A
Options (3)

Option Name

Description

After Object Id

N/A

Before Object Id

N/A

Position

Position the member will be moved to. To insert athe the end send -1

PATCH Update asset

/v1/assets/{asset_id}/

Required roles:

  • can_write_assets

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

Generate Subclip Keyframes

If the asset is a subclip, generate keyframes for it

Response Type

N/A
Options (35)

Option Name

Description

Analyze Status

N/A

Archive Status

N/A

Category

N/A

Created By User

N/A

Custom Keyframe

N/A

Custom Poster

N/A

Date Created

N/A

Date Deleted

N/A

Date Imported

N/A

Date Modified

N/A

Date Viewed

N/A

Deleted By User

N/A

External Id

N/A

External Link

N/A

Face Recognition Status

N/A

Favoured

N/A

Has Unconfirmed Persons

N/A

Id

N/A

In Collections

N/A

Is Blocked

N/A

Is Online

N/A

Last Archive Restore Date

N/A

Limit Download To Groups

N/A

Original Asset Id

N/A

Original Segment Id

N/A

Original Version Id

N/A

Person Ids

N/A

Site Name

N/A

Status

N/A

Time End Milliseconds

N/A

Time Start Milliseconds

N/A

Title

N/A

Type

N/A

Updated By User

N/A

Warning

N/A

PUT Update asset

/v1/assets/{asset_id}/

Required roles:

  • can_write_assets

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

Generate Subclip Keyframes

If the asset is a subclip, generate keyframes for it

Response Type

N/A
Options (35)

Option Name

Description

Analyze Status

N/A

Archive Status

N/A

Category

N/A

Created By User

N/A

Custom Keyframe

N/A

Custom Poster

N/A

Date Created

N/A

Date Deleted

N/A

Date Imported

N/A

Date Modified

N/A

Date Viewed

N/A

Deleted By User

N/A

External Id

N/A

External Link

N/A

Face Recognition Status

N/A

Favoured

N/A

Has Unconfirmed Persons

N/A

Id

N/A

In Collections

N/A

Is Blocked

N/A

Is Online

N/A

Last Archive Restore Date

N/A

Limit Download To Groups

N/A

Original Asset Id

N/A

Original Segment Id

N/A

Original Version Id

N/A

Person Ids

N/A

Site Name

N/A

Status

N/A

Time End Milliseconds

N/A

Time Start Milliseconds

N/A

Title

N/A

Type

N/A

Updated By User

N/A

Warning

N/A

PATCH Update collection

/v1/collections/{collection_id}/

Required roles:

  • can_write_collections

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Collection Id

N/A

Change Parent Mode

Set to 'move' or 'copy'. Ignored if 'parent_id' hasn't changed

Response Type

N/A
Options (11)

Option Name

Description

Category

N/A

Custom Keyframe

N/A

Custom Poster

N/A

Date Created

N/A

External Id

N/A

Is Root

N/A

Keyframe Asset Ids

N/A

Parent Id

N/A

Status

N/A

Storage Id

N/A

Title

N/A

PUT Update collection

/v1/collections/{collection_id}/

Required roles:

  • can_write_collections

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Collection Id

N/A

Change Parent Mode

Set to 'move' or 'copy'. Ignored if 'parent_id' hasn't changed

Response Type

N/A
Options (11)

Option Name

Description

Category

N/A

Custom Keyframe

N/A

Custom Poster

N/A

Date Created

N/A

External Id

N/A

Is Root

N/A

Keyframe Asset Ids

N/A

Parent Id

N/A

Status

N/A

Storage Id

N/A

Title

N/A

PUT Update metadata for asset

/v1/assets/{asset_id}/search_document/

Required roles:

  • can_reindex_assets

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

Response Type

N/A
Options (47)

Option Name

Description

Analyze Status

N/A

Ancestor Collections

Unordered list of all ancestor collection ids

Archive Status

N/A

Category

N/A

Comments Count

N/A

Created By User

N/A

Custom Keyframe

N/A

Custom Poster

N/A

Date Created

N/A

Date Deleted

N/A

Date Imported

N/A

Date Modified

N/A

Date Viewed

N/A

Deleted By User

N/A

Duration Milliseconds

N/A

External Id

N/A

External Link

N/A

Face Recognition Status

N/A

Favoured

N/A

Files

N/A

Formats

N/A

Has Unconfirmed Persons

N/A

Id

N/A

In Collections

N/A

Is Blocked

N/A

Is Online

N/A

Keyframes

N/A

Last Archive Restore Date

N/A

Limit Download To Groups

N/A

Media Type

N/A

Metadata

N/A

Object Type

N/A

Original Asset Id

N/A

Original Segment Id

N/A

Original Version Id

N/A

Person Ids

N/A

Position

N/A

Proxies

N/A

Site Name

N/A

Status

N/A

Time End Milliseconds

N/A

Time Start Milliseconds

N/A

Title

N/A

Type

N/A

Updated By User

N/A

Versions Number

N/A

Warning

N/A

PUT Update metadata for collection

/v1/collections/{collection_id}/search_document/

Required roles:

  • can_reindex_collections

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Collection Id

N/A

Response Type

N/A
Options (26)

Option Name

Description

Category

N/A

Created By User

N/A

Custom Keyframe

N/A

Custom Order Status

N/A

Custom Poster

N/A

Date Created

N/A

Date Deleted

N/A

Date Modified

N/A

Deleted By User

N/A

External Id

N/A

Favoured

N/A

Id

N/A

In Collections

N/A

Is Root

N/A

Keyframe Asset Ids

N/A

Keyframes

N/A

Metadata

N/A

Object Type

N/A

Parent Id

N/A

Parents

N/A

Permissions

N/A

Position

N/A

Project Id

N/A

Status

N/A

Storage Id

N/A

Title

N/A

PATCH Update project

/v1/projects/{project_id}/

Required roles:

  • can_write_projects

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Project Id

N/A

Response Type

N/A
Options (9)

Option Name

Description

Collection Id

N/A

Created By User

N/A

Date Created

N/A

Date Modified

N/A

Id

N/A

Name

N/A

Status

N/A

Storage Id

N/A

System Domain Id

N/A

PUT Update project

/v1/projects/{project_id}/

Required roles:

  • can_write_projects

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Project Id

N/A

Response Type

N/A
Options (9)

Option Name

Description

Collection Id

N/A

Created By User

N/A

Date Created

N/A

Date Modified

N/A

Id

N/A

Name

N/A

Status

N/A

Storage Id

N/A

System Domain Id

N/A

PATCH Update segment

/v1/assets/{asset_id}/segments/{segment_id}/

Required roles:

  • can_write_segments

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

Segment Id

N/A

Generate Subclip Keyframes

If the segment is a subclip, generate keyframes for it

Response Type

N/A
Options (31)

Option Name

Description

Asset Id

N/A

Date Created

N/A

Date Modified

N/A

External Id

N/A

Id

N/A

Is Internal

If set to true, the segment is only visible to internal iconik users

Keyframe Id

N/A

Metadata

N/A

Metadata View Id

N/A

Parent Id

N/A

Path

N/A

Person Id

N/A

Project Id

ID of a project if the segment is created from a project

Segment Checked

N/A

Segment Color

N/A

Segment Text

N/A

Segment Track

N/A

Segment Type

N/A

Share Id

ID of a share if the segment is created from a share

Share User Email

N/A

Status

N/A

Subclip Id

N/A

Time End Milliseconds

N/A

Time Start Milliseconds

N/A

Top Level

N/A

Transcription Id

N/A

User First Name

N/A

User Id

N/A

User Last Name

N/A

User Photo

N/A

Version Id

N/A

PUT Update segment

/v1/assets/{asset_id}/segments/{segment_id}/

Required roles:

  • can_write_segments

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

Segment Id

N/A

Generate Subclip Keyframes

If the segment is a subclip, generate keyframes for it

Response Type

N/A
Options (31)

Option Name

Description

Asset Id

N/A

Date Created

N/A

Date Modified

N/A

External Id

N/A

Id

N/A

Is Internal

If set to true, the segment is only visible to internal iconik users

Keyframe Id

N/A

Metadata

N/A

Metadata View Id

N/A

Parent Id

N/A

Path

N/A

Person Id

N/A

Project Id

ID of a project if the segment is created from a project

Segment Checked

N/A

Segment Color

N/A

Segment Text

N/A

Segment Track

N/A

Segment Type

N/A

Share Id

ID of a share if the segment is created from a share

Share User Email

N/A

Status

N/A

Subclip Id

N/A

Time End Milliseconds

N/A

Time Start Milliseconds

N/A

Top Level

N/A

Transcription Id

N/A

User First Name

N/A

User Id

N/A

User Last Name

N/A

User Photo

N/A

Version Id

N/A

PUT Update share

/v1/{object_type}/{object_id}/shares/{share_id}/

Required roles:

  • can_write_shares

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Object Type

N/A

Object Id

N/A

Share Id

N/A

Response Type

N/A
Options (27)

Option Name

Description

Allow Approving Comments

N/A

Allow Comments

N/A

Allow Custom Actions

N/A

Allow Download

N/A

Allow Download Proxy

N/A

Allow Setting Approve Status

N/A

Allow Upload

N/A

Allow User Search For Mentions

N/A

Allow View Transcriptions

N/A

Allow View Versions

N/A

Date Created

N/A

Expires

N/A

Has Password

N/A

Id

N/A

Is Approval

N/A

Message

N/A

Metadata Views

N/A

Object Id

N/A

Object Type

N/A

Owner Id

N/A

Project Id

Project ID if the share is created from a project

Review Experience Public Beta

N/A

Show Watermark

N/A

System Domain Id

N/A

Title

N/A

Upload Storage Id

N/A

Url

N/A

PATCH Update share user

/v1/{object_type}/{object_id}/shares/{share_id}/users/{share_user_id}/

Required roles:

  • can_write_shares

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Object Type

N/A

Object Id

N/A

Share Id

N/A

Share User Id

N/A

Response Type

N/A
Options (14)

Option Name

Description

Access Count

N/A

Email

N/A

First Name

N/A

Id

N/A

Internal User Id

N/A

Last Access Date

N/A

Last Name

N/A

Object Id

N/A

Object Type

N/A

Password

N/A

Photo

N/A

Photo Big

N/A

Photo Small

N/A

Share Id

N/A

PUT Update share user

/v1/{object_type}/{object_id}/shares/{share_id}/users/{share_user_id}/

Required roles:

  • can_write_shares

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Object Type

N/A

Object Id

N/A

Share Id

N/A

Share User Id

N/A

Response Type

N/A
Options (14)

Option Name

Description

Access Count

N/A

Email

N/A

First Name

N/A

Id

N/A

Internal User Id

N/A

Last Access Date

N/A

Last Name

N/A

Object Id

N/A

Object Type

N/A

Password

N/A

Photo

N/A

Photo Big

N/A

Photo Small

N/A

Share Id

N/A

PATCH Update transcription properties by ID

/v1/assets/{asset_id}/versions/{version_id}/transcriptions/{transcription_id}/properties/

Required roles:

  • can_write_transcriptions

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

Version Id

N/A

Transcription Id

N/A

Response Type

N/A
Options (5)

Option Name

Description

Asset Id

N/A

Id

N/A

Language

N/A

System Domain Id

N/A

Version Id

N/A

PUT Update transcription properties by ID

/v1/assets/{asset_id}/versions/{version_id}/transcriptions/{transcription_id}/properties/

Required roles:

  • can_write_transcriptions

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

App-id

N/A

Auth-token

N/A

Asset Id

N/A

Version Id

N/A

Transcription Id

N/A

Response Type

N/A
Options (5)

Option Name

Description

Asset Id

N/A

Id

N/A

Language

N/A

System Domain Id

N/A

Version Id

N/A