property-value-result

Array of all the failures in this property value validation result.

result

Failure

Array of all the validation rule lookup entries.

ruleList

rule-lookup-entry

Property Value Result

The details for a property value validation failure.

elementId

string

elementLabel

The zero-based index used to lookup the validation rule in the ruleList.

ruleIndex

integer

badValue

displayName

Rule Lookup Entry

Array of property value validation rule templates

property-value-rule-templates

ruleTemplates

property-value-rule-template

_links

forward-only-paging-links

Property Value Templates

description

prompt

templateExpression

object

Property Value Rule Template

create-update-property-value-rule

templateId

creationDateTime

date-time

The date/time when the rule was last modified.

modificationDateTime

ecSchema

ecClass

whereClause

functionName

functionParameters

The severity of the rule. One of 'veryHigh', 'high', 'medium', 'low'

severity

The data type of the rule. One of 'property', 'aspect', 'typeDefinition'

dataType

property-value-rule-self-link

Property Value Rule

self

Link

Property Value Rule Link

property-value-rule-details-link

rule

Property Value Rule Details Link

Property value validation rule summary (id and display name)

property-value-rule-summary

The display name of the property value validation rule.

get-property-value-rule

property-value-rule-user-link

user

Property Value Rule User Link

Array of property value validation rules metadata (summary)

property-value-rules-prefer-return-minimal

rules

Property Value Rules

Array of property value validation rules metadata

property-value-rules-prefer-return-representation

create-update-property-value-test

stopExecutionOnFailure

boolean

property-value-test-self-link

Property Value Test

Property Value Test Link

get-property-value-test

property-value-test-user-links

The link to get user details of the user that created the test.

createdBy

The link to get user details of the user that last modified the test.

lastModifiedBy

Property Value Test User Links

property-value-test-summary-link

The link to get user details for the user that created the test.

The link to get user details for the user that last modified the test.

test

Property Value Test Links

property-value-test-summary

The display name of the property value validation test.

The date/time when the test was last modified.

Array of property value validation tests metadata

property-value-tests

tests

Property Value Tests

property-value-run

The display name of the run is the test name and execution date/time.

The date/time when the test was executed.

executedDateTime

count

The name of the user that started the run.

userName

The status of the validation run. One of 'queued', 'started', 'completed', 'failed', 'downloadingIModel', 'storingResults', 'inProgress', 'completedToLimit', 'cancelled'

status

resultId

The links to get the result and test details.

property-value-run-links

Property Value Run

Property Value Run Links

Property value validation run summary (id and display name)

property-value-run-summary

The display name of the property value validation run.

Array of property value validation runs metadata (summary)

property-value-runs-prefer-return-minimal

runs

Property Value Runs

Array of property value validation runs metadata

property-value-runs-prefer-return-representation

property-value-run-create

property-value-run-link

Specify the settings to run property value test.

property-value-test-settings

The maximum results limit for the property value test.

resultsLimit

Property Value Test Settings

Specify the test id, iModel id and named version id to run property value test.

property-value-run-body

testId

iModelId

The id of the named version being tested.

namedVersionId

Run Property Value Test

property-value-rule-link

Specify the test criteria to create a property value validation test.

create-property-value-test-body

projectId

The ids of the rules to associate with the test.

Create Property Value Test

Specify the test criteria to update a property value validation test.

update-property-value-test-body

Update Property Value Test

Specify the rule criteria to create a property value validation rule.

create-property-value-rule-body

Create Property Value Rule

Specify the rule criteria to update a property value validation rule.

update-property-value-rule-body

Update Property Value Rule

Property Value Run Link

href

Link to get the next page of data, if applicable. Link to the previous page is not available.

Forward-Only Paging Link

properties-info

The status of the properties info. One of 'available', 'unavailable'

searchProperty

search-property

schemas

Schema

Search Property

name

label

entities

entity-class

properties

Property

An array of aspect properties of the class.

aspects

An array of type definitions properties of the class.

typeDefinitions

Entity Class

Contains error information and an array of more specific errors.

DetailedError

One of a server-defined set of error codes.

code

A human-readable representation of the error.

message

target

details

Error

Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.

DetailedErrorResponse

error

Detailed Error Response

ErrorResponse

Error Response

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

---

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.

API references