Get suppression templates - Clash Detection

REST API Overview

Reference

Clash Detection

Download API definition:

GET https://api.bentley.com/clash-detection/itwins/{itwinId}/suppression-templates[?$top][&$continuationToken][&description][&definition]

Retrieves a list of clash detection suppression templates 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

$top

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

$continuationToken

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.

description

Filters Rule Templates description based on input description.

definition

Filters Rule Templates definitions based on input definition.

Request headers

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,
    "suppressionTemplates": [{
        "id": "080c182c-c9ce-44e6-9932-de9f098befbc",
        "name": "Suppression/Definition/Generic/CompareProperties",
        "description": "Suppress clashes by comparing properties between the two clashing elements",
        "sampleText": "Suppress clashes if property -Property- on one of the clashing elements is -Operator- the same property on the other clashing element",
        "example": {
            "propertyKey": {
                "relationshipPath": "ArchitecturalPhysical:Door",
                "propertyName": "Roll"
            },
            "operator": {
                "value": "="
            }
        }
    }],
    "_links": {
        "self": {
            "href": "https://dev-api.bentley.com/apis/clash-detection-v2/operations/itwins/1b7d4045-a99e-441e-9318-93df23b49a57/suppression-templates"
        },
        "next": {
            "href": "https://dev-api.bentley.com/apis/clash-detection-v2/operations/itwins/1b7d4045-a99e-441e-9318-93df23b49a57/suppression-templates?$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.

Suppression Rule Templates

Array of suppression rule templates

suppressionTemplates

suppression-rule-template[]

count

Number

Number of suppression rule templates for the given itwin id.

_links

get-page-ref

Links for the paginated response.

Suppression Rule Template

String

The id of the suppression rule template.

name

String

The display name of the suppression rule template.

description

String

The description of the suppression rule template.

sampleText

String

The prompt for the suppression rule template.

example

suppression-rule-template-example

The example expression of the suppression rule template.

Suppression Rule Template Example

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?