This operation is deprecated. Please upgrade to the current version of this API as soon as possible.
POST https://api.bentley.com/clashdetection/runs
Runs a Clash Detection test for the specified test id and returns the run id. The maximum number of clashes may be specified with the resultsLimit parameter in the request body. If none is specified, the default is 100,000.
This API has a rate limit of 6 API calls per second. If an application exceeds the rate limit it will receive an HTTP error code 429 "Too Many Requests". The error response includes a Retry-After header that indicates how long clients should wait before retrying.
A link is included to retrieve the run status as the agent job completes asynchronously.
Optional - Select inPlace flag, available values - False: create new clash results in subsequent runs for the combination of TestId, iModelId and namedVersionId; True: update the existing clash results in subsequent runs for the combination of TestId, iModelId and namedVersionId; Force: run the clash test on same combination
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
HeaderNotFound
{"error":{"code":"HeaderNotFound","message":"Header Authorization was not found in the request. Access denied."}}
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":"InvalidClashDetectionRequest","message":"Invalid clash detection request.","details":[{"code":"InvalidRequestBody","message":"Required property 'iModelId' is missing in the request body.","target":"iModelId"},{"code":"InvalidRequestBody","message":"Required property 'namedVersionId' is missing in the request body.","target":"namedVersionId"},{"code":"InvalidRequestBody","message":"Required property 'testId' is missing in the request body.","target":"testId"},{"code":"InvalidRequestBody","message":"Request body was not provided."},{"code":"InvalidRequestBody","message":"The request is invalid."},{"code":"InvalidRequestBody","message":"The request body is not a valid JSON object."}]}}
Optional - Select inPlace flag, available values - False: create new clash results in subsequent runs for the combination of TestId, iModelId and namedVersionId; True: update the existing clash results in subsequent runs for the combination of TestId, iModelId and namedVersionId; Force: run the clash test on same combination
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.