Get clash detection suppression rule - Clash Detection

Clash Detection

Download API definition:

Get clash detection suppression rule

GET https://api.bentley.com/clash-detection/itwins/{itwinId}/suppression-rules/{id}

Retrieves the details of the clash detection suppression rule for the given rule id.

Discover rule ids by calling GET /clash-detection/itwins/{iTwinId}/suppression-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

Yes

Rule id

itwinId

Yes

The iTwin Id

Request headers

Include-User-Metadata

Optional - Include user metadata when true.

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Response 200 OK

json

{
    "suppressionRule": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "templateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "createdBy": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "Test Rule",
        "reason": "Clash Detection Test",
        "parameters": {
            "propertyName": "Pitch",
            "lowerBound": "1",
            "upperBound": "2"
        },
        "creationDate": "2024-04-23T17:09:59.008Z",
        "modificationDate": "2024-04-23T17:09:59.008Z",
        "lastModifiedBy": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "userMetadata": {
            "createdBy": {
                "email": "TestUser@bentley.com",
                "name": "Test User"
            },
            "modifiedBy": {
                "email": "Test.User@bentley.com",
                "name": "Test User"
            }
        }
    }
}

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": "SuppressionRuleNotFound",
        "message": "Requested suppression rule is not available."
    }
}

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

Clash Detection Suppression Rule

String

The id of the suppression rule.

name

String

The name of the suppression rule.

templateId

String

The template id of the suppression rule.

reason

String

The reason for the suppression rule.

parameters

One of: object string, null

The parameters for the suppression rule.

creationDate

Date-time

The date/time when the suppression rule was created.

modificationDate

Date-time

The date/time when the suppression rule was last modified.

createdBy

String

Id of the user that created the suppression rule.

lastModifiedBy

String

Id of user that last modified the suppression rule.

userMetadata

get-test-rule-usermetadata

The user metadata associated with the suppression rule.

json

{
    "title": "Clash Detection Suppression Rule",
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "description": "The id of the suppression rule."
        },
        "name": {
            "type": "string",
            "description": "The name of the suppression rule."
        },
        "templateId": {
            "type": "string",
            "description": "The template id of the suppression rule."
        },
        "reason": {
            "type": "string",
            "description": "The reason for the suppression rule."
        },
        "parameters": {
            "oneOf": [
                {
                    "type": "object"
                },
                {
                    "type": "string"
                }
            ],
            "nullable": true,
            "description": "The parameters for the suppression rule."
        },
        "creationDate": {
            "type": "string",
            "format": "date-time",
            "description": "The date/time when the suppression rule was created."
        },
        "modificationDate": {
            "type": "string",
            "format": "date-time",
            "description": "The date/time when the suppression rule was last modified."
        },
        "createdBy": {
            "type": "string",
            "description": "Id of the user that created the suppression rule."
        },
        "lastModifiedBy": {
            "type": "string",
            "description": "Id of user that last modified the suppression rule."
        },
        "userMetadata": {
            "$ref": "#/components/schemas/get-test-rule-usermetadata",
            "description": "The user metadata associated with the suppression rule."
        }
    },
    "additionalProperties": false
}

User Details

User Details.

createdBy

rule-usermetadata-createdby

User details.

modifiedBy

rule-usermetadata-modifiedby

User details.

json

{
    "title": "User Details",
    "type": "object",
    "description": "User Details.",
    "properties": {
        "createdBy": {
            "$ref": "#/components/schemas/rule-usermetadata-createdby",
            "description": "User details."
        },
        "modifiedBy": {
            "$ref": "#/components/schemas/rule-usermetadata-modifiedby",
            "description": "User details."
        }
    },
    "additionalProperties": false
}

Created By User Details

Created By User Details.

name

String

Name of user that created the suppression rule.

String

Email id of user that created the suppression rule.

json

{
    "title": "Created By User Details",
    "type": "object",
    "description": "Created By User Details.",
    "properties": {
        "name": {
            "type": "string",
            "description": "Name of user that created the suppression rule."
        },
        "email": {
            "type": "string",
            "description": "Email id of user that created the suppression rule."
        }
    },
    "additionalProperties": false
}

Modified By User Details

Modified By User Details.

name

String

Name of user that modified the suppression rule.

String

Email of user that modified the suppression rule.

json

{
    "title": "Modified By User Details",
    "type": "object",
    "description": "Modified By User Details.",
    "properties": {
        "name": {
            "type": "string",
            "description": "Name of user that modified the suppression rule."
        },
        "email": {
            "type": "string",
            "description": "Email of user that modified the suppression rule."
        }
    },
    "additionalProperties": false
}

Clash Detection Suppression Rule

Clash detection suppression rule details

suppressionRule

get-clash-detection-suppression-rule-response

json

{
    "title": "Clash Detection Suppression Rule",
    "type": "object",
    "description": "Clash detection suppression rule details",
    "properties": {
        "suppressionRule": {
            "$ref": "#/components/schemas/get-clash-detection-suppression-rule-response"
        }
    },
    "additionalProperties": false
}

Error

Contains error information.

code

String

One of a server-defined set of error codes.

message

String

A human-readable representation of the error.

target

String, null

The target of the error.

json

{
    "type": "object",
    "description": "Contains error information.",
    "properties": {
        "code": {
            "type": "string",
            "description": "One of a server-defined set of error codes."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        },
        "target": {
            "type": "string",
            "description": "The target of the error.",
            "nullable": true
        }
    },
    "required": [
        "code",
        "message"
    ],
    "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",
    "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.",
    "properties": {
        "error": {
            "description": "Error information.",
            "$ref": "#/components/schemas/Error"
        }
    },
    "required": [
        "error"
    ],
    "additionalProperties": false
}

Was this page helpful?