Tenant configuration Validation API

Learn more about how to run full validation of a tenant's business configuration and return validation errors and/or warnings.

Use Validation API to run full validation of a tenant's business configuration (metadata configuration) and return validation errors and/or warnings. Use the GET endpoint to validate the business configuration stored for the tenant. Use the POST endpoint to validate a business configuration JSON payload without saving it. This topic covers tenant-level business configuration validation only.

HTTP method and endpoint

Use the following HTTP methods and endpoint paths to validate a tenant business configuration.

Method Endpoint Description

GET

Method	Endpoint	Description
GET	`{{envUri}}/reltio/api/{{tenantId}}/configuration/_validateTenantConfiguration?validationErrorLevel=<validation-level>`	Validates the stored business configuration stored in the database for the tenant.
POST	`{{envUri}}/reltio/api/{{tenantId}}/configuration/_validation?validationErrorLevel=<validation-level>`	Validates a configuration JSON payload provided in the request body without saving it.

{{envUri}}/reltio/api/{{tenantId}}/configuration/_validateTenantConfiguration?validationErrorLevel=<validation-level>

Validates the stored business configuration stored in the database for the tenant.

POST

{{envUri}}/reltio/api/{{tenantId}}/configuration/_validation?validationErrorLevel=<validation-level>

Validates a configuration JSON payload provided in the request body without saving it.

The following table describes the endpoint path parameters.


Parameter	Type	Required	Description
`tenantId`	String	Yes	The unique identifier of the tenant. Specifies the tenant context for the request. Example: ce5627DYnQ6abcD

Query parameter

The following table describes the query parameter and its value.


Parameter	Type	Required	Description	Accepted values / Default	When to use
`validationErrorLevel`	String	Yes	Filters the severity level of validation findings returned in the response output. Replace `<validation-level>` with one of the accepted values — `all`, `error` and `warning`.	`all`	Use this value when you want the response to include both validation errors and warnings. This is the default value.
				`warning`	Use this value when you want to review only validation warnings.
				`error`	Use this value when you want to review only validation errors.

Request headers

The following request headers must be included.


Header	Value	Required
Authorization	Bearer `<Access_Token>`	Yes
Content-Type	application/json	Yes (POST only)

Request body

The following table describes the request body requirements for each HTTP method.


HTTP method	Request body	Description
GET	Not required	This operation does not require a request body.
POST	Required (JSON payload)	Send the business configuration that you want to validate in the request body as a JSON payload. The API validates the payload and returns validation findings without saving the configuration to the database.

Example request

Use the following example to see how a complete request is structured.

GET example

GET {{envUri}}/reltio/api/{{tenantId}}/configuration/_validateTenantConfiguration?validationErrorLevel=all

POST example

POST {{envUri}}/reltio/api/{{tenantId}}/configuration/_validation?validationErrorLevel=all

{ ...configuration payload to validate... }

Response body

The following table describes the fields returned in the response body.

The response groups results by configuration path (for example, configuration/entityTypes/Organization), and each configuration path includes a warnings array.


Field	Type	Description
`warnings`	array of object	The list of validation findings for the configuration path.
`severity`	string	The severity level of the finding. Example: `Error`.
`errorMessage`	string	A short message that describes the finding.
`errorCode`	integer	The numeric code for the finding. Example: `1801`.
`errorDetailMessage`	string	A detailed message that describes the finding and how to fix it.

Example response

The following example shows a successful response. The response format is the same for both the GET and POST endpoints.

{
    "configuration/entityTypes/Organization": {
        "warnings": [
            {
                "severity": "Error",
                "errorMessage": "No surrogate crosswalk defined for entityconfiguration/entityTypes/Organization",
                "errorCode": 1801,
                "errorDetailMessage": "No surrogate crosswalk defined for entityconfiguration/entityTypes/Organization, Please define surrogate crosswalk"
            }
        ]
    },
    "configuration/entityTypes/Location": {
        "warnings": [
            {
                "severity": "Error",
                "errorMessage": "No surrogate crosswalk defined for entityconfiguration/entityTypes/Location",
                "errorCode": 1801,
                "errorDetailMessage": "No surrogate crosswalk defined for entityconfiguration/entityTypes/Location, Please define surrogate crosswalk"
            }
        ]
    }
}

Unify and manage your data