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.
- Discover clash report id 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.
Request parameters
The iTwin Id
Request headers
OAuth access token with itwin-platform scope
Setting to application/vnd.bentley.itwin-platform.v2+json is recommended.
Request body
Operation Request
Array of report ids to be deleted.
Operation to be performed. Possible values - delete.
Example
{ "jobs": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ], "operation": "delete" }
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.
{ "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.
{ "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)
{ "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.
{ "error": { "code": "RateLimitExceeded", "message": "The client sent more requests than allowed by this API for the current tier of the client." } }
Response headers
Number of seconds to wait until client is allowed to make more requests.
Operation Request
Array of report ids to be deleted.
Operation to be performed. Possible values - delete.
{ "title": "Operation Request", "type": "object", "properties": { "jobs": { "type": "array", "description": "Array of report ids to be deleted.", "items": { "type": "string", "description": "Report id." } }, "operation": { "type": "string", "description": "Operation to be performed. Possible values - delete." } }, "additionalProperties": false, "required": [ "jobs", "operation" ] }
Result Response
Result of the operation.
{ "title": "Result Response", "type": "object", "properties": { "result": { "type": "string", "description": "Result of the operation." } }, "additionalProperties": false, "required": [ "result" ] }
Error
Contains error information.
One of a server-defined set of error codes.
A human-readable representation of the error.
The target of the error.
{ "type": "object", "description": "Contains error information.", "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "A human-readable representation of the error." }, "target": { "type": "string", "description": "The target of the error.", "nullable": true } }, "required": [ "code", "message" ], "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.
{ "type": "object", "title": "Error Response", "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.", "properties": { "error": { "description": "Error information.", "$ref": "#/components/schemas/Error" } }, "required": [ "error" ], "additionalProperties": false }
Was this page helpful?