• Get Started
  • Documentation
  • Samples
  • Blog
  • Pricing
    • Free Trial
    Table of contents
    Overview
    Samples
    Changelog
    Clash Detection
    Download API definition:
    Apply clash detection manual suppressions
    POST https://api.bentley.com/clash-detection/itwins/{itwinId}/manual-suppressions

    Apply manual suppressions to clash detection reports.

    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

    Request parameters

    Name
    Required?
    Description
    itwinId
    Yes

    The iTwin Id

    Request headers

    Name
    Required?
    Description
    repository-id
    Yes

    Repository id (iModel id) of the clash report to which manual suppressions should be applied.

    clash-report-id
    Yes

    Clash report id to which manual suppressions should be applied.

    Authorization
    Yes

    OAuth access token with itwin-platform scope

    Accept
    Yes

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

    Request body

    Apply Clash Detection Manual Suppression

    Name
    Type
    Required?
    Description
    elementIds
    element-id-pair[]
    Yes

    Array of elementId pair (maximum allowed is 50).

    reason
    String
    Yes

    Reason why the clashes will be suppressed.

    Example

    json
    {
    "elementIds": [
        ["0x21", "0x23"],
        ["0x61", "0x96"]
    ],
    "reason": "Reason why the clashes will be manually suppressed."
}

    Response

    Response 201 Created

    Indicates that the manual suppressions were successfully applied. There is no response body in this case.

    Response 401 Unauthorized

    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 clash report/repository/iTwin was not found.

    json
    {
    "error": {
        "code": "ResourceNotFound",
        "message": "Requested Resource is not available.",
        "details": [{
                "code": "iTwinNotFound",
                "message": "Requested iTwin is not available.",
                "target": "itwin-id"
            },
            {
                "code": "repositoryIdNotFound",
                "message": "Requested Repository Id is not available.",
                "target": "repository-id"
            },
            {
                "code": "ClashReportIdNotFound",
                "message": "Requested Clash Report Id is not available.",
                "target": "clash-report-id"
            }
        ]
    }
}

    Response 422 Unprocessable Entity

    The 422 (Unprocessable Entity) status code indicates that the request cannot be processed by the server due to a client error (e.g. malformed request syntax)

    json
    {
    "error": {
        "code": "InvalidManualSuppressionsRequest",
        "message": "Invalid manual suppressions request."
    }
}

    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

    Name
    Description
    retry-after

    Number of seconds to wait until client is allowed to make more requests.

    Definitions

    Apply Clash Detection Manual Suppression

    Name
    Type
    Description
    elementIds
    element-id-pair[]

    Array of elementId pair (maximum allowed is 50).

    reason
    String

    Reason why the clashes will be suppressed.

    Element id pair

    Pair of element ids which needs to be manually suppressed/unsuppressed.

    DetailedError

    Contains error information and an array of more specific errors.

    Name
    Type
    Description
    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.

    details
    Error[]

    Optional array of more specific errors.

    Detailed 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.

    Name
    Type
    Description
    error
    DetailedError

    Error Detailed information.

    Error

    Contains error information.

    Name
    Type
    Description
    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.

    Name
    Type
    Description
    error
    Error

    Error information.

    Was this page helpful?