Use the following HTTP method and endpoint path to submit the request:

POST http(s)://{{environment}}.reltio.com/reltio/api/{tenantId}/syncToDataPipeline

The syncToDataPipeline accepts an optional request body containing a list of entity URIs. Use the request body when you need to scope the reindex to a specific set of entity records rather than reindexing all records of a given data type. When a list of entity URIs is provided, the reindex processes only those records. When no body is provided, the reindex processes all records matching the query parameters.

["entities/I1", "entities/I2", "entities/I3"]

Field	Type	Description
id	String	Unique identifier of the background task.
groupId	String	Unique identifier that groups all background tasks created by the same reindex job.
createdTime	Number	Timestamp when the task was created, in epoch milliseconds.
createdBy	String	Email address of the user who triggered the reindex job.
updatedTime	Number	Timestamp of the last task update, in epoch milliseconds.
updatedBy	String	Email address of the user who last updated the task.
type	String	Fully qualified class name of the background task. Identifies the data type being reindexed.
status	String	Current execution status of the task. Example: SCHEDULED.
name	String	Description of the reindex operation.
createdOnHost	String	Hostname of the server that created the task.
parallelExecution	Boolean	Indicates whether the task runs in parallel execution mode.
nodesGroup	String	Node group on which the task runs.
parameters.tenantId	String	Tenant ID for which the reindex is running.
parameters.updatedSince	String	The updatedSince value applied to the task.
parameters.eventQueueProcessors	String	Event queue processors used to stream data.
parameters.streamingDestinations	String	Streaming destination queue for the tenant.
currentState	Object	Current execution state of the task. Empty when newly scheduled.
duration	String	Elapsed execution time of the task.

All requests return the same response structure, an array of background tasks created for the reindex job. The following example shows a response for a request that reindexes interactions, potential matches, and merges.

[
  {
    "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"
  }
]

If the request is invalid, the API returns a 400 Bad Request response. Review the error details, correct the request, and try again.

{
  "severity": "Error",
  "errorMessage": "Failed to parse content as JSON",
  "errorCode": 150,
  "errorDetailMessage": "Expecting request content in JSON format, failed to parse.",
  "innerErrorData": {
    "exception": "com.reltio.rest.data.marshalling.MarshallerException"
  }
}

Goal	API
Check the status of all active tasks	Get active tasks for tenant
Review completed task history	Get task history for tenant
Check the status of a specific task by ID	Get task by ID for tenant
Verify that processing is complete	Tenant Queue Status API, confirm the queue count is 0 Note: A non-zero queue count does not always indicate that the sync is still running. Ongoing activity in the tenant may contribute to the count. Check for other active processes before concluding the sync is incomplete.