Version 1
Connector Overview: This page documents all 255 actions for the Mediavaletconnector v1.
Add Metadata to an Image (2)
POST Add Keyword to an Image
/assets/{assetId}/keywords
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The asset id. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
PATCH Add or Update Image Description Attribute
/assets/{assetId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The asset id. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
Assets (42)
POST Create Asset
/assets
Creates an asset and returns newly created asset information.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create Asset Attributes
/assets/{assetId}/attributes
Add attributes to an asset.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The asset id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create Asset Comments
/assets/{assetId}/comments
Adds comments to the asset.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The asset id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Create Asset Rating
/assets/{assetId}/rating
Sets rating for asset.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The asset id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Create Asset Upload
/assets/{assetId}/uploads
Creates an asset upload and returns newly created asset information.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The asset id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create Association of Asset And Categories
/assets/{assetId}/categories
Associates Asset into list of categories
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The asset id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Create Association with Asset and Related Assets
/assets/{assetId}/relatedassets
Add related assets to an asset.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The asset id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Create Intelligence Analysis Insight
/assets/{assetId}/videoIntelligence/insightsupdated
Create video intelligence analysis for an asset.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The asset id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
POST Create Keywords And Associate With Asset [Audio And Video]
/assets/{assetId}/videoIntelligence/keywords
Creates one or more keywords in the default Audio and Video Keyword Group and assigns the keyword to the asset specified in the URL.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The asset id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Create Keywords And Associate With Asset [Cognitive]
/assets/{assetId}/autotags/keywords
Creates one or more keywords in the default Cognitive Keyword Group,
and assigns the keyword to the asset specified in the URL.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The asset id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Create Video Intelligence Analysis
/assets/{assetId}/videoIntelligence/analyze
Create the video intelligence analysis.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The asset id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Create View Count Increment For Asset
/assets/{assetId}/viewed
Increments view count for asset.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The asset id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Remove Asset
/assets/{assetId}
Deletes an asset.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The boolean to flag hard deletion of asset. |
|
|
(Required) The asset id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Remove Asset Autotag
/assets/{assetId}/autotags/{autotag}
Removes autotag from an asset.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The asset id. |
|
|
(Required) The autotag. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
DELETE Remove Asset Category
/assets/{assetId}/categories/{categoryId}
Removes the category from the asset.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The asset id. |
|
|
(Required) The guid of the category. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
DELETE Remove Asset Keyword
/assets/{assetId}/keywords/{keyword}
Removes keyword from asset.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The asset id. |
|
|
(Required) The keyword name. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
DELETE Remove Asset Rating
/assets/{assetId}/rating
Removes rating from an asset.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The asset id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Remove Related Asset
/assets/{assetId}/relatedassets/{relatedAssetId}
Remove related asset based on asset id.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The asset id. |
|
|
(Required) The related asset id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
POST Report Downloaded Asset
/assets/{assetId}/downloaded
Reports that the asset was downloaded.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The asset id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
GET Retrieve Asset
/assets/{assetId}
Retrieve an asset based on the asset id parameter.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Allow soft deleted assets if permissible. |
|
|
(Required) The asset id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
GET Retrieve Asset Attributes
/assets/{assetId}/attributes
Retrieves attributes associated with an asset.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Allow soft deleted assets if permissible. |
|
|
(Required) The asset id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
GET Retrieve Asset Autotags
/assets/{assetId}/autotags
Retrieves autotags associated with specified asset.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Allow soft deleted assets if permissible. |
|
|
(Required) The asset id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
GET Retrieve Asset Categories
/assets/{assetId}/categories
Returns list of categories an asset belongs to
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Allow soft deleted assets if permissible. |
|
|
N/A |
|
|
(Required) The asset id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
GET Retrieve Asset Comments
/assets/{assetId}/comments
Retrieves asset comments.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Allow soft deleted assets if permissible. |
|
|
(Required) The asset id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
GET Retrieve Asset History
/assets/{assetId}/history
Retrieves asset history.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Allow soft deleted assets if permissible. |
|
|
(Required) The asset id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
GET Retrieve Asset Keywords
/assets/{assetId}/keywords
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Allow soft deleted assets if permissible. |
|
|
(Required) The asset id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
GET Retrieve Asset Metadata
/assets/{assetId}/{metadataType}
Retrieve meta data for an asset.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The asset id. |
|
|
(Required) Specify which type of information is being requested. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
GET Retrieve Asset Related Assets
/assets/{assetId}/relatedassets
Retrieve related assets based on the asset id.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The asset id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
GET Retrieve Asset Renditions
/assets/{assetId}/renditions
Retrieves an asset's renditions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Allow soft deleted assets if permissible. |
|
|
(Required) The asset ID. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
GET Retrieve Asset Renditions By Kind
/assets/{assetId}/renditions/{renditionKindId}
Retrieves an asset's renditions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Allow soft deleted assets if permissible. |
|
|
(Required) The asset id. |
|
|
(Required) The rendition kind id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
GET Retrieve Assets With Search Criteria
/assets
Search for assets within a library that match optional search criteria.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Allow soft deleted assets if permissible. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
GET Retrieve Media File Versions
/assets/{assetId}/versions
Gets an asset's media file versions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Allow soft deleted assets if permissible. |
|
|
(Required) The asset id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Related Asset Gallery Url
/assets/{assetId}/relatedAssetsGalleryUrl
Retrieve the url for use with related assets gallery application.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The asset id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
GET Retrieve Related Assets
/public/assets/{id}/relatedasset/{token}
Retrieve related assets for an asset.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The asset id. |
|
|
(Required) The url token. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
GET Retrieve Related Assets
/assets/{assetId}/searchRelatedAssets
Search for assets and exclude asset that match search criteria to retrieve assets that can be related to current asset.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The asset id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
GET Retrieve Video Indexer Subscription
/assets/{assetId}/videoIntelligence/token
Retrieves video indexer subscription metadata for an asset.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The boolean indicating whether edit is allowed or not. |
|
|
(Required) The asset id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Video Intelligence Limits
/assets/videoIntelligence/limits
Retrieves video intelligence limits and usage information.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Video Intelligence Result
/assets/{assetId}/videoIntelligence/insights
Retrieves video intelligence insights for an asset.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The asset id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Video Intelligence Status
/assets/{assetId}/videoIntelligence/status
Retrieve video intelligence analysis status for an asset.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The asset id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PUT Update Association of Asset And Categories
/assets/{assetId}/categories
Associates specified asset into list of categories, replacing previous list with provided list
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The asset id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
PUT Update Upload Process To Complete
/assets/{assetId}
Completes upload process for asset and updates description for now.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The asset id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Validate Asset Deletion Rollback
/assets/undeleteValidate
Check whether assets can be undeleted or not.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
Attributes (10)
POST Create Attribute
/attributes
Create a attribute in a library.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (17)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Remove Attribute
/attributes/{attributeId}
Removes attribute in a library.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The attribute id |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
GET Retrieve Attribute By ID
/attributes/{attributeId}
Retrieve attributes in a library by attribute id.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The attribute id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Attributes
/attributes
Retrieve attributes from a library.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Attributes Data Types
/attributes/attributeDataType
Returns attributes data types.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Attributes Embedded Data Mapping Types
/attributes/embeddedDataMappingType
Returns an of embedded attribute data mapping types.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Attributes Embedded Data Types
/attributes/embeddedDataType
Returns an embedded attribute data types.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Attributes Embedded Data Values
/attributes/{dataTypeValue}/embeddedDataValue
Returns an embedded attribute data values.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) A Data Type Value |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Cascading Attributes
/attributes/cascadingAttributes
Returns an cascading attributes.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PUT Update Attributes
/attributes/{attributeId}
Update attributes in a library.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The attribute id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (17)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
BrandedPortals (38)
POST Authorize Branded Portal Access
/public/brandedportals/{host}/{path}/authorize
Authorize access for branded portal.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The branded portal library domain name. |
|
|
(Required) The branded portal name in URL path. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Create A Download Live Branded Portal Assets
/public/{libraryId}/brandedportals/{brandedPortalId}/downloads
Returns a live branded portal assets.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The library id. |
|
|
(Required) The branded portal id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create Branded Portal Upload Section
/brandedportals/{brandedPortalId}/sections/{sectionId}/uploads
Create branded portal upload section.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The branded portal id. |
|
|
(Required) The section id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Create Duplicate Branded Portal
/brandedportals/{brandedPortalId}/duplicate
Duplicates a branded portal.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create section sync
/brandedportals/{brandedPortalId}/{sectionId}/sync
Sync Branded Portal section.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The branded portal id. |
|
|
(Required) The section id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
POST Disable Branded Portal
/brandedportals/{brandedPortalId}/disable
Disable branded portal.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The branded portal id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get branded portal section sync details
/brandedportals/{brandedPortalId}/{sectionId}/sync
Return branded portal section sync details
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The branded portal id. |
|
|
(Required) The section id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Move Assets To A Branded Portal Section
/brandedportals/{brandedPortalId}/move/assets
Move assets to a branded portal section.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The branded portal id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Remove Assets Form A Branded Portal.
/brandedportals/{brandedPortalId}/assets
Remove assets form a branded portal.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The branded portal id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Remove Branded Portal
/brandedportals/{brandedPortalId}
Remove a branded portal by branded portal id.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The branded portal id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
DELETE Remove Branded Portal Upload Section
/brandedportals/{brandedPortalId}/sections/{sectionId}/uploads
Remove a branded portal upload section by branded portal id and upload section id.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The branded portal id. |
|
|
(Required) The upload section id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
POST Remove section sync
/brandedportals/{brandedPortalId}/{sectionId}/unsync
Unsync Branded Portal section.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The branded portal id. |
|
|
(Required) The section id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
GET Retrieve Branded Portal
/brandedportals/{brandedPortalId}
Returns a branded portal by branded portal id.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The branded portal id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Branded Portal Access Key
/brandedportals/{brandedPortalId}/settings/accesskey
Returns a branded portal access key.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The branded portal id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Branded Portal Assets By CategoryId
/brandedportals/categories/{categoryId}/assets
Returns a collection of assets by categoryId in a branded portal.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The id of the category. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Branded Portal Assets By LightboxId
/brandedportals/lightboxes/{lightboxId}/assets
Returns a collection of asset by lightboxId in a branded portal.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The lightbox id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Branded Portal Draft Assets
/brandedportals/{brandedPortalId}/{sectionId}/assets
Returns draft assets in a branded portal.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The flag used to show fully ingested assets. |
|
|
(Required) The branded portal id. |
|
|
(Required) The section id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Branded Portal Terms and Conditions
/public/brandedportals/{host}/termsAndConditions
Returns the terms and condititons of a branded portal.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The branded portal library domain name. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Branded Portal Upload Section Details
/brandedportals/{brandedPortalId}/sections/{sectionId}/uploads
Return branded portal upload section details
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The branded portal id. |
|
|
(Required) The section id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Branded Portals
/brandedportals
Returns branded portals.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Branded Portals Asset Rendition
/public/{libraryId}/brandedportals/{brandedPortalId}/assets/{assetId}/renditions/{renditionKindId}
Retrieves a specific rendition for a given published Branded Portal asset.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The library id. |
|
|
(Required) The branded portal id. |
|
|
(Required) The asset id. |
|
|
(Required) The specific rendition kind id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Live Branded Portal
/public/brandedportals/{host}/{path}
Returns a live branded portal.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The branded portal library domain name. |
|
|
(Required) The branded portal name in URL path. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Live Branded Portal Assets
/public/{libraryId}/brandedportals/{brandedPortalId}/downloads/{downloadId}
Retrieve a live branded portal assets.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The library id. |
|
|
(Required) The branded portal id. |
|
|
(Required) The download id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieves Branded Portal Asset Rendition Types
/public/{libraryId}/brandedportals/{brandedPortalId}/renditionKinds
Retrieves all the rendition types available for the given Branded Portal.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The library id. |
|
|
(Required) The branded portal id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Search Branded Portal Assets
/brandedportals/assets
Returns assets form a search results in a branded portal.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Search Branded Portal Draft Assets
/brandedportals/{brandedPortalId}/assets
Returns search results from branded portal draft assets.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The flag used to show fully ingested assets. |
|
|
(Required) The branded portal id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PUT Update Branded Portal
/brandedportals/{brandedPortalId}/layout
Update the branded portal page layout.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The branded portal id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
PUT Update Branded Portal Access Settings
/brandedportals/{brandedPortalId}/settings/restrictaccess
Update the restricted access settings for branded portal.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The branded portal id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
PUT Update Branded Portal Download Settings
/brandedportals/{brandedPortalId}/settings/download
Update download settings for a branded portal.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The branded portal id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
PUT Update Branded Portal Highlight Colour
/brandedportals/{brandedPortalId}/settings/highlightcolour
Update highlight colour for a branded portal.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The branded portal id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
PUT Update Branded Portal Language Settings
/brandedportals/{brandedPortalId}/settings/language
Update language settings for a branded portal.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The branded portal id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
PUT Update Branded Portal Name
/brandedportals/{brandedPortalId}/name
Update the branded portal name.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The branded portal id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
PUT Update Branded Portal Navigation Settings
/brandedportals/{brandedPortalId}/settings/navigation
Update navigation for a branded portal.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The branded portal id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
PUT Update Branded Portal Search Settings
/brandedportals/{brandedPortalId}/settings/search
Update the search settings for branded portal.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The branded portal id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
PUT Update Branded Portal URL Settings
/brandedportals/{brandedPortalId}/settings/url
Update the URL settings for a branded portal.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The branded portal id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
PUT Update Branded Portal Upload Section
/brandedportals/{brandedPortalId}/sections/{sectionId}/uploads
Update a branded portal upload section by branded portal id and upload section id.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The branded portal id. |
|
|
(Required) The upload section id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Validate Assets In A Branded Portal
/brandedportals/{brandedPortalId}/validate/assets
Validate assets in a branded portal.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The branded portal id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Validate Assets In All Branded Portals
/brandedportals/validate/assets
Validates assets in all branded portal.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
Categories (16)
POST Create Category
/folders
Creates a category in the library.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create Permission Set
/categories/permissionSets
Creates a permission set in the library.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create User Group Association With Category
/categories/{categoryId}/userGroups
Assigns the user group to a category.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) Guid of the category to which we are assigning user group. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
DELETE Remove Category
/categories/{categoryId}
Deletes a category in the library.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The guid of the category being deleted. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
DELETE Remove User Group From Category
/categories/{categoryId}/userGroups/{userGroupId}
Unassign the user group permissions from a category.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The category id. |
|
|
(Required) The user group id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
GET Retrieve Categories
/categories
Returns list of categories for the library.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Category
/folders/{categoryGuid}
Returns detailed information on a specific category based on guid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The category guid. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Category Assets
/categories/{categoryId}/assets
Returns assets that belongs to the specified category.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The category guid. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Category1
/categories/{categoryGuid}
Returns detailed information on a specific category based on guid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The category guid. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Root Categories
/folders
Returns list of root categories for the library.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The boolean indicator to include pinned saved searches. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Root Sub Categories
/categories/subcategories
Returns the sub categories that belongs to the specified category.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Sub Categories
/folders/{categoryGuid}/subfolders
Returns list of subcategories based on parent category guid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) Parent category guid. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Sub Categories1
/categories/{categoryGuid}/subcategories
Returns list of subcategories based on parent category guid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) Parent category guid. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PATCH Update Category
/folders/{categoryId}
Updates a category in a library by renaming or moving its parent category.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The guid of the category being updated. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PATCH Update Category Features
/categories/{categoryId}/features
Updates the category features with a list of patch operations.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The category guid. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PATCH Update Category1
/categories/{categoryId}
Updates a category in a library by renaming or moving its parent category.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The guid of the category being updated. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Config
GET Retrieve Rendition Kinds
/config/renditionkinds
Retrieves the supported rendition kinds.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Create Branded Portal (4)
POST Add Assets In Branded Portal Section
/brandedportals/{brandedPortalId}/{sectionId}/assets
Adds assets to specific branded portal section.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The branded portal id. |
|
|
(Required) The section id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The asset id. |
|
|
The asset id. |
POST Create Branded Portal
/brandedportals
Creates a branded portal with hero section and one additional section.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
(Required) Branded portal id |
|
|
(Required) Branded portal name |
|
|
(Required) Branded portal host |
|
|
(Required) Branded portal path |
|
|
(Required) Branded portal page layout |
POST Publish Branded Portal
/brandedportals/{brandedPortalId}/publish
Publish branded portal.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The branded portal id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
DELETE Remove Assets From A Branded Portal Section
/brandedportals/{brandedPortalId}/{sectionId}/assets
Remove assets from specific branded portal section.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The branded portal id. |
|
|
(Required) The section id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Create a New Asset Version (4)
POST 02. Checkout Asset
/assets/{assetId}/checkOut
Perform a checkout to the asset that you want to create a new version with and add some comments.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST 03. Validate Asset Checkin
/assetCheckIn/{id}/validate
Validate the asset filename of the asset you want to upload.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
GET 04. Request Upload URL
/assetCheckIn/{assetId}
Request for an upload URL of the new asset version to upload. This automatically sets the environment URL for the upload request.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PUT 06. Finalize Upload/Set Asset Metadata
/assetCheckIn/{assetId}
Finalize the upload by setting the asset's metadata.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Create a Restricted Category (3)
POST 01. Create Category
/categories
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
POST 02. Create User Group
/groups
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
PATCH 03. Grant Group Access to the Category
/groups/{userGroupId}/categories
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
User group id |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
Create a webhook for an Event (4)
GET 01. Get Events Types
/skyhook/events
Return all Events Types that you can Subscribe to. Take note of the Event Name you will need to create a subscription.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST 02. Create Subscription
/skyhook/subscriptions
Create a Subscription for your own Webhook URL.
Use the Event Name form the Get Events request.
You must ensure that your Webhook URL will respond with the Validation Response Code. You can read more Here; If SkyBridge fails to validate the URL the subscription will not be created.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
GET 03. Get Subscription
/skyhook/subscriptions/list
Return all the Subscriptions that you are subscribed to.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PUT 04. Update Subscription
/skyhook/subscriptions/{subscriptionID}
Update Subscription's. Subscription ID's can be found by using the Get Subscription endpoint.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
Crop (8)
POST Create Crop
/crop/{assetId}
Create a crop image for an asset.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The asset id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (7)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create Crop From Template
/cropWithTemplate/{assetId}
Create a crop image for an asset using a crop template.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The asset id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create Crop Template
/crop/templates
Create crop template.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Remove Crop Template
/crop/templates/{cropTemplateId}
Remove crop template.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The crop template id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Crop
/crop/{cropId}
Retrieve the crop image url.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The crop id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Crop Templates
/crop/templates
Retrieve crop templates.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Predefined Crop Templates
/crop/predefinedTemplates
Retrieve predefined crop templates.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PUT Update Crop Template
/crop/templates/{cropTemplateId}
Update crop template.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The crop template id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DirectLinks (8)
PUT Activate All Direct Links
/directLinks/{assetId}/activateAll
Activate all direct links.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The asset id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
PUT Activate Direct Link
/directLinks/{assetId}/activate/{directLinkId}
Activate direct link.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The asset id. |
|
|
(Required) The directlink id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PUT Archive Direct Link
/directLinks/{assetId}/archive/{directLinkId}
Archive direct link.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The asset id. |
|
|
(Required) The directlink id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PUT Deactivate All Direct Links
/directLinks/{assetId}/deactivateAll
Deactivate all direct links.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The asset id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
PUT Deactivate Direct Link
/directLinks/{assetId}/deactivate/{directLinkId}
Deactivate direct link.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The asset id. |
|
|
(Required) The directlink id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Direct Links
/directlinks/export
Returns a zip file of collection of direct links.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Validate Asset In All Direct Links
/directlinks/validate/assets
Validate assets in all direct links.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Validate a Direct Link
/directlinks/{assetId}/validate
Validate a direct link.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The link name. |
|
|
(Required) The asset id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Downloads (7)
POST Create A New Download By Id
/downloads/{id}
Creates a new download by id.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The download id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create Download By Id
/downloads
Creates a new download.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create Single Asset Download
/downloads/{id}/asset
Create a single asset download by id.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The download id |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
DELETE Remove Download
/downloads/{id}
Remove a specific download by download id.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The id of the download. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Download Detailed Information
/downloads/{id}
Retrieve detailed information for a specific download.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The id of the download. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Downloads
/downloads
Returns a collection of all downloads.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Validate Download
/downloads/validate
Validate a download.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
Generate CDN Links (2)
POST Create A Direct Link
/directlinks/{assetId}
Generates a direct link for an original or renditions.
Following requests are describing generate direct link for each asset type.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The asset id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
GET Retrieve Direct Links
/directlinks/{assetId}
Returns a collection of direct links.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Allow soft deleted assets if permissible. |
|
|
(Required) The asset id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
Home (2)
POST Home Bulk
/bulk
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Json Home Document
/
Retrieve a collection of endpoints that are available to authenticated user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
IntroductionAndHelp
GET Retrieve Introduction And Help
/introductionAndHelp
Returns assets that are used to help and introduce user to the DAM.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
KeywordGroups (5)
POST Create A Keyword Group
/keywordGroups
Creates a keyword group in the library.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (7)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Remove Keyword Group
/keywordGroups/{keywordGroupId}
Removes a keyword group from the library.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The keyword group id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
GET Retrieve All Keyword Groups
/keywordGroups
Returns a collection of keyword groups.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Keyword Groups By Parent Keyword Group Id
/keywordGroups/{keywordGroupId}/subGroups
Returns all keyword groups for the parent keyword group.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The parent keyword group id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PATCH Update Keyword Group
/keywordGroups/{keywordGroupId}
Updates a keyword group in the library.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The keyword group id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Keywords (3)
POST Create Keyword
/keywords
Creates a keyword in the library.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
GET Retrieve Keywords
/keywords
Returns all keywords in library.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PATCH Update Keyword
/keywords/{keyword}
Update a keyword.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The keyword. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Lightbox (12)
POST Create Lightbox
/lightboxes
Creates a new lightbox.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create Lightbox Association With Assets
/lightboxes/{lightboxId}/assets
Add a set of assets to the lightbox.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The lightbox id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
DELETE Remove Asset From Lightbox
/lightboxes/{lightboxId}/assets/{assetId}
Removes an asset from a given lightbox.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The lightbox id. |
|
|
(Required) The asset id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
DELETE Remove Assets From Lightbox
/lightboxes/{lightboxId}/assets
Removes a set of assets from a given lightbox.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The lightbox id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Remove Lightbox
/lightboxes/{lightboxId}
Removes a given lightbox id.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The lightbox id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
GET Retrieve Assets From Lightbox For Approval
/lightboxes/lightboxesForApproval/{lightboxId}/assets
Retrieves the assets from a specific lightbox for approval.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The lightbox id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
GET Retrieve Lightbox
/lightboxes/{lightboxId}
Retrieves lightbox for a given lightbox id.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The lightbox id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Lightbox Assets
/lightboxes/{lightboxId}/assets
Retrieves the assets for a given lightbox id.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The lightbox id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Lightboxes
/lightboxes
Retrieves all lightboxes.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Lightboxes For Approval
/lightboxes/lightboxesForApproval
Retrieves list of lightboxes for approval.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
PUT Update Lightbox
/lightboxes/{lightboxId}
Updates the lightbox details.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The lightbox id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PATCH Update Lightbox1
/lightboxes/{lightboxId}
Update lightbox with a list of patch operations.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The lightbox id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Notification (3)
POST Create Video Intelligence Trial Request
/notification/videointelligence/trial-request
Starts a video intelligence trial.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
GET Notification Get Users And User Groups
/notification/usersandusergroups
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Notification Send Notification Async
/notification
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
OrgUnit (9)
GET Retrieve Current Org Unit Information
/organizationalunits/current
Retrieves detailed information for current organizational unit.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Current Org Unit Libraries Information
/organizationalunits/current/libraries
Retrieves detailed information for current organizational unit libraries.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Org Unit Information
/public/organizationalUnits/{hostName}
Retrieves org unit information based on hostname.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) Domain name of host. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Org Unit Information By Id
/organizationalunits/{id}
Retrieves detailed information for a specific organizational unit.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The id of the organizational unit. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Org Unit Library By Id
/organizationalunits/current/libraries/{id}
Retrieves an organizational unit library by Id.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The identifier of getting organizational unit library. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Print UI Credential For Current Org Unit
/organizationalunits/current/integrations/printui
Retrieves print ui auth token and client ID for current organizational unit.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieves Portals Details For Current Org Unit
/organizationalunits/current/portals
Retrieves information for portals of current organizational unit.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PATCH Update Current Library Name
/organizationalUnits/{libraryId}
Updates the current library name.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The library id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PATCH Update Current Library's Root Category Name
/organizationalunits/current/libraries/{libraryId}
Updates the library's root category name.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The library id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Reports (10)
GET Retrieve Groups Report
/reports/{reportType}/groups
Returns report groups by report type.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The report type name. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Report
/report/{reportType}
Returns a report.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The report type name. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Report Types
/reports
Returns a collection of report types.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Reports
/reports/{reportType}
Returns reports by report type.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The report type name. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve User Asset Events Report
/reports/{reportType}/users/{userId}/assets/{assetId}/events
Returns a report of user assets events.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The report type name. |
|
|
(Required) The user id. |
|
|
(Required) The asset id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve User Group Assets Events Report
/reports/{reportType}/groups/{groupId}/users/{userId}/assets/{assetId}/events
Returns a report of user groups assets events.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The report type name. |
|
|
(Required) The group id. |
|
|
(Required) The user id. |
|
|
(Required) The asset id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve User Group Assets Report
/reports/{reportType}/groups/{groupId}/users/{userId}/assets
Returns a report of user groups assets.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The report type name. |
|
|
(Required) The group id. |
|
|
(Required) The user id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve User Groups Report
/reports/{reportType}/groups/{groupId}/users
Returns a report on user groups.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The report type name. |
|
|
(Required) The group id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Users Assets Report
/reports/{reportType}/users/{userId}/assets
Returns a report of user assets.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The report type name. |
|
|
(Required) The user id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Users Report
/reports/{reportType}/users
Returns a report on users.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The report type name. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Retrieve and Search Assets From A Live Branded Portal (2)
GET Retrieve Assets From Specific Section
/public/{libraryId}/brandedportals/{brandedPortalId}/{sectionId}/assets
Returns assets from specific section.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Count of assets to retrieve |
|
|
Count of assets to skip |
|
|
Include total count |
|
|
(Required) The library id. |
|
|
(Required) The branded portal id. |
|
|
(Required) The section id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
GET Search Assets From Any Section
/public/{libraryId}/brandedportals/{brandedPortalId}/assets
Returns filtered assets from any section.
Enables search assets by title and file extension by using search term.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Count of assets to retrieve |
|
|
Count of assets to skip |
|
|
Search by file title and extension |
|
|
Do not search in sections |
|
|
Include total count |
|
|
(Required) The library id. |
|
|
(Required) The branded portal id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
SavedSearches (8)
POST Create Saved Search
/savedsearches
Creates a new custom search.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create Saved Search
/savedsearches/{savedSearchId}/share
Creates a custom saved search.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Remove Saved Search
/savedsearches/{savedSearchId}
Removes a custom saved search.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The saved search id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
GET Retrieve Pinned Saved Searches
/savedsearches/pinned
Retrieves all pinned saved searches.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Saved Search
/savedsearches/{savedSearchId}
Retrieves a custom saved search.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The saved search id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Saved Search Shares
/savedsearches/{savedSearchId}/share
Retrieves shares for a saved search.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The saved search id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Saved Searches
/savedsearches
Retrieves all custom saved searches.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PATCH Update Saved Search
/savedsearches/{savedSearchId}
Update a custom saved search with a list of patch operations.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The saved search id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Search for Assets
POST Search by Custom Attributes
/assets/search
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Searches (3)
GET Retrieve Facets
/search/facets
Returns a collection of facets.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Most Viewed Assets
/mostViewed
Returns list of most viewed assets.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Recently Uploaded Assets
/recentlyUploaded
Returns list of recently uploaded assets.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Setup/Helpers
GET Clear Upload File Variables
/get
Clear all the environment dynamic variables sets in the Upload Step.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Sharing (9)
POST Create Gallery Authorization
/public/share/{shareCode}/authorize
Creates a gallery authorization request.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The share code. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Create Share
/shareAssets
Initiate a share operation for a given set of assets.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (9)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create Share For Lightbox Set
/shareLightboxes
Initiate a share operation for a given set of lightbox.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (9)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Shared Asset
/public/share/{shareCode}/assets/{assetId}
Retrieves a shared asset for a given share code and asset id.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The share code. |
|
|
(Required) The asset id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Shared Asset Information
/public/share/{shareCode}
Retrieves shared assets information.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The share code. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Shared Asset's Rendition
/public/share/{shareCode}/assets/{assetId}/renditions/{renditionKindId}
Retrieves a specific rendition for a given shared asset.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The share code. |
|
|
(Required) The asset id. |
|
|
(Required) The specific rendition kind id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Shared Assets
/public/share/{shareCode}/assets
Retrieves shared assets.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The share code. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieves Shared Asset's Rendition Types
/public/share/{shareCode}/assets/{assetId}/renditions
Retrieves all rendition types for a given shared asset.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The share code. |
|
|
(Required) The asset id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieves Shared Asset's Rendition Types By Share Code
/public/share/{shareCode}/renditionKinds
Retrieves all the rendition types available for the given share code.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The share code. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
SkyHOOK API Endpoints
DELETE Delete Subscription
/skyhook/subscriptions/{subscriptionID}
Delete a Subscription.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
TermsAndConditions
GET Retrieve Terms And Conditions
/public/{domainName}/termsAndConditions
Retrieves the terms and conditions for a given domain name.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The domain name. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
Upload an Asset (5)
POST 01. Request Upload URL
/uploads
POST to the upload resource. This creates a holding record and creates the Shared Access Signature (SAS) URL for the user to upload the file to. The SAS url allows temporary write access to BLOB storage.
Request
{
"filename": "MyImage.jpg"
}
Response
The response from the POST consists of the Asset Identifier, the temporary file name, and the upload url.
-
id is the Guid identifier of the asset.
-
uploadUrl is the Azure Secured Asset Signature (SAS) URL where the file should be uploaded to.
-
uploadFilename is a temporary filename given to the file for security purposes. It will be changed back to the original filename after upload is complete.
{
"id":"2c6b34da-c2fd-41ea-84ee-3ab32219b591",
"uploadUrl":"[Shared Access Signature URL]",
"uploadFilename":"2c6b34da-c2fd-41ea-84ee-3ab32219b591.bin"
}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
PUT 02. Upload File
/
This step requires the user to upload the file to blob storage in Azure using the SAS URL provided in the POST step. The upload is accomplished by issuing a PUT, or a number of PUT request to the SAS URL with the binary segments of the file as the body. It is important to note, the SAS URL expires after 24 hours and another will have to be requested at that point.
There are a few key points to this upload.
-
Maximum file size Azure supports is 200GB.
If the file is over 64 MB, it must be broken up into segments.
-
The maximum segment size is 64 MB, but MediaValet recommends using much smaller segments.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
PUT 03. Add Title/Description/FileSize
/uploads/{assetId}
This step allows the user to (optionally) supply a description to each asset being uploaded as well as change the default title. By default the system will use the filename (without file extension) as the asset title.
Note: It is important to supply the original file size in this step. In order to supply a title, description and fileSizeinBytes upload the PUT end-point is available.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST 04. Assign Asset to the Category
/uploads/{assetId}/categories
The step forces the user to apply at least one category to each asset being uploaded.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
PATCH 05. Finalize Upload
/uploads/{assetId}
The final step is mainly a confirmation that the assets were successfully uploaded. After this, the system needs to render thumbnails and otherwise process the assets. This may take some time depending on overall load of the system and how many assets were added. In order to finalize the upload, the PATCH end-point is available.
PATCH
The PATCH request finalizes the upload. PATCH indicates that the upload is ready for processing with the ReadyForProcessing status update. Before it starts processing, the finalize upload patch end-point applies the pre-flight check which validates the following parameters:
1. If the file size in Blob storage does not match the file size submitted, a 404(Not Found - Upload of [SAS] failed) is returned as the status of the request.
2. If file name has invalid characters, a 400(Bad Request) is returned as the status of the request.
3. At least one category must be assigned to the Asset, otherwise a 400(Bad Request) is returned as the status of the request.
4. All required attributes should match, otherwise a 400(Bad Request) is returned as the status of the request.
The PATCH request sends instructions on updating single fields. There can be more than one instruction per request, but each instruction should do something to a single field.
PATCH will not work if the asset is in the Uploading state.
The fields that are accepted for PATCH are:
-
Title
-
Description
-
FileSizeInBytes
-
Filename
-
Status (ReadyForProcessing)
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
Uploads (7)
POST Create Asset Association With Keywords
/uploads/{assetId}/keywords
Associates list of keywords to specified asset.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The asset id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Create Asset Association With Lightbox
/uploads/{assetId}/lightboxes
Add asset to a lightbox.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The asset id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create Asset Attributes
/uploads/{assetId}/attributes
Add attributes to an asset.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The asset id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create Lightbox Association With Asset List
/uploads/lightboxes/{lightboxId}/assets
Add a list of assets to a lightbox.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The lightbox id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
POST Create Upload Association With Lightbox
/uploads/{uploadId}/lightboxesassets
Add uploaded asset to a lightbox.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The upload id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
PATCH Update Lightbox
/uploads/{assetId}/lightboxes/{lightboxId}
Update the lightbox with a list of patch operations.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The asset id. |
|
|
(Required) The lightbox id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Validate Uploads
/uploads/validate
Validate a collection of uploads.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
UserGroups (5)
DELETE Remove Group
/groups/{userGroupId}
Removes the user group and detaches its permissions from the library.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The group id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
GET Retrieve Group Categories
/groups/{userGroupId}/categories
Retrieves list of categories based on the group id.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The group id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Group Details
/groups/{id}
Retrieves group details based on group id.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The group id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Groups
/groups
Retrieves list of groups that belong to the Organizational Unit.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PUT Update Group
/groups/{userGroupId}
Updates user group and gives/revokes permission to the library.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The group id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (9)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Users (18)
POST Create Custom Fields
/public/{domainName}/users/registrationfields
Creates custom fields for a given domain name.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The domain name. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Create Custom Fields
/users/registrationfields
Creates custom fields in the current library.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Create User
/users
Creates a new user in the library.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (24)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create User
/public/{domainName}/users
Creates a a new user for a given domain name.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The domain name. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (24)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Recover Password
/public/users/recoverpassword
Recovers the user password for a given username.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Recover Password
/public/users/recoverpassword/{token}
Defines a new user password.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The token. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
DELETE Remove User
/users/{userId}
Remove the given user id.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The user id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
GET Retrieve Approval Users
/users/approvers
Retrieves the approval users in the library.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Current User
/users/current
Retrieves the user details for the current user in the request.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Current User Permissions
/users/current/permissions
Retrieves the user permission for the current user in the request.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Custom Fields From Library
/users/registrationfields
Retrieves all custom fields from current user's library.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Custom Fields From User
/users/{id}/customfields
Retrieves the collection of custom fields from a given user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The user id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Public Custom Fields
/public/{domainName}/users/registrationfields
Retrieves the public custom fields for a given domain name.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The domain name. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve User
/users/{userId}
Retrieves the user details for a given user id.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The user id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Users
/users
Retrieves a collection of users details belonging to the library.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PATCH Update Current User
/users/current
Update the current user details with a list of patch operations.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PUT Update User
/users/{userId}
Update the user details for a given user id.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The user id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (23)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PATCH Update User1
/users/{userId}
Update the user details for a given user id with a list of patch operations.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
(Required) The user id. |
|
|
(Required) The subscription key of your api plan. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |