Update property value validation rule - Property Validation

REST API Overview

Reference

Property Validation

Download API definition:

This operation is deprecated. Please upgrade to the current version of this API as soon as possible.

PUT https://api.bentley.com/validation/propertyValue/rules/{id}

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

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

Request parameters

template

Yes

Rule id

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Request body

Update Property Value Rule

displayName

String

The name of the rule.

description

String

The description of the rule.

ecSchema

String

The EC schema of the rule.

ecClass

String

The EC class of the rule.

whereClause

String,null

The where clause of the rule.

severity

String

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

Example

json

{
    "displayName": "PV-rule-2",
    "description": "PV rule 2",
    "severity": "medium",
    "ecSchema": "ArchitecturalPhysical",
    "ecClass": "Door",
    "whereClause": "Roll = '10'"
}

Response 200 OK

json

{
    "rule": {
        "id": "ZuO3OCC8sUuVcgeXz1Ih_TNQnikmoHhLj_zItVtcYzI",
        "displayName": "PV-rule-2",
        "description": "PV rule 2",
        "templateId": "ZuO3OCC8sUuVcgeXz1Ih_RpYx1PXkMhIiXAjtrhii30",
        "severity": "medium",
        "ecSchema": "ArchitecturalPhysical",
        "ecClass": "Door",
        "whereClause": "Roll = '10'",
        "functionParameters": {
            "propertyName": "Pitch",
            "lowerBound": "1",
            "upperBound": "2"
        },
        "dataType": "property",
        "_links": {
            "self": {
                "href": "https://api.bentley.com/validation/propertyValue/rules/ZuO3OCC8sUuVcgeXz1Ih_TNQnikmoHhLj_zItVtcYzI"
            },
            "createdBy": {
                "href": "https://api.bentley.com/accesscontrol/itwins/38b7e366-bc20-4bb1-9572-0797cf5221fd/members/99cf5e21-735c-4598-99eb-fe3940f96353"
            },
            "lastModifiedBy": {
                "href": "https://api.bentley.com/accesscontrol/itwins/38b7e366-bc20-4bb1-9572-0797cf5221fd/members/99cf5e21-735c-4598-99eb-fe3940f96353"
            }
        }
    }
}

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.

json

{
    "error": {
        "code": "HeaderNotFound",
        "message": "Header Authorization was not found in the request. Access denied."
    }
}

Response 404 Not Found

This response indicates that the specified rule was not found.

json

{
    "error": {
        "code": "ValidationRuleNotFound",
        "message": "Requested rule is not available."
    }
}

Response 422 Unprocessable Entity

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)

json

{
    "error": {
        "code": "InvalidValidationRequest",
        "message": "Invalid property value validation request.",
        "details": [{
                "code": "InvalidRequestBody",
                "message": "Required property 'displayName' is missing in the request body.",
                "target": "displayName"
            },
            {
                "code": "InvalidRequestBody",
                "message": "Required property 'description' is missing in the request body.",
                "target": "description"
            },
            {
                "code": "InvalidRequestBody",
                "message": "Required property 'severity' is missing in the request body.",
                "target": "severity"
            },
            {
                "code": "InvalidRequestBody",
                "message": "Required property 'ecSchema' is missing in the request body.",
                "target": "ecSchema"
            },
            {
                "code": "InvalidRequestBody",
                "message": "Required property 'ecClass' is missing in the request body.",
                "target": "ecClass"
            },
            {
                "code": "InvalidRequestBody",
                "message": "Request body was not provided."
            },
            {
                "code": "InvalidRequestBody",
                "message": "The request is invalid."
            },
            {
                "code": "InvalidRequestBody",
                "message": "The request body is not a valid JSON object."
            }
        ]
    }
}

Response 429 Too many requests

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

json

{
    "error": {
        "code": "TooManyRequests",
        "message": "More requests were received than the subscription rate-limit allows."
    }
}

Response headers

retry-after

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

Definitions

Property Value Rule

TableSchema

String

The id of the rule.

displayName

String

The display name of the rule.

description

String

The description of the rule.

templateId

String

The template id of the rule.

creationDateTime

Date-time

The date/time when the rule was created.

modificationDateTime

Date-time

The date/time when the rule was last modified.

ecSchema

String

The EC schema of the rule.

ecClass

String

The EC class of the rule.

whereClause

String,null

The where clause of the rule.

functionName

String

The function name of the rule.

functionParameters

Object

The function parameters for the rule.

severity

String

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

dataType

String

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

_links

property-value-rule-self-link

The link to get the rule details.

Property Value Rule Link

TableSchema

self

Link

The link to get the rule details.

Update Property Value Rule

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

TableSchema

displayName

String

The name of the rule.

description

String

The description of the rule.

ecSchema

String

The EC schema of the rule.

ecClass

String

The EC class of the rule.

whereClause

String,null

The where clause of the rule.

severity

String

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

Link

Hyperlink container.

TableSchema

href

String

Hyperlink container.

Error

Contains error information.

TableSchema

code

String

One of a server-defined set of error codes.

message

String

A human-readable representation of the error.

target

String

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.

TableSchema

error

Error

Error information.