Create clash detection suppression rule

Clash Detection

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

post https://dev-api.bentley.com/clashdetection/suppressionrules

Creates a clash detection suppression rule for the specified criteria and returns the rule id.

Discover rule template ids by calling GET /clashdetection/suppressionRuleTemplates

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 headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

reason

String

Yes

The description of the suppression rule.

parameters

Object

Yes

The parameters of the suppression rule must match the parameters of the template.

templateId

String

Yes

The template id of the suppression rule.

displayName

String

Yes

The name of the suppression rule.

Example

json

{
    "projectId": "38b7e366-bc20-4bb1-9572-0797cf5221fd",
    "displayName": "TestRule1",
    "reason": "test rule",
    "templateId": "ZuO3OCC8sUuVcgeXz1Ih_SwYDAjOyeZEmTLenwmL77w",
    "parameters": {
        "propertyKey": {
            "relationshipPath": "ArchitecturalPhysical:Door",
            "propertyName": "Roll"
        },
        "operator": {
            "value": "="
        }
    }
}

Response 201 Created

Created

json

{
    "suppressionRule": {
        "id": "ZuO3OCC8sUuVcgeXz1Ih_bY3PLfjqRhEhbD1lD18eZU",
        "displayName": "PV-rule-3",
        "templateId": "ZuO3OCC8sUuVcgeXz1Ih_SwYDAjOyeZEmTLenwmL77w",
        "reason": "PV rule 3",
        "parameters": "{\"propertyKey\":{\"relationshipPath\":\"ArchitecturalPhysical:Door\",\"propertyName\":\"Roll\"},\"operator\":{\"value\":\"=\"}}",
        "_links": {
            "self": {
                "href": "https://api.bentley.com/clashdetection/suppressionrules/ZuO3OCC8sUuVcgeXz1Ih_bY3PLfjqRhEhbD1lD18eZU"
            },
            "createdBy": {
                "href": "https://api.bentley.com/accesscontrol/itwins/38b7e366-bc20-4bb1-9572-0797cf5221fd/members/fd4c4a79-e24a-4b35-9faf-f4fa6f4fa62b"
            }
        }
    }
}

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

{
    "$ref": "#/components/examples/401.HeaderNotFound.example"
}

Response 404 Not Found

This response indicates that the specified project was not found.

json

{
    "error": {
        "code": "ProjectNotFound",
        "message": "Requested project 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": "InvalidClashDetectionRequest",
        "message": "Invalid clash detection request.",
        "details": [{
            "code": "InvalidRequestBody",
            "message": "Required property 'displayName' is missing in the request body.",
            "target": "displayName"
        }, {
            "code": "InvalidRequestBody",
            "message": "Required property 'reason' is missing in the request body.",
            "target": "reason"
        }, {
            "code": "InvalidRequestBody",
            "message": "Required property 'templateId' is missing in the request body.",
            "target": "templateId"
        }, {
            "code": "InvalidRequestBody",
            "message": "Required property 'parameters' is missing in the request body.",
            "target": "parameters"
        }, {
            "code": "InvalidRequestBody",
            "message": "The request is invalid."
        }, {
            "code": "InvalidRequestBody",
            "message": "Request body was not provided."
        }, {
            "code": "InvalidRequestBody",
            "message": "The request body is not a valid JSON object."
        }]
    }
}

Response 429 Too many requests

This response indicates that the client sent more requests than allowed by this API for the current tier of the client.

json

{
    "error": {
        "code": "RateLimitExceeded",
        "message": "The client sent more requests than allowed by this API for the current tier of the client."
    }
}

Response headers

retry-after

Number of seconds to wait until client is allowed to make more requests.

Definitions

Link

Hyperlink container.

href

String

Hyperlink container.

json

{
    "properties": {
        "href": {
            "type": "string",
            "description": "Hyperlink container."
        }
    },
    "description": "Hyperlink container."
}

Error

Contains error information.

code

String

One of a server-defined set of error codes.

target

String, null

The target of the error.

message

String

A human-readable representation of the error.

json

{
    "type": "object",
    "required": [
        "code",
        "message"
    ],
    "properties": {
        "code": {
            "type": "string",
            "description": "One of a server-defined set of error codes."
        },
        "target": {
            "type": "string",
            "nullable": true,
            "description": "The target of the error."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        }
    },
    "description": "Contains error information.",
    "additionalProperties": true
}

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.

error

Error

Error information.

json

{
    "type": "object",
    "title": "Error Response",
    "required": [
        "error"
    ],
    "properties": {
        "error": {
            "$ref": "#/components/schemas/Error",
            "description": "Error information."
        }
    },
    "description": "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.",
    "additionalProperties": false
}