Get DVFs by entity type
Learn how to retrieve the Data Validation Functions (DVFs) configured for a specific entity type in your Reltio tenant.
Use this operation to retrieve the DVFs configured for a specific entity type. The Data Validation runs on a dedicated service host, separate from your tenant's base API host. Reltio scopes the DVFs returned by the environment you specify in the request, in addition to the entity type.
HTTP method and endpoint
Use the following HTTP method and endpoint path to retrieve DVFs for an entity type:
GET https://data-validation-functions.reltio.com/api/{tenantId}/dataValidationFunctions/entityTypes/{entityType}| Parameter | Type | Required | Description |
|---|---|---|---|
tenantId | String | Yes | The unique identifier of the tenant. |
entityType | String | Yes | The short name of the entity type, for example Organization. Not the fully qualified entity type URI. |
Request headers
Include the following headers in the request. Use the env header to scope which DVFs are returned.
| Header | Value | Required |
|---|---|---|
Authorization | Bearer <access_token> | Yes |
env | The environment identifier that scopes the DVFs returned by this request. Results reflect only the DVFs configured for the specified environment. | Yes |
Request body
This operation does not require a request body.
Example request
Use the following example to see how a complete request is structured with headers and a JSON body.
GET https://data-validation-functions.reltio.com/api/{tenantId}/dataValidationFunctions/entityTypes/Organization
Authorization: Bearer <access_token>
Response body
The response is an array of DVF objects.
| Field | Type | Description |
|---|---|---|
uri | String | Unique identifier of the DVF. |
name | String | Name of the DVF. |
label | String | Display label of the DVF. |
description | String | Description of the DVF. |
expression | String | The validation expression evaluated by the DVF. |
action | String | The action taken when the DVF evaluates to true, for example WARNING. |
message | String | Validation message for the function when the expression is evaluated as true. |
validationEvent | String | The lifecycle event on which the DVF runs. |
status | String | Whether the DVF is ACTIVE or inactive. |
attribute | String | The attribute URI the DVF validates. |
createdBy | String | The user or system that created the DVF. |
createdTime | String | Epoch timestamp, in milliseconds, when the DVF was created. |
updatedBy | String | The user or system that last updated the DVF. |
updatedTime | String | Epoch timestamp, in milliseconds, when the DVF was last updated. |
applyOn | String | Scope the DVF applies to, for example OV (object version). |
sourceTypes | Array | Source types the DVF applies to. Empty when the DVF applies to all sources. |
Example response
The following example shows a response with two DVFs where every object in the response shares the entity type requested in the path, in this example, Organization.
[
{
"uri": "c71e300b-d992-4e9b-80d2-f2245cab6521",
"name": "ShortNameCheck",
"label": "",
"description": "Name is suspiciously short",
"expression": "regexp(attributes.Name.value, '^.{1,3}$')",
"action": "WARNING",
"message": "Name must contain at least 3 characters."
"validationEvent": "ALL",
"status": "ACTIVE",
"attribute": "configuration/entityTypes/Organization/attributes/Name",
"createdBy": "jane.doe@example.com",
"createdTime": "1783418619169",
"updatedBy": "jane.doe@example.com",
"updatedTime": "1783418619169",
"applyOn": "OV",
"sourceTypes": []
},
{
"uri": "8b2c4d61-3f77-4a19-b0e5-6d9a1c7e4f32",
"name": "MissingTaxID",
"label": "",
"description": "Tax ID is required for this organization type",
"expression": "isNull(attributes.TaxID.value)",
"action": "WARNING",
"message": "Tax ID is required for organizations of this type."
"validationEvent": "ALL",
"status": "ACTIVE",
"attribute": "configuration/entityTypes/Organization/attributes/TaxID",
"createdBy": "jane.doe@example.com",
"createdTime": "1783418750000",
"updatedBy": "jane.doe@example.com",
"updatedTime": "1783418750000",
"applyOn": "OV",
"sourceTypes": []
},
...
]Error codes and recommended actions
The following table lists the possible error responses returned by this API
| HTTP status code | Error code | Description | Recommended action |
|---|---|---|---|
| 401 Unauthorized | MISSING | Missing or invalid authentication credentials. | Provide a valid bearer token. |
| 403 Forbidden | MISSING | Insufficient permissions. | Confirm the account has DVF read permissions. |
| 500 Internal Server Error | MISSING | Unexpected server-side error. | Retry; contact support if the issue persists. |
| 503 Service Unavailable | MISSING | The service is temporarily unavailable. | Retry after a delay. |
Related pages
For more information, see Validate entities using DVF, Get all DVFs, and Get DVF by URI.