Cancel the clash detection runs for the specified job ids (clash report ids) of the respective iTwin.

• Note: At present, only one run using clash report id can be cancelled at a time.

• Note: This operation is to be used only for test runs that are in progress and not completed. To delete the clash report for a completed test run, please use - POST /clash-detection/itwins/{itwinId}/reports/jobs/deletion

• To retrieve the run status as the agent job completes asynchronously, use the clash report id to call GET /clash-detection/itwins/{itwinId}/reports/{id}

• Discover clash report ids by calling GET /clash-detection/itwins/{itwinId}/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.

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

{
    "result": "success"
}

{
    "error": {
        "code": "HeaderNotFound",
        "message": "Header Authorization was not found in the request. Access denied."
    }
}

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

{
    "error": {
        "code": "InvalidCancelRunRequest",
        "message": "Clash Detection Run Cancellation Failed."
    }
}

{
    "error": {
        "code": "RateLimitExceeded",
        "message": "The client sent more requests than allowed by this API for the current tier of the client."
    }
}