Get DVF by URI
Learn how to retrieve a single Data Validation Function (DVF) using its function URI.
Use this operation to retrieve a single DVF using its function URI. The Data Validation runs on a dedicated service host, separate from your tenant's base API host. This operation identifies the DVF using the tenant ID and function URI only. Any environment header included in the request doesn't affect the result.
HTTP method and endpoint
Use the following HTTP method and endpoint path to retrieve a DVF with a specific URI:
GET https://data-validation-functions.reltio.com/api/{tenantId}/dataValidationFunctions/{uri}| Parameter | Type | Required | Description |
|---|---|---|---|
tenantId | String | Yes | The unique identifier of the tenant. |
uri | String | Yes | The function URI of the DVF to retrieve. |
Request headers
Include the following headers in the request. An env header isn't required for this operation.
| Header | Value | Required |
|---|---|---|
Authorization | Bearer <access_token> | Yes |
Request body
This operation doesn't 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/171a5836-49f1-4928-b286-728a2e5bab79
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 a DVFs for a specific URI.
{
"uri": "171a5836-49f1-4928-b286-728a2e5bab79",
"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": "PLATFORM_CONTROL_CENTER",
"createdTime": "1783418619169",
"updatedBy": "PLATFORM_CONTROL_CENTER",
"updatedTime": "1783418619169",
"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. |
| 404 Not Found | MISSING | No DVF exists for the specified URI in this tenant. | Confirm the function URI and tenant ID. |
Related pages
For more information, see Validate entities using DVF, Get all DVFs, and Get DVFs by entity type.