Reltio Generic Execute

Overview

The Reltio Generic Execute Snap allows you to perform Read, Write, Update, and Delete operations upon objects in the specified Reltio tenant by executing REST APIs (GET, PUT, POST, and DELETE).

The API key that you specify in the Account settings determines the API calls that you can make.

This is a Write-type Snap.
Works in Ultra Tasks

Prerequisites

A Reltio account with a valid Tenant ID so that the Tenant URL can be formed/API for Account settings.
The Reltio account must have appropriate read and write access to create objects in the Tenant.

Limitations

You cannot roll back the productized Reltio Snap Pack in 4.20 to a prior version.

Snap views


Type	Description	Examples of upstream and downstream Snaps
Input	This Snap has at most one document input view. Min: 0 Max: 1	JSON Generator JSON Formatter
Output	This Snap has exactly one document output view. Min: 1 Max: 1	Mapper Copy
Learn more about Error handling.

Snap settings

Note: Learn about the common controls in the Snap settings dialog.


Field/Field set	Description
Label `String`	Specify a unique name for the Snap. Modify this to be more appropriate, especially if more than one of the same Snaps is in the pipeline. Default value: Reltio Generic Execute
Service URL* `String`	Specify the service URL. The format to be followed: For performing an operation on all objects of an object type: `https://www.reltio.com/tenant_id/object_type` For performing an operation on a specific object in an object type: `https://www.reltio.com/tenant_id/object_type/object_id` For performing an operation on crosswalks related to an object: `https://www.reltio.com/tenant_id/object_type/entity_id/crosswalks` Default value: {tenantUrl}/{serviceUri} Example: {tenantUrl}/{serviceUri}
HTTP Method* `Dropdown list`	Select the type of HTTP request. Get Post Put Delete Default value: Get Example: Post
HTTP Request Body `String`	Specify the HTTP body of the request. Relevant to POST request. Note: You can provide this value dynamically as a Pipeline parameter and upstream parameter or directly in the Snap. Default value: N/A
Query parameters	Use this field set to define query parameters and their values. The query parameters are attached to the URL using the HTTP query parameter syntax, separated by & and added as 'key=value'. Note: You can provide the parameters dynamically as Pipeline parameters or directly in the Snap, but not as upstream values.
Query parameter `String`	Specify the name of the query parameter to pass in the API. Default value: N/A Example: type
Query parameter value `String`	Specify the value for the specified query parameter. Default value: N/A Example: reltio
Raw data `Checkbox`	Select this checkbox to write the HTTP response content to the output view as it is. If you deselect this checkbox, the data is parsed according to content type. Default value: Deselected
Empty Responses as Separate Documents `Checkbox`	Select this checkbox to write all responses into separate output documents in the same order as they appear in the request body. Deselect this checkbox to group all empty responses into one output document. Note: When you fetch multiple entities with POST {TenantURL}/entities/_byUris, the non-existing entities result in empty-string responses. Default value: Deselected
Retry limit `Integer`	Specify the maximum number of attempts to get the response. Minimum value: 1 Maximum value: 10 Default value: 5 Example: 3
Snap execution `Dropdown list`	Choose one of the three modes in which the Snap executes. Available options are: `Validate & Execute`. Performs limited execution of the Snap and generates a data preview during pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during pipeline runtime. `Execute only`. Performs full execution of the Snap during pipeline execution without generating preview data. `Disabled`. Disables the Snap and all Snaps that are downstream from it. Default value: `Execute only` Example: `Validate & Execute`

Troubleshooting


Error	Reason	Resolution
`errorCode: 543` When you configure the Reltio OAuth2 Account for the Reltio Generic Execute Snap, it fails due to invalid input.	The user does not have a valid email ID to export data.	To resolve this issue, specify an email parameter in the Query parameters and retry the execution. The pipeline should run successfully.