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

    Delete the clash detection reports for the specified job ids (clash report ids) of the respective iTwin.

    -Note: At present, only one clash report can be deleted at a time.

    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
    Authorization
    Yes

    OAuth access token with itwin-platform scope

    Accept
    Yes

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

    Request body

    Operation Request

    Name
    Type
    Required?
    Description
    jobs
    String[]
    Yes

    Array of report ids to be deleted.

    operation
    String
    Yes

    Operation to be performed. Possible values - delete.

    Example

    json
    {
    "jobs": [
        "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    ],
    "operation": "delete"
}

    Response

    Response 200 OK

    OK

    json
    {
    "result": "success"
}

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

    json
    {
    "error": {
        "code": "iTwinNotFound",
        "message": "Requested iTwin is not available."
    }
}

    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": "InvalidDeleteReportsRequest",
        "message": "Clash Detection Reports Deletion Failed."
    }
}

    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

    Operation Request

    Name
    Type
    Description
    jobs
    String[]

    Array of report ids to be deleted.

    operation
    String

    Operation to be performed. Possible values - delete.

    Result Response

    Name
    Type
    Description
    result
    String

    Result of the operation.

    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?