Generate a Reltio ID for an entity
Learn about running a task that generates a ReltioID parameter value for entities that have Reltio ID generation configured in a tenant.
Take a sneak peek at Reltio ID - your unique, durable identifier.
You can generate a Reltio ID for the following reasons:
- If the Reltio ID is missing for an entity in an existing tenant.
- If the Reltio ID is required for an entity for which data already exists.
- For a cloned tenant, the Reltio IDs are the same for the original and cloned tenant. Customers can regenerate the Reltio ID for the cloned tenant so that it has a unique Reltio ID for the Profile.
By default, a Reltio ID isn’t regenerated for an entity that already has Reltio Id, that is, the regenerate parameter is set to false. If the regenerate parameter is set to true, then a new Reltio ID is generated for an entity.
Request
Admin role is required:
POST {ApplicationURL}/generateReltioIdPOST {ApplicationURL}/api/{tenantId}/generateReltioId| Parameter | Required | Description |
|---|---|---|
tenantId
| Yes | The ID of the tenant for which Reltio ID generation enablement must be done. |
distributed | No |
If set to
true, the task runs in distributed mode. Default value is false. For more information, see Distributed mode. |
taskPartsCount | No |
Specifies the maximum number of sub-tasks for distributed execution. The platform determines the optimal number based on performance limits. Default value is
2. Note: This parameter is only applicable when distributed=true. Otherwise, it s ignored. |
regenerate | No |
The current Reltio ID is removed and a new Reltio ID is regenerated for the entity when the parameter is set to |
Response
[
{
"id": "805478c5-1a6e-4ac7-ade2-e6df8b76e0b9",
"groupId": "a39cd7fc-ba5a-4d1d-ae03-706a0db3abd1",
"createdTime": 1663729380240,
"createdBy": "yourname@yourcompany.com",
"updatedTime": 1663729380240,
"updatedBy": "yourname@yourcompany.com",
"type": "com.reltio.businesslogic.tasks.ReltioID.GenerateReltioIDTask",
"status": "SCHEDULED",
"name": "Generate Reltio Id",
"createdOnHost": "dataload-7448df5f5c-cs5rq",
"parallelExecution": false,
"nodesGroup": "default",
"parameters": {
"tenantId": "your tenantname",
"entityType": "all types",
"uriList": "",
"regenerate": "false"
},
"currentState": {},
"duration": "0s"
}
]The request body, if provided, must contain a JSON array of the entity URIs that must be checked.
Request
POST {ApplicationURL}/api/{tenantId}/generateReltioId
["entities/9LIMXfO"]Response
[
{
"id": "464ad37b-cedb-44a2-9746-ea6e743806cb",
"groupId": "b7c0f9ab-cd21-4841-b973-09ba1f0aedd8",
"createdTime": 1663730488676,
"createdBy": "yourname@yourcompany.com",
"updatedTime": 1663730488676,
"updatedBy": "yourname@yourcompany.com",
"type": "com.reltio.businesslogic.tasks.ReltioID.GenerateReltioIDTask",
"status": "SCHEDULED",
"name": "Generate Reltio Id",
"createdOnHost": "dataload-7448df5f5c-5pp5q",
"parallelExecution": false,
"nodesGroup": "default",
"parameters": {
"tenantId": "mytenantid",
"entityType": "all types",
"uriList": "[\"entities/9LIMXfO\"]",
"regenerate": "false"
},
"currentState": {},
"duration": "0s"
}
]If you send a request using the regenerate parameter, a new ID is generated in the response.
Request
POST {ApplicationURL}/api/{tenantId}/generateReltioId?regenerate=trueResponse
[
{
"id": "1caf2410-742a-4e04-8cc2-83d79a8a336b",
"groupId": "bea0f45c-859d-45f2-8f96-9315c8bc3360",
"createdTime": 1663729455540,
"createdBy": "yourname@yourcompany.com",
"updatedTime": 1663729455540,
"updatedBy": "yourname@yourcompany.com",
"type": "com.reltio.businesslogic.tasks.ReltioID.GenerateReltioIDTask",
"status": "SCHEDULED",
"name": "Generate Reltio Id",
"createdOnHost": "dataload-7448df5f5c-cs5rq",
"parallelExecution": false,
"nodesGroup": "default",
"parameters": {
"tenantId": "mytenantid",
"entityType": "all types",
"uriList": "",
"regenerate": "true"
},
"currentState": {},
"duration": "0s"
}
]