AMI resource type is used to submit AMI requests to AMS system. Currently AMI Bulk (POST) to create/update assets on AMS and AMI Delete (DELETE) to delete an asset on AMS are supported. AMI Get request to query for the asset eTag is also available.
PROPERTIES
| Name |
AMI |
| System ID |
AM |
| Connection String |
|
| Heartbeat Connection String |
|
SUPPORTED NODE
DEFINITIONS
* Indicates the message has been deprecated.
Please use the replacement message(s) instead.
NODE DEFINITION
DETAILS
Adds eTag attribute to each asset in the metadata for an Update using Bulk Submit
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| assetEtags |
NO |
String containing asset etags delimited by a colon |
| assetUriIds |
NO |
string containing all asset URI Ids delimited by a colon |
| metadataFilePath |
NO |
Metadata file path to process |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
| success |
|
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| assetEtags |
NO |
The Etags of the asset represented by the URI |
| assetUris |
NO |
The URI Ids of the asset to be deleted. |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
| responseCode |
Response code returned from the server |
The Bulk Submit message is used to send AMI Bulk (POST) request to an AMS implementing the AMI interface. This message will create/update assets defined in the outgoing metadata.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| assetUriIdsToUpdate |
NO |
A string of all the asset uri Ids separated by a colon delimiter which is used to update the metadata |
| assetEtagsToUpdate |
NO |
A string of all the Etags from the response separated by a colon delimiter which is used to update the metadata |
| metadataFilePath |
NO |
Complete path to the metadata file that should be posted to the AMS. |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
| assetUriIds |
A string of all the asset uri Ids separated by a colon delimiter |
| assetEtags |
A string of all the Etags from the response separated by a colon delimiter |
| responseCode |
return the response code for the request |
| success |
|
modify metadata and create or update in mdms
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| toBeDeletedAssetUriIds |
NO |
|
| toBeDeletedEtags |
NO |
|
| remainingAssetUriIds |
NO |
|
| remainingEtags |
NO |
|
| metadataFilePath |
NO |
|
| mdmsEtagsOriginal |
NO |
|
| assetListToDeleteBeforeUpdate |
NO |
|
| metaAssetUriIds |
NO |
|
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
| responseCode |
|
| insertEtagSuccess |
|
| i |
|
| success |
|
| mdmsEtags |
|
| mdmsAssetUriIds |
|
| errorMessage |
|
Sends a REST (DELETE) call to the AMS to request deletion of the specified asset
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| assetEtag |
NO |
The Etag of the asset represented by the URI |
| assetUri |
NO |
The URI Id of the asset to be deleted. |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
| deleted |
|
| responseCode |
Response code returned from the server |
Makes a REST (GET) call to the AMS and extracts the 'ETag'.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| assetUriId |
NO |
The URI Id of the asset |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
| assetEtag |
The eTag of the asset |
| responseCode |
The response code from the server |
Get asset eTag list basing on asset Uri.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| assetUriIds |
NO |
The Uri Id list which is retrieved from CL30 metadata. |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
| eTagList |
The eTag list. |
Makes a REST (GET) call to the AMS and extracts the 'ETag' header field value.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| assetUri |
NO |
The URI Id of the asset |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
| eTag |
The Etag of the asset represented by the URI |
Get all asset URIs by metadata file path.
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| metadataFilePath |
NO |
|
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
| success |
|
| assetUriIds |
|
sort the given asset Uris and asset Etags to 2 groups according to the asset types that are configured to be deleted
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| assetUris |
NO |
Uris of all the assets |
| assetEtags |
NO |
eTags of all the assets |
| assetTypesToDelete |
NO |
Asset Types that are configured to delete |
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
| assetUristoDelete |
Uirs of asset that are to be deleted |
| assetEtagstoDelete |
Etags of assets that are to be deleted |
| assetUristoReserve |
Uris of assets that are to be reserved |
| assetEtagstoReserve |
Etags of assets that are to be reserved |
Sort Asset Uri Id according to MDMS asset purge constrains
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| assetUriIds |
NO |
|
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
| sortedAssetUriIdList |
|
| sortedAssetTypeList |
|
Validate the xml file based on the CL 3.0 schema
REQUEST MESSAGE:
| Parameter Name |
Blank Value Allowed? |
Description / Value |
| metadataXmlFile |
NO |
|
RESPONSE MESSAGE:
| Parameter Name |
Description / Value |
| isValid |
|
| errMsg |
|
| validationErrors |
List of validation errors |
| © 2002 - 2021 Ericsson Television Inc. |
| All Rights Reserved. |