AMI Resource Type

[ami] 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	null
Heartbeat Connection String	null

SUPPORTED NODE DEFINITIONS

Message UID	Node Definition Name
01AM04	Add Asset eTag Attr to Metadata
01AM01	Bulk Submit
01AM03	Delete Asset
01AM05	Get Asset eTag Attr
01AM02	Get Asset eTag
01AM07	Get Uris
01AM08	Sort Asset Uri Ids
01AM06	Validate XML

* The message has been deprecated. Please use the replacement message(s) instead.

NODE DEFINITION DETAILS

Add Asset eTag Attr to Metadata (01AM04)

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

Bulk Submit (01AM01)

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
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

Delete Asset (01AM03)

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

Get Asset eTag Attr (01AM05)

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 (01AM02)

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 Uris (01AM07)

REQUEST MESSAGE:

Parameter Name	Blank Value Allowed?	Description / Value
metadataFilePath	NO

RESPONSE MESSAGE:

Parameter Name	Description / Value
success
assetUriIds

Sort Asset Uri Ids (01AM08)

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 XML (01AM06)

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