Tenant Data Synchronization

Start a background task that streams data from your tenant to the Data Pipeline Hub using the configured adapters.

The Tenant Data Synchronization streams tenant data to the Data Pipeline Hub using the configured streaming destination and adapters defined in your tenant's physical configuration. You can control what data is streamed — entities, relations, interactions, matches, merges, and more, using query parameters. You can also run the task in distributed mode to distribute the data transfer across nodes.

Parameters

Use this API to stream tenant data to the Data Pipeline Hub. You can restrict data by type, filter by update time, or target specific entities. When distributed mode is enabled, multiple task parts run in parallel.

Endpoint:

POST /reltio/api/{tenantId}/syncToDataPipeline


Category	Parameter	Required	Description
Headers	`Authorization`	Yes	Bearer token for authentication. Format: `"Bearer <accessToken>"`.
Query	`dataTypes`	No	Comma-separated list of data types to stream. Supported values: `entities`, `deleted_entities`, `relations`, `deleted_relations`, `interactions`, `matches`, `merges`, `activities`.
	`distributed`	No	If `true`, the task runs in distributed mode. Default: `false`.
	`taskPartsCount`	No	Number of parts to split the distributed task into. Ignored unless `distributed=true`. Default: `2`. Must be ≤ `maxTaskPartsCount` from physical configuration.
	`distributedTaskIndex`	No	Reruns a specific part of a distributed task. Range: 0 to `taskPartsCount-1`.
	`reindexDeleted`	No	If `true`, also includes deleted records in the stream. Ignored if `dataTypes` is specified. Default: `false`.
	`updateSince`	No	Epoch timestamp. Only objects updated after this time are streamed. Default: `0`.
	`entityType`	No	Limits entity reindexing to a specific entity type (for example, `HCP`).
	`relationType`	No	Limits relation reindexing to a specific relation type (for example, `HCOToHCP`).
Body	`[URIs]`	No	Optional list of specific entity URIs to sync. Applies only to relevant data types.

Response structure

Returns a JSON array of task objects representing scheduled sync jobs.
Each object includes id, type, status, createdBy, parameters, and other metadata.
Tasks run asynchronously and can be tracked using task monitoring APIs.

Send all data

This request streams all entity, relation, and interaction data from the tenant to the Data Pipeline Hub.

POST https://{env}.reltio.com/reltio/api/{tenantID}/syncToDataPipeline

Response

[
    {
        "id": "6feb9c74-7701-4c46-b053-b4e0e245b4c9",
        "groupId": "f1993d72-1216-4d80-9666-ede952f5e2b0",
        "createdTime": 1665054423545,
        "createdBy": "test@reltio.com",
        "updatedTime": 1665054423545,
        "updatedBy": "test@reltio.com",
        "type": "com.reltio.businesslogic.tasks.reindex.ReindexDataTask",
        "status": "SCHEDULED",
        "name": "Reindexing of all types in tenant LocalTest",
        "createdOnHost": "DESKTOP-1N09DOF",
        "parallelExecution": false,
        "nodesGroup": "default",
        "parameters": {
            "tenantId": "LocalTest",
            "eventQueueProcessors": "crud_streaming,datapipeline_snowflake_processor",
            "streamingDestinations": "03ff3091f067027b0d484b4e02e36861_queue_local-datapipeline-events_LocalTest"
        },
        "currentState": {},
        "duration": "0s"
    },
    {
        "id": "ee814042-3e73-4def-ab9a-6ad6816d7702",
        "groupId": "f4090bdc-411e-4442-9456-155aebba0c87",
        "createdTime": 1665054423545,
        "createdBy": "test@reltio.com",
        "updatedTime": 1665054423545,
        "updatedBy": "test@reltio.com",
        "type": "com.reltio.businesslogic.tasks.reindex.ReindexRelationsTask",
        "status": "SCHEDULED",
        "name": "Reindexing of all types in tenant LocalTest",
        "createdOnHost": "DESKTOP-1N09DOF",
        "parallelExecution": false,
        "nodesGroup": "default",
        "parameters": {
            "tenantId": "LocalTest",
            "eventQueueProcessors": "crud_streaming,datapipeline_snowflake_processor",
            "streamingDestinations": "03ff3091f067027b0d484b4e02e36861_queue_local-datapipeline-events_LocalTest"
        },
        "currentState": {},
        "duration": "0s"
    },
    {
        "id": "9916103e-8757-4ad1-8d69-4d6afa17b125",
        "groupId": "27856767-5cef-4970-92b9-7403c714b293",
        "createdTime": 1665054423545,
        "createdBy": "test@reltio.com",
        "updatedTime": 1665054423545,
        "updatedBy": "test@reltio.com",
        "type": "com.reltio.businesslogic.tasks.reindex.ReindexInteractionsTask",
        "status": "SCHEDULED",
        "name": "Reindexing interactions in tenant LocalTest",
        "createdOnHost": "DESKTOP-1N09DOF",
        "parallelExecution": false,
        "nodesGroup": "default",
        "parameters": {
            "tenantId": "LocalTest",
            "eventQueueProcessors": "crud_streaming,datapipeline_snowflake_processor",
            "streamingDestinations": "03ff3091f067027b0d484b4e02e36861_queue_local-datapipeline-events_LocalTest"
        },
        "currentState": {},
        "duration": "0s"
    },
    {
        "id": "5d5b448d-377e-4937-a098-43a6bebacf9b",
        "groupId": "21e1fa97-d90b-4609-a0d4-0356e3f2a3fd",
        "createdTime": 1665054423545,
        "createdBy": "test@reltio.com",
        "updatedTime": 1665054423545,
        "updatedBy": "test@reltio.com",
        "type": "com.reltio.businesslogic.tasks.reindex.PotentialMatchesReindexTask",
        "status": "SCHEDULED",
        "name": "Reindexing potential matches information for tenant LocalTest",
        "createdOnHost": "DESKTOP-1N09DOF",
        "parallelExecution": false,
        "nodesGroup": "default",
        "parameters": {
            "tenantId": "LocalTest",
            "eventQueueProcessors": "crud_streaming,datapipeline_snowflake_processor",
            "streamingDestinations": "03ff3091f067027b0d484b4e02e36861_queue_local-datapipeline-events_LocalTest"
        },
        "currentState": {},
        "duration": "0s"
    },
    {
        "id": "2bb5f03b-8163-46fe-a383-4523f77cf5b4",
        "groupId": "7df39c85-b230-4b7d-bc02-1cc10d68b891",
        "createdTime": 1665054423545,
        "createdBy": "test@reltio.com",
        "updatedTime": 1665054423545,
        "updatedBy": "test@reltio.com",
        "type": "com.reltio.businesslogic.tasks.reindex.ReindexMergesTask",
        "status": "SCHEDULED",
        "name": "Reindexing of merges in tenant LocalTest",
        "createdOnHost": "DESKTOP-1N09DOF",
        "parallelExecution": false,
        "nodesGroup": "default",
        "parameters": {
            "tenantId": "LocalTest",
            "eventQueueProcessors": "match_streaming,datapipeline_snowflake_processor",
            "streamingDestinations": "03ff3091f067027b0d484b4e02e36861_queue_local-datapipeline-events_LocalTest"
        },
        "currentState": {},
        "duration": "0s"
    }
]

Send all data with deleted and loser records

This request includes deleted and loser records in the data stream.

POST https://{env}.reltio.com/reltio/api/{tenantID}/syncToDataPipeline?reindexDeleted=true

Synchronize only entities

This request streams only entity data.

POST https://{env}.reltio.com/reltio/api/{tenantID}/syncToDataPipeline?dataTypes=entities

Synchronize only relations

This request streams only relation data.

POST https://{env}.reltio.com/reltio/api/{tenantID}/syncToDataPipeline?dataTypes=relations

Synchronize only a specific entity type

This request streams only entities of type HCP.

POST https://{env}.reltio.com/reltio/api/{tenantID}/syncToDataPipeline?dataTypes=entities&entityType=HCP

Synchronize only a specific relation type

This request streams only relations of type HCOToHCP.

POST https://{env}.reltio.com/reltio/api/{tenantID}/syncToDataPipeline?dataTypes=relations&relationType=HCOToHCP

Synchronize only specific entity IDs

This request streams only the specified entity records.

POST https://{env}.reltio.com/reltio/api/{tenantID}/syncToDataPipeline?dataTypes=entities


Request Body:
[
"entities/I1",
"entities/I2",
"entities/I3"
]

Synchronize only specific deleted or loser entity IDs

This request streams only deleted or loser entities based on their URIs.

POST https://{env}.reltio.com/reltio/api/{tenantID}/syncToDataPipeline?dataTypes=deleted_entities


Request Body:
[
"entities/I1",
"entities/I2",
"entities/I3"
]

Synchronize all data for specific entity URIs

This request streams all data (create, match, and merge events) for specified entity URIs.

POST https://{env}.reltio.com/reltio/api/{tenantID}/syncToDataPipeline


Request Body:
[
"entities/I1",
"entities/I2",
"entities/I3"
]

Send only data updated after a specific timestamp

This request streams only records updated after the specified epoch time (specified in the example as XYZ).

POST https://{env}.reltio.com/reltio/api/{tenantID}/syncToDataPipeline?updateSince=XYZ

Synchronize using entity URIs in distributed mode

This request streams matches, merges, and interactions in distributed mode for specific entities.

POST https://{env}.reltio.com/reltio/api/{tenantID}/syncToDataPipeline?dataTypes=matches,merges,interactions&distributed=true&distributedTaskIndex=0&taskPartsCount=4&updatedSince=123456&reindexDeleted=true


Request Body:
[
"entities/I1",
"entities/I2",
"entities/I3"
]

Response

[
    {
        "id": "9916103e-8757-4ad1-8d69-4d6afa17b125",
        "groupId": "27856767-5cef-4970-92b9-7403c714b293",
        "createdTime": 1665054423545,
        "createdBy": "test@reltio.com",
        "updatedTime": 1665054423545,
        "updatedBy": "test@reltio.com",
        "type": "com.reltio.businesslogic.tasks.reindex.ReindexInteractionsTask",
        "status": "SCHEDULED",
        "name": "Reindexing interactions in tenant LocalTest",
        "createdOnHost": "DESKTOP-1N09DOF",
        "parallelExecution": false,
        "nodesGroup": "default",
        "parameters": {
            "tenantId": "LocalTest",
            "eventQueueProcessors": "crud_streaming,datapipeline_snowflake_processor",
            "streamingDestinations": "03ff3091f067027b0d484b4e02e36861_queue_local-datapipeline-events_LocalTest"
        },
        "currentState": {},
        "duration": "0s"
    },
    {
        "id": "5d5b448d-377e-4937-a098-43a6bebacf9b",
        "groupId": "21e1fa97-d90b-4609-a0d4-0356e3f2a3fd",
        "createdTime": 1665054423545,
        "createdBy": "test@reltio.com",
        "updatedTime": 1665054423545,
        "updatedBy": "test@reltio.com",
        "type": "com.reltio.businesslogic.tasks.reindex.PotentialMatchesReindexTask",
        "status": "SCHEDULED",
        "name": "Reindexing potential matches information for tenant LocalTest",
        "createdOnHost": "DESKTOP-1N09DOF",
        "parallelExecution": false,
        "nodesGroup": "default",
        "parameters": {
            "tenantId": "LocalTest",
            "eventQueueProcessors": "crud_streaming,datapipeline_snowflake_processor",
            "streamingDestinations": "03ff3091f067027b0d484b4e02e36861_queue_local-datapipeline-events_LocalTest"
        },
        "currentState": {},
        "duration": "0s"
    },
    {
        "id": "2bb5f03b-8163-46fe-a383-4523f77cf5b4",
        "groupId": "7df39c85-b230-4b7d-bc02-1cc10d68b891",
        "createdTime": 1665054423545,
        "createdBy": "test@reltio.com",
        "updatedTime": 1665054423545,
        "updatedBy": "test@reltio.com",
        "type": "com.reltio.businesslogic.tasks.reindex.ReindexMergesTask",
        "status": "SCHEDULED",
        "name": "Reindexing of merges in tenant LocalTest",
        "createdOnHost": "DESKTOP-1N09DOF",
        "parallelExecution": false,
        "nodesGroup": "default",
        "parameters": {
            "tenantId": "LocalTest",
            "eventQueueProcessors": "match_streaming,datapipeline_snowflake_processor",
            "streamingDestinations": "03ff3091f067027b0d484b4e02e36861_queue_local-datapipeline-events_LocalTest"
        },
        "currentState": {},
        "duration": "0s"
    }
]

Example with parameters

POST https://{env}.reltio.com/reltio/api/{tenantID}/syncToDataPipeline?
dataTypes=matches,merges,interactions&distributed=true&distributedTaskIndex=0&taskPartsCount=4
&updatedSince=123456&reindexDeleted=true&entitytype=hcp&relationType=Location

Response

[
    {
        "id": "9916103e-8757-4ad1-8d69-4d6afa17b125",
        "groupId": "27856767-5cef-4970-92b9-7403c714b293",
        "createdTime": 1665054423545,
        "createdBy": "test@reltio.com",
        "updatedTime": 1665054423545,
        "updatedBy": "test@reltio.com",
        "type": "com.reltio.businesslogic.tasks.reindex.ReindexInteractionsTask",
        "status": "SCHEDULED",
        "name": "Reindexing interactions in tenant LocalTest",
        "createdOnHost": "DESKTOP-1N09DOF",
        "parallelExecution": false,
        "nodesGroup": "default",
        "parameters": {
            "tenantId": "LocalTest",
            "eventQueueProcessors": "crud_streaming,datapipeline_snowflake_processor",
            "streamingDestinations": "03ff3091f067027b0d484b4e02e36861_queue_local-datapipeline-events_LocalTest"
        },
        "currentState": {},
        "duration": "0s"
    },
    {
        "id": "5d5b448d-377e-4937-a098-43a6bebacf9b",
        "groupId": "21e1fa97-d90b-4609-a0d4-0356e3f2a3fd",
        "createdTime": 1665054423545,
        "createdBy": "test@reltio.com",
        "updatedTime": 1665054423545,
        "updatedBy": "test@reltio.com",
        "type": "com.reltio.businesslogic.tasks.reindex.PotentialMatchesReindexTask",
        "status": "SCHEDULED",
        "name": "Reindexing potential matches information for tenant LocalTest",
        "createdOnHost": "DESKTOP-1N09DOF",
        "parallelExecution": false,
        "nodesGroup": "default",
        "parameters": {
            "tenantId": "LocalTest",
            "eventQueueProcessors": "crud_streaming,datapipeline_snowflake_processor",
            "streamingDestinations": "03ff3091f067027b0d484b4e02e36861_queue_local-datapipeline-events_LocalTest"
        },
        "currentState": {},
        "duration": "0s"
    },
    {
        "id": "2bb5f03b-8163-46fe-a383-4523f77cf5b4",
        "groupId": "7df39c85-b230-4b7d-bc02-1cc10d68b891",
        "createdTime": 1665054423545,
        "createdBy": "test@reltio.com",
        "updatedTime": 1665054423545,
        "updatedBy": "test@reltio.com",
        "type": "com.reltio.businesslogic.tasks.reindex.ReindexMergesTask",
        "status": "SCHEDULED",
        "name": "Reindexing of merges in tenant LocalTest",
        "createdOnHost": "DESKTOP-1N09DOF",
        "parallelExecution": false,
        "nodesGroup": "default",
        "parameters": {
            "tenantId": "LocalTest",
            "eventQueueProcessors": "match_streaming,datapipeline_snowflake_processor",
            "streamingDestinations": "03ff3091f067027b0d484b4e02e36861_queue_local-datapipeline-events_LocalTest"
        },
        "currentState": {},
        "duration": "0s"
    }
]

Unify and manage your data

Tenant Data Synchronization

Parameters

Send all data

Send all data with deleted and loser records

Synchronize only entities

Synchronize only relations

Synchronize only a specific entity type

Synchronize only a specific relation type

Synchronize only specific entity IDs

Synchronize only specific deleted or loser entity IDs

Synchronize all data for specific entity URIs

Send only data updated after a specific timestamp

Synchronize using entity URIs in distributed mode

Example with parameters

Footer