On this Page
Table of Contents | ||||
---|---|---|---|---|
|
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). Which API calls you can make are based on the API key specified in the Account settings.
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.
Configuring Accounts
This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See Configuring Reltio Accounts for information on setting up this type of account.
Configuring Views
Input | This Snap has at most one document input view. |
---|---|
Output | This Snap has exactly one document output view. |
Error | This Snap has at most one document error view. |
Support
- Works in Ultra Task Pipelines.
Limitations and Known Issues
- You cannot roll back the productized Reltio Snap Pack in 4.20 to a prior version.
Snap Settings
Label | Required. 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 | Required. 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: [None] Example: | ||||||||||||||
HTTP Method | Required. Type of HTTP request. For ex, GET or POST (required)
Default value: Get Example: Post | ||||||||||||||
HTTP Request Body | Specifies the HTTP body of the request. Relevant to post request. Default value: [None] This value can be provided dynamically as a pipeline parameter and upstream parameter or directly in the Snap | ||||||||||||||
Query parameters | Define query parameters and their values. The query parameters will be attached to the URL using the HTTP query parameter syntax, separated by & and added as key=value. The values here can be provided dynamically as a pipeline parameter or directly in the Snap, but not as an upstream parameter. | ||||||||||||||
Query parameter | The name of the query parameter that can be passed in the API. Default value: [None] Example: type | ||||||||||||||
Query parameter value | The value for a specified query parameter Default value: [None] Example: reltio | ||||||||||||||
Raw data | If checked, HTTP response content is written to the output view as it is. If unchecked, it is parsed according to content type. Default value: Unselected | ||||||||||||||
|
| ||||||||||||||
Retry limit |
| ||||||||||||||
|
|
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.
Expand | ||
---|---|---|
| ||
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: |
Expand | ||
---|---|---|
| ||
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: |
Expand | ||
---|---|---|
| ||
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: |
Expand | ||
---|---|---|
| ||
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
Attachments | ||
---|---|---|
|
Insert excerpt | ||||||
---|---|---|---|---|---|---|
|