Aprimoconnector v1.0 | OneTeg Documentation

Version 1.0

Connector Overview: This page documents all 12 actions for the Aprimoconnector v1.0.

Download

GET Download Asset

x-oneteg-downloader-path-without-authorization

Downloads an asset from a specified URL. Use this action to retrieve a file or asset from an external source.

Parameters

Parameter Name	Description
`HTTP Method`	The HTTP method to use for the download request, such as GET.
`Download Url`	The URL of the asset to download.
`Asset Name`	The name to assign to the downloaded asset.
`Try Count`	The number of retry attempts if the download fails.
`Read Timeout (seconds)`	The maximum time in seconds to wait for data to be read.
`Connection Timeout (seconds)`	The maximum time in seconds to establish a connection.
`Load File Content As Output`	This toggle enables you to load file content as the step output. Supported formats include JSON, XML, YML/YAML, CSV, TXT, and other text-based file types. Note that images, PDF files, and other binary formats cannot be loaded. Additionally, there is a file size limit for this feature; please check the logs for details.
`Follow Redirects`	Enable or disable following URL redirects. If it is enabled, it will follow the URL redirects.
`headers`	Additional HTTP header name/value pairs to include in the request.

Records (11)

POST (OAuth2) Client Creds Auth Copy

/.aprimo.com/login/connect/token

Authenticates using OAuth2 client credentials grant type to obtain an access token. Use this action to authorize API requests.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Grant Type`	The OAuth2 grant type, typically 'client_credentials'.
`Scope`	The scope of the access token, defining the permissions requested.
`Client Id`	The client identifier provided by the authentication server.
`Client Secret`	The client secret associated with the client identifier.

DELETE Delete Single Record

/api/core/record/{recordID}

Permanently deletes a single record identified by its ID. Use this action to remove a record from the system.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Api-version`	The API version to use for the request, specified as an integer.
`Recordid`	The unique identifier of the record to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

GET GET All Records

/api/core/records

Retrieves a list of all records with optional pagination. Use this action to fetch multiple records at once.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Api-version`	The API version to use for the request.
`Pagesize`	The number of records to include per page.
`Page`	The page number to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

GET GET Field Definitions

/api/core/fielddefinitions

Retrieves the field definitions for records. Use this action to understand the available fields and their properties.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Api-version`	The API version to use for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

GET GET Single Record

/api/core/record/{recordID}

Retrieves a single record by its ID, with options to select specific record or master file version. Use this action to fetch detailed information about a record.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Api-version`	The API version to use for the request.
`Select-record`	Specifies which record to select, if applicable.
`Select-masterfilelatestversion`	Specifies whether to select the latest version of the master file.
`Recordid`	The unique identifier of the record to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

GET GET Single Record All Fields

/api/core/record/{recordID}/fields

Retrieves all fields of a single record identified by its ID. Use this action to get the complete field data for a record.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Api-version`	The API version to use for the request.
`Recordid`	The unique identifier of the record.
`Response Type`	The response format expected from the API (e.g. application/json).

POST POST Create Record

/api/core/records

Creates a new record in the system. Use this action to add a new record with the provided data.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Api-version`	The API version to use for the request.
`Accept`	The media type expected in the response, such as 'application/json'.
`Response Type`	The response format expected from the API (e.g. application/json).

POST POST Public CDN Order Copy

/api/core/orders

Creates a public CDN order copy request. Use this action to initiate a copy operation for a CDN order.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	The media type expected in the response.
`Api-version`	The API version to use for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Type`	The type of order copy to create.

POST POST Upload File

/api/core/uploads

Uploads a file to the system. Use this action to upload a file that can be associated with records.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Api-version`	The API version to use for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	The binaries of the file

PUT PUT Edit Record Field Value

/api/core/record/{recordID}

To see a full list of possible options with making a PUT Edit request of a record see the following DAM documentation: https://training3.dam.aprimo.com/api/core/docs/resources/record#example-edit

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Api-version`	The API version to use for the request.
`Recordid`	The unique identifier of the record to update.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Search Record

/api/core/search/records

Searches for records based on a search query. Use this action to find records matching specified criteria.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Api-version`	The API version to use for the request.
`Accept`	The media type expected in the response.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Logrequest`	A boolean flag indicating whether to log the search request.