Get clash detection suppression rules - Clash Detection

REST API Overview

Reference

Clash Detection

Download API definition:

GET https://api.bentley.com/clash-detection/itwins/{itwinId}/suppression-rules?$continuationToken&$top[&orderBy][&reason][&name]

Retrieves the list of clash detection suppression rules for the specified iTwin id.

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

itwinId

Yes

The iTwin Id

$continuationToken

Yes

The token to access next set of suppression rules.

$top

Yes

Limit of entries on one page. Default value is 100, maximum allowed is 500.

orderBy

Optional - Allows sorting based on : creationDate, modificationDate, name, description or reason. Default is based on modificationDate

reason

Optional - It allow us to filter rules with the given value if contains in reason.

name

Optional - It allow us to filter rules with the given value if contains in name.

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

{
    "count": 2,
    "suppressionRules": [{
        "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": "{\"propertyKey\":{\"relationshipPath\":\"ArchitecturalPhysical:Door\",\"propertyName\":\"Roll\"},\"operator\":{\"value\":\"=\"}}",
        "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"
            }
        }
    }],
    "_links": {
        "self": {
            "href": "https://dev-api.bentley.com/apis/clash-detection-v2/operations/itwins/1b7d4045-a99e-441e-9318-93df23b49a57/suppression-rules"
        },
        "next": {
            "href": "https://dev-api.bentley.com/apis/clash-detection-v2/operations/itwins/1b7d4045-a99e-441e-9318-93df23b49a57/suppression-rules?$top=1&$continuationToken=Mg=="
        },
        "prev": null
    }
}

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 iTwin was not found.

json

{
    "error": {
        "code": "iTwinNotFound",
        "message": "Requested iTwin 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

Reference for response pages

self

href-link, null

Link for the current page.

href-link, null

Link to the next page.

href-link, null

Link to the previous page.

Link

href

String, null

The link to the page.

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.

User Details

User Details.

createdBy

rule-usermetadata-createdby

User details.

modifiedBy

rule-usermetadata-modifiedby

User details.

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.

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.

Clash Detection Suppression Rules

Array of clash detection suppression rules details

suppressionRules

get-clash-detection-suppression-rule-response[]

count

Number

Suppression rules count for the given iTwin.

_links

get-page-ref

Links for the paginated response.

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.

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.

Was this page helpful?