The Aprimo API Post Order Data Block (Aprimo_api_post_order) Data Block is not edited. The following details are informational only.
The Aprimo API Post Order Data Block is an API forwarder and describes how to sends a request to an the Aprimo API and creates a request to download the latest version of a file without sending any notifications. The Aprimo API Post Order Data Block is not edited.
- api_fowarder_key: identifies the system or API being targeted.
- method: The request method is
"POST"
. - path: The request is sent to the
"orders"
endpoint. - bodyTemplate: A JSON template for the request body, where placeholders (
"{{recordId}}"
,"{{targetType}}"
) will be replaced with actual values before making the request. The payload is designed to trigger a download operation with certain parameters. - jsonpath_for_data: Specifies that the full response (denoted by
"$"
) will be processed or used.
General Info #
The following table shows the default fields of the Data Block.
Field | Value |
---|---|
Name | Aprimo_api_post_order |
Block Category | Interface |
Block Type | API Call |
Data Category | None |
Output Type | Data Table |
Dependencies #
None
Columns #
None
Example Definition #
{
"api_fowarder_key": "Aprimo",
"method": "POST",
"path": "orders",
"bodyTemplate": "{\"type\":\"download\",\"disableNotification\":true,\"priority\": 1,\"targets\":[{\"recordId\": \"{{recordId}}\",\"targetTypes\":[\"{{targetType}}\"],\"assetType\": \"LatestVersionOfMasterFile\"}]}",
"jsonpath_for_data": "$"
}
Example Request #
None
Example Response #
None