Otmmconnector V6 v1 | OneTeg Documentation

/v6/assets/{id}/contents

Add Or Update Renditions of an Asset. Supported Rendtion types are Thumbnail or Preview. The content image supported as a multipart/form-data format. If the rendition sent other than png file, the file name with extension must be set to FormDataBodyPart.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Asset Id
`Response Type`	N/A

Options (3)

Option Name	Description
`Rendition Type`	The rendition type
`Job Name`	User defined name of the job. If this parameter is not set, the default value is job class name.
`File`	N/A

/v6/assets

Create Asset(s) with the specified asset representation or import template. This should be a multipart/form-data request. Please use the utf-8 charset encoding so that any unicode characters in names of the attached files are interpreted properly. The operation creates a job and returns the job handle. Using the job id in job handle, you can query the 'jobs' resource for completion status.If only an asset representation is specified the user is required to have Apply/Remove Security Policy permission for all security policies assigned. If only an import template is specified the user is not required to have Apply/Remove Security Policy permission for the security policies inherited from the import template. If both an asset representation and an import template are specified the metadata, security policies, and categories populated into the assets will be determined by the asset representation, but the user will only be required to have Apply/Remove Security Policy permission for the security policies not present in the import template.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

Options (11)

Option Name	Description
`Import Template Id`	Id of the import template to use
`Parent Folder Id`	The parent folder id
`Review Job Id`	The review job id
`Review Task Id`	The review job task id
`Job Id`	The id of the job from where import is initiated.
`Task Id`	The id of the task from where import is initiated.
`No Content`	Optional flag that indicates whether this asset has content or not. Set to true if the asset is not associated with content and false if associated with content. If set to true then any attached files and upload manifest will be ignored.
`Files`	N/A
`Job Name`	User defined name of the job. If this parameter is not set, the default value is job class name.
`Job Type`	Name of the job to be triggered on the server. If this parameter is not set, the default value will be picked from settings. This parameter has highest precedence while deciding the job to trigger.
`Callback Url`	Callback URL in the encoded form, which needs to be notified once the job is complete. For more information on the format of callbackURl , refer to integration guide.

/v6/assets/links

Create one or more links between assets.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Asset Ids`	Comma separated list of source asset ids

/v6/assets/{id}/duplicate

Duplicate the given asset/folder to the destination folder.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	N/A
`Load Type`	Data load type
`Metadata To Return`	Comma separated list of metadata field ids. This parameter is ignored unless the load_type parameter is set to metadata or inherited_metadata
`Preference Id`	Preference Id
`Filter Fields By Model`	Filter metadata fields relevant to asset model. This parameter is honored only when metadata_to_return and/or preference_id are set in the request.
`Load Multilingual Values`	Load multilingual values. This parameter is honored only when the load_type parameter is set to metadata or full. For the custom load type multilingual values can be requested using the load_multilingual_field_values property of the data_load_request parameter.
`Data Load Request`	JSON representation of DataLoadRequest object. This parameter is ignored unless the load_type parameter is set to custom
`Level Of Detail`	Controls whether field definitions are suppressed in the metadata fields returned.
`Response Type`	N/A

Options (5)

Option Name	Description
`Destination Folder Id`	Destination folder id to move, copy or duplicate assets
`Position Type`	Method used to determine the position of the new children in the Folder
`Position`	If position_type is absolute the numeric position where the new children should be inserted into the existing children. If not specified the new children will be position after all existing children. If position_type is relative then you must specify either before or after to determine where the new children are inserted relative to the existing child identified by the relative_asset_id parameter.
`Relative Asset Id`	If position_type is relative then this parameter must be set to the asset id of the existing child relative to which new children should be added or moved. If position_type is absolute this parameter is ignored
`Depth`	Depth to traverse when duplicating containers. Less than zero means traverse all the way down.

/v6/assets/duplicate

Duplicate assets based on the selection context to the given destination folder.
For duplicating the hierarchy of folders, use the depth parameter. Using selection context to expand will flatten out the asset structure and duplicate it.
Using selection context parameter to duplicate hierarchy of asset will result in validation error.While using selection context to filter the assets based on permissions, pass permissions_filter parameter in selection context. Valid permission filters:

ASSETVIEW_PERM
SUMMARYVIEW_PERM
PREVIEWVIEW_PERM
EXPORT_PERM
SUBSCRIBE_PERM
METAEDIT_PERM
CONTENTEDIT_PERM
MEMBERSHIPEDIT_PERM
DELETEASSET_PERM
EDITPARENTS_PERM
CUSTOM01_PERM
CUSTOM02_PERM
CUSTOM03_PERM
CUSTOM04_PERM

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

Options (5)

Option Name	Description
`Destination Folder Id`	Destination folder id to move, copy or duplicate assets
`Position Type`	Method used to determine the position of the new children in the Folder
`Position`	If position_type is absolute the numeric position where the new children should be inserted into the existing children. If not specified the new children will be position after all existing children. If position_type is relative then you must specify either before or after to determine where the new children are inserted relative to the existing child identified by the relative_asset_id parameter.
`Relative Asset Id`	If position_type is relative then this parameter must be set to the asset id of the existing child relative to which new children should be added or moved. If position_type is absolute this parameter is ignored
`Depth`	Depth to traverse when duplicating containers. Less than zero means traverse all the way down.

/v6/assets/state

Lock or unlock or check-out or cancel check-out or delete or un-delete of an assetWhile using selection context to filter the assets based on permissions, pass permissions_filter parameter in selection context. Valid permission filters:

ASSETVIEW_PERM
SUMMARYVIEW_PERM
PREVIEWVIEW_PERM
EXPORT_PERM
SUBSCRIBE_PERM
METAEDIT_PERM
CONTENTEDIT_PERM
MEMBERSHIPEDIT_PERM
DELETEASSET_PERM
EDITPARENTS_PERM
CUSTOM01_PERM
CUSTOM02_PERM
CUSTOM03_PERM
CUSTOM04_PERM

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Action`	Asset 'state change' action; allowed values are check_out, cancel_check_out, lock, unlock, delete, un_delete

/v6/assets/{id}/state

Lock or unlock or check-out or cancel check-out or delete or un-delete of an asset

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Action`	Asset 'state change' action; allowed values are check_out, cancel_check_out, lock, unlock, delete, un_delete

/v6/assets/{id}/parents

Remove parents which are mentioned in comma separated parentIds string for current asset resource.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Asset Id
`Response Type`	N/A

Options (2)

Option Name	Description
`Type`	Type of operation.
`Parent Ids`	Comma separated list of the parent's ids to be detached

/v6/assets/links

Remove the links between assets

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Delete Links Param`	Delete links parameter holding information about mode of removing the links between the assets and assetIds.AssetIds specified must be source of given links
`Response Type`	N/A

/v6/assets/nofolders

Retrieve all orphan assets.The fields populated in the returned object is based on the load_type parameter value. The allowable load_type values are (full,system,metadata,inherited_metadata,custom). If the load_type parameter is set to custom then you must also provide a data_load_request parameter containing the JSON representation of a DataLoadRequest object. If the load_type parameter is set to metadata or inherited_metadata then you may optionally set the metadata_to_return and/or preference_id parameters to restrict what metadata fields are retrieved. The preference_id parameter is also honored when load_type is custom

For load_type options that return metadata fields it is possible to suppress field definitions and retrieve just the values for metadata fields by specifying the request parameter level_of_detail. The allowed values are slim, or full(default)

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Load Type`	Data load type
`Metadata To Return`	Comma separated list of metadata field ids. This parameter is ignored unless the load_type parameter is set to metadata or inherited_metadata
`Preference Id`	Preference Id
`Filter Fields By Model`	Filter metadata fields relevant to asset model. This parameter is honored only when metadata_to_return and/or preference_id are set in the request.
`Load Multilingual Values`	Load multilingual values. This parameter is honored only when the load_type parameter is set to metadata or full. For the custom load type multilingual values can be requested using the load_multilingual_field_values property of the data_load_request parameter.
`Data Load Request`	JSON representation of DataLoadRequest object. This parameter is ignored unless the load_type parameter is set to custom
`Level Of Detail`	Controls whether field definitions are suppressed in the metadata fields returned.
`After`	Retrieve collection starting at the position after the specified value. If neither the after or before parameters are specified this is equivalent to after=0 and will retrieve items starting at the beginning of the collection
`Before`	Retrieve collection starting at the position before the specified value and going backwards
`Limit`	Maximum number of items to retrieve.
`Sort`	Comma separated list of sort options. Sort options can optionally be prepended with 'asc_' or 'desc_' to specify ascending or descending sort (default is ascending).
`Response Type`	N/A

/v6/assets/nofolders/sortoptions

Retrieves all sort options to sortorphan assets of the logged in user.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/assets/recent

Retrieve all recently accessed assets of the logged in user.The fields populated in the returned object is based on the load_type parameter value. The allowable load_type values are (full,system,metadata,inherited_metadata,custom). If the load_type parameter is set to custom then you must also provide a data_load_request parameter containing the JSON representation of a DataLoadRequest object. If the load_type parameter is set to metadata or inherited_metadata then you may optionally set the metadata_to_return and/or preference_id parameters to restrict what metadata fields are retrieved. The preference_id parameter is also honored when load_type is custom

For load_type options that return metadata fields it is possible to suppress field definitions and retrieve just the values for metadata fields by specifying the request parameter level_of_detail. The allowed values are slim, or full(default)

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Load Type`	Data load type
`Metadata To Return`	Comma separated list of metadata field ids. This parameter is ignored unless the load_type parameter is set to metadata or inherited_metadata
`Preference Id`	Preference Id
`Filter Fields By Model`	Filter metadata fields relevant to asset model. This parameter is honored only when metadata_to_return and/or preference_id are set in the request.
`Load Multilingual Values`	Load multilingual values. This parameter is honored only when the load_type parameter is set to metadata or full. For the custom load type multilingual values can be requested using the load_multilingual_field_values property of the data_load_request parameter.
`Data Load Request`	JSON representation of DataLoadRequest object. This parameter is ignored unless the load_type parameter is set to custom
`Level Of Detail`	Controls whether field definitions are suppressed in the metadata fields returned.
`After`	Retrieve collection starting at the position after the specified value. If neither the after or before parameters are specified this is equivalent to after=0 and will retrieve items starting at the beginning of the collection
`Before`	Retrieve collection starting at the position before the specified value and going backwards
`Limit`	Maximum number of items to retrieve.
`Sort`	Comma separated list of sort options. Sort options can optionally be prepended with 'asc_' or 'desc_' to specify ascending or descending sort (default is ascending).
`Response Type`	N/A

/v6/assets/recent/sortoptions

Retrieves all sort options to sort recently accessed assets of the logged in user.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/assets/{id}/versions

Retrieve all versions of the specified Asset.The fields populated in the returned object is based on the load_type parameter value. The allowable load_type values are (full,system,metadata,inherited_metadata,custom). If the load_type parameter is set to custom then you must also provide a data_load_request parameter containing the JSON representation of a DataLoadRequest object. If the load_type parameter is set to metadata or inherited_metadata then you may optionally set the metadata_to_return and/or preference_id parameters to restrict what metadata fields are retrieved. The preference_id parameter is also honored when load_type is custom

For load_type options that return metadata fields it is possible to suppress field definitions and retrieve just the values for metadata fields by specifying the request parameter level_of_detail. The allowed values are slim, or full(default)

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Asset Id
`Load Type`	Data load type
`Metadata To Return`	Comma separated list of metadata field ids. This parameter is ignored unless the load_type parameter is set to metadata or inherited_metadata
`Preference Id`	Preference Id
`Filter Fields By Model`	Filter metadata fields relevant to asset model. This parameter is honored only when metadata_to_return and/or preference_id are set in the request.
`Load Multilingual Values`	Load multilingual values. This parameter is honored only when the load_type parameter is set to metadata or full. For the custom load type multilingual values can be requested using the load_multilingual_field_values property of the data_load_request parameter.
`Data Load Request`	JSON representation of DataLoadRequest object. This parameter is ignored unless the load_type parameter is set to custom
`Level Of Detail`	Controls whether field definitions are suppressed in the metadata fields returned.
`Response Type`	N/A

/v6/assets/{id}

Retrieve an Asset by asset id.The fields populated in the returned object is based on the load_type parameter value. The allowable load_type values are (full,system,metadata,inherited_metadata,custom). If the load_type parameter is set to custom then you must also provide a data_load_request parameter containing the JSON representation of a DataLoadRequest object. If the load_type parameter is set to metadata or inherited_metadata then you may optionally set the metadata_to_return and/or preference_id parameters to restrict what metadata fields are retrieved. The preference_id parameter is also honored when load_type is custom

For load_type options that return metadata fields it is possible to suppress field definitions and retrieve just the values for metadata fields by specifying the request parameter level_of_detail. The allowed values are slim, or full(default)

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Asset Id
`Load Type`	Data load type
`Metadata To Return`	Comma separated list of metadata field ids. This parameter is ignored unless the load_type parameter is set to metadata or inherited_metadata
`Preference Id`	Preference Id
`Filter Fields By Model`	Filter metadata fields relevant to asset model. This parameter is honored only when metadata_to_return and/or preference_id are set in the request.
`Load Multilingual Values`	Load multilingual values. This parameter is honored only when the load_type parameter is set to metadata or full. For the custom load type multilingual values can be requested using the load_multilingual_field_values property of the data_load_request parameter.
`Data Load Request`	JSON representation of DataLoadRequest object. This parameter is ignored unless the load_type parameter is set to custom
`Level Of Detail`	Controls whether field definitions are suppressed in the metadata fields returned.
`Asset Id Container Path Map`	Map of asset id and container path to expand. The given path will be expanded to have children of path elements.
`Collection Id`	A comma separated list of Collection Ids
`Response Type`	N/A

/v6/assets

Retrieve assets based on the provided selection context. The request needs the pagination parameters to be passed. The asset collection will also include summary about the collection. To load only collection summary pass limit as 0.The fields populated in the returned object is based on the load_type parameter value. The allowable load_type values are (full,system,metadata,inherited_metadata,custom). If the load_type parameter is set to custom then you must also provide a data_load_request parameter containing the JSON representation of a DataLoadRequest object. If the load_type parameter is set to metadata or inherited_metadata then you may optionally set the metadata_to_return and/or preference_id parameters to restrict what metadata fields are retrieved. The preference_id parameter is also honored when load_type is custom

For load_type options that return metadata fields it is possible to suppress field definitions and retrieve just the values for metadata fields by specifying the request parameter level_of_detail. The allowed values are slim, or full(default)

While using selection context to filter the assets based on permissions, pass permissions_filter parameter in selection context. Valid permission filters:

ASSETVIEW_PERM
SUMMARYVIEW_PERM
PREVIEWVIEW_PERM
EXPORT_PERM
SUBSCRIBE_PERM
METAEDIT_PERM
CONTENTEDIT_PERM
MEMBERSHIPEDIT_PERM
DELETEASSET_PERM
EDITPARENTS_PERM
CUSTOM01_PERM
CUSTOM02_PERM
CUSTOM03_PERM
CUSTOM04_PERM

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Load Type`	Data load type
`Metadata To Return`	Comma separated list of metadata field ids. This parameter is ignored unless the load_type parameter is set to metadata or inherited_metadata
`Preference Id`	Preference Id
`Filter Fields By Model`	Filter metadata fields relevant to asset model. This parameter is honored only when metadata_to_return and/or preference_id are set in the request.
`Load Multilingual Values`	Load multilingual values. This parameter is honored only when the load_type parameter is set to metadata or full. For the custom load type multilingual values can be requested using the load_multilingual_field_values property of the data_load_request parameter.
`Data Load Request`	JSON representation of DataLoadRequest object. This parameter is ignored unless the load_type parameter is set to custom
`Level Of Detail`	Controls whether field definitions are suppressed in the metadata fields returned.
`Selection Context`	The selection context for the assets.
`Asset Id Container Path Map`	Map of asset id and container path to expand. The given path will be expanded to have children of path elements.
`After`	Retrieve collection starting at the position after the specified value. If neither the after or before parameters are specified this is equivalent to after=0 and will retrieve items starting at the beginning of the collection
`Before`	Retrieve collection starting at the position before the specified value and going backwards
`Limit`	Maximum number of items to retrieve.
`Group By`	Attribute to group and count the assets in a asset collection
`Response Type`	N/A

/v6/assets/{id}/relatedassets

Retrieve related assets of an asset.The fields populated in the returned object is based on the load_type parameter value. The allowable load_type values are (full,system,metadata,inherited_metadata,custom). If the load_type parameter is set to custom then you must also provide a data_load_request parameter containing the JSON representation of a DataLoadRequest object. If the load_type parameter is set to metadata or inherited_metadata then you may optionally set the metadata_to_return and/or preference_id parameters to restrict what metadata fields are retrieved. The preference_id parameter is also honored when load_type is custom

For load_type options that return metadata fields it is possible to suppress field definitions and retrieve just the values for metadata fields by specifying the request parameter level_of_detail. The allowed values are slim, or full(default)

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Asset Id
`Load Type`	Data load type
`Metadata To Return`	Comma separated list of metadata field ids. This parameter is ignored unless the load_type parameter is set to metadata or inherited_metadata
`Preference Id`	Preference Id
`Filter Fields By Model`	Filter metadata fields relevant to asset model. This parameter is honored only when metadata_to_return and/or preference_id are set in the request.
`Load Multilingual Values`	Load multilingual values. This parameter is honored only when the load_type parameter is set to metadata or full. For the custom load type multilingual values can be requested using the load_multilingual_field_values property of the data_load_request parameter.
`Data Load Request`	JSON representation of DataLoadRequest object. This parameter is ignored unless the load_type parameter is set to custom
`Level Of Detail`	Controls whether field definitions are suppressed in the metadata fields returned.
`Link Type Ids`	List of asset relations to retrieve assets
`Response Type`	N/A

/v6/assets/{id}/contents/spin360

Retrieve spin360 content of an Asset by asset id.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Asset Id
`Response Type`	N/A

/v6/assets/{id}/collections

Retrieve the collections associated for the given asset id.The fields populated in the returned object is based on the load_type parameter value. The allowable load_type values are (full,system,metadata,inherited_metadata,custom). If the load_type parameter is set to custom then you must also provide a data_load_request parameter containing the JSON representation of a DataLoadRequest object. If the load_type parameter is set to metadata or inherited_metadata then you may optionally set the metadata_to_return and/or preference_id parameters to restrict what metadata fields are retrieved. The preference_id parameter is also honored when load_type is custom

For load_type options that return metadata fields it is possible to suppress field definitions and retrieve just the values for metadata fields by specifying the request parameter level_of_detail. The allowed values are slim, or full(default)

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Asset Id
`Sort`	Comma separated list of sort options. Sort options can optionally be prepended with 'asc_' or 'desc_' to specify ascending or descending sort (default is ascending).
`Level Of Detail`	Controls whether field definitions are suppressed in the metadata fields returned.
`After`	Retrieve collection starting at the position after the specified value. If neither the after or before parameters are specified this is equivalent to after=0 and will retrieve items starting at the beginning of the collection
`Before`	Retrieve collection starting at the position before the specified value and going backwards
`Limit`	Maximum number of items to retrieve.
`Response Type`	N/A

/v6/assets/{id}/contents

Retrieve the content or a rendition for the specified Asset. If no rendition_type parameter is specified the content of the asset will be returned.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Asset Id
`Collection Id`	Collection Id
`Rendition Type`	The rendition type
`Disposition`	The disposition type
`Enable Caching`	Is caching enabled for this request
`User-agent`	User-Agent HTTP header
`Response Type`	N/A

/v6/assets/{original_asset_id}/latestversion

Retrieve the latest version of an Asset by original asset id.The fields populated in the returned object is based on the load_type parameter value. The allowable load_type values are (full,system,metadata,inherited_metadata,custom). If the load_type parameter is set to custom then you must also provide a data_load_request parameter containing the JSON representation of a DataLoadRequest object. If the load_type parameter is set to metadata or inherited_metadata then you may optionally set the metadata_to_return and/or preference_id parameters to restrict what metadata fields are retrieved. The preference_id parameter is also honored when load_type is custom

For load_type options that return metadata fields it is possible to suppress field definitions and retrieve just the values for metadata fields by specifying the request parameter level_of_detail. The allowed values are slim, or full(default)

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Original Asset Id`	The Original Asset Id
`Load Type`	Data load type
`Metadata To Return`	Comma separated list of metadata field ids. This parameter is ignored unless the load_type parameter is set to metadata or inherited_metadata
`Preference Id`	Preference Id
`Filter Fields By Model`	Filter metadata fields relevant to asset model. This parameter is honored only when metadata_to_return and/or preference_id are set in the request.
`Load Multilingual Values`	Load multilingual values. This parameter is honored only when the load_type parameter is set to metadata or full. For the custom load type multilingual values can be requested using the load_multilingual_field_values property of the data_load_request parameter.
`Data Load Request`	JSON representation of DataLoadRequest object. This parameter is ignored unless the load_type parameter is set to custom
`Level Of Detail`	Controls whether field definitions are suppressed in the metadata fields returned.
`Response Type`	N/A

/v6/assets/{id}/parents

Retrieve the parents for given asset id.The fields populated in the returned object is based on the load_type parameter value. The allowable load_type values are (full,system,metadata,inherited_metadata,custom). If the load_type parameter is set to custom then you must also provide a data_load_request parameter containing the JSON representation of a DataLoadRequest object. If the load_type parameter is set to metadata or inherited_metadata then you may optionally set the metadata_to_return and/or preference_id parameters to restrict what metadata fields are retrieved. The preference_id parameter is also honored when load_type is custom

For load_type options that return metadata fields it is possible to suppress field definitions and retrieve just the values for metadata fields by specifying the request parameter level_of_detail. The allowed values are slim, or full(default)

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Asset Id
`Load Type`	Data load type
`Metadata To Return`	Comma separated list of metadata field ids. This parameter is ignored unless the load_type parameter is set to metadata or inherited_metadata
`Preference Id`	Preference Id
`Filter Fields By Model`	Filter metadata fields relevant to asset model. This parameter is honored only when metadata_to_return and/or preference_id are set in the request.
`Load Multilingual Values`	Load multilingual values. This parameter is honored only when the load_type parameter is set to metadata or full. For the custom load type multilingual values can be requested using the load_multilingual_field_values property of the data_load_request parameter.
`Data Load Request`	JSON representation of DataLoadRequest object. This parameter is ignored unless the load_type parameter is set to custom
`Level Of Detail`	Controls whether field definitions are suppressed in the metadata fields returned.
`After`	Retrieve collection starting at the position after the specified value. If neither the after or before parameters are specified this is equivalent to after=0 and will retrieve items starting at the beginning of the collection
`Before`	Retrieve collection starting at the position before the specified value and going backwards
`Limit`	Maximum number of items to retrieve.
`Response Type`	N/A

/v6/assets

Update metadata and/or reassign applicable security policies and/or associated categories for the specified Asset.
For metadata fields, only the type, id and value need to be specified.The asset must be locked by the user who is performing the edit operation.If the value for lockStrategy parameter passed is optimistic, then the user doesn't need to lock the asset prior to calling.The API will obtain the lock internally and perform the asset update

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/assets/{id}

Update metadata and/or reassign applicable security policies and/or associated categories for the specified Asset.
For metadata fields, only the type, id and value need to be specified.The asset must be locked by the user who is performing the edit operation.If the value for lockStrategy parameter passed is optimistic, then the user doesn't need to lock the asset prior to calling.The API will obtain the lock internally and perform the asset update

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Asset Id
`Lock Strategy`	Lock Strategy: allowed values are optimistic,default.
`Response Type`	N/A

/v6/assets/{id}/subscriptions

subscribe of an asset

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	N/A
`Response Type`	N/A

/v6/assets/subscriptions

subscribe of assetsWhile using selection context to filter the assets based on permissions, pass permissions_filter parameter in selection context. Valid permission filters:

ASSETVIEW_PERM
SUMMARYVIEW_PERM
PREVIEWVIEW_PERM
EXPORT_PERM
SUBSCRIBE_PERM
METAEDIT_PERM
CONTENTEDIT_PERM
MEMBERSHIPEDIT_PERM
DELETEASSET_PERM
EDITPARENTS_PERM
CUSTOM01_PERM
CUSTOM02_PERM
CUSTOM03_PERM
CUSTOM04_PERM

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`After`	Retrieve collection starting at the position after the specified value. If neither the after or before parameters are specified this is equivalent to after=0 and will retrieve items starting at the beginning of the collection
`Limit`	Maximum number of items to retrieve.

/v6/assets/{id}/subscriptions

un-subscribe of an asset

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	N/A
`Response Type`	N/A

/v6/assets/subscriptions

un-subscribe of assetsWhile using selection context to filter the assets based on permissions, pass permissions_filter parameter in selection context. Valid permission filters:

ASSETVIEW_PERM
SUMMARYVIEW_PERM
PREVIEWVIEW_PERM
EXPORT_PERM
SUBSCRIBE_PERM
METAEDIT_PERM
CONTENTEDIT_PERM
MEMBERSHIPEDIT_PERM
DELETEASSET_PERM
EDITPARENTS_PERM
CUSTOM01_PERM
CUSTOM02_PERM
CUSTOM03_PERM
CUSTOM04_PERM

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Selection Context`	The selection context for the assets.
`After`	Retrieve collection starting at the position after the specified value. If neither the after or before parameters are specified this is equivalent to after=0 and will retrieve items starting at the beginning of the collection
`Limit`	Maximum number of items to retrieve.
`Response Type`	N/A

/v6/auditactivity/eventfilter/{assetType}

Retrieve all audit tab event filter options based on asset type to populate the filter.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Assettype`	Accepted value is "container" or "asset"
`Response Type`	N/A

/v6/auditactivity/sortoptions

Retrieve all sort options to sort audited events for assets or containers.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/auditactivity/{assetId}/activityhistory

Retrieve audited events for the selected asset.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Assetid`	N/A
`Event Type`	Event Ids, comma delimited, If not specified, will retrieve based on System Settings.
`User Id`	N/A
`Date Range`	Date Range for retrieveing events by audited date.
`Asset Type`	Accepted value is "container" or "asset"
`Sort`	Field to sort audited events. Prefix with asc_ or desc_ to specify the order
`After`	Retrieve collection starting at the position after the specified value. If neither the after or before parameters are specified this is equivalent to after=0 and will retrieve items starting at the beginning of the collection
`Before`	Retrieve collection starting at the position before the specified value and going backwards
`Limit`	Maximum number of items to retrieve.If limit is not specified, the default limit will be 25.
`Response Type`	N/A

/v6/auditactivity/{sequenceId}/details

Retrieve event details for event with given sequence id. Event details are only available for events whose extended_msg_data property is true.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Sequenceid`	N/A
`Response Type`	N/A

/v6/brandings

Retrieve list of branings for logged in user (from session) if apply_user_filter is not set or true(default is true) and it retrieves all brandings in the system if apply_user_filter is set as false.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Apply User Filter`	Apply user filter
`Load Content`	Loads branding content information
`Response Type`	N/A

/v6/brandings/{id}

Retrieve branding by branding id

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Branding Id
`Load Content`	Loads branding content information
`Response Type`	N/A

/v6/cascadinggroups/{id}

Retrieve a Cascading Group by cascading group id.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Cascading Group Id
`Load Cascading Domain Values`	Load cascading domain values.
`Response Type`	N/A

/v6/cascadinggroups/{id}/lookupvalues

Retrieve the cascading lookup values for a level based on the values provided for previous levels. The value(s) need to be passed as query parameter(s) named as "path" in the same order they were populated.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Cascading Group Id
`Path`	List of selected parent cascading domain value(s) as query parameter(s). The values should appear in the same order as they are populated in cascading domain.
`Input Filter String`	String for filtering cascading lookup values. If this parameter is provided, it returns only those cascading lookup values whose display field value starts with the value provided for this parameter and one which doesn't start are filtered out.
`Domain Value Id`	String for retrieving cascading lookup value, based on id of the value of lookup domain.Note : If this value is set then search parameter "input_filter_string" will be ignored.
`Response Type`	N/A

/v6/collections/assets

Add Selected assets by creating new private collection and also add into existing collections.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Name`	Private Collection Name
`Collection List`	List of Collection Ids
`Operation`	Operation to be performed on the collection assets. An 'add/remove' operation expects 'selection_context'

/v6/collections/{id}/thumbnail

Change the collection thumbnail to the thumbnail of the specified asset id. Asset should be part of the collection

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Collection Id
`Response Type`	N/A

Options (1)

Option Name	Description
`Asset Id`	The id of the asset to be used as the collection thumbnail, Asset should be part of the collection

/v6/collections

Create a collection for the given user. In the CollectionRepresentation, specify the name, permissions and rating enabled or not.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Brand Id`	Brand id for the current logged in user
`Action`	Collection microsite action type ; allowed values are create or delete.

/v6/collections/{id}

This collection will be delete from the system and it will no longer be accessible. This operation cannot be undone. All shared recipients will be removed from the collection and they will no longer be able to access it.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Collection Id
`Response Type`	N/A

/v6/collections

This collection will be delete from the system and it will no longer be accessible. This operation cannot be undone. All shared recipients will be removed from the collection and they will no longer be able to access it.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Action`	Actions to be performed on the collection. An 'delete' action expects 'collection_list_selection_context'

/v6/collections/accesstypes

Get all list of access types to share the collection

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/collections/{id}

Get collection by collection id

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Collection Id
`Level Of Detail`	Controls whether field definitions are suppressed in the metadata fields returned.
`Response Type`	N/A

/v6/collections

Get list of collections for current user

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Sort`	Comma separated list of sort options. Sort options can optionally be prepended with 'asc_' or 'desc_' to specify ascending or descending sort (default is ascending).
`After`	Retrieve collection starting at the position after the specified value. If neither the after or before parameters are specified this is equivalent to after=0 and will retrieve items starting at the beginning of the collection
`Before`	Retrieve collection starting at the position before the specified value and going backwards
`Limit`	Maximum number of items to retrieve.
`Collection Filters`	JSON representation of ContainerFilters object to perform filtering on collections.
`Level Of Detail`	Controls whether field definitions are suppressed in the metadata fields returned.
`Response Type`	N/A

/v6/collections/me/promotions

Get list of collections promoted for current user

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Sort`	Comma separated list of sort options. Sort options can optionally be prepended with 'asc_' or 'desc_' to specify ascending or descending sort (default is ascending).
`After`	Retrieve collection starting at the position after the specified value. If neither the after or before parameters are specified this is equivalent to after=0 and will retrieve items starting at the beginning of the collection
`Before`	Retrieve collection starting at the position before the specified value and going backwards
`Limit`	Maximum number of items to retrieve.
`Response Type`	N/A

/v6/collections/{id}/promotions

Promote or demote the collection.All the selected user groups will be considered as promoted user groups. All the remaining user groups not selected will be consided as demoted.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Collection Id
`Response Type`	N/A

Options (2)

Option Name	Description
`User Group Ids`	List of user groups selected for promotion.
`Brand Id`	Brand id for the current logged in user

/v6/collections/{id}/publish

Publish the collection in OTMM to generate microsite for the collection.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Collection Id
`Response Type`	N/A

Options (1)

Option Name	Description
`Brand Id`	Brand id for the current logged in user

/v6/collections/{id}/rating

Rate the shared collection as the logged in user.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Collection Id
`Response Type`	N/A

Options (1)

Option Name	Description
`Rating`	Rating to be added for an collection.

/v6/collections/{id}/thumbnail

Remove the collection thumbnail to the thumbnail of the specified asset id.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Collection Id
`Response Type`	N/A

/v6/collections/{id}/assets

Retrieve all the assets for the specified Collection.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Collection Id
`Sort`	Comma separated list of sort options. Sort options can optionally be prepended with 'asc_' or 'desc_' to specify ascending or descending sort (default is ascending).
`Load Type`	Data load type
`Metadata To Return`	Comma separated list of metadata field ids. This parameter is ignored unless the load_type parameter is set to metadata or inherited_metadata
`Preference Id`	Preference Id
`Filter Fields By Model`	Filter metadata fields relevant to asset model. This parameter is honored only when metadata_to_return and/or preference_id are set in the request.
`Load Multilingual Values`	Load multilingual values. This parameter is honored only when the load_type parameter is set to metadata or full. For the custom load type multilingual values can be requested using the load_multilingual_field_values property of the data_load_request parameter.
`Data Load Request`	JSON representation of DataLoadRequest object. This parameter is ignored unless the load_type parameter is set to custom
`After`	Retrieve collection starting at the position after the specified value. If neither the after or before parameters are specified this is equivalent to after=0 and will retrieve items starting at the beginning of the collection
`Before`	Retrieve collection starting at the position before the specified value and going backwards
`Limit`	Maximum number of items to retrieve.
`Level Of Detail`	Controls whether field definitions are suppressed in the metadata fields returned.
`Group By`	Attribute to group and count the assets in a asset collection
`Response Type`	N/A

/v6/collections/sortoptions

Retrieves all sort options to sorting the collections of the logged in user.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/collections/assets/sortoptions

Retrieves all sort options to sort recently accessed assets of the logged in user.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/collections/assets

Retrieve assets based on the provided selection context. The request needs the pagination parameters to be passed. The asset collection will also include summary about the collection. To load only collection summary pass limit as 0.The fields populated in the returned object is based on the load_type parameter value. The allowable load_type values are (full,system,metadata,inherited_metadata,custom). If the load_type parameter is set to custom then you must also provide a data_load_request parameter containing the JSON representation of a DataLoadRequest object. If the load_type parameter is set to metadata or inherited_metadata then you may optionally set the metadata_to_return and/or preference_id parameters to restrict what metadata fields are retrieved. The preference_id parameter is also honored when load_type is custom

For load_type options that return metadata fields it is possible to suppress field definitions and retrieve just the values for metadata fields by specifying the request parameter level_of_detail. The allowed values are slim, or full(default)

While using selection context to filter the assets based on permissions, pass permissions_filter parameter in selection context. Valid permission filters:

ASSETVIEW_PERM
SUMMARYVIEW_PERM
PREVIEWVIEW_PERM
EXPORT_PERM
SUBSCRIBE_PERM
METAEDIT_PERM
CONTENTEDIT_PERM
MEMBERSHIPEDIT_PERM
DELETEASSET_PERM
EDITPARENTS_PERM
CUSTOM01_PERM
CUSTOM02_PERM
CUSTOM03_PERM
CUSTOM04_PERM

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Load Type`	Data load type
`Metadata To Return`	Comma separated list of metadata field ids. This parameter is ignored unless the load_type parameter is set to metadata or inherited_metadata
`Preference Id`	Preference Id
`Filter Fields By Model`	Filter metadata fields relevant to asset model. This parameter is honored only when metadata_to_return and/or preference_id are set in the request.
`Load Multilingual Values`	Load multilingual values. This parameter is honored only when the load_type parameter is set to metadata or full. For the custom load type multilingual values can be requested using the load_multilingual_field_values property of the data_load_request parameter.
`Data Load Request`	JSON representation of DataLoadRequest object. This parameter is ignored unless the load_type parameter is set to custom
`Level Of Detail`	Controls whether field definitions are suppressed in the metadata fields returned.
`Selection Context`	The selection context for the assets.
`Asset Id Container Path Map`	Map of asset id and container path to expand. The given path will be expanded to have children of path elements.
`After`	Retrieve collection starting at the position after the specified value. If neither the after or before parameters are specified this is equivalent to after=0 and will retrieve items starting at the beginning of the collection
`Before`	Retrieve collection starting at the position before the specified value and going backwards
`Limit`	Maximum number of items to retrieve.
`Group By`	Attribute to group and count the assets in a asset collection
`Response Type`	N/A

/v6/collections/{id}/thumbnail

Retrieve the thumbnail for the specified collection.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Collection Id
`Disposition`	The disposition type
`Enable Caching`	Is caching enabled for this request
`User-agent`	User-Agent HTTP header
`Response Type`	N/A

/v6/collections/filterTypes

Retrieve list of all collection filter types.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/collections/sharedFilterTypes

Retrieve list of all collection filter types.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/collections/{id}/promotions

Retrieve promoted user groups in a collection.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Collection Id
`Response Type`	N/A

/v6/collections/{id}/unpublish

Unpublish the collection in OTMM to remove microsite for the collection.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Collection Id
`Response Type`	N/A

/v6/collections/{id}

Update properties of a collection selectively.
name, description, collectionType, ratingEnabled, collectionShareAccessInfo can be modified using this endpoint.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Collection Id
`Response Type`	N/A

/v6/collections/{id}

Update properties of a collection.
CollectionSource can't be modified using this endpoint.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Collection Id
`Response Type`	N/A

Options (2)

Option Name	Description
`Brand Id`	Brand id for the current logged in user
`Action`	Collection microsite action type ; allowed values are create or delete.

/v6/collections/{id}/subscriptions

subscribe a collection

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	N/A
`Response Type`	N/A

/v6/collections/subscriptions

subscribe collectionsSelection context for performing action on single/list of Collections.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`After`	Retrieve collection starting at the position after the specified value. If neither the after or before parameters are specified this is equivalent to after=0 and will retrieve items starting at the beginning of the collection
`Limit`	Maximum number of items to retrieve.

/v6/collections/{id}/subscriptions

un-subscribe a collection

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	N/A
`Response Type`	N/A

/v6/collections/subscriptions

un-subscribe of assetsWhile using selection context to filter the assets based on permissions, pass permissions_filter parameter in selection context. Valid permission filters:

ASSETVIEW_PERM
SUMMARYVIEW_PERM
PREVIEWVIEW_PERM
EXPORT_PERM
SUBSCRIBE_PERM
METAEDIT_PERM
CONTENTEDIT_PERM
MEMBERSHIPEDIT_PERM
DELETEASSET_PERM
EDITPARENTS_PERM
CUSTOM01_PERM
CUSTOM02_PERM
CUSTOM03_PERM
CUSTOM04_PERM

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Selection Context`	The selection context for the assets.
`After`	Retrieve collection starting at the position after the specified value. If neither the after or before parameters are specified this is equivalent to after=0 and will retrieve items starting at the beginning of the collection
`Limit`	Maximum number of items to retrieve.
`Response Type`	N/A

/v6/colorfilters/{id}

Retrieve a Color Filter by color filter id. Color Filters are used when filtering a search result by colr. Color Filters are only supported for text based searches.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Color Filter Id.
`Response Type`	N/A

/v6/colorfilters

Retrieve all Color Filters. Color Filters are used when filtering a search result by colr. Color Filters are only supported for text based searches.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

x-oneteg-downloader-path-without-authorization

Parameters

Parameter Name	Description
`HTTP Method`	N/A
`Download Url`	N/A
`Asset Name`	N/A
`Try Count`	N/A
`Read Timeout (seconds)`	N/A
`Connection Timeout (seconds)`	N/A
`Load File Content As Output`	This toggle enables you to load file content as the step output. Supported formats include JSON, XML, YML/YAML, CSV, TXT, and other text-based file types. Note that images, PDF files, and other binary formats cannot be loaded. Additionally, there is a file size limit for this feature; please check the logs for details.
`Follow Redirects`	Enable or disable following URL redirects. If it is enabled, it will follow the URL redirects.
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A

/v6/exports/schedules

Create a new export schedule. If the export_contents parameter is set to assets_and_assets_list then asset metadata will not be included in the export schedule. If metadata is exported then metadata file format to export schedule should be specified in export_request parameter.While using selection context to filter the assets based on permissions, pass permissions_filter parameter in selection context. Valid permission filters:

ASSETVIEW_PERM
SUMMARYVIEW_PERM
PREVIEWVIEW_PERM
EXPORT_PERM
SUBSCRIBE_PERM
METAEDIT_PERM
CONTENTEDIT_PERM
MEMBERSHIPEDIT_PERM
DELETEASSET_PERM
EDITPARENTS_PERM
CUSTOM01_PERM
CUSTOM02_PERM
CUSTOM03_PERM
CUSTOM04_PERMIf delivery template is set to 'Email Asset URL' in export request and FolderSelectionContext is provided for the selection_context parameter then 'include_descendants' and 'child_type' flags in the selection_context object are overridden to 'IMMEDIATE' and 'ASSETS_AND_CONTAINERS' respectively. Similarly, when AssetIdsSelectionContext or SearchSelectionContext is provided for the selection_context parameter then 'include_descendants' flag is set to 'NONE' in the selection_context object

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

Options (5)

Option Name	Description
`Export Contents`	Data load type
`Metadata To Return`	Comma separated list of metadata field ids. This parameter is ignored unless the load_type parameter is set to metadata
`Load Multilingual Values`	Load multilingual values. This parameter is honored only when the load_type parameter is set to metadata.
`Export Schedule Name`	User defined name of the export schedule. If this parameter is not set, the default value is export schedule class name.
`Force Mode`	Create an export schedule in force mode, by updating an existing schedule delivery if it is matched with given folder id or search id

/v6/facetconfigurations/{id}

Retrieve a Facet Configuration by facet configuration id. Facet Configurations are used to configure what facet information is returned with search results.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Facet Configuration Id
`Response Type`	N/A

/v6/facetconfigurations

Retrieve all Facet Configurations. Facet Configurations are used to configure what facet information is returned with search results.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Retrieval Type`	If partial is specified only a subset of the Facet Configuration information will be retrieved. This is intended for use in generating a list of available Facet Configurations
`Response Type`	N/A

/v6/featurepermissions

Get all supported feature permissions

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/featurepermissions/me

Get feature permissions for logged in user

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/folders/{id}/contents

Add Or Update Renditions of a folder. Supported Rendtion types are Thumbnail or Preview. The content image supported as a multipart/form-data format or asset id. Asset Id should be child of current folder

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Folder Id
`Response Type`	N/A

Options (4)

Option Name	Description
`Rendition Type`	The rendition type
`Asset Id`	Asset to be set as Renditions of a parent folder
`Job Name`	User defined name of the job. If this parameter is not set, the default value is job class name.
`File`	N/A

/v6/folders/{id}/children

Add children to, or move children into the specified Folder or remove children from current folder. Whether an add or move or remove is performed is determined by the value assigned to the required type parameter. A move operation moves children from one Folder to another Folder. One should specify either asset_ids or selection_context parameter value in the request. A remove operation removes children from current selected Folder, which are mentioned as either asset_ids or selection_context parameter value in the request. The selection_context identifies the assets that will be part of the operation.The response of this operation includes both the Folder into which the children were inserted, a list of children successfully added or moved, and a list of children that could not be added or moved.

The failed list also specifies the reason for failure - Failure errors can be one of the following:CIRCULAR - Has circular dependencyNOT_EXIST - Folder/Asset with given id does not existASSET_NOT_ALLOWED - Assets not allowed to be childrenCONTAINER_TYPE_NOT_ALLOWED - The folder type associated with child folder is not allowed to be child or parentSINGLE_PARENT - Child folder can have only single parentWRONG_TREE - Child folder does not belong to same treeCANT_BE_ROOT - Folder/Asset cannot be rootEXISTING_CHILD - Folder/Asset already a childINACTIVE - Folder type associated with folder is inactiveNO_EDIT_PARENTS - User does not have permission on the parent folder to add or move children.CONTAINER_TYPE_NOT_ALLOWED_FOR_USER - User does not belong to allowable user groups for the folder type associated with the parent folderWhile using selection context to filter the assets based on permissions, pass permissions_filter parameter in selection context. Valid permission filters:

ASSETVIEW_PERM
SUMMARYVIEW_PERM
PREVIEWVIEW_PERM
EXPORT_PERM
SUBSCRIBE_PERM
METAEDIT_PERM
CONTENTEDIT_PERM
MEMBERSHIPEDIT_PERM
DELETEASSET_PERM
EDITPARENTS_PERM
CUSTOM01_PERM
CUSTOM02_PERM
CUSTOM03_PERM
CUSTOM04_PERM

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Folder Id
`Response Type`	N/A

Options (6)

Option Name	Description
`Type`	Type of operation.
`Asset Ids`	Comma separated list of the ids of the children to add or move
`Parent Id`	For move operations, the id of the Folder in which all children are currently located. This parameter is required for move operations and ignored for add operations
`Position Type`	Method used to determine the position of the new children in the Folder
`Position`	If position_type is absolute the numeric position where the new children should be inserted into the existing children. If not specified the new children will be position after all existing children. If position_type is relative then you must specify either before or after to determine where the new children are inserted relative to the existing child identified by the relative_asset_id parameter.
`Relative Asset Id`	If position_type is relative then this parameter must be set to the asset id of the existing child relative to which new children should be added or moved. If position_type is absolute this parameter is ignored

/v6/folders/{id}

Create a sub-folder under the specified Folder. In the supplied FolderRepresentation, one needs to set only folder name, folder type id, metadata and security policies. In metadata, set only field id and value.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Folder Id
`Response Type`	N/A

/v6/folders/{id}/contents

Remove Renditions of a folder

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Folder Id
`Response Type`	N/A

/v6/folders/{id}

Mark the specified Folder as DELETED. The Folder is not purged from the system.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Folder Id
`Response Type`	N/A

/v6/folders/{id}/duplicate

Duplicate the given asset/folder to the destination folder.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	N/A
`Load Type`	Data load type
`Metadata To Return`	Comma separated list of metadata field ids. This parameter is ignored unless the load_type parameter is set to metadata or inherited_metadata
`Preference Id`	Preference Id
`Filter Fields By Model`	Filter metadata fields relevant to asset model. This parameter is honored only when metadata_to_return and/or preference_id are set in the request.
`Load Multilingual Values`	Load multilingual values. This parameter is honored only when the load_type parameter is set to metadata or full. For the custom load type multilingual values can be requested using the load_multilingual_field_values property of the data_load_request parameter.
`Data Load Request`	JSON representation of DataLoadRequest object. This parameter is ignored unless the load_type parameter is set to custom
`Level Of Detail`	Controls whether field definitions are suppressed in the metadata fields returned.
`Response Type`	N/A

Options (5)

Option Name	Description
`Destination Folder Id`	Destination folder id to move, copy or duplicate assets
`Position Type`	Method used to determine the position of the new children in the Folder
`Position`	If position_type is absolute the numeric position where the new children should be inserted into the existing children. If not specified the new children will be position after all existing children. If position_type is relative then you must specify either before or after to determine where the new children are inserted relative to the existing child identified by the relative_asset_id parameter.
`Relative Asset Id`	If position_type is relative then this parameter must be set to the asset id of the existing child relative to which new children should be added or moved. If position_type is absolute this parameter is ignored
`Depth`	Depth to traverse when duplicating containers. Less than zero means traverse all the way down.

/v6/folders/{id}/state

Lock or unlock or un-delete of a folder

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Action`	Folder 'state change' action; allowed values are lock, unlock, delete, un_delete

/v6/folders/{id}/parents

Remove parents which are mentioned in comma separated parentIds string for current folder resource.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Folder Id
`Response Type`	N/A

Options (2)

Option Name	Description
`Type`	Type of operation.
`Parent Ids`	Comma separated list of the parent's ids to be detached

/v6/folders/{id}

Retrieve a Folder by folder id.The fields populated in the returned object is based on the load_type parameter value. The allowable load_type values are (full,system,metadata,inherited_metadata,custom). If the load_type parameter is set to custom then you must also provide a data_load_request parameter containing the JSON representation of a DataLoadRequest object. If the load_type parameter is set to metadata or inherited_metadata then you may optionally set the metadata_to_return and/or preference_id parameters to restrict what metadata fields are retrieved. The preference_id parameter is also honored when load_type is custom

For load_type options that return metadata fields it is possible to suppress field definitions and retrieve just the values for metadata fields by specifying the request parameter level_of_detail. The allowed values are slim, or full(default)

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Folder Id
`Load Type`	Data load type
`Metadata To Return`	Comma separated list of metadata field ids. This parameter is ignored unless the load_type parameter is set to metadata or inherited_metadata
`Preference Id`	Preference Id
`Filter Fields By Model`	Filter metadata fields relevant to asset model. This parameter is honored only when metadata_to_return and/or preference_id are set in the request.
`Load Multilingual Values`	Load multilingual values. This parameter is honored only when the load_type parameter is set to metadata or full. For the custom load type multilingual values can be requested using the load_multilingual_field_values property of the data_load_request parameter.
`Data Load Request`	JSON representation of DataLoadRequest object. This parameter is ignored unless the load_type parameter is set to custom
`Level Of Detail`	Controls whether field definitions are suppressed in the metadata fields returned.
`Asset Id Container Path Map`	Map of asset id and container path to expand. The given path will be expanded to have children of path elements.
`Asset Filter Request`	JSON representation of AssetFilterRequest objcet to perform filtering on assets
`Response Type`	N/A

/v6/folders/{id}/contents

Retrieve a rendition for the specified Folder. Folders may optionally have either thumbnail or preview renditions.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Folder Id
`Rendition Type`	The rendition type
`Disposition`	The disposition type
`Enable Caching`	Is caching enabled for this request
`User-agent`	User-Agent HTTP header
`Response Type`	N/A

/v6/folders/{id}/assets

Retrieve all Assets in the specified Folder.The fields populated in the returned object is based on the load_type parameter value. The allowable load_type values are (full,system,metadata,inherited_metadata,custom). If the load_type parameter is set to custom then you must also provide a data_load_request parameter containing the JSON representation of a DataLoadRequest object. If the load_type parameter is set to metadata or inherited_metadata then you may optionally set the metadata_to_return and/or preference_id parameters to restrict what metadata fields are retrieved. The preference_id parameter is also honored when load_type is custom

For load_type options that return metadata fields it is possible to suppress field definitions and retrieve just the values for metadata fields by specifying the request parameter level_of_detail. The allowed values are slim, or full(default)

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Folder Id
`Sort`	Comma separated list of sort options. Sort options can optionally be prepended with 'asc_' or 'desc_' to specify ascending or descending sort (default is ascending).
`Load Type`	Data load type
`Metadata To Return`	Comma separated list of metadata field ids. This parameter is ignored unless the load_type parameter is set to metadata or inherited_metadata
`Preference Id`	Preference Id
`Filter Fields By Model`	Filter metadata fields relevant to asset model. This parameter is honored only when metadata_to_return and/or preference_id are set in the request.
`Load Multilingual Values`	Load multilingual values. This parameter is honored only when the load_type parameter is set to metadata or full. For the custom load type multilingual values can be requested using the load_multilingual_field_values property of the data_load_request parameter.
`Data Load Request`	JSON representation of DataLoadRequest object. This parameter is ignored unless the load_type parameter is set to custom
`After`	Retrieve collection starting at the position after the specified value. If neither the after or before parameters are specified this is equivalent to after=0 and will retrieve items starting at the beginning of the collection
`Before`	Retrieve collection starting at the position before the specified value and going backwards
`Limit`	Maximum number of items to retrieve.
`Level Of Detail`	Controls whether field definitions are suppressed in the metadata fields returned.
`Group By`	Attribute to group and count the assets in a asset collection
`Asset Filter Request`	JSON representation of AssetFilterRequest objcet to perform filtering on assets
`Response Type`	N/A

/v6/folders/rootfolders

Retrieve all system Root Folders.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Generate Child Count`	Should a child count be returned for each root folder
`Response Type`	N/A

/v6/folders/{id}/folders

Retrieve all child Folders in the specified Folder. If the request is for the first page or all folders within a system Root Folder, the Public Orphans or My Orphans is also retrieved.The fields populated in the returned object is based on the load_type parameter value. The allowable load_type values are (full,system,metadata,inherited_metadata,custom). If the load_type parameter is set to custom then you must also provide a data_load_request parameter containing the JSON representation of a DataLoadRequest object. If the load_type parameter is set to metadata or inherited_metadata then you may optionally set the metadata_to_return and/or preference_id parameters to restrict what metadata fields are retrieved. The preference_id parameter is also honored when load_type is custom

For load_type options that return metadata fields it is possible to suppress field definitions and retrieve just the values for metadata fields by specifying the request parameter level_of_detail. The allowed values are slim, or full(default)

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Folder Id
`Sort`	Comma separated list of sort options. Sort options can optionally be prepended with 'asc_' or 'desc_' to specify ascending or descending sort (default is ascending).
`Load Type`	Data load type
`Metadata To Return`	Comma separated list of metadata field ids. This parameter is ignored unless the load_type parameter is set to metadata or inherited_metadata
`Preference Id`	Preference Id
`Filter Fields By Model`	Filter metadata fields relevant to asset model. This parameter is honored only when metadata_to_return and/or preference_id are set in the request.
`Load Multilingual Values`	Load multilingual values. This parameter is honored only when the load_type parameter is set to metadata or full. For the custom load type multilingual values can be requested using the load_multilingual_field_values property of the data_load_request parameter.
`Data Load Request`	JSON representation of DataLoadRequest object. This parameter is ignored unless the load_type parameter is set to custom
`After`	Retrieve collection starting at the position after the specified value. If neither the after or before parameters are specified this is equivalent to after=0 and will retrieve items starting at the beginning of the collection
`Before`	Retrieve collection starting at the position before the specified value and going backwards
`Limit`	Maximum number of items to retrieve.
`Level Of Detail`	Controls whether field definitions are suppressed in the metadata fields returned.
`Asset Filter Request`	JSON representation of AssetFilterRequest objcet to perform filtering on assets
`Response Type`	N/A

/v6/folders/{id}/children

Retrieve all the children, both Assets and Folders, of the specified Folder.You can distinguish between the Folders and Assets in the response with the help of the type field. The type field is present only for Folders and has the value com.artesia.container.Container.

The fields populated in the returned object is based on the load_type parameter value. The allowable load_type values are (full,system,metadata,inherited_metadata,custom). If the load_type parameter is set to custom then you must also provide a data_load_request parameter containing the JSON representation of a DataLoadRequest object. If the load_type parameter is set to metadata or inherited_metadata then you may optionally set the metadata_to_return and/or preference_id parameters to restrict what metadata fields are retrieved. The preference_id parameter is also honored when load_type is custom

For load_type options that return metadata fields it is possible to suppress field definitions and retrieve just the values for metadata fields by specifying the request parameter level_of_detail. The allowed values are slim, or full(default)

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Folder Id
`Sort`	Comma separated list of sort options. Sort options can optionally be prepended with 'asc_' or 'desc_' to specify ascending or descending sort (default is ascending).
`Load Type`	Data load type
`Metadata To Return`	Comma separated list of metadata field ids. This parameter is ignored unless the load_type parameter is set to metadata or inherited_metadata
`Preference Id`	Preference Id
`Filter Fields By Model`	Filter metadata fields relevant to asset model. This parameter is honored only when metadata_to_return and/or preference_id are set in the request.
`Load Multilingual Values`	Load multilingual values. This parameter is honored only when the load_type parameter is set to metadata or full. For the custom load type multilingual values can be requested using the load_multilingual_field_values property of the data_load_request parameter.
`Data Load Request`	JSON representation of DataLoadRequest object. This parameter is ignored unless the load_type parameter is set to custom
`After`	Retrieve collection starting at the position after the specified value. If neither the after or before parameters are specified this is equivalent to after=0 and will retrieve items starting at the beginning of the collection
`Before`	Retrieve collection starting at the position before the specified value and going backwards
`Limit`	Maximum number of items to retrieve.
`Level Of Detail`	Controls whether field definitions are suppressed in the metadata fields returned.
`Asset Filter Request`	JSON representation of AssetFilterRequest objcet to perform filtering on assets
`Response Type`	N/A

/v6/folders/sortoptions

Retrieves all Sort Options available for sorting folder content. These options can be used when retrieving the children of a folder, the assets with in a folder, or the subfolders of a folder.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/folders/recent/sortoptions

Retrieves all Sort Options to sort recently accessed folders of the logged in user.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/folders/{id}/templates

Retrieve all content specific Property templates including default property template of a folder.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Folder Id
`Response Type`	N/A

/v6/folders/recent

Retrieve all recently accessed folders of the logged in user.The fields populated in the returned object is based on the load_type parameter value. The allowable load_type values are (full,system,metadata,inherited_metadata,custom). If the load_type parameter is set to custom then you must also provide a data_load_request parameter containing the JSON representation of a DataLoadRequest object. If the load_type parameter is set to metadata or inherited_metadata then you may optionally set the metadata_to_return and/or preference_id parameters to restrict what metadata fields are retrieved. The preference_id parameter is also honored when load_type is custom

For load_type options that return metadata fields it is possible to suppress field definitions and retrieve just the values for metadata fields by specifying the request parameter level_of_detail. The allowed values are slim, or full(default)

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Load Type`	Data load type
`Metadata To Return`	Comma separated list of metadata field ids. This parameter is ignored unless the load_type parameter is set to metadata or inherited_metadata
`Preference Id`	Preference Id
`Filter Fields By Model`	Filter metadata fields relevant to asset model. This parameter is honored only when metadata_to_return and/or preference_id are set in the request.
`Load Multilingual Values`	Load multilingual values. This parameter is honored only when the load_type parameter is set to metadata or full. For the custom load type multilingual values can be requested using the load_multilingual_field_values property of the data_load_request parameter.
`Data Load Request`	JSON representation of DataLoadRequest object. This parameter is ignored unless the load_type parameter is set to custom
`Level Of Detail`	Controls whether field definitions are suppressed in the metadata fields returned.
`After`	Retrieve collection starting at the position after the specified value. If neither the after or before parameters are specified this is equivalent to after=0 and will retrieve items starting at the beginning of the collection
`Before`	Retrieve collection starting at the position before the specified value and going backwards
`Limit`	Maximum number of items to retrieve.
`Sort`	Comma separated list of sort options. Sort options can optionally be prepended with 'asc_' or 'desc_' to specify ascending or descending sort (default is ascending).
`Asset Filter Request`	JSON representation of AssetFilterRequest objcet to perform filtering on assets
`Response Type`	N/A

/v6/folders/{id}/parents

Retrieve the parents for given asset id.The fields populated in the returned object is based on the load_type parameter value. The allowable load_type values are (full,system,metadata,inherited_metadata,custom). If the load_type parameter is set to custom then you must also provide a data_load_request parameter containing the JSON representation of a DataLoadRequest object. If the load_type parameter is set to metadata or inherited_metadata then you may optionally set the metadata_to_return and/or preference_id parameters to restrict what metadata fields are retrieved. The preference_id parameter is also honored when load_type is custom

For load_type options that return metadata fields it is possible to suppress field definitions and retrieve just the values for metadata fields by specifying the request parameter level_of_detail. The allowed values are slim, or full(default)

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Asset Id
`Load Type`	Data load type
`Metadata To Return`	Comma separated list of metadata field ids. This parameter is ignored unless the load_type parameter is set to metadata or inherited_metadata
`Preference Id`	Preference Id
`Filter Fields By Model`	Filter metadata fields relevant to asset model. This parameter is honored only when metadata_to_return and/or preference_id are set in the request.
`Load Multilingual Values`	Load multilingual values. This parameter is honored only when the load_type parameter is set to metadata or full. For the custom load type multilingual values can be requested using the load_multilingual_field_values property of the data_load_request parameter.
`Data Load Request`	JSON representation of DataLoadRequest object. This parameter is ignored unless the load_type parameter is set to custom
`Level Of Detail`	Controls whether field definitions are suppressed in the metadata fields returned.
`After`	Retrieve collection starting at the position after the specified value. If neither the after or before parameters are specified this is equivalent to after=0 and will retrieve items starting at the beginning of the collection
`Before`	Retrieve collection starting at the position before the specified value and going backwards
`Limit`	Maximum number of items to retrieve.
`Response Type`	N/A

/v6/folders/{id}

Update metadata and/or reassign applicable security policies for the specified folder.
For Metadata Fields, only the type, Id and value need to be specified. For security policies,
only the teams identifier(s) need to be specified.
The asset must be locked by the user who is performing the edit operation.
If the value for lockStrategy parameter passed is optimistic, then the user doesn't need to lock the asset prior to calling.The API will obtain the lock internally and perform the asset update

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Folder Id
`Lock Strategy`	Lock Strategy: allowed values are optimistic,default.
`Response Type`	N/A

/v6/folders/{id}/templates

Update all content specific Property templates including default property template of a folder.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	N/A
`Response Type`	N/A

/v6/folders/{id}/subscriptions

subscribe of an asset

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	N/A
`Response Type`	N/A

/v6/folders/{id}/subscriptions

un-subscribe of an asset

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	N/A
`Response Type`	N/A

/v6/foldertypes/{id}

Retrieve a Folder Type by folder type id.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Folder Type Id
`Response Type`	N/A

/v6/foldertypes

Retrieve all Folder Types. Optionally just Folder Types that are configued as active, Folder Types that the user has permission to create Folders with, or Folder Types that are configured as valid for creating top level folders can be retrieved. These options can be combined.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Load Active Only`	Retrieve only Folder Types configured as active
`Load Creatable Only`	Retrieve only Folder Types that the user has permission to create Folders with
`Load Root Only`	Retrieve only Folder Types configured as valid for creating top level Folders
`Response Type`	N/A

/v6/hightail/tokens/oauth2

Callback to generate Hightail Oauth2 Tokens.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Code`	Oauth2 Code
`State`	Oauth2 State
`Error`	Oauth2 Error
`Description`	Oauth2 Error Description
`Response Type`	N/A

/v6/hightail/spaces

Create a Hightail Space.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Space Type`	Space type
`Name`	Space name
`Description`	Space description

/v6/hightail/tokens

Logout the cached Hightail Access Token.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/hightail/contacts

Retrieve User Contacts.
Contacts will be retrieved from both Hightail send/share address book and users configured in OTMM.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Where First And Last Name`	Filter by user's first and last name. This parameter supports wildcards.
`Where For Job`	Indicates whether to retrieve contacts for use with a Hightail based Review Job
`Limit`	Maximum number of items to retrieve.
`Response Type`	N/A

/v6/hightail/tokens/validations

Validate that the cached Hightail Access Token is valid.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/importtemplates

Retrieve all Permissible Property Templates.For load_type options that return metadata fields it is possible to suppress field definitions and retrieve just the values for metadata fields by specifying the request parameter level_of_detail. The allowed values are slim, or full(default)

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Data Load Request`	JSON Representation of ImportTemplateDataLoadRequest object
`Level Of Detail`	Controls whether field definitions are suppressed in the metadata fields returned.
`Response Type`	N/A

/v6/intervalprofiles

Retrieve all Interval Profiles. Interval Profiles are used to implement Interval Facets in a Facet Configuration. Either the full Interval Profile representation can be retrieved, or just a partial representation. A partial representation does not include the interval definitions, and is intended for use in generating a list of available Interval Profiles.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Retrieval Type`	The retrieval type
`Profile Types`	The profile types
`Response Type`	N/A

/v6/intervalprofiles/{id}

Retrieve an Interval Profile by interval profile id. Interval Profiles are used to implement Interval Facets in a Facet Configuration.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Interval Profile Id.
`Response Type`	N/A

/v6/jobs/attachcontents/{import_job_id}

Attach Content for specified metadata only asset(s). This should be a multipart/form-data request. The operation creates an attachcontent job and returns the job handle. Using the job id in job handle, you can query the 'jobs' resource for completion status.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Import Job Id`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Job Name`	User defined name of the job. If this parameter is not set, the default value is job class name.
`Job Type`	Name of the job to be triggered on the server. If this parameter is not set, the default value will be picked from settings. This parameter has highest precedence while deciding the job to trigger.
`Callback Url`	Callback URL in the encoded form, which needs to be notified once the job is complete. For more information on the format of callbackURl , refer to integration guide.

/v6/jobs/exports

Create a new export job. If the export_contents parameter is set to assets_and_assets_list then asset metadata will not be included in the export. If metadata is exported then metadata file format to export should be specified in export_request parameter.While using selection context to filter the assets based on permissions, pass permissions_filter parameter in selection context. Valid permission filters:

ASSETVIEW_PERM
SUMMARYVIEW_PERM
PREVIEWVIEW_PERM
EXPORT_PERM
SUBSCRIBE_PERM
METAEDIT_PERM
CONTENTEDIT_PERM
MEMBERSHIPEDIT_PERM
DELETEASSET_PERM
EDITPARENTS_PERM
CUSTOM01_PERM
CUSTOM02_PERM
CUSTOM03_PERM
CUSTOM04_PERMIf delivery template is set to 'Email Asset URL' in export request and FolderSelectionContext is provided for the selection_context parameter then 'include_descendants' and 'child_type' flags in the selection_context object are overridden to 'IMMEDIATE' and 'ASSETS_AND_CONTAINERS' respectively. Similarly, when AssetIdsSelectionContext or SearchSelectionContext is provided for the selection_context parameter then 'include_descendants' flag is set to 'NONE' in the selection_context object

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

Options (6)

Option Name	Description
`Export Contents`	Data load type
`Metadata To Return`	Comma separated list of metadata field ids. This parameter is ignored unless the load_type parameter is set to metadata
`Preference Id`	Preference id to be honored during operation on assets and metadata during an export job. This parameter is ignored unless the load_type parameter is set to metadata
`Load Multilingual Values`	Load multilingual values. This parameter is honored only when the load_type parameter is set to metadata.
`Job Name`	User defined name of the job. If this parameter is not set, the default value is job class name.
`Job Type`	Name of the job to be triggered on the server. If this parameter is not set, the default value will be picked from settings. This parameter has highest precedence while deciding the job to trigger.

/v6/jobs

Instantiates a new job and returns the job handle holding id of the new job

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/jobs/imports

Create an import job to upload content and create asset(s) against. The Job Id in the returned job handle can be used to upload content for the import job against the 'renditions' resource.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/jobs/checkins/{import_job_id}

Create Asset(s) version for the specified asset(s). This should be a multipart/form-data request. The operation creates an checkin job and returns the job handle. Using the job id in job handle, you can query the 'jobs' resource for completion status.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Import Job Id`	N/A
`Response Type`	N/A

Options (5)

Option Name	Description
`Job Name`	User defined name of the job. If this parameter is not set, the default value is job class name.
`Job Type`	Name of the job to be triggered on the server. If this parameter is not set, the default value will be picked from settings. This parameter has highest precedence while deciding the job to trigger.
`Job Id`	The id of the job from where import is initiated.
`Task Id`	The id of the task from where import is initiated.
`Callback Url`	Callback URL in the encoded form, which needs to be notified once the job is complete. For more information on the format of callbackURl , refer to integration guide.

/v6/jobs

Get Jobs for current user with filters.
Note :
1. Parameter job_class will have precedence over job_type. If job_class is present, job_type will be ignored.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`After`	Retrieve collection starting at the position after the specified value. If neither the after or before parameters are specified this is equivalent to after=0 and will retrieve items starting at the beginning of the collection
`Before`	Retrieve collection starting at the position before the specified value and going backwards
`Limit`	Maximum number of items to retrieve.If limit is set to zero then only collection summary is returned assuming that the request is made only to retrieve the counts.If limit is not passed, the default limit will be picked from the 'JOB_LIST_RECORD_COUNT' setting.
`Status`	Comma separated list of status ids. Use the '/statusoptions' resource to get the list of statuses
`Role`	Comma separated list of assigned roles. Use the '/roleoptions' resource to get the list of assigned roles
`Sort`	Comma separated list of sort options. Sort options can optionally be prepended with 'asc_' or 'desc_' to specify ascending or descending sort (default is ascending). Sorting on jobs is supported for the fields job_name, job_class, start_time, end_time, status. For sorting the results by status, the status values COMPLETED, ERROR and WARN are treated alike as all these statuses are considered as 'end' in BPM server
`Load Job Data`	Flag to load job data
`Load Job Details`	Flag to load job details. If set to true, will load job details.
`Load Asset Details`	Flag to load asset ids and asset count are part of job. If set to true, will load asset details.
`Load Form`	Flag to load job form(prelaunch form)
`Asset Ids Limit`	Maximum number of asset ids to retrieve. This parameter is honored only when load_asset_details is set to true. If limit is not passed, the default limit will be picked from the 'ASSET_IDS_TO_LOAD_INTO_JOB' setting.
`Load Steps`	Flag to load steps
`Load Downloadable Jobs Only`	Flag to load only downloadable jobs
`Load Inprogress Task Jobs`	Flag to load the jobs those have inprogress task
`Job Type`	Filter to retrieve Jobs based on the job's type. Parameter can be set to a comma separated list of job types.
`Job Class`	Job class to be used to filter jobs.
`Start Date Time`	Date Range for retrieveing jobs by creation date. Dates ranges are calculate w.r.t server time.
`End Date Time`	Date Range for retrieving jobs by completion date. Dates ranges are calculate w.r.t server time.
`Last Updated Date Time`	Date Range for retrieving jobs by completion date. Dates ranges are calculate w.r.t server time.
`Job End Date Start`	Retrieving jobs by end date range, starting limit. Date format: 'yyyy-MM-dd'T'HH:mm:ss'. By default dates are calculated w.r.t server time. Server considers Dynamic date only if static date ranges are not provided
`Job Category`	Name of the job category: System or Custom
`Job EndDate End`	Retrieving jobs by end date range,ending limit. Date format: 'yyyy-MM-dd'T'HH:mm:ss'. By default dates are calculated w.r.t server time. Server considers Dynamic date only if static date ranges are not provided
`Job StartDate Start`	Retrieving jobs by start date range, starting limit. Date format: 'yyyy-MM-dd'T'HH:mm:ss'. By default dates are calculated w.r.t server time. Server considers Dynamic date only if static date ranges are not provided
`Job Start Date End`	Retrieving jobs by start date range, ending limit. Date format: 'yyyy-MM-dd'T'HH:mm:ss'. By default dates are calculated w.r.t server time. Server considers Dynamic date only if static date ranges are not provided
`Response Type`	N/A

/v6/jobs/{id}/users

Get all the job users who are participated in the job. The list includes both participants and assignees

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Id of the job to be retrieved
`Response Type`	N/A

/v6/jobs/{id}/exports/contents

Get contents of a job by job id

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Id of the job to be retrieved
`User-agent`	User-Agent HTTP header
`Enable Caching`	Is caching enabled for this request
`Response Type`	N/A

/v6/jobs/{id}/tasks

Get related tasks information for a job id

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Id of the job to be retrieved
`Response Type`	N/A

/v6/jobs/imports/{import_job_id}

Register Asset(s) for creation with the specified asset representation or import template. This should be a multipart/form-data request. The operation creates an import job and returns the job handle. Using the job id in job handle, you can query the 'jobs' resource for completion status.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Import Job Id`	N/A
`Response Type`	N/A

Options (10)

Option Name	Description
`Import Template Id`	Id of the import template to use
`Parent Folder Id`	The parent folder id
`Review Job Id`	The review job id
`Review Task Id`	The review job task id
`Job Id`	The id of the job from where import is initiated.
`Task Id`	The id of the task from where import is initiated.
`Job Name`	User defined name of the job. If this parameter is not set, the default value is job class name.
`Job Type`	Name of the job to be triggered on the server. If this parameter is not set, the default value will be picked from settings. This parameter has highest precedence while deciding the job to trigger.
`Callback Url`	Callback URL in the encoded form, which needs to be notified once the job is complete. For more information on the format of callbackURl , refer to integration guide.
`Merge Folder Hierarchies`	Flag indicating whether folder hierarchies should be merged with existing hierarchies. Default is create hierarchies without merging into existing hierarchies. This flag is optional and will be considered only if assets are uploaded with hierarchy.

/v6/jobs/{id}

Retrieve user job by id. This operation is allowed for user who triggered the job and system administrator

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Id of the job to be retrieved
`Load Job Data`	Flag to load job data
`Load Job Details`	Flag to load job details. If set to true, will load job details.
`Load Asset Details`	Flag to load asset ids and asset count are part of job. If set to true, will load asset details.
`Asset Ids Limit`	Maximum number of asset ids to retrieve. This parameter is honored only when load_asset_details is set to true. If limit is not passed, the default limit will be picked from the 'ASSET_IDS_TO_LOAD_INTO_JOB' setting.
`Load Steps`	Flag to load steps
`Load Task Details`	Flag to load in-progress tasks information. The return object includes user assignment details of the task
`Load Form`	Flag to load job form(prelaunch form)
`Response Type`	N/A

/v6/jobs/definitions

Retrieves all Job definitions that the user has access to. User can instantiate only those jobs returned by this api.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Job Type`	Name of the job to filter jobs.
`Load Steps`	Flag to load steps
`Load All Versions`	Flag to load all versions of the job definitions
`Response Type`	N/A

/v6/jobs/statusoptions

Retrieves all supported Status Options available for retrieving Jobs.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/jobs/stepstatusoptions

Retrieves all supported Status Options available for retrieving Jobs.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/jobs/roleoptions

Retrieves all supported assignee roles options available for retrieving Jobs.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/jobs/sortoptions

Retrieves all Sort Options available for sorting jobs contents.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/jobs/{id}/assets

Retrieve assets associated with a job by job id. This operation is allowed for user who triggered the job and system administratorThe fields populated in the returned object is based on the load_type parameter value. The allowable load_type values are (full,system,metadata,inherited_metadata,custom). If the load_type parameter is set to custom then you must also provide a data_load_request parameter containing the JSON representation of a DataLoadRequest object. If the load_type parameter is set to metadata or inherited_metadata then you may optionally set the metadata_to_return and/or preference_id parameters to restrict what metadata fields are retrieved. The preference_id parameter is also honored when load_type is custom

For load_type options that return metadata fields it is possible to suppress field definitions and retrieve just the values for metadata fields by specifying the request parameter level_of_detail. The allowed values are slim, or full(default)

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Id of the job to be retrieved
`Load Type`	Data load type
`Metadata To Return`	Comma separated list of metadata field ids. This parameter is ignored unless the load_type parameter is set to metadata or inherited_metadata
`Preference Id`	Preference Id
`Filter Fields By Model`	Filter metadata fields relevant to asset model. This parameter is honored only when metadata_to_return and/or preference_id are set in the request.
`Load Multilingual Values`	Load multilingual values. This parameter is honored only when the load_type parameter is set to metadata or full. For the custom load type multilingual values can be requested using the load_multilingual_field_values property of the data_load_request parameter.
`Data Load Request`	JSON representation of DataLoadRequest object. This parameter is ignored unless the load_type parameter is set to custom
`Level Of Detail`	Controls whether field definitions are suppressed in the metadata fields returned.
`After`	Retrieve collection starting at the position after the specified value. If neither the after or before parameters are specified this is equivalent to after=0 and will retrieve items starting at the beginning of the collection
`Before`	Retrieve collection starting at the position before the specified value and going backwards
`Limit`	Maximum number of items to retrieve.If limit is set to zero then only collection summary is returned assuming that the request is made only to retrieve the counts.
`Task Id`	Specify the task id to skip the assets which are present in the task while retrieving the job assets.
`Response Type`	N/A

/v6/jobs/{name}/forms

Retrieve pre launch form associated with the given activity name

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Name`	Name of the activity to retrieve pre launch form which is configured to the activity
`Response Type`	N/A

/v6/jobs/{id}/state

Sets job status for a user job and all sub jobs instantiated from current job. This operation is allowed for user who triggered the job.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Id of the job to be retrieved
`Response Type`	N/A

Options (1)

Option Name	Description
`Job State`	Job State to set. Current allowed value is 'end' only.

/v6/jobs

Add assets to all the given jobs. The assets will be added only to the jobs which are triggered by the requested user.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Job Ids`	Comma separated list of job id's

/v6/jobs/{id}

Updates the Job data.
Note :
1. Currently it only updates content downloaded flag, anything else passed will be ignored.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Id of the job to be updated
`Response Type`	N/A

/v6/linktypes

Retreive all Link Types.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/lookupdomains/{id}

Retrieve a Lookup Domain by lookup domain id. Only valid domain values are populated. Expired values are excluded.
If search string is provided it returns only lookup domain id along with domain values matching the search string and other information related to lookup domain will be filtered out.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Lookup Domain Id
`Search String`	search string for filtering Lookup Domain values
`Is Prefix Only`	If true, search only for domain values starting with search string
`Response Type`	N/A

/v6/lookupdomains

Retrieve all Lookup Domains. In each of the retrieved Lookup Domains, only the valid domain values are populated. Expired values are excluded.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/MarsExtn/custom-query/lighthouse/assets-imported-by-date-range

get the query output

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Format`	N/A
`Startdate`	N/A
`Enddate`	N/A
`Startrow`	N/A
`Perpage`	N/A
`Response Type`	N/A

/v6/MarsExtn/chili-xml

Encrypt the given String

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/MarsExtn/tool/password/encrypt

Encrypt the given String

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Input`	N/A
`Response Type`	N/A

/v6/MarsExtn/custom-query/lightbulb/assets-with-audits-by-date-range

Based on Event Id and Time Range information as input, the Audit information is given as distinct asset-ids from the Audit Table

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/MarsExtn/custom-query/lighthouse/findJobsByAssetId

Get Derived template asset Id and JobId from db table

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/MarsExtn/support-tool/trigger-template-process-error-email

send email when template creation/process fails. assetId of asset is required

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Assetid`	N/A
`Emailto`	Primary recepient
`Emailcc`	Secondary recepient

/v6/MarsExtn/unflagIncorrectMetadata

Unflag an Asset as incorrect Metadata and close the job

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/MarsExtn/percolate/intake-request-status/{otmmAssetId}

Update Percolate Metadata Status Field

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Otmmassetid`	Asset Id in Lighthouse
`Response Type`	N/A

/v6/MarsExtn/salsify/update-field/{assetId}

Update Salsify Metadata Date Field

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Assetid`	Asset Id in Lighthouse
`Response Type`	N/A

/v6/metadatafieldgroups/{id}

Retrieve a Metadata Field Group by metadata field group id.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Metadata Field Group Id
`Response Type`	N/A

/v6/metadatafieldgroups

Retrieve all Metadata Field Groups.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/metadatafields/{id}

Retrieve a Metadata Field by metadata field id.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Metadata Field Id
`Response Type`	N/A

/v6/metadatafields

Retrieve all Metadata Fields. Optionally the Metadata Fields returned can be limited using the id parameter.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Ids`	Comma separated list of metadata field ids to retrieve.
`Response Type`	N/A

/v6/metadatalocales

Retrieve all Metadata Locales.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/metadatamodels

Retrieve Metadata Models for specified object type. If object type provided is null, it retrieves all models in the system. If model doesn't have type been set, then it considered for all.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Object Type`	Model Object Type
`Response Type`	N/A

/v6/metadatamodels/{id}

Retrieve a Metadata Model by metadata model id.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Metadata Model Id
`Response Type`	N/A

/v6/preferences

Get all user preferences for logged in user

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/preferences/{preference_id}

Get the user preference by preference id for logged in user

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Preference Id`	Preference id
`Response Type`	N/A

/v6/preferences/dateranges

Get the user preference by preference id for logged in user

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/preferences/{preference_id}

Set the user preference by preference id to logged in user

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Preference Id`	Preference id
`Response Type`	N/A

/v6/preferences

Set user preferences to logged in user

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/renditions

Create a rendition for an earlier created import job, this method also supports chunk file upload.To enable chunk file upload, client must set request header "X-USES-CHUNKS" as "true" and include chunk parameters as part of the rest client request.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

Options (9)

Option Name	Description
`Import Job Id`	The id of the import job as part of which the asset(s) is(are) being created.
`File Name`	The file name for the rendition. If specified, overrides the file name set in the 'file' part's Content-Disposition header
`File Path`	The path of the file relative to the import working directory.
`File`	N/A
`Chunk Size`	Upload chunk size.
`File Size`	File size.
`File Id`	Unique file identifier.
`Chunks Count`	Total number of chunks for file.
`File Index`	Upload chunk index.

/v6/renditions/{id}

Retrieve a Rendition associated with an Asset or Folder by rendition id.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Rendition Id
`Disposition`	The disposition type
`Enable Caching`	Is caching enabled for this request
`User-agent`	User-Agent HTTP header
`Collection Id`	Collection Id
`Response Type`	N/A

/v6/savedsearches/{id}/thumbnail

Change the Saved Search thumbnail

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Saved Search Id
`Response Type`	N/A

Options (1)

Option Name	Description
`Asset Id`	The id of the asset to be used as the Saved Search thumbnail

/v6/savedsearches/database

Create a database based Saved Search.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

Options (7)

Option Name	Description
`Name`	Saved Search name
`Description`	Saved Search description
`Is Public`	Saved Search public flag
`Is Favorite`	Saved Search favorite flag
`Sort`	Comma separated list of sort fields. Field ids can optionally be prepended with 'asc_' or 'desc_' to specify ascending or descending sort (default is ascending).
`Search Plugin Id`	The search plugin id
`User Group Ids`	List of user groups to be associated with the saved search. Only users belonging to these groups or sub groups can use this search

/v6/savedsearches/saved

Create a new Saved Search from an existing Saved Search.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

Options (8)

Option Name	Description
`Name`	Saved Search name
`Description`	Saved Search description
`Is Public`	Saved Search public flag
`Is Favorite`	Saved Search favorite flag
`Saved Search Id`	Saved Search Id
`Sort`	Comma separated list of sort fields. Field ids can optionally be prepended with 'asc_' or 'desc_' to specify ascending or descending sort (default is ascending).
`Facet Config Id`	Facet Configuration Id
`User Group Ids`	List of user groups to be associated with the saved search. Only users belonging to these groups or sub groups can use this search

/v6/savedsearches/text

Create a text based Saved Search.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

Options (21)

Option Name	Description
`Name`	Saved Search name
`Id`	Saved Search Id
`Description`	Saved Search description
`Is Public`	Saved Search public flag
`Is Favorite`	Saved Search favorite flag
`Keyword Query`	The keyword search query
`Keyword Scope Id`	The keyword scope id1 - Metadata2 - File Content3 - Metadata and Content
`Keyword Filter`	A keyword query that can be used to filter search results
`Keyword Filter Scope Id`	The keyword filter scope id1 - Metadata2 - File Content3 - Metadata and Content
`Search Config Id`	Search Configuration Id. This parameter cannot be used if either the fixed_condition_list or candidate_field_list parameters have been specified.
`Keyword Search Allowed`	Sets whether the UI should allow keyword search conditions to be added to this search. This parameter will be ignored if a search_config_id parameter has been specified. To execute a search based on a Search Configuration, specifying the search_config_id parameter is recommended. This parameter can be used if a saved search based on a Search Configuration has been retrieved, and you wish to modify and re-execute the search and retain the Keyword Search Allowed property inherited from the Search Configuration.
`Default Operator`	The default operatorIf not specified then set using the Tresource [SEARCH\SERVER] DEFAULT_OPERATOR entry
`Facet Config Id`	Facet Configuration Id
`Collection Filter`	Allows you to filter your search result to include only assets that are part of one of the specified list of collections. Specify a comma separated list of the ids of the collections to be used to filter results.
`Color Filter`	Allows you to filter your search result to include only assets whose score for the specified color exceeds the configured threshold. Specify the id of the color to be used to filter results.
`Folder Filter`	Allows you to filter your search result to include only descendants of the specified folder. Specify the id of the folder to be used to filter results. The folder_filter_type parameter can be used to modify the behavior of the folder filter.
`Folder Filter Type`	Modifies the behavior of the folder_filter parameter. If set to all all descendants of the specified folder are included in the filtered result. If set to direct only the immediate children of the specified folder are included in the filtered result. This parameter is ignored if the folder_filter parameter is not set.
`Sort`	Comma separated list of sort fields. Field ids can optionally be prepended with 'asc_' or 'desc_' to specify ascending or descending sort (default is ascending).
`Search Plugin Id`	The search plugin id
`Multilingual Language Code`	If searching multilingual fields, allows you to specify the code of the language varient to search against
`User Group Ids`	List of user groups to be associated with the saved search. Only users belonging to these groups or sub groups can use this search

/v6/savedsearches/{id}

Delete a Saved Search by saved search id.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Saved Search Id
`Response Type`	N/A

/v6/savedsearches/sortoptions

Retrieve all supported options for overriding the default sort order of Saved Searches

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/savedsearches/{id}

Retrieve a Saved Search by saved search id.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Saved Search Id
`Response Type`	N/A

/v6/savedsearches

Retrieves all Saved Searches. Optionally just Saved Searches of a specific type (public, restricted or private) can be retrieved, or Saved Searches can be retrieved by id by specifying selected as the save_type and populating a comma separated list of Saved Search ids in the search_ids parameter. Either the full Saved Search representation can be retrieved, just a partial representation, or a partial representation with the sort conditions added. A partial representation does not include the search criteria or sort conditions, and is intended for use in generating a list of available Saved Searches.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Retrieval Type`	The retrieval type
`Save Type`	The saved search type
`Search Ids`	Comma separated list of ids of the Saved Searches to retrieve. This parameter is ignored unless save_type is set to selected. Note that the paging related parameters will be ignored when retrieving Saved Searches by id.
`Sort`	Allows you to override the default sort order. Specify the property to sort Saved Searches on. Prefix with asc_ (default) or desc_ to specify the order
`After`	Retrieve collection starting at the position after the specified value. If neither the after or before parameters are specified this is equivalent to after=0 and will retrieve items starting at the beginning of the collection
`Before`	Retrieve collection starting at the position before the specified value and going backwards
`Limit`	Maximum number of items to retrieve.
`Response Type`	N/A

/v6/savedsearches/{id}

Update a Saved Search by saved search id.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Saved Search Id
`Response Type`	N/A

/v6/savedsearches/{id}

Update properties of a Saved Search by saved search id.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Saved Search Id
`Response Type`	N/A

Options (5)

Option Name	Description
`Name`	Saved Search name
`Description`	Saved Search description
`Is Public`	Saved Search public flag
`Is Favorite`	Saved Search favorite flag
`User Group Ids`	List of user groups to be associated with the saved search. Only users belonging to these groups or sub groups can use this search

/v6/ScreenDragonIntegration/validateSDUserExists

This endpoint returns true if a LH user exists in SD system, false otherwise

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Emailid`	N/A

/v6/ScreenDragonIntegration/sendToScreenDragon

Create Form in ScreenDragon

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

/v6/ScreenDragonIntegration/Test

Test api

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/search/saved/{id}

Generate a search result from a Saved Search.The fields populated in the returned object is based on the load_type parameter value. The allowable load_type values are (full,system,metadata,inherited_metadata,custom). If the load_type parameter is set to custom then you must also provide a data_load_request parameter containing the JSON representation of a DataLoadRequest object. If the load_type parameter is set to metadata or inherited_metadata then you may optionally set the metadata_to_return and/or preference_id parameters to restrict what metadata fields are retrieved. The preference_id parameter is also honored when load_type is custom

For load_type options that return metadata fields it is possible to suppress field definitions and retrieve just the values for metadata fields by specifying the request parameter level_of_detail. The allowed values are slim, or full(default)

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Saved Search Id
`Facet Config Id`	Facet Configuration Id
`Generate Facets`	Generated facets for this search
`Facet Restriction List`	JSON representation of the FacetRestriction List object
`Merge Filters`	If true any facet restrictions or keyword filters passed in will be merged with the facet restrictions and keyword filters inherited from the saved search. If false the facet restrictions and keyword filters from the saved search will be ignored, and the passed in facet_restriction_list and keyword_filter parameters (if any) will be used exclusively.
`Sort`	Comma separated list of sort fields. Field ids can optionally be prepended with 'asc_' or 'desc_' to specify ascending or descending sort (default is ascending).
`Generate Type Counts`	Generate type counts for this search
`Apply Search Filters`	Apply search filter user preferences for this search
`Keyword Filter`	A keyword query that can be used to filter search results
`Keyword Filter Scope Id`	The keyword filter scope id1 - Metadata2 - File Content3 - Metadata and Content
`Keyword Query`	The keyword search query. If specified, this overrides any keyword query present in the saved search.
`Keyword Scope Id`	The keyword scope id1 - Metadata2 - File Content3 - Metadata and Content
`Ignore Keyword Query`	Ignore the original keyword search query present in the saved search. If a keyword_query parameter has been specified, the original keyword search query will always be ignored regardless of how this parameter is set.
`Search Condition List`	JSON representation of the SearchCondition List object. If specified, this overrides any condition list present in the saved search.The SearchCondition sub types supported is dependent on the search plugin the saved search is based on.
`Ignore Search Condition List`	Ignore the original search condition list present in the saved search. If a search_condition_list parameter has been specified, the original search condition list will always be ignored regardless of how this parameter is set.
`Collection Filter`	Allows you to filter your search result to include only assets that are part of one of the specified list of collections. Specify a comma separated list of the ids of the collections to be used to filter results. If specified, this overrides any collection filter present in the saved search.
`Ignore Collection Filter`	Ignore the original collection filter present in the saved search. If a collection_filter parameter has been specified, the original collection filter will always be ignored regardless of how this parameter is set.
`Color Filter`	Allows you to filter your search result to include only assets whose score for the specified color exceeds the configured threshold. Specify the id of the color to be used to filter results.If specified, this overrides any color filter present in the saved search.
`Ignore Color Filter`	Ignore the original color filter present in the saved search. If a color_filter parameter has been specified, the original color filter will always be ignored regardless of how this parameter is set.
`Folder Filter`	Allows you to filter your search result to include only descendants of the specified folder. Specify the id of the folder to be used to filter results. If specified, this overrides any folder filter present in the saved search. The folder_filter_type parameter can be used to modify the behavior of the folder filter.
`Folder Filter Type`	Modifies the behavior of the folder_filter parameter. If set to all all descendants of the specified folder are included in the filtered result. If set to direct only the immediate children of the specified folder are included in the filtered result. This parameter is ignored if the folder_filter parameter is not set.
`Ignore Folder Filter`	Ignore the original folder filter present in the saved search. If a folder_filter parameter has been specified, the original folder filter will always be ignored regardless of how this parameter is set.
`Multilingual Language Code`	If searching multilingual fields, allows you to specify the code of the language varient to search against. If specified, this overrides any language varient code present in the saved search.
`Load Type`	Data load type
`Metadata To Return`	Comma separated list of metadata field ids. This parameter is ignored unless the load_type parameter is set to metadata or inherited_metadata
`Preference Id`	Preference Id
`Filter Fields By Model`	Filter metadata fields relevant to asset model. This parameter is honored only when metadata_to_return and/or preference_id are set in the request.
`Load Multilingual Values`	Load multilingual values. This parameter is honored only when the load_type parameter is set to metadata or full. For the custom load type multilingual values can be requested using the load_multilingual_field_values property of the data_load_request parameter.
`Data Load Request`	JSON representation of DataLoadRequest object. This parameter is ignored unless the load_type parameter is set to custom
`After`	Retrieve collection starting at the position after the specified value. If neither the after or before parameters are specified this is equivalent to after=0 and will retrieve items starting at the beginning of the collection
`Before`	Retrieve collection starting at the position before the specified value and going backwards
`Limit`	Maximum number of items to retrieve.
`Level Of Detail`	Controls whether field definitions are suppressed in the metadata fields returned.
`Group By`	Attribute to group and count the assets in a asset collection
`Return Type`	The amount of information to be passed back in the responseThe following return types are supported:count - only the number of assets matching the query will be returned. Parameters other than the search criteria will be ignoredids - asset ids returnedobjects - asset objects returnedall - both ids and objects returned
`Return Search Object`	If true the SDK search object generated for this search is returned in the SearchResultRepresentation
`Context Notes`	Optional notes on the context in which this search is being performed. This parameter has no impact on the search execution and is not persisted when searches are saved, but if the return_search_object parameter is set to true will be passed back with the search result.
`Response Type`	N/A

/v6/search/saved/{id}

Generate a search result from a Saved Search.The fields populated in the returned object is based on the load_type parameter value. The allowable load_type values are (full,system,metadata,inherited_metadata,custom). If the load_type parameter is set to custom then you must also provide a data_load_request parameter containing the JSON representation of a DataLoadRequest object. If the load_type parameter is set to metadata or inherited_metadata then you may optionally set the metadata_to_return and/or preference_id parameters to restrict what metadata fields are retrieved. The preference_id parameter is also honored when load_type is custom

For load_type options that return metadata fields it is possible to suppress field definitions and retrieve just the values for metadata fields by specifying the request parameter level_of_detail. The allowed values are slim, or full(default)

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Saved Search Id
`Response Type`	N/A

Options (33)

Option Name	Description
`Facet Config Id`	Facet Configuration Id
`Generate Facets`	Generated facets for this search
`Merge Filters`	If true any facet restrictions or keyword filters passed in will be merged with the facet restrictions and keyword filters inherited from the saved search. If false the facet restrictions and keyword filters from the saved search will be ignored, and the passed in facet_restriction_list and keyword_filter parameters (if any) will be used exclusively.
`Sort`	Comma separated list of sort fields. Field ids can optionally be prepended with 'asc_' or 'desc_' to specify ascending or descending sort (default is ascending).
`Generate Type Counts`	Generate type counts for this search
`Apply Search Filters`	Apply search filter user preferences for this search
`Keyword Filter`	A keyword query that can be used to filter search results
`Keyword Filter Scope Id`	The keyword filter scope id1 - Metadata2 - File Content3 - Metadata and Content
`Keyword Query`	The keyword search query. If specified, this overrides any keyword query present in the saved search.
`Keyword Scope Id`	The keyword scope id1 - Metadata2 - File Content3 - Metadata and Content
`Ignore Keyword Query`	Ignore the original keyword search query present in the saved search. If a keyword_query parameter has been specified, the original keyword search query will always be ignored regardless of how this parameter is set.
`Ignore Search Condition List`	Ignore the original search condition list present in the saved search. If a search_condition_list parameter has been specified, the original search condition list will always be ignored regardless of how this parameter is set.
`Collection Filter`	Allows you to filter your search result to include only assets that are part of one of the specified list of collections. Specify a comma separated list of the ids of the collections to be used to filter results. If specified, this overrides any collection filter present in the saved search.
`Ignore Collection Filter`	Ignore the original collection filter present in the saved search. If a collection_filter parameter has been specified, the original collection filter will always be ignored regardless of how this parameter is set.
`Color Filter`	Allows you to filter your search result to include only assets whose score for the specified color exceeds the configured threshold. Specify the id of the color to be used to filter results.If specified, this overrides any color filter present in the saved search.
`Ignore Color Filter`	Ignore the original color filter present in the saved search. If a color_filter parameter has been specified, the original color filter will always be ignored regardless of how this parameter is set.
`Folder Filter`	Allows you to filter your search result to include only descendants of the specified folder. Specify the id of the folder to be used to filter results. If specified, this overrides any folder filter present in the saved search. The folder_filter_type parameter can be used to modify the behavior of the folder filter.
`Folder Filter Type`	Modifies the behavior of the folder_filter parameter. If set to all all descendants of the specified folder are included in the filtered result. If set to direct only the immediate children of the specified folder are included in the filtered result. This parameter is ignored if the folder_filter parameter is not set.
`Ignore Folder Filter`	Ignore the original folder filter present in the saved search. If a folder_filter parameter has been specified, the original folder filter will always be ignored regardless of how this parameter is set.
`Multilingual Language Code`	If searching multilingual fields, allows you to specify the code of the language varient to search against. If specified, this overrides any language varient code present in the saved search.
`Load Type`	Data load type
`Metadata To Return`	Comma separated list of metadata field ids. This parameter is ignored unless the load_type parameter is set to metadata or inherited_metadata
`Preference Id`	Preference Id
`Filter Fields By Model`	Filter metadata fields relevant to asset model. This parameter is honored only when metadata_to_return and/or preference_id are set in the request.
`Load Multilingual Values`	Load multilingual values. This parameter is honored only when the load_type parameter is set to metadata or full. For the custom load type multilingual values can be requested using the load_multilingual_field_values property of the data_load_request parameter.
`After`	Retrieve collection starting at the position after the specified value. If neither the after or before parameters are specified this is equivalent to after=0 and will retrieve items starting at the beginning of the collection
`Before`	Retrieve collection starting at the position before the specified value and going backwards
`Limit`	Maximum number of items to retrieve.
`Level Of Detail`	Controls whether field definitions are suppressed in the metadata fields returned.
`Group By`	Attribute to group and count the assets in a asset collection
`Return Type`	The amount of information to be passed back in the responseThe following return types are supported:count - only the number of assets matching the query will be returned. Parameters other than the search criteria will be ignoredids - asset ids returnedobjects - asset objects returnedall - both ids and objects returned
`Return Search Object`	If true the SDK search object generated for this search is returned in the SearchResultRepresentation
`Context Notes`	Optional notes on the context in which this search is being performed. This parameter has no impact on the search execution and is not persisted when searches are saved, but if the return_search_object parameter is set to true will be passed back with the search result.

/v6/search/database

Generate a search result from the database search engine.The fields populated in the returned object is based on the load_type parameter value. The allowable load_type values are (full,system,metadata,inherited_metadata,custom). If the load_type parameter is set to custom then you must also provide a data_load_request parameter containing the JSON representation of a DataLoadRequest object. If the load_type parameter is set to metadata or inherited_metadata then you may optionally set the metadata_to_return and/or preference_id parameters to restrict what metadata fields are retrieved. The preference_id parameter is also honored when load_type is custom

For load_type options that return metadata fields it is possible to suppress field definitions and retrieve just the values for metadata fields by specifying the request parameter level_of_detail. The allowed values are slim, or full(default)

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Search Condition List`	JSON representation of the SearchCondition List objectDatabase search supports the following SearchCondition sub types:SearchMetadataCondition
`Sort`	Comma separated list of sort fields. Field ids can optionally be prepended with 'asc_' or 'desc_' to specify ascending or descending sort (default is ascending).
`Search Plugin Id`	The search plugin id
`Generate Type Counts`	Generate type counts for this search
`Apply Search Filters`	Apply search filter user preferences for this search
`Load Type`	Data load type
`Metadata To Return`	Comma separated list of metadata field ids. This parameter is ignored unless the load_type parameter is set to metadata or inherited_metadata
`Preference Id`	Preference Id
`Filter Fields By Model`	Filter metadata fields relevant to asset model. This parameter is honored only when metadata_to_return and/or preference_id are set in the request.
`Load Multilingual Values`	Load multilingual values. This parameter is honored only when the load_type parameter is set to metadata or full. For the custom load type multilingual values can be requested using the load_multilingual_field_values property of the data_load_request parameter.
`Data Load Request`	JSON representation of DataLoadRequest object. This parameter is ignored unless the load_type parameter is set to custom
`After`	Retrieve collection starting at the position after the specified value. If neither the after or before parameters are specified this is equivalent to after=0 and will retrieve items starting at the beginning of the collection
`Before`	Retrieve collection starting at the position before the specified value and going backwards
`Limit`	Maximum number of items to retrieve.
`Level Of Detail`	Controls whether field definitions are suppressed in the metadata fields returned.
`Group By`	Attribute to group and count the assets in a asset collection
`Return Type`	The amount of information to be passed back in the responseThe following return types are supported:count - only the number of assets matching the query will be returned. Parameters other than the search criteria will be ignoredids - asset ids returnedobjects - asset objects returnedall - both ids and objects returned
`Return Search Object`	If true the SDK search object generated for this search is returned in the SearchResultRepresentation
`Context Notes`	Optional notes on the context in which this search is being performed. This parameter has no impact on the search execution and is not persisted when searches are saved, but if the return_search_object parameter is set to true will be passed back with the search result.
`Response Type`	N/A

/v6/search/database

Generate a search result from the database search engine.The fields populated in the returned object is based on the load_type parameter value. The allowable load_type values are (full,system,metadata,inherited_metadata,custom). If the load_type parameter is set to custom then you must also provide a data_load_request parameter containing the JSON representation of a DataLoadRequest object. If the load_type parameter is set to metadata or inherited_metadata then you may optionally set the metadata_to_return and/or preference_id parameters to restrict what metadata fields are retrieved. The preference_id parameter is also honored when load_type is custom

For load_type options that return metadata fields it is possible to suppress field definitions and retrieve just the values for metadata fields by specifying the request parameter level_of_detail. The allowed values are slim, or full(default)

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

Options (17)

Option Name	Description
`Sort`	Comma separated list of sort fields. Field ids can optionally be prepended with 'asc_' or 'desc_' to specify ascending or descending sort (default is ascending).
`Search Plugin Id`	The search plugin id
`Generate Type Counts`	Generate type counts for this search
`Apply Search Filters`	Apply search filter user preferences for this search
`Load Type`	Data load type
`Metadata To Return`	Comma separated list of metadata field ids. This parameter is ignored unless the load_type parameter is set to metadata or inherited_metadata
`Preference Id`	Preference Id
`Filter Fields By Model`	Filter metadata fields relevant to asset model. This parameter is honored only when metadata_to_return and/or preference_id are set in the request.
`Load Multilingual Values`	Load multilingual values. This parameter is honored only when the load_type parameter is set to metadata or full. For the custom load type multilingual values can be requested using the load_multilingual_field_values property of the data_load_request parameter.
`After`	Retrieve collection starting at the position after the specified value. If neither the after or before parameters are specified this is equivalent to after=0 and will retrieve items starting at the beginning of the collection
`Before`	Retrieve collection starting at the position before the specified value and going backwards
`Limit`	Maximum number of items to retrieve.
`Level Of Detail`	Controls whether field definitions are suppressed in the metadata fields returned.
`Group By`	Attribute to group and count the assets in a asset collection
`Return Type`	The amount of information to be passed back in the responseThe following return types are supported:count - only the number of assets matching the query will be returned. Parameters other than the search criteria will be ignoredids - asset ids returnedobjects - asset objects returnedall - both ids and objects returned
`Return Search Object`	If true the SDK search object generated for this search is returned in the SearchResultRepresentation
`Context Notes`	Optional notes on the context in which this search is being performed. This parameter has no impact on the search execution and is not persisted when searches are saved, but if the return_search_object parameter is set to true will be passed back with the search result.

/v6/search/text

Generate a search result from the text search engine.The fields populated in the returned object is based on the load_type parameter value. The allowable load_type values are (full,system,metadata,inherited_metadata,custom). If the load_type parameter is set to custom then you must also provide a data_load_request parameter containing the JSON representation of a DataLoadRequest object. If the load_type parameter is set to metadata or inherited_metadata then you may optionally set the metadata_to_return and/or preference_id parameters to restrict what metadata fields are retrieved. The preference_id parameter is also honored when load_type is custom

For load_type options that return metadata fields it is possible to suppress field definitions and retrieve just the values for metadata fields by specifying the request parameter level_of_detail. The allowed values are slim, or full(default)

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Keyword Query`	The keyword search query
`Keyword Scope Id`	The keyword scope id1 - Metadata2 - File Content3 - Metadata and Content
`Search Condition List`	JSON representation of the SearchCondition List objectText search supports the following SearchCondition sub types:SearchScalarConditionSearchTabularConditionSearchFulltextCondition
`Search Config Id`	Search Configuration Id. This parameter cannot be used if either the fixed_condition_list or candidate_field_list parameters have been specified.
`Fixed Condition List`	JSON representation of the Fixed SearchCondition List object. This parameter cannot be used if a search_config_id parameter has been specified. To execute a search based on a Search Configuration, specifying the search_config_id parameter is recommended. This parameter can be used if a saved search based on a Search Configuration has been retrieved, and you wish to modify and re-execute the search and retain the Fixed SearchCondition List inherited from the Search Configuration. Text search supports the following SearchCondition sub types in the Fixed SearchCondition List:SearchScalarConditionSearchTabularCondition
`Candidate Field List`	JSON representation of the CandidateFieldListParam object. This parameter cannot be used if a search_config_id parameter has been specified. To execute a search based on a Search Configuration, specifying the search_config_id parameter is recommended. This parameter can be used if a saved search based on a Search Configuration has been retrieved, and you wish to modify and re-execute the search and retain the Candidate Field List inherited from the Search Configuration.
`Keyword Search Allowed`	Sets whether the UI should allow keyword search conditions to be added to this search. This parameter will be ignored if a search_config_id parameter has been specified. To execute a search based on a Search Configuration, specifying the search_config_id parameter is recommended. This parameter can be used if a saved search based on a Search Configuration has been retrieved, and you wish to modify and re-execute the search and retain the Keyword Search Allowed property inherited from the Search Configuration.
`Default Operator`	The default operatorIf not specified then set using the Tresource [SEARCH\SERVER] DEFAULT_OPERATOR entry
`Facet Config Id`	Facet Configuration Id
`Generate Facets`	Generated facets for this search
`Facet Restriction List`	JSON representation of the FacetRestriction List object
`Keyword Filter`	A keyword query that can be used to filter search results
`Keyword Filter Scope Id`	The keyword filter scope id1 - Metadata2 - File Content3 - Metadata and Content
`Collection Filter`	Allows you to filter your search result to include only assets that are part of one of the specified list of collections. Specify a comma separated list of the ids of the collections to be used to filter results.
`Color Filter`	Allows you to filter your search result to include only assets whose score for the specified color exceeds the configured threshold. Specify the id of the color to be used to filter results.
`Folder Filter`	Allows you to filter your search result to include only descendants of the specified folder. Specify the id of the folder to be used to filter results. The folder_filter_type parameter can be used to modify the behavior of the folder filter.
`Folder Filter Type`	Modifies the behavior of the folder_filter parameter. If set to all all descendants of the specified folder are included in the filtered result. If set to direct only the immediate children of the specified folder are included in the filtered result. This parameter is ignored if the folder_filter parameter is not set.
`Sort`	Comma separated list of sort fields. Field ids can optionally be prepended with 'asc_' or 'desc_' to specify ascending or descending sort (default is ascending).
`Search Plugin Id`	The search plugin id
`Generate Type Counts`	Generate type counts for this search
`Apply Search Filters`	Apply search filter user preferences for this search
`Multilingual Language Code`	If searching multilingual fields, allows you to specify the code of the language varient to search against
`Load Type`	Data load type
`Metadata To Return`	Comma separated list of metadata field ids. This parameter is ignored unless the load_type parameter is set to metadata or inherited_metadata
`Preference Id`	Preference Id
`Filter Fields By Model`	Filter metadata fields relevant to asset model. This parameter is honored only when metadata_to_return and/or preference_id are set in the request.
`Load Multilingual Values`	Load multilingual values. This parameter is honored only when the load_type parameter is set to metadata or full. For the custom load type multilingual values can be requested using the load_multilingual_field_values property of the data_load_request parameter.
`Data Load Request`	JSON representation of DataLoadRequest object. This parameter is ignored unless the load_type parameter is set to custom
`After`	Retrieve collection starting at the position after the specified value. If neither the after or before parameters are specified this is equivalent to after=0 and will retrieve items starting at the beginning of the collection
`Before`	Retrieve collection starting at the position before the specified value and going backwards
`Limit`	Maximum number of items to retrieve.
`Level Of Detail`	Controls whether field definitions are suppressed in the metadata fields returned.
`Group By`	Attribute to group and count the assets in a asset collection
`Return Type`	The amount of information to be passed back in the responseThe following return types are supported:count - only the number of assets matching the query will be returned. Parameters other than the search criteria will be ignoredids - asset ids returnedobjects - asset objects returnedall - both ids and objects returned
`Return Search Object`	If true the SDK search object generated for this search is returned in the SearchResultRepresentation
`Context Notes`	Optional notes on the context in which this search is being performed. This parameter has no impact on the search execution and is not persisted when searches are saved, but if the return_search_object parameter is set to true will be passed back with the search result.
`Response Type`	N/A

/v6/search/text

Generate a search result from the text search engine.The fields populated in the returned object is based on the load_type parameter value. The allowable load_type values are (full,system,metadata,inherited_metadata,custom). If the load_type parameter is set to custom then you must also provide a data_load_request parameter containing the JSON representation of a DataLoadRequest object. If the load_type parameter is set to metadata or inherited_metadata then you may optionally set the metadata_to_return and/or preference_id parameters to restrict what metadata fields are retrieved. The preference_id parameter is also honored when load_type is custom

For load_type options that return metadata fields it is possible to suppress field definitions and retrieve just the values for metadata fields by specifying the request parameter level_of_detail. The allowed values are slim, or full(default)

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

Options (31)

Option Name	Description
`Keyword Query`	The keyword search query
`Keyword Scope Id`	The keyword scope id1 - Metadata2 - File Content3 - Metadata and Content
`Search Config Id`	Search Configuration Id. This parameter cannot be used if either the fixed_condition_list or candidate_field_list parameters have been specified.
`Keyword Search Allowed`	Sets whether the UI should allow keyword search conditions to be added to this search. This parameter will be ignored if a search_config_id parameter has been specified. To execute a search based on a Search Configuration, specifying the search_config_id parameter is recommended. This parameter can be used if a saved search based on a Search Configuration has been retrieved, and you wish to modify and re-execute the search and retain the Keyword Search Allowed property inherited from the Search Configuration.
`Default Operator`	The default operatorIf not specified then set using the Tresource [SEARCH\SERVER] DEFAULT_OPERATOR entry
`Facet Config Id`	Facet Configuration Id
`Generate Facets`	Generated facets for this search
`Keyword Filter`	A keyword query that can be used to filter search results
`Keyword Filter Scope Id`	The keyword filter scope id1 - Metadata2 - File Content3 - Metadata and Content
`Collection Filter`	Allows you to filter your search result to include only assets that are part of one of the specified list of collections. Specify a comma separated list of the ids of the collections to be used to filter results.
`Color Filter`	Allows you to filter your search result to include only assets whose score for the specified color exceeds the configured threshold. Specify the id of the color to be used to filter results.
`Folder Filter`	Allows you to filter your search result to include only descendants of the specified folder. Specify the id of the folder to be used to filter results. The folder_filter_type parameter can be used to modify the behavior of the folder filter.
`Folder Filter Type`	Modifies the behavior of the folder_filter parameter. If set to all all descendants of the specified folder are included in the filtered result. If set to direct only the immediate children of the specified folder are included in the filtered result. This parameter is ignored if the folder_filter parameter is not set.
`Sort`	Comma separated list of sort fields. Field ids can optionally be prepended with 'asc_' or 'desc_' to specify ascending or descending sort (default is ascending).
`Search Plugin Id`	The search plugin id
`Generate Type Counts`	Generate type counts for this search
`Apply Search Filters`	Apply search filter user preferences for this search
`Multilingual Language Code`	If searching multilingual fields, allows you to specify the code of the language varient to search against
`Load Type`	Data load type
`Metadata To Return`	Comma separated list of metadata field ids. This parameter is ignored unless the load_type parameter is set to metadata or inherited_metadata
`Preference Id`	Preference Id
`Filter Fields By Model`	Filter metadata fields relevant to asset model. This parameter is honored only when metadata_to_return and/or preference_id are set in the request.
`Load Multilingual Values`	Load multilingual values. This parameter is honored only when the load_type parameter is set to metadata or full. For the custom load type multilingual values can be requested using the load_multilingual_field_values property of the data_load_request parameter.
`After`	Retrieve collection starting at the position after the specified value. If neither the after or before parameters are specified this is equivalent to after=0 and will retrieve items starting at the beginning of the collection
`Before`	Retrieve collection starting at the position before the specified value and going backwards
`Limit`	Maximum number of items to retrieve.
`Level Of Detail`	Controls whether field definitions are suppressed in the metadata fields returned.
`Group By`	Attribute to group and count the assets in a asset collection
`Return Type`	The amount of information to be passed back in the responseThe following return types are supported:count - only the number of assets matching the query will be returned. Parameters other than the search criteria will be ignoredids - asset ids returnedobjects - asset objects returnedall - both ids and objects returned
`Return Search Object`	If true the SDK search object generated for this search is returned in the SearchResultRepresentation
`Context Notes`	Optional notes on the context in which this search is being performed. This parameter has no impact on the search execution and is not persisted when searches are saved, but if the return_search_object parameter is set to true will be passed back with the search result.

/v6/search/sortoptions

Retrieves all Sort Options available for sorting search results.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/search/text/suggestions

Retrieve search suggestions for the specified input string.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Input`	The input suggestions are being requested for
`Search Plugin Id`	The search plugin id
`Max Suggestions`	Maximum number of search suggestions to retrieve. If not specified the value defined in the DEFAULT_MAX_SUGGESTIONS setting will be used.
`Index Id`	Id of the index suggestions will be generated from. If not specified the value defined in the DEFAULT_SUGGESTION_INDEX_ID setting will be used.
`Response Type`	N/A

/v6/searchconfigurations/{id}

Retrieve a Search Configuration by search configuration id. Search Configurations are used to implement Advanced Search.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Search Configuration Id.
`Response Type`	N/A

/v6/searchconfigurations

Retrieve all Search Configurations. Search Configurations are used to implement Advanced Search. Either the full Search Configuration representation can be retrieved, or just a partial representation. A partial representation does not include the search criteria, and is intended for use in generating a list of available Search Configurations.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Retrieval Type`	The retrieval type
`Response Type`	N/A

/v6/searchoperators

Retrieve all Search Operators. Search Operators are used when creating fielded search conditions. Not all Search Operators are supported for text based searches. The subset of operators valid for text based searches can be retrieved by using the search_type parameter.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Search Type`	The search type
`Response Type`	N/A

/v6/searchscopes

Retrieve all Search Scopes. Search Scopes are used when performing keyword searches to specify what data will be searched.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/securitypolicies/{id}/permissions

Retrieve Security Policy permissions for all User Groups or retrieves only Security Policies with permissions assigned atleast at one level in the hierrachy. Permissions will be retrieved in a tree representation based on the User Group hierarchy.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Security Policy Id
`Filter Security Policies By Permissions Assigned`	Optional flag that indicates whether all the security policies to be retrieved or only the security policies with permissions assigned atleast at one level in the hierrachy to be retrieved. Set to true if only security policies with permissions assigned to be retrieved and false in case if all the security policies to be retrieved. Default value is false.
`Response Type`	N/A

/v6/securitypolicies/{id}

Retrieve a Security Policy by security policy id.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Security Policy Id
`Response Type`	N/A

/v6/securitypolicies

Retrieve all Security Policies. Optionally only Security Policies which the user has edit permission for may be retrieved.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/sessions

Create a security Session in OTMM. It returns a valid SecuritySession object if the provided credentials are valid. This is equivalent to login to OTMM

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Username`	UserName/UserId
`Password`	N/A

/v6/sessions/oauth2/token

Create/Refresh an access token. You need to register an OAuth client in OTDS and obtain the client Id and secret key.For more info on how to create OAuth client,refer to the OTDS documentation.Intended for server-to-server authentication.This is equivalent to login from OTMM

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

Options (6)

Option Name	Description
`Grant Type`	Grant Type.Allowed values are client_credentials,password,refresh_token
`Client Id`	Client Id
`Client Secret`	Client Secret
`Username`	Username. Applicable only if grant_type=password
`Password`	Password Applicable only if grant_type=password
`Refresh Token`	Refresh Token. Applicable only if grant_type=refresh_token

/v6/sessions

Delete the current security Session. This is equivalent to logout from OTMM

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/sessions/otdssessions

Request otds ticket for given resource id. It returns a new otds ticket for corresponding resource id

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Target Resource`	Target Resource

/v6/sessions

Retrieve the current security Session.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/systemannouncements/me

Retrieve list of system announcements

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Load Type`	Generates new Announcments count from last login
`Response Type`	N/A

/v6/systemdetails/helpURL

Retrieve hosted help information. The retrieved url is used to view the application specific hosted help information.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Appid`	The unique help id assigned to an application. For instance OTMM is assigned 'medmgtmod-h-ucw'
`Topic`	The topic/context to be displayed
`Type`	The type of OT Help Content. Default value is 'ofh1'.
`Response Type`	N/A

/v6/systemdetails

Retrieve the system details

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/systemsettings/{id}

Retrieve a System Setting matching the given id.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	ID of the system setting. Formed by combination of component, key and name delimited by "^^"
`Response Type`	N/A

/v6/systemsettings/supporteddateranges

Retrieve all Supported Dynamic Date Ranges. The values retrieved are used for filtering content returned by server based on date ranges

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/systemsettings/supportedduedateranges

Retrieve all Supported Dynamic Due Date Ranges. The values retrieved are used for filtering content returned by server based on date ranges

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/systemsettings/supportedlocales

Retrieve all Supported Locales. The values retrieved are derived from the SUPPORTED_LOCALES setting.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/systemsettings/supportedpriorities

Retrieve all Supported Priorities. The values retrieved are used for filtering content returned by server based on priorities. Priorities are typically defined on user actions.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/systemsettings

Retrieve all System Settings

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/tasks/{id}/assets/{asset_id}/comments

Add a comment for the specified Asset in the Task. Only the participants of the task can perform this action.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Id of the task to be retrieved
`Asset Id`	Asset Id
`Response Type`	N/A

Options (3)

Option Name	Description
`Job Id`	The job id
`Comment`	Asset comment.
`Annotation Data`	Annotation data associated with the comment

/v6/tasks/{id}/assets

Add all the given new assets to the task.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Id of the task to be retrieved
`Response Type`	N/A

Options (1)

Option Name	Description
`Asset Ids`	Comma separated list of asset id's

/v6/tasks/{id}/assets/{asset_id}/comments

Delete a comment on the specified Asset in the Task. Only the comment creator can perform this action. Comments with an associated approval status cannot be deleted.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Id of the task to be retrieved
`Asset Id`	Asset Id
`Response Type`	N/A

Options (2)

Option Name	Description
`Job Id`	The job id
`Comment Id`	The comment id

/v6/tasks

Get Tasks information for current user with filters.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`After`	Retrieve collection starting at the position after the specified value. If neither the after or before parameters are specified this is equivalent to after=0 and will retrieve items starting at the beginning of the collection
`Before`	Retrieve collection starting at the position before the specified value and going backwards
`Limit`	Maximum number of items to retrieve.If limit is set to zero then only collection summary is returned assuming that the request is made only to retrieve the counts.If limit is not passed, the default limit will be picked from the 'INBOX_RECORD_COUNT' setting.
`Status`	Filter retrieved Jobs based on the job's status. Parameter can be set to a comma separated list of status.
`Sort`	Comma separated list of sort options. Sort options can optionally be prepended with 'asc_' or 'desc_' to specify ascending or descending sort (default is ascending). Sorting on tasks is supported for the fields name, current_step_name, job_name, priority, due_date, end_date, start_date, status.
`Job Name`	Filter to retrieve Jobs based on the job's type. Parameter can be set to a comma separated list of job types.
`Load Task Data`	Flag to load job data
`Load Asset Details`	Flag to load asset ids and asset count are part of tak. If set to true, will load asset details.
`Asset Ids Limit`	Maximum number of asset ids to retrieve. This parameter is honored only when load_asset_details is set to true. If limit is not passed, the default limit will be picked from the 'ASSET_IDS_TO_LOAD_INTO_TASK' setting.
`Start Date`	Date Range for retrieveing tasks by creation date. Dates ranges are calculate w.r.t server time.
`End Date`	Date Range for retrieving tasks by completion date. Dates ranges are calculate w.r.t server time.
`Due Date`	Date Ranges for retrieving tasks by due dates. Dates ranges are calculate w.r.t server time.Parameter can be set to a comma separated list of due dates.
`Task End Date Start`	Retrieving tasks by end date range, starting limit. Date format: 'yyyy-MM-dd'T'HH:mm:ss'. By default dates are calculated w.r.t server time. Server considers Dynamic date only if static date ranges are not provided
`Task EndDate End`	Retrieving tasks by end date range, ending limit. Date format: 'yyyy-MM-dd'T'HH:mm:ss'. By default dates are calculated w.r.t server time. Server considers Dynamic date only if static date ranges are not provided
`Task StartDate Start`	Retrieving tasks by start date range, starting limit. Date format: 'yyyy-MM-dd'T'HH:mm:ss'. By default dates are calculated w.r.t server time. Server considers Dynamic date only if static date ranges are not provided
`Task Start Date End`	Retrieving tasks by start date range, ending limit. Date format: 'yyyy-MM-dd'T'HH:mm:ss'. By default dates are calculated w.r.t server time. Server considers Dynamic date only if static date ranges are not provided
`Task Due Date Start`	Retrieving tasks by due date range, starting limit. Date format: 'yyyy-MM-dd'T'HH:mm:ss'. By default dates are calculated w.r.t server time. Server considers Dynamic date only if static date ranges are not provided
`Task Due Date End`	Retrieving tasks by due date range, ending limit. Date format: 'yyyy-MM-dd'T'HH:mm:ss'. By default dates are calculated w.r.t server time. Server considers Dynamic date only if static date ranges are not provided
`Priority`	Filter retrieved Jobs based on the job's priority. Parameter can be set to a comma separated list of priority ids. Use the 'systemsettings/supportedpriorities' resource to get the list of priorities
`Response Type`	N/A

/v6/tasks/{id}

Retrieve user task by id

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Id of the task to be retrieved
`Load Asset Details`	Flag to load asset ids and asset count are part of tak. If set to true, will load asset details.
`Asset Ids Limit`	Maximum number of asset ids to retrieve. This parameter is honored only when load_asset_details is set to true. If limit is not passed, the default limit will be picked from the 'ASSET_IDS_TO_LOAD_INTO_TASK' setting.
`Load Job Steps`	Flag to load the steps in the job where task is triggered from the job. If set to true, will load step.
`Response Type`	N/A

/v6/tasks/sortoptions

Retrieves the sort options available to sort all the tasks

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/tasks/statusoptions

Retrieves all supported Status Options available for retrieving Tasks.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/tasks/{id}/assets

Retrieve assets associated with a task by task idThe fields populated in the returned object is based on the load_type parameter value. The allowable load_type values are (full,system,metadata,inherited_metadata,custom). If the load_type parameter is set to custom then you must also provide a data_load_request parameter containing the JSON representation of a DataLoadRequest object. If the load_type parameter is set to metadata or inherited_metadata then you may optionally set the metadata_to_return and/or preference_id parameters to restrict what metadata fields are retrieved. The preference_id parameter is also honored when load_type is custom

For load_type options that return metadata fields it is possible to suppress field definitions and retrieve just the values for metadata fields by specifying the request parameter level_of_detail. The allowed values are slim, or full(default)

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Id of the task to be retrieved
`Load Type`	Data load type
`Metadata To Return`	Comma separated list of metadata field ids. This parameter is ignored unless the load_type parameter is set to metadata or inherited_metadata
`Preference Id`	Preference Id
`Filter Fields By Model`	Filter metadata fields relevant to asset model. This parameter is honored only when metadata_to_return and/or preference_id are set in the request.
`Load Multilingual Values`	Load multilingual values. This parameter is honored only when the load_type parameter is set to metadata or full. For the custom load type multilingual values can be requested using the load_multilingual_field_values property of the data_load_request parameter.
`Data Load Request`	JSON representation of DataLoadRequest object. This parameter is ignored unless the load_type parameter is set to custom
`Level Of Detail`	Controls whether field definitions are suppressed in the metadata fields returned.
`After`	Retrieve collection starting at the position after the specified value. If neither the after or before parameters are specified this is equivalent to after=0 and will retrieve items starting at the beginning of the collection
`Before`	Retrieve collection starting at the position before the specified value and going backwards
`Limit`	Maximum number of items to retrieve.
`Load Task Asset Summary`	Flag to load task asset summary like approval state and comment count. This flag is applicable only for review type tasks.
`Response Type`	N/A

/v6/tasks/{id}/assets/{asset_id}/comments

Retrieve task asset review comments for given task id and asset id.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Id of the task to be retrieved
`Asset Id`	Asset Id
`Response Type`	N/A

/v6/tasks/{id}/assets/{asset_id}/state

Set the asset approval state for an asset in a task.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Id of the task to be retrieved
`Asset Id`	Asset Id
`Response Type`	N/A

Options (3)

Option Name	Description
`Job Id`	The job id
`Approval State`	Set asset approval state. The allowed values are 'APPROVED', 'REJECTED' and 'NONE'.
`Comment`	Asset approval comment.

/v6/tasks/{id}/assignees

API to change the assignees of the task to other users or user group. This operation is allowed only for user who created the task.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Id of the task to be assigned
`Response Type`	N/A

/v6/tasks/{id}

Update task data for the specified Task.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Id of the task to update
`Response Type`	N/A

/v6/transferschemes/{transfer_scheme}/sessions

Get Transfer session for a transfer scheme

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Transfer Scheme`	Name of the transfer scheme
`Response Type`	N/A

/v6/transferschemes

Get Transfer Schemes configured in the system

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/transformers

Retrieve transformers list based on the given query paramaters

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Where Export Transformer`	Flag to retrieve only export transformer
`Where Import Transformer`	Flag to retrieve only import transformer
`Where Delivery Transformer`	Flag to retrieve only export delivery transformer
`Where Job Transformer`	Flag to retrieve only export job transformer
`Where Scheduler Transformer`	Flag to retrieve export job transformer which can be schedule
`Where Resolve Template Values`	Flag to replace transformer template values with actual values
`Content Types`	Retrieve export transformer associated with the content types
`Response Type`	N/A

/v6/usergroups/{id}/children

Retrieve a User Group's child group(s). This will return only user groups which are immediate children of the given parent user group.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	User Group Id
`Response Type`	N/A

/v6/usergroups/me

Retrieve User Group(s) for the currently logged in user. Optionally comma separated list of user group ids associated with a user can be passed.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	User Group Id
`Response Type`	N/A

/v6/users/{userid}/updaterole

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Userid`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Role Name`	N/A
`User Type`	N/A
`Is Group Administrator`	N/A
`Is Security Administrator`	N/A

/v6/users/me/sessions

Delete all the active sessions for currently logged on User. This operation will not delete the internal sessions associated with the user.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/users

Retrieve all Users with filters.Filters are case-insensitive. For those filter parameters documented as supporting wildcards below, a '*' in the parameter value will match 0 or more characters and a '?' will match exactly 1 character. If multiple filters are specified, all filters must be matched.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Where First Name`	Filter by user's first name. This parameter supports wildcards.
`Where Last Name`	Filter by user's last name. This parameter supports wildcards.
`Where First And Last Name`	Filter by user's first and last name. This parameter supports wildcards.
`Where Login Name`	Filter by user's login name. This parameter supports wildcards.
`Where User Id`	Filter by user's login id. This parameter supports wildcards.
`Where Department`	Filter by user's department.
`Where Role Id`	Filter by numeric representation of user's role id.
`Where Fet Id`	Filter by FET id. Only users who have been granted the specified FET will be returned.
`Where User Status`	First by user's status (active, inactive).
`Where Email Status`	First by user's email status (active, inactive). To be considered active both the email_enabled property must be set to true, and the email_address property must have a value populated.
`Sort`	Property to sort the users returned by. Sort option can optionally be prepended with 'asc_' or 'desc_' to specify ascending or descending sort (default is ascending).
`After`	Retrieve collection starting at the position after the specified value. If neither the after or before parameters are specified this is equivalent to after=0 and will retrieve items starting at the beginning of the collection
`Before`	Retrieve collection starting at the position before the specified value and going backwards
`Limit`	Maximum number of items to retrieve.
`Response Type`	N/A

/v6/users/{userIdentifier}

Retrieve a User by username or userId.
For example if a user ABC is having username as abc and userId as 1234, then you can either pass abc or 1234 in place of userIdentifier to get the details of that particular user.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Useridentifier`	UserName/UserId
`Response Type`	N/A

/v6/users/me/sessions

Retrieve all active session info for currently logged on User. The response of the operation does not include the internal sessions created by Media Management and the current logged in session

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/users/me

Retrieve the currently logged on User.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/usertypes

Retrieve all User Type

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/usertypes/{userTypeId}

Retrieve all User Type

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Usertypeid`	User Type Id
`Response Type`	N/A

/v6/videos/proxies

Create a Proxies for the given video asset.While using selection context to filter the assets based on permissions, pass permissions_filter parameter in selection context. Valid permission filters:

ASSETVIEW_PERM
SUMMARYVIEW_PERM
PREVIEWVIEW_PERM
EXPORT_PERM
SUBSCRIBE_PERM
METAEDIT_PERM
CONTENTEDIT_PERM
MEMBERSHIPEDIT_PERM
DELETEASSET_PERM
EDITPARENTS_PERM
CUSTOM01_PERM
CUSTOM02_PERM
CUSTOM03_PERM
CUSTOM04_PERM

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

/v6/videos/{id}/subclips

Creates a new clip for the given video asset. The ranging of the clip within and including the specified time codes for a given asset.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Asset Id
`Response Type`	N/A

/v6/videos/{id}/speech

Delete video speech data for Asset Id.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	assetId
`Video Speech Text Param`	video speech text param
`Response Type`	N/A

/v6/videos/{id}/speech/srtfile

Get downloadable srt file from an video by passing the video assetId.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	assetId
`User-agent`	User-Agent HTTP header
`Enable Caching`	Is caching enabled for this request
`Response Type`	N/A

/v6/videos/{id}/insights

Retrieve insights of video asset. The request needs the pagination parameters to be passed.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	assetId
`Video Insight Request`	insightsRequestParam
`Response Type`	N/A

/v6/videos/{id}/keyframes

Retrieve keyframes of video asset. The request needs the pagination parameters to be passed.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Asset Id
`After`	Retrieve collection starting at the position after the specified value. If neither the after or before parameters are specified this is equivalent to after=0 and will retrieve items starting at the beginning of the collection
`Before`	Retrieve collection starting at the position before the specified value and going backwards
`Limit`	Maximum number of items to retrieve.
`Response Type`	N/A

/v6/videos/{id}/speech/search

Retrieve specific speech text by passing a specific string and returns speech text which contains the requested string

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	assetId
`Search`	searchable string
`Response Type`	N/A

/v6/videos/{id}/subclips

Retrieve sub clips of video asset. The request needs the pagination parameters to be passed.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	Asset Id
`Load Type`	Data load type
`Metadata To Return`	Comma separated list of metadata field ids. This parameter is ignored unless the load_type parameter is set to metadata or inherited_metadata
`Preference Id`	Preference Id
`Filter Fields By Model`	Filter metadata fields relevant to asset model. This parameter is honored only when metadata_to_return and/or preference_id are set in the request.
`Load Multilingual Values`	Load multilingual values. This parameter is honored only when the load_type parameter is set to metadata or full. For the custom load type multilingual values can be requested using the load_multilingual_field_values property of the data_load_request parameter.
`Data Load Request`	JSON representation of DataLoadRequest object. This parameter is ignored unless the load_type parameter is set to custom
`Level Of Detail`	Controls whether field definitions are suppressed in the metadata fields returned.
`After`	Retrieve collection starting at the position after the specified value. If neither the after or before parameters are specified this is equivalent to after=0 and will retrieve items starting at the beginning of the collection
`Before`	Retrieve collection starting at the position before the specified value and going backwards
`Limit`	Maximum number of items to retrieve.
`Response Type`	N/A

/v6/videos/{id}/insight/persondetails

Update a person's exisitng name in a video along with those who are not recognized or marked as unknown.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	assetId
`Video Person Edit`	JSON object for VideoInsightPersonParam
`Response Type`	N/A

/v6/videos/{id}/speech

Update video speech data for Asset Id.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Id`	assetId
`Video Speech Text Param`	videoSpeechTextParam
`Response Type`	N/A

/v6/videos/subclips/state

delete or un-delete of an video sub clipWhile using selection context to filter the assets based on permissions, pass permissions_filter parameter in selection context. Valid permission filters:

ASSETVIEW_PERM
SUMMARYVIEW_PERM
PREVIEWVIEW_PERM
EXPORT_PERM
SUBSCRIBE_PERM
METAEDIT_PERM
CONTENTEDIT_PERM
MEMBERSHIPEDIT_PERM
DELETEASSET_PERM
EDITPARENTS_PERM
CUSTOM01_PERM
CUSTOM02_PERM
CUSTOM03_PERM
CUSTOM04_PERM

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Action`	Video sub clip 'state change' action; allowed values are delete, un_delete

Assets (28)

Auditactivity (4)

Brandings (2)

Cascadinggroups (2)

Collections (28)

Colorfilters (2)

Download

Exports

Facetconfigurations (2)

Featurepermissions (2)

Folders (23)

Foldertypes (2)

Hightail (5)

Importtemplates

Intervalprofiles (2)

Jobs (21)

Linktypes

Lookupdomains (2)

MarsExtn (9)

Metadatafieldgroups (2)

Metadatafields (2)

Metadatalocales

Metadatamodels (2)

Preferences (5)

Renditions (2)

Savedsearches (10)

ScreenDragonIntegration (3)

Search (8)

Searchconfigurations (2)

Searchoperators

Searchscopes

Securitypolicies (3)

Sessions (5)

Systemannouncements

Systemdetails (2)

Systemsettings (6)

Tasks (12)

Transferschemes (2)

Transformers

Usergroups (2)

Users (6)

Usertypes (2)

Videos (11)