Get clash detection suppression rules - Clash Detection

Clash Detection

Get clash detection suppression rules

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

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

Retrieves a list of clash detection suppression rules for the project specified by the project id.

Notes

The Prefer header can be used to specify how much rule metadata is desired

"return=minimal" (default) - returns the minimum suppression rule metadata
"return=representation" - returns the full suppression rule metadata

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 project id of the project from which to retrieve clash detection suppression rules.

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 rules to get in each page. Max 50, but 10 is the default if this parameter is not included.

Request headers

Prefer

Indicates a level of details in the response.

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.v1+json is recommended.

Response 200 OK

json

{
    "suppressionRules": [{
        "id": "ZuO3OCC8sUuVcgeXz1Ih_TGCT5rBByBBqcycpQKmKtY",
        "displayName": "MySuppressionRule1011202134318",
        "_links": {
            "rule": {
                "href": "https://api.bentley.com/clashdetection/suppressionrules/ZuO3OCC8sUuVcgeXz1Ih_TGCT5rBByBBqcycpQKmKtY"
            }
        }
    }],
    "_links": {
        "next": {
            "href": "https://api.bentley.com/clashdetection/suppressionrules?projectId=38b7e366-bc20-4bb1-9572-0797cf5221fd&continuationToken=eyJ0b3AiOjEwLCJza2lwVG9rZW4iOiJNZz09In0"
        }
    }
}

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
}

Clash Detection Rule Link

rule

Link

json

{
    "type": "object",
    "title": "Clash Detection Rule Link",
    "properties": {
        "rule": {
            "$ref": "#/components/schemas/Link"
        }
    }
}

Clash Detection Suppression Rule

Clash detection suppression rule summary (id and display name)

String

The clash detection suppression rule id.

_links

clash-detection-suppression-rule-link

displayName

String

The display name of the clash detection suppression rule.

json

{
    "type": "object",
    "title": "Clash Detection Suppression Rule",
    "properties": {
        "id": {
            "type": "string",
            "description": "The clash detection suppression rule id."
        },
        "_links": {
            "$ref": "#/components/schemas/clash-detection-suppression-rule-link"
        },
        "displayName": {
            "type": "string",
            "description": "The display name of the clash detection suppression rule."
        }
    },
    "description": "Clash detection suppression rule summary (id and display name)"
}

Clash Detection Suppression Rule

String

The id of the suppression rule.

_links

update-clash-detection-suppression-rule-response-links

reason

String

The reason for the suppression rule.

parameters

String

The parameters for the suppression rule.

templateId

String

The template id of the suppression rule.

displayName

String

The name of the suppression rule.

creationDateTime

Date-time

The date/time when the test was created.

modificationDateTime

Date-time

The date/time when the test was last modified.

json

{
    "type": "object",
    "title": "Clash Detection Suppression Rule",
    "properties": {
        "id": {
            "type": "string",
            "description": "The id of the suppression rule."
        },
        "_links": {
            "$ref": "#/components/schemas/update-clash-detection-suppression-rule-response-links"
        },
        "reason": {
            "type": "string",
            "description": "The reason for the suppression rule."
        },
        "parameters": {
            "type": "string",
            "description": "The parameters for the suppression rule."
        },
        "templateId": {
            "type": "string",
            "description": "The template id of the suppression rule."
        },
        "displayName": {
            "type": "string",
            "description": "The name of the suppression rule."
        },
        "creationDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "The date/time when the test was created."
        },
        "modificationDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "The date/time when the test was last modified."
        }
    }
}

Clash Detection Suppression Rule Links

self

Link

createdBy

Link

lastModifiedBy

Link

json

{
    "type": "object",
    "title": "Clash Detection Suppression Rule Links",
    "properties": {
        "self": {
            "$ref": "#/components/schemas/Link"
        },
        "createdBy": {
            "$ref": "#/components/schemas/Link"
        },
        "lastModifiedBy": {
            "$ref": "#/components/schemas/Link"
        }
    }
}

Clash Detection Suppression Rules

Array of clash detection suppression rules metadata (summary)

runs

clash-detection-suppression-rule-summary[]

json

{
    "type": "object",
    "title": "Clash Detection Suppression Rules",
    "properties": {
        "runs": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/clash-detection-suppression-rule-summary"
            }
        }
    },
    "description": "Array of clash detection suppression rules metadata (summary)"
}

Clash Detection Suppression Rules

Array of clash detection suppression rules metadata

runs

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

json

{
    "type": "object",
    "title": "Clash Detection Suppression Rules",
    "properties": {
        "runs": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/update-clash-detection-suppression-rule-response"
            }
        }
    },
    "description": "Array of clash detection suppression rules metadata"
}

Was this page helpful?