In this article

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. 

Prerequisites

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

Support for Ultra Pipelines  

Works in Ultra Pipelines. 

Limitations and Known Issues

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

Snap Input and Output

Input/OutputType of ViewNumber of viewsExamples of upstream/downstream Snaps
InputDocument
Min: 0
Max: 1
  • JSON Generator
  • JSON Formatter
OutputDocument
Min: 1
Max: 1
  • Mapper 
  • Copy


Snap Settings


FieldField TypeDescription
Label*StringSpecify the name for the Snap. Modify this to be more specific, especially if there are more than one of the same Snap in the Pipeline.
Service URL*String

Specify the service URL in the format: .

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 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 BodyString

Specify the HTTP body of the request. Relevant to post request.

You can provide this value dynamically as a Pipeline parameter and upstream parameter or directly in the Snap.

Default Value: [None] 

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'.

You can provide the parameters dynamically as Pipeline parameters or directly in the Snap, but not as upstream values.


Query parameterString

Specify the name of the query parameter to pass in the API.

Default Value: [None]
Example: type

Query parameter valueString

Specify the value for the specified query parameter.

Default Value: [None]
Example: reltio

Raw data

Empty Responses as Separate Documents


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

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.

When you fetch multiple entities with POST {TenantURL}/entities/_byUris, the non-existing entities result in empty-string responses.

Default Value: Deselected


Empty Responses as Separate DocumentsCheckbox

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.

When you fetch multiple entities with POST {TenantURL}/entities/_byUris, the non-existing entities result in empty-string responses.

Default Value: Deselected

Retry limitInteger

Specify the maximum number of attempts to get the response. 
Minimum value: 1
Maximum value: 10

Default Value: 5

Snap Execution

Dropdown list


Examples

GET

The Pipelines below demonstrates how the Reltio Generic Execute Snap can be used to read Reltio objects and Crosswalks. Based on the Snap's configuration you can either read one or all objects of a type. All four pipelines are included in one file and can be downloaded from the Downloads section below.

This pipeline shows how all entities can be read from the specified tenant URL and the data sent downstream for further processing. The pipeline is as shown below:

The Reltio Generic Execute Snap is configured as shown below: 

 

An output preview of of the Snap's execution is as shown below, it lists details of all the entities in the tenant:


To retrieve details of a specific entity, the Service URL property will have to be configured to include the entity ID in question. The pipeline is as shown below:

The Reltio Generic Execute Snap is configured as shown in the screenshot below, the configuration is the same as that in the above example with the only difference being that the Service URL includes the entity ID.

An output preview of of the Snap's execution is as shown below, it lists details of the specified entity:


This pipeline demonstrates the Reltio Generic Execute Snap accepting Pipeline Parameters:

 

The Pipeline Parameter is configured as shown below:

The Reltio Generic Execute Snap is configured as shown below, the value for the Service URL property is passed as a Pipeline Parameter:

 

An output preview of of the Snap's execution is as shown below, it lists details of the specified entity:


The same Pipeline shown in the example above can be modified to show crosswalk data for a specified entity. This is demonstrated in the Pipeline below:

The Reltio Generic Execute Snap is configured as shown in the screenshot below:

An output preview of of the Snap's execution is as shown below, it lists details of the crosswalks related to the specified entity:


Downloads