File Retrieval using API

API Endpoint

The Post method should be used when a Digital Asset retrieval is requested considering the metadata information.

Note:

The Get, Delete and Put methods are not valid and hence not supported.

The API endpoint is as follows:

https://environmentname/tenancy/api/DigitalAsset/v1/DigitalAssetSearch

Replace the environmentname with your specific URL information specific to your Service endpoint.

Replace tenancy with the target tenancy (non-prod, pre-prod or prod) within the environment.

Example,

https://futurabank/non-
prod/api/DigitalAsset/v1/DigitalAssetSearch?returnOutputInd=true&returnMetadata=true

Headers

There are several headers that may be required by the methodology utilized to call the Post method on the API. The intention here is to identify those that have special consideration or maybe considered optional for other API calls.

The standard "Content-Type" header should be set to "application/json".
The standard "Authorization" header must be set to "Bearer Token" where Token is the authentication token provided by a call to the OAuth access API. For more information, refer to the Authorization topic.

Request

The body of the post is JSON and must identify the configuration and the data to be used to retrieve the Digital Asset(s). The body may also contain optional elements as described below.

{ 
"DigitalAssetSearchFilters": { 
"SearchConfigUuid": "AA110E0CAD30442088987B3CAA1A22F1", 
"SearchConfigShortName": "Search Config Short Name", 
"SearchConfigName": "Search Config Name", 
"Metadata": [ 
             {
                "Name": "Metadata1", 
                "Value": "1234", 
                "DataType": "String" 
            }, 
            { 
                "Name": "Metadata2", 
                "Value": 123, 
                "DataType": "Number" 
            } 
        ], 
        "MarketingCompanyShortName": "Marketing Company Short name", 
        "DigitalAssetConfigUuid": "AA110E0CAD30442088987B3CAA1A22F1", 
        "DigitalAssetTransactionType": "Communication", 
        "DigitalAssetConfigShortName": "Digital Asset Config Short Name", 
        "DigitalAssetConfigName": "Digital Asset Config Name", 
        "DigitalAssetEffDt": "2025-07-16" 
    } 
}

Parameters

The following inline parameters can be added to the POST request.

returnOutputInd: A Boolean value that when set to true will include the Base64 details of the DigitalAsset in the response.
returnMetadata: A Boolean value that when set to true will return the metadata details that were tagged against the DigitalAsset.

Elements

SearchConfigUuid: A unique identifier for the ‘Search’ configuration record that includes the search and sort configuration details.
SearchConfigShortName: A unique ShortName (max 30 characters) defined for the ‘Search’ configuration record that includes the search and sort configuration details.
SearchConfigName: A unique Name (max 256 characters) defined for the ‘Search’ configuration record that includes the search and sort configuration details.

Note:
‘Search’ is a feature offered by Communication Cloud Service to configure the search and sort definitions. At least one of SearchConfigUuid or SearchConfigShortName or SearchConfigName is required.
Metadata: This element is of type array which can be utilized by a consuming service to provide data that includes ‘Name’, ‘Value’ and ‘DataType’ required to search and retrieve the DigitalAsset(s).
MarketingCompanyShortName: The Marketing Company Short Name is the name of the Marketing Company whose DigitalAsset Configuration should be used.
DigitalAssetTransactionType: Used to identify the specific DigitalAsset Configuration for the DigitalAsset. Allowed value is “Communication”.
DigitalAssetConfigUuid: The UUID of the DigitalAsset Configuration to use with this execution. A UUID is a unique identifier the Service attaches to every configuration when created and is often returned in other API responses. The Configuration holds the settings that control what additional metadata has been tagged against the storing DigitalAsset.
DigitalAssetConfigShortName: A unique ShortName (max 30 characters) defined for the ‘DigitalAsset’ configuration record that includes the search and sort configuration details.
DigitalAssetConfigName: A unique Name (max 256 characters) defined for the ‘DigitalAsset’ configuration record that includes the search and sort configuration details.

Note:
Note: The decision to use a MarketingCompanyShortName & DigitalAssetTransactionType or DigitalAssetConfigUuid or DigitalAssetConfigShortName or DigitalAssetConfigName will depend on the use case being implemented.
DigitalAssetEffDt: Reserved for future implementation.

Response

The response will return an appropriate status code (201, 404, etc.) but will also include a body that contains additional information as shown below that may be useful to the client.

{ 
    "DigitalAssetSearchResults": [ 
        { 
            "DigitalAsset": { 
                "ShortName": "Digital Asset Short Name", 
                "Name": "Digital Asset Name", 
                "Desc": "Digital Asset Description", 
                "StatusCode": "Active", 
                "EffDtTm": "2025-07-16", 
                "DigitalAssetConfigUuid": "002F5CBF2811434586D8499DE5F48D10", 
                "DigitalAssetUuid": "AA110E0CAD30442088987B3CAA1A22F1", 
                "Metadata": [ 
                    { 
                        "Name": "Metadata1", 
                        "Value": "1234", 
                        "DataType": "String" 
                    }, 
                    { 
                        "Name": "Metadata2", 
                        "Value": 123, 
                        "DataType": "Number" 
                    } 
                ], 
                "FileContentBase64": "JVBERi0xLjcKJeLjz9MKMjcgMCBvYm..." 
            } 
        } 
    ] 
}

Elements

DigitalAssetSearchResults: The array type element that returns single or multiple DigitalAsset(s) that meets the request.
DigitalAsset: The object type element that returns the information about the retrieved DigitalAsset like ShortName, Name, Description etc.
Metadata: This element is of type array which can be utilized by a consuming service to render the additional information about the retrieved DigitalAsset.
FileContentBase64: This will hold the base64 details of the retrieved DigitalAsset.