Get suppression rule templates - Clash Detection

Clash Detection

Get suppression rule templates

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

get https://dev-api.bentley.com/clashdetection/suppressionruletemplates?projectId[&continuationToken][&$top]

Retrieves a list of Clash Detection suppression rule templates for the project specified by the project 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

projectId

Yes

The id of the project associated with the suppression rule templates.

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's _links.next property. If this is specified and $top is omitted, the next page will be the same size as the previous page.

$top

The number of rule templates to get in each page. Max 50, but 15 is the default if this parameter is not included.

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Response 200 OK

json

{
    "suppressionRuleTemplates": [{
        "id": "080c182c-c9ce-44e6-9932-de9f098befbc",
        "displayName": "Suppression/Definition/Generic/CompareProperties",
        "description": "Suppress clashes by comparing properties between the two clashing elements",
        "prompt": "Suppress clashes if property -Property- on one of the clashing elements is -Operator- the same property on the other clashing element",
        "templateExpression": {
            "propertyKey": {
                "relationshipPath": "ArchitecturalPhysical:Door",
                "propertyName": "Roll"
            },
            "operator": {
                "value": "="
            }
        }
    }],
    "_links": {
        "next": {
            "href": "https://api.bentley.com/clashdetection/suppressionRuleTemplates?projectId=38b7e366-bc20-4bb1-9572-0797cf5221fd&continuationToken=eyJ0b3AiOjMsInNraXBUb2tlbiI6Ik5RPT0ifQ"
        }
    }
}

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 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
}

Forward-Only Paging Link

Link to get the next page of data, if applicable. Link to the previous page is not available.

Link

json

{
    "type": "object",
    "title": "Forward-Only Paging Link",
    "properties": {
        "next": {
            "$ref": "#/components/schemas/Link"
        }
    },
    "description": "Link to get the next page of data, if applicable. Link to the previous page is not available."
}

Suppresion Rule Template

String

The id of the suppression rule template.

prompt

String

The prompt for the suppression rule template.

description

String

The description of the suppression rule template.

displayName

String

The display name of the suppression rule template.

templateExpression

Object

The expression of the suppression rule template.

json

{
    "type": "object",
    "title": "Suppresion Rule Template",
    "properties": {
        "id": {
            "type": "string",
            "description": "The id of the suppression rule template."
        },
        "prompt": {
            "type": "string",
            "description": "The prompt for the suppression rule template."
        },
        "description": {
            "type": "string",
            "description": "The description of the suppression rule template."
        },
        "displayName": {
            "type": "string",
            "description": "The display name of the suppression rule template."
        },
        "templateExpression": {
            "description": "The expression of the suppression rule template."
        }
    }
}

Suppression Rule Templates

Array of suppression rule templates

_links

forward-only-paging-links

suppressionRuleTemplates

suppression-rule-template[]

json

{
    "type": "object",
    "title": "Suppression Rule Templates",
    "properties": {
        "_links": {
            "$ref": "#/components/schemas/forward-only-paging-links"
        },
        "suppressionRuleTemplates": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/suppression-rule-template"
            }
        }
    },
    "description": "Array of suppression rule templates"
}

Was this page helpful?