Property Value Rules
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 validation:read
.
For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.
Request parameters
The project id of the project from which to retrieve property value validation rules.
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.
The number of rulesto get in each page. Max 50, but 10 is the default if this parameter is not included.
Request headers
Optional. Selected preferred representation.
Optional. Include user metadata when true.
OAuth access token with scope validation:read
Setting to application/vnd.bentley.itwin-platform.v1+json
is recommended.
Response 200 OK
OK
{ "rules": [{ "id": "ZuO3OCC8sUuVcgeXz1Ih_QE_7wcQ6WZIqE_IWb8geVc", "displayName": "MyRule6242021104843", "_links": { "rule": { "href": "https://api.bentley.com/validation/propertyValue/rules/ZuO3OCC8sUuVcgeXz1Ih_QE_7wcQ6WZIqE_IWb8geVc" } } }], "_links": { "next": { "href": "https://api.bentley.com/validation/propertyValue/rules?projectId=38b7e366-bc20-4bb1-9572-0797cf5221fd&continuationToken=eyJ0b3AiOjUwLCJza2lwVG9rZW4iOiJNZz09In0" } } }
Response 401 Unauthorized
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.
{ "error": { "code": "HeaderNotFound", "message": "Header Authorization was not found in the request. Access denied." } }
Response 404 Not Found
This response indicates that the specified project was not found.
{ "error": { "code": "ProjectNotFound", "message": "Requested project is not available." } }
Response 429 Too many requests
This response indicates that the user has sent too many requests in a given amount of time.
{ "error": { "code": "TooManyRequests", "message": "More requests were received than the subscription rate-limit allows." } }
The number of requests exceeds the rate-limit for the client subscription.
Property Value Rule
Property value validation rule summary (id and display name)
The property value validation rule id.
The display name of the property value validation rule.
Property Value Rule
The display name of the rule.
The description of the rule.
The template id of the rule.
The date/time when the rule was created.
The date/time when the rule was last modified.
The EC schema of the rule.
The EC class of the rule.
The where clause of the rule.
The function name of the rule.
The function parameters for the rule.
The severity of the rule. One of 'veryHigh', 'high', 'medium', 'low'
The data type of the rule. One of 'property', 'aspect', 'typeDefinition'
Property Value Rules
Array of property value validation rules metadata (summary)
Property Value Rules
Array of property value validation rules metadata
Forward-Only Paging Link
Link to get the next page of data, if applicable. Link to the previous page is not available.
Error
Contains error information.
One of a server-defined set of error codes.
A human-readable representation of the error.
The target of the error.
Error Response
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.