PROPERTIES
| Name | content-management-additional |
| System ID | MA |
| Connection String | |
| Heartbeat Connection String |
SUPPORTED NODE
DEFINITIONS
* Indicates the message has been deprecated. Please use the replacement message(s) instead.
NODE DEFINITION
DETAILS
Add asset with updating specific fields.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | |
| assetType | NO | |
| parentAssetId | NO | |
| derivedAssetId | NO | |
| derivedProviderId | NO | |
| field1 | NO | |
| field2 | NO | |
| field3 | NO | |
| field4 | NO | |
| field5 | NO | |
| field6 | NO | |
| field7 | NO | |
| field8 | NO | |
| field9 | NO | |
| field10 | NO | |
| value1 | NO | |
| value2 | NO | |
| value3 | NO | |
| value4 | NO | |
| value5 | NO | |
| value6 | NO | |
| value7 | NO | |
| value8 | NO | |
| value9 | NO | |
| value10 | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| assetId |
Add property to hazelcast cache, if the cache exists originally, the cache value will be updated directly.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| name | NO | |
| value | NO | |
| titleId | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | The ID of the title to be analysed. |
| lastDistOffers | NO | A string in the format of "MF Title ID1:Offer ID1;MF Title ID2:Offer ID2;" containing all the Offer ids that is distributed successfully last time. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| offersToExpire | A string in the format of "MF Title ID1:Offer ID1;MF Title ID2:Offer ID2;" containing all the OfferIds to expire. |
Append items into list in title property, use CAS and retry (pair with 01MA57). This message can specify the items could be duplicate or not.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | @Required The title id to append items into it's property. |
| itemsToAppend | NO | @Required Items to append to the specified title's property |
| delimiter | NO | The delimiter to seperate the list, "," as default. |
| propertyName | NO | @Required The title property name. |
| allowDuplicate | NO | @Required The flag to specified if values in the title property could be duplicate or not. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
Asset ids transition between db ids and field ids.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | |
| assetDbIdList | NO | |
| fieldIdentifierIdList | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| outIdList1 | |
| outIdList2 |
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | Master title id of the parent title |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
Create Simple Title
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| providerId | NO | Provider id |
| packageAssetId | NO | Package asset id |
| titleAssetId | NO | Package asset id |
| movieAssetId | NO | Movie asset id |
| previewAssetId | NO | Preview asset id |
| encryptedAssetId | NO | Encrypted asset id |
| posterAssetId | NO | Poster asset id |
| bocoverAssetId | NO | Bocover asset id |
| contentClassName | NO | Content Class name |
| createBoxcoverAsset | NO | |
| createEncryptyAsset | NO | |
| createMovieAsset | NO | |
| createPosterAsset | NO | |
| createPreviewAsset | NO | |
| createTtileAsset | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| titleId |
Delete Title Content Files (01MA13) [DEPRECATED]
Delete title content files by title id.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
Filter assets with checksum mismatch.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | |
| mtOutput | NO | |
| allAssetIdList | NO | |
| validationVersionList | NO | |
| mismatchedAssetIdList | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| remainingAssetIdList |
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| lastDistOffers | NO | |
| titleId | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| newLastDistOffers |
Generate metadata with lookup keys.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| assetLookupKeys | NO | |
| assetLookupKeyType | NO | |
| outputMetadataFilePath | NO | |
| spec | NO | |
| titleId | NO | |
| assetContentKeptLookupKeys | NO | @param isRemoveContentInMetadata : |
| assetContentKeptLookupKeyType | NO | |
| removeCustomFieldsProfile | NO | |
| refTitleList | NO | The latest reference title list which should be included in the output metadata file. This parameter only workable for offer title. |
| isRefTitleEmpty | NO | Indecates whether the refTitleList is empty or not. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| isCurrentVersion | |
| version | |
| result |
Generate string by pattern.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | |
| assetId | NO | |
| parentAssetId | NO | |
| pattern1 | NO | |
| pattern2 | NO | |
| pattern3 | NO | |
| pattern4 | NO | |
| pattern5 | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| result1 | |
| result2 | |
| result3 | |
| result4 | |
| result5 |
Find those files need to do QC
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| originalFileUri | NO | Original File URI |
| orgFilePrefix | NO | The Original File Prefix |
| regexFilter | NO | The regex filter |
| newFilePrefix | NO | The new file prefix |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| qcFileList | A list of QC file |
Get the distribution status and reset it.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | |
| currentSteps | NO | |
| currentStepMethods | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| lastDistributedStepsList | |
| lastDistributedStepsStatusList |
Get distribution asset id list via distribution options.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| updateAssetIdList | NO | |
| assetId | NO | |
| oldAssetIdDistributionList | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| needDistribution | |
| newAssetIdDistributionList |
Get asset expected version.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | |
| assetId | NO | |
| versionType | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| assetVersion |
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | @Required The id of the title. |
| separator | NO | The separator used for the input and output parameters in the message. |
| fieldXpaths | NO | The field xpaths of the target asset. It represents custom field when a xpath start with "#" |
| fieldValues | NO | The field values of the target asset. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| assetDbIds | The asset db ids of the target assets. |
Get asset id list by lookup key.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| lookupKeyType | NO | |
| lookupKey | NO | |
| titleId | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| assetIdList |
Get asset id list by platform key.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| platformKey | NO | |
| titleId | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| assetIdList |
Get asset id list with content file in original directory.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | |
| originDir | NO | |
| isIncludeEncrypted | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| assetIdList |
Get asset id list with content file.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| isIncludeEncrypted | NO | Identify whether to include Encrypt Asset |
| titleId | NO | Identify to retrieve assets of a specified title |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| assetIdList | Assets have file registered |
Get asset id list with version changed.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| assetIdList | |
| firstTimeProcess | |
| titleChanged |
Get asset id list without content file.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | |
| isIncludeEncrypted | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| assetIdList |
Get lookup key respresentation of the asset specified by parameter assetId
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | |
| assetId | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| lookupKey | The lookupKey which represents the asset specified by parameter assetId |
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | |
| assetId | NO | |
| fieldXpath | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| values |
Get the reprocess status for asset during content processing.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | @Required The title id. |
| assetId | NO | @Required The asset DB id. |
| platform | NO | @Required The platform of the derived asset. |
| completedFieldName | NO | The completed field name of the derived asset, default is "Processing_Complete" |
| checkUpdatedDerivedAsset | NO | Determine whether to check the title property "UPDATED_DERIVED_ASSETS" |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| result | Indicate whether the asset needs to reprocess. |
Get the asset whether need to reprocess for distribution.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | |
| assetId | NO | |
| lastDistributeStatus | NO | |
| distPropertyName | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| isReprocess |
Get asset version.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | |
| assetId | NO | |
| versionType | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| assetVersion |
Get asset id and its checksum in pairs form the asset id list.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | |
| dbAssetIdsList | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| assetIdChecksumPairs | @param assetChecksumList : |
Get category changed detail between property and metadata
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| offerId | NO | cms offer id |
| siteId | NO | cms site id |
| mfSubscriptionId | NO | MediaFirst subscription id |
| mfSubscriptionName | NO | MediaFrist subscription name |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| categoryToAddList | categories to add |
| categoryToRemoveList | categories to remove |
| categoryToAddTitleList | a list of titleId for titles where there are changed categories need to be re-added |
| categoryToRemoveTitleList | a list of titleId for titles where there are changed category need to be removed. |
Get custom fields by title id.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| assetIdsAndCustomFieldsJsonString |
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | @Required the title id |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| dependencySiteTitleIdList | the dependency site title id list of the input title |
Returns the distributed asset id list which stores in the title property "DISTRIBUTED_ASSETS"
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| assetIds | the asset id list which includes in the distributed property |
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | title id |
| assetId | NO | asset db id |
| pattern | NO | xpath pattern |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| result | result list, item format: 'ttvXpath:value' |
Get the name of the file by rename pattern.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | |
| assetId | NO | |
| transcodeFileRenamePattern | NO | |
| currentFileName | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| renamedFileName |
Get the generated asset of another asset, platform name should be specific
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | |
| parentAssetId | NO | |
| platform | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| assetIdList |
Check if the previous asset process is completed.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| separator | NO | The separator of the platforms. |
| assetId | NO | @Required The id of the source asset. |
| platforms | NO | @Required The platforms of the derived assets. |
| titleId | NO | @Required The id of the title. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| isLastAssetProcessCompleted | Indicates whether the last asset process is completed. true or false. |
Get JSON data from metadata, user able to configure which asset fields are required to retrieve
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | The title id |
| configPath | NO | The asseet and field mapping configuration path. The configuration defines which asset and fields are required to retieve |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| jsonData | The JSON data store the asset field values. |
Get latest historical file id.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | The Title Id |
| assetId | NO | The asset Id |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| latestHistoricalFileId | Return the latest historical file id |
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| cmsTitleId | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| mfTitleId |
Get persons(participant) in the metadata.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | The id of the title. |
| assetId | NO | The id of the title asset. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| metadataPersons | The participant in the metadata. |
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | The id of the title. |
| assetId | NO | The id of the title asset. |
| separator | NO | The separator to separate the xpath values. |
| parentXpath | NO | |
| columnFieldXpath1 | NO | The first desired xpath. |
| columnFieldXpath10 | NO | The tenth desired xpath. |
| columnFieldXpath2 | NO | The second desired xpath. |
| columnFieldXpath3 | NO | The third desired xpath. |
| columnFieldXpath4 | NO | The fourth xpath four. |
| columnFieldXpath5 | NO | The fifth desired xpath. |
| columnFieldXpath6 | NO | The sixth desired xpath. |
| columnFieldXpath7 | NO | The seventh desired xpath. |
| columnFieldXpath8 | NO | The eighth desired xpath. |
| columnFieldXpath9 | NO | The ninth desired xpath. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| fieldValuesPerRow | The value list where every single element is row data separated with {separator}. |
search the parent asset id by search the source aset id
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | |
| assetId | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| parentAssetId |
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| name | NO | |
| titleId | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| result |
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| seriesId | NO | the series id of the episode |
| titleId | NO | @Required the title id |
| toRemoveCategoryIdList | NO | the list of the storefront category id that are ready to be removed |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| finalToRemoveCategoryIdList | the list of the storefront category id that will be removed |
Get category names under storefront from metadata.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| assetId | NO | The id of the title asset |
| titleId | NO | The id of the title. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| storefrontCategoryNames | The category names under storefront for title. |
Get subscription category names according to specific subscription name for title
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| subscriptionName | NO | The name of current subscription |
| titleId | NO | The id of the reference title |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| categoryNames | The category names under specific subscription for title. |
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | title Id |
| assetId | NO | asset Id |
| fieldXpath | NO | field xPath like "/Fields/Categories/Category" |
| separator | NO | a delimiter to join category columns to a row default to be ";" |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| tableBody | table body rows joined by separator like ["Category1;Domain1;Market1", "Category2;Domain2;Market2", "Category3;;Market3"] |
| tableHead | table head list like ["/Fields/Categories/Category/Text", "/Fields/Categories/Category/Domain", "/Fields/Categories/Category/Market"] |
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | Title DB id |
| mfSubscriptionId | NO | MF subscription id |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| seriesId | MF series id |
| categoryIds | MF category ids |
| isTVShow | is TV Show or not |
Check whether all the content files are presented for all assets in the title
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | |
| includeAllAssets | NO | @param isCompleted : @param allAssets : @param isCompleted : |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| isCompleted | @param allAssets : @param isCompleted : |
Get Title Latest Revision
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | Title Id |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| latestRevision | Latest revision of title |
Get whether the title is ready for processing.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | |
| isIncludeEncrypted | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| isReady |
Get title spec identifers by title Id
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| specAlias | NO | |
| useDefault | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| identifierMetadataXpaths | Title identifier xpaths list for metadata file. |
| identifierTtvXpaths | Title identifier ttv xpath. |
Get the DB Asset Id via the asset metadata asset Id.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | package title Id |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| dbAssetIds | The database asset ids |
Get updated asset id list by distribution mode after distribution.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | |
| mode | NO | |
| propertyNamePrefix | NO | Property name prefix. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| assetIdList |
Handle checksum validation properties.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | |
| checksumMismatchLevel | NO | |
| allAssetIdList | NO | |
| mismatchedAssetIdList | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| latestValidationVersionList |
Handle metadata validation properties.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | |
| validationResultLevel | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| latestValidationVersion |
Get the asset id list filter the zero byte content file.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| isIncludeEncrypted | NO | |
| originDir | NO | |
| titleId | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| assetIdList |
Increase asset expected version.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | |
| assetId | NO | |
| versionType | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| newAssetVersion |
Increase asset version.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | |
| assetId | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| newAssetVersion |
Merge and set distribution detail.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | |
| step | NO | |
| assetDistributionDetail | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
Normalize asset checksum by title id.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| siteTitleId | NO | |
| masterTitleId | NO | master title id of site title |
| purgeResult | NO | purge result of site title SUCCESS/FAILURE |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
Notify Waiting Node (01MA28) [DEPRECATED]
Such message is used to trigger a notification message which with "task-complete" command.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| completeState | NO | |
| parentWorkOrderTokenIds | NO | @param completeState : |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
Register purge notification.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | Master title id for getting all its site titles |
| maxWaitThresold | NO | |
| isSiteTitle | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
Remove assets by asset id list.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | |
| assetIdList | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| result | |
| removeFilePaths |
Remove Content Files by Platform Keys
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | titleId |
| platformKeys | NO | platform key string split by comma "," like "MOVIE-CBR,MOVIE-ABR" |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| result | indicate whether it is successful or not. |
Remove Generated Assets by some indicator
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | |
| removeEncryptedAssets | NO | |
| removeEncryptedAssetsMethod | NO | |
| isDeleteFiles | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
Remove items from list in title property, use CAS and retry(pair 01MA56).
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| delimiter | NO | The delimiter to seperate the list, "," as default. |
| titleId | NO | @Required The title to remove items from its property. |
| propertyName | NO | @Required The title property name. |
| itemsToRemove | NO | @Required Items to remove from title property. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| name | NO | |
| titleId | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| remove_success |
Reset encrypted asset fields.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
Reset metadata custom field values.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | |
| assetIds | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| result |
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| assetDirectoryMapping | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| assetIdList | |
| directoryList | |
| assetFileList |
Return only the parent assets which specified in the parameter assetIds.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | title id |
| assetIds | NO | a list of asset ids |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| parentAssetIds | the list which only contains parent assets |
Resolve validation messages.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| messages | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| level |
Restore custom fields.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| assetIdsAndCustomFieldsJsonString | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | The title id |
| assetId | NO | The Asset id (store as database id) |
| filePath | NO | The file path of content evaluation result |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
Save the value to metadata with base64 decode first. It represents custom field when a xpath start with "#"
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| assetId | NO | @Required The asset id to save metadata |
| titleId | NO | @Required The title id to save |
| fieldXpath | NO | @Required The xpath of the target field. It represents custom field when a xpath start with "#" |
| value | NO | The value would be base64 decode first then save to the title |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
Save asset id list and its checksum list in pair.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| propertyNamePrefix | NO | Property name prefix. |
| assetIdList | NO | |
| assetIdChecksumPairs | NO | |
| titleId | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| filePath | NO | The path of content evaluation result |
| fieldXpaths | NO | The List of field xpath |
| fieldValues | NO | The List of field value |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
Save current process version.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
Save SeriesId and MatchStatus to property and metadata
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | Title Id |
| mfSeriesId | NO | MF series Id get from MF API |
| mfMatchStatus | NO | MF match status from MF API |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
Search title assets info by provider id and content uri.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| providerId | NO | |
| contentUri | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| matchingCount | |
| titleLongAssetIds | @param assetIds : |
| titleDbAssetIds | @param matchingCount : |
| titleIds |
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | |
| assetId | NO | |
| values | NO | |
| fieldName | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
Set asset expected version.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | |
| assetId | NO | |
| newAssetVersion | NO | |
| versionType | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
Set asset version.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | |
| assetId | NO | |
| newAssetVersion | NO | |
| versionType | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
Set values into according fields for the Offer Title.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | @Required The ID of the Offer Title to write the metadata values. |
| fieldsList | NO | @Required List to store offer fields that are going to be set values. |
| valuesList | NO | @Required The values to be set into the according fields of the Offer Title. |
| assetTypesList | NO | @Required The list of the asset types to write the metadata values. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
Set Title Participants.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | title Id |
| assetId | NO | asset Id |
| personList | NO | person name list like ["Eduardo Jones", "chris phillips"] |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
Set the asset type to movie or preview for encrypted asset. If the encrypted asset is generated for movie asset, then set its asset type to movie if the encrypted asset is generated for preview asset, then set its asset type to preview
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| metadataFilePath | NO | CL_3. 0 metadata path |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| result |
Update distributed asset content tag
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| updatedAssetIDChecksum | NO | asset ID and checksum paris of updated asset |
| distributedAssetIDChecksum | NO | asset ID and checksum pairs of distributed asset |
| assetID | NO | @param updatedAssetIDChecksum : asset ID and checksum paris of updated asset |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| updatedDistributedAssetIDChecksum | update asset ID and checksum pairs |
| checksumUpdated | true if checksum is updated, otherwise false |
Update distribution version.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
Update Metadata by Configuration
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| titleId | NO | Title id |
| configPath | NO | The file path of configration which define the mapping of asset and fields |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
Update Metadata with JSON data which store the title id , asset id and corresponding field path/value
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| jsonData | NO | The JSON data String |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
Update multiple value field
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| fieldXpath | NO | @Required The xpath of the multiple value field to be updated |
| rowIndex | NO | @Required The row index indicate the value in which row |
| titleId | NO | @Required the title to be updated |
| assetId | NO | @Required the asset to be updated |
| values | NO | The value list for the field |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| error-message |
Validate the checksums of the asset id list.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| assetIdList | NO | |
| titleId | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| mismatchedAssetIds |
Wait for purge site titles complete.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| masterTitleId | NO | The master title Id |
| interval | NO | An interval to check site titles (seconds) |
| timeout | NO | Timeout in specified (seconds) |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| isTimeout | To indicate the message whether timeout or not |
Such node will be blocked until retrieving notification message.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| completeState |
| © 2002 - 2023 Ericsson Television Inc. |
| All Rights Reserved. |