Reltio Delete (Object)

Overview

The Reltio Delete (Object) Snap deletes records associated with Reltio objects (Entities, Relations, or Categories) from the specified Tenant.

This Snap also supports bulk operation by using the Bulk Delete functionality. This Snap cannot be used for deleting Interactions because transaction-based data cannot be deleted.

Prerequisites

  • Reltio account with a valid Tenant ID so that Tenant URL can be formed/API for Account Settings.
  • The Reltio account must have sufficient access to delete 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.

Input view is optional and is required only to pass the Object ID from the upstream Snap or value in that field.

Output

This Snap has exactly one document output view.

Response for the Snap contains either success or an error, depending on whether the URI was deleted or not.

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 Delete (Object)

Tenant URL*

String/Expression

The Reltio host with Tenant ID. Use this format: https://<reltio_host>/api/<tenant_id>.

Note: This value can be provided dynamically as a pipeline parameter or directly in the Snap, but not as an upstream parameter.

Default value: https://<your_reltio_host>/reltio/api/<tenant_id>

Example: https://test.reltio.com/reltiotest/api/XKiqdracb178fmuXYr3U7ZrG6/

Object*

String/Expression/ Suggestion

The Reltio Object from where the data is to be deleted. This is a suggestible field.

Reltio typically has 4 objects - Entities, Interactions, Relations, and Categories. Suggestion only works if a valid account or tenant URL is provided.

Note: This value can be provided dynamically as a pipeline parameter or directly in the Snap, but not as an upstream parameter.

Default value: N/A

Example: Entities

Object Id*

String/Expression

The identifier for the object to be deleted. Multiple objects can be deleted by using the Bulk delete option but in that case the multiple IDs must be separated by a comma (,).

Default value: N/A

Example: 12345abc-def6-7890-ghij-klmnopqrstuv

Bulk delete

Checkbox

Enables deleting multiple entities at a time, separated by commas.

Default value: Deselected

Retry limit

Integer/Expression

Specify the maximum number of attempts to get the response.

Minimum value: 1

Maximum value: 10

Note: You can provide this value dynamically as a Pipeline parameter or directly in the Snap, but not as an upstream value.

Default value: 5

Example: 3

Batch size

Integer/Expression

Specifies the number of records that you want the Snap to process in a single API call.

Minimum value: 1

Maximum value: 2,147,483,647

Note: This value can be provided dynamically as a pipeline parameter or directly in the Snap, but not as an upstream parameter.

Default value: 1

Example: 100

Thread limit*

Integer/Expression

Specifies the maximum threads of this Snap to delete the Reltio Objects.

Minimum value: 1

Maximum value: 50

Note: This value can be provided dynamically as a pipeline parameter or directly in the Snap, but not as an upstream parameter.

Default value: 20

Example: 10

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