The Property Validation API allows you to manage property value validation rules, tests, runs, and results. You can run tests and monitor the progress.

validation

Deprecated - Properties Info API will be removed soon.

Added support for API call to get filtered list of properties in an iModel.

Added support for multi-property property value validation.

Added support for testSettings:resultsLimit parameter to run test API.

Added support for returning user metadata for get rule/test APIs.

---

Creates a property value validation rule for the specified criteria and returns the rule id.

- Discover rule template ids by calling [GET /validation/propertyValue/ruleTemplates](/api-groups/validation/apis/validation/operations/get-validation-propertyvalue-rule-templates/)

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

create-validation-propertyvalue-rule

OAuth access token with `itwin-platform` scope

Authorization

Setting to `application/vnd.bentley.itwin-platform.v1+json` is recommended.

Accept

default

This response indicates that request lacks valid authentication credentials. Access token might not been provided, issued by the wrong issuer, does not have required scopes or request headers were malformed.

HeaderNotFound

InvalidAuthorizationScheme

InvalidHeaderValue

RequiredScopeMissing

Unauthorized

InvalidApplicationTier

The 422 (Unprocessable Entity) status code indicates that the request cannot be processed by the server due to a client error (e.g. malformed request syntax)

This response indicates that the user has sent too many requests in a given amount of time.

The number of requests exceeds the rate-limit for the client subscription.

retry-after

---

Deletes the property value validation rule for the specified rule id.

- Discover rule ids by calling [GET /validation/propertyValue/rules](/api-groups/validation/apis/validation/operations/get-validation-propertyvalue-rules/)

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


delete-validation-propertyvalue-rule

Indicates that the rule was successfully deleted. There is no response body in this case.

This response indicates that the specified rule was not found.

---

Gets the property value validation rule details for the specified rule id.

- Discover rule ids by calling [GET /validation/propertyValue/rules](/api-groups/validation/apis/validation/operations/get-validation-propertyvalue-rules/)

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


get-validation-propertyvalue-rule

Optional. Include user metadata when true.

Include-User-Metadata

---

Retrieves a list of property value validation rule templates for the project specified by the project id.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


get-validation-propertyvalue-rule-templates

The id of the project associated with the rule templates.

projectId

Parameter that enables continuing to the next page of the previous paged query. This must be passed exactly as it is in the response body's _links.next property. If this is specified and $top is omitted, the next page will be the same size as the previous page.

continuationToken

The number of rule templates to get in each page. Max 50, but 15 is the default if this parameter is not included.

$top

This response indicates that the specified project was not found.

---

Retrieves a list of property value validation rules for the project specified by the project id.

### Notes

The Prefer header can be used to specify how much rule metadata is desired

- "return=minimal" (default) - returns the minimum property value validation rule metadata

- "return=representation" - returns the full property value validation rule metadata

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


get-validation-propertyvalue-rules

The project id of the project from which to retrieve property value validation rules.

The number of rulesto get in each page. Max 50, but 10 is the default if this parameter is not included.

Optional. Selected preferred representation.

Prefer

minimal

representation

---

Updates a property value validation rule for the specified criteria and returns the id of the successfully updated rule.

- Discover rule ids by calling [GET /validation/propertyValue/rules](/api-groups/validation/apis/validation/operations/get-validation-propertyvalue-rules/)

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

update-validation-propertyvalue-rule

---

Creates property value validation test for the specified criteria and returns the test id.

- Discover rule ids by calling [GET /validation/propertyValue/rules](/api-groups/validation/apis/validation/operations/get-validation-propertyvalue-rules/)

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

create-validation-propertyvalue-tests

---

Deletes the property value validation test for the specified test id.

- Discover test ids by calling [GET /validation/propertyValue/tests](/api-groups/validation/apis/validation/operations/get-validation-propertyvalue-tests/)

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


delete-validation-propertyvalue-test

Indicates that the test was successfully deleted. There is no response body in this case.

This response indicates that the specified test was not found.

---

Gets the property value validation test details for the specified test id.

- Discover test ids by calling [GET /validation/propertyValue/tests](/api-groups/validation/apis/validation/operations/get-validation-propertyvalue-tests/)

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


get-validation-propertyvalue-test

---

Retrieves a list of property value validation tests for the project specified by the project id.

### Notes

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


get-validation-propertyvalue-tests

The project id of the project from which to retrieve property value validation tests.

The number of tests to get in each page. Max 50, but 10 is the default if this parameter is not included.

---

Updates a property value validation test for the specified criteria and returns the id of the successfully updated test.

- Discover test ids by calling [GET /validation/propertyValue/tests](/api-groups/validation/apis/validation/operations/get-validation-propertyvalue-tests/)

- Discover rule ids by calling [GET /validation/propertyValue/rules](/api-groups/validation/apis/validation/operations/get-validation-propertyvalue-rules/)

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

update-validation-propertyvalue-test

---

Deletes a property value validation run for specified run id.

- Discover run ids by calling [GET /validation/propertyValue/runs](/api-groups/validation/apis/validation/operations/get-validation-propertyvalue-runs/)

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

delete-validation-propertyvalue-run

Indicates that the run was successfully deleted. There is no response body in this case.

This response indicates that the specified run was not found.

---

Retrieves details of a validation run for the run specified by the run id.

- Links are included to retrieve the associated test and result. The run status in the response can be polled periodically as the agent job completes asynchronously. Calling the link to get the result before the run status is 'completed' will return a 202 response.

- Discover run ids by calling [GET /validation/propertyValue/runs](/api-groups/validation/apis/validation/operations/get-validation-propertyvalue-runs/)

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


get-validation-propertyvalue-run

---

Retrieves a list of property value validation runs for the project specified by the project id.

### Notes

The Prefer header can be used to specify how much validation run metadata is desired

- "return=minimal" (default) - returns the minimum property value validation run metadata

- "return=representation" - returns the full property value validation run metadata

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


get-validation-propertyvalue-runs

The project id of the project from which to retrieve the property value validation runs.

Optional.  Select preferred representation.

---

Runs a property value validation test for the specified test id and returns the run id. The maximum number of validation failures may be specified with the resultsLimit parameter in the request body. If none is specified, the default is 100,000.

- This API has a rate limit of 6 API calls per second.  If an application exceeds the rate limit it will receive an HTTP error code 429 "Too Many Requests". The error response includes a Retry-After header that indicates how long clients should wait before retrying.

- A link is included to retrieve the run status as the agent job completes asynchronously.

- Discover test ids by calling [GET /validation/propertyValue/tests](/api-groups/validation/apis/validation/operations/get-validation-propertyvalue-tests/)

- Discover iModel ids by calling [GET /imodels](/api-groups/data-management/apis/imodels/operations/get-project-imodels/)

- Discover named version ids by calling [GET /imodels/{id}/namedversions](/api-groups/data-management/apis/imodels/operations/get-imodel-named-versions/)

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

run-validation-propertyvalue-test

---

Gets the properties matching a filter string for the latest named version of an iModel. This request relies on a previous call to start schema extraction on an agent. Since this extraction completes asynchronously, the user can send this request periodically until a status of 'available' is returned in the response.

- Discover iModel ids by calling [GET /imodels](/api-groups/data-management/apis/imodels/operations/get-project-imodels/)

- Extract iModel schemas by calling [POST /clashdetection/schemas/imodels](/api-groups/validation/apis/clash-detection/operations/extract-schema-info/)

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

get-validation-propertyvalue-properties

The id of the project containing the iModel from which to retrieve the properties info.

The filter string to search for properties.

filter

This response indicates that the specified iModel or project was not found.

---

Gets the property value validation result details for the specified result id.

- Discover result ids by calling [GET /validation/propertyValue/runs](/api-groups/validation/apis/validation/operations/get-validation-propertyvalue-runs/)

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


get-validation-propertyvalue-result

This response indicates that the specified result was not found.

Changelog - Property Validation | iTwin Platform

Walk-through to create property validation rules and tests and then run them and get the results.

Property Validation Basics

Walk-through to create a multi-property validation rule.

Create Multi-Property Validation Rule

Walk-through of retrieving and understanding basic model information needed for various validation functions.

Changelog

Oct 19, 2023

Aug 23, 2022