Otcoredamconnector v1.0 | OneTeg Documentation

Version 1.0

Connector Overview: This page documents all 10 actions for the Otcoredamconnector v1.0.

General (10)

POST Create asset

/cms/instances/file/cms_file

Create asset

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Description`	Provide a textual description for the new asset.
`Name`	Specify the file name for the new asset.
`Parent Folder Id`	Set the folder ID where the asset should be stored.
`Type`	Indicate the asset type (e.g., image, video) to classify the file.

POST Create folder

/cms/instances/folder/cms_folder

Create folder

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Description`	Provide a textual description for the new folder.
`Name`	Specify the folder name.
`Parent Folder Id`	Set the parent folder ID where the new folder will be created.

DELETE Delete folder

/cms/instances/folder/cms_folder/{folder_id}

Delete folder

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Folder Id`	Specify the unique identifier of the folder to delete.
`Recursive`	Set to "true" to delete all subfolders and assets inside the folder; otherwise only empty folders are deleted.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Asset

/v1/assets/{asset_id}

Get Asset

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Asset Id`	Provide the unique identifier of the asset to retrieve.
`Load Default Ds Urls`	Set to "true" to include default delivery service URLs in the response.
`Load Profile Ds Urls`	Set to "true" to include profile-specific delivery service URLs.
`Profile Ds Urls To Return`	Specify a comma-separated list of profile names to limit which profile delivery service URLs are returned.
`Custom Ds Url Options`	Provide a JSON string with custom delivery service URL options to override default settings.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Asset Profiles

/v1/profiles

Get Asset Profiles

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Assets by Filter

/v1/assets

Get Assets by Filter

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filter`	Provide a filter expression (e.g., "name eq 'example.jpg'") to narrow down the assets returned.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get Folder Children

/v1/folders/{folder_id}/children

Get Folder Children

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Folder Id`	Specify the unique identifier of the parent folder whose children to retrieve.
`Type`	Filter the children by asset or folder type (e.g., "image", "folder").
`Page`	Set the page number for paginated results (defaults to 1).
`Items Per Page`	Set the number of items per page (defaults to a system-defined limit).
`Load Default Ds Urls`	Set to "true" to include default delivery service URLs in the response.
`Load Profile Ds Urls`	Set to "true" to include profile-specific delivery service URLs.
`Profile Urls To Return`	Specify a comma-separated list of profile names to limit which profile delivery service URLs are returned.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get digital asset library folder

/cms/instances/folder/cms_folder/{enterprise_volume_id}/items

Get digital asset library folder

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Enterprise Volume Id`	Provide the unique identifier of the enterprise volume to list items from.
`Filter`	Provide a filter expression to narrow down the items returned (e.g., by name or type).
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get enterprise volume

/cms/instances/folder/ccmapp_enterprise_volume

Get enterprise volume

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Sortby`	Specify a field name to sort the enterprise volumes by (e.g., "name" or "createdDate").
`Response Type`	The response format expected from the API (e.g. application/json).

POST Upload a file into CSS

/v3/files/fromStream

Upload a file into CSS

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Tenant`	Provide the tenant identifier if the upload is for a specific tenant.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	Specify the file to upload; this can be a file path or binary data.