Update clash detection test

Clash Detection

This operation is deprecated. Please upgrade to the current version of this API as soon as possible.

put https://dev-api.bentley.com/clashdetection/tests/{id}

Updates a clash detection test for the specified criteria and returns the id of the successfully updated test.

Discover test ids by calling GET /clashdetection/tests
Discover rule ids by calling GET /clashdetection/suppressionrules

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

Yes

Test id

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

setA

clash-detection-test-set

Yes

setB

clash-detection-test-set

Yes

description

String

Yes

The description of the test.

displayName

String

Yes

The name of the test.

advancedSettings

clash-detection-test-advanced-settings

includeSubModels

Boolean

Yes

Flag to include sub-models.

suppressTouching

Boolean

Yes

Flag to suppress touching.

suppressionRules

String[]

Yes

The ids of the suppression rules.

touchingTolerance

Number

Yes

The touching tolerance to be applied.

Example

json

{
    "displayName": "APIMtest-updated",
    "description": "APIM test",
    "setA": {
        "modelIds": ["0x21", "0x66", "0x68", "0x6a", "0x6c"],
        "categoryIds": [],
        "selfCheck": true,
        "clearance": 0.001
    },
    "setB": {
        "modelIds": [],
        "categoryIds": [],
        "selfCheck": false,
        "clearance": 0
    },
    "suppressTouching": false,
    "touchingTolerance": 0,
    "includeSubModels": false,
    "suppressionRules": ["ZuO3OCC8sUuVcgeXz1Ih_Z44rgIyaT1Nia7oxeYeNew"],
    "advancedSettings": {
        "longClash": true,
        "calculateOverlap": false,
        "toleranceOverlapValidation": false
    }
}

Response 200 OK

json

{
    "test": {
        "id": "ZuO3OCC8sUuVcgeXz1Ih_Rq6jGDLcfxNiCS9xpPhGuU",
        "displayName": "APIM-test4",
        "description": "APIM test 4",
        "setA": {
            "modelIds": ["0x21", "0x66", "0x68", "0x6a", "0x6c"],
            "categoryIds": [],
            "selfCheck": true,
            "clearance": 0.001
        },
        "setB": {
            "modelIds": [],
            "categoryIds": [],
            "selfCheck": false,
            "clearance": 0
        },
        "suppressTouching": false,
        "touchingTolerance": 0,
        "includeSubModels": false,
        "suppressionRules": ["ZuO3OCC8sUuVcgeXz1Ih_Z44rgIyaT1Nia7oxeYeNew"],
        "advancedSettings": {
            "longClash": true,
            "calculateOverlap": false,
            "toleranceOverlapValidation": false
        },
        "_links": {
            "self": {
                "href": "https://api.bentley.com/clashdetection/tests/ZuO3OCC8sUuVcgeXz1Ih_Rq6jGDLcfxNiCS9xpPhGuU"
            }
        }
    }
}

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

{
    "$ref": "#/components/examples/401.HeaderNotFound.example"
}

Response 404 Not Found

This response indicates that the specified test was not found.

json

{
    "error": {
        "code": "ClashDetectionTestNotFound",
        "message": "Requested test 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": "InvalidClashDetectionRequest",
        "message": "Invalid clash detection request.",
        "details": [{
            "code": "InvalidRequestBody",
            "message": "Required property 'displayName' is missing in the request body.",
            "target": "displayName"
        }, {
            "code": "InvalidRequestBody",
            "message": "Required property 'description' is missing in the request body.",
            "target": "description"
        }, {
            "code": "InvalidRequestBody",
            "message": "Required property 'setA' is missing in the request body.",
            "target": "setA"
        }, {
            "code": "InvalidRequestBody",
            "message": "Required property 'modelIds' is missing in setA of the request body.",
            "target": "modelIds"
        }, {
            "code": "InvalidRequestBody",
            "message": "Required property 'categoryIds' is missing in setA of the request body.",
            "target": "categoryIds"
        }, {
            "code": "InvalidRequestBody",
            "message": "Required property 'query' is missing in setA of the request body.",
            "target": "query"
        }, {
            "code": "InvalidRequestBody",
            "message": "Required property 'queryName' is missing in setA of the request body.",
            "target": "queryName"
        }, {
            "code": "InvalidRequestBody",
            "message": "Required property 'selfCheck' is missing in setA of the request body.",
            "target": "selfCheck"
        }, {
            "code": "InvalidRequestBody",
            "message": "Required property 'clearance' is missing in setA of the request body.",
            "target": "clearance"
        }, {
            "code": "InvalidRequestBody",
            "message": "Required property 'setB' is missing in the request body.",
            "target": "setB"
        }, {
            "code": "InvalidRequestBody",
            "message": "Required property 'modelIds' is missing in setB of the request body.",
            "target": "modelIds"
        }, {
            "code": "InvalidRequestBody",
            "message": "Required property 'categoryIds' is missing in setB of the request body.",
            "target": "categoryIds"
        }, {
            "code": "InvalidRequestBody",
            "message": "Required property 'query' is missing in setB of the request body.",
            "target": "query"
        }, {
            "code": "InvalidRequestBody",
            "message": "Required property 'queryName' is missing in setB of the request body.",
            "target": "queryName"
        }, {
            "code": "InvalidRequestBody",
            "message": "Required property 'selfCheck' is missing in setB of the request body.",
            "target": "setB"
        }, {
            "code": "InvalidRequestBody",
            "message": "Required property 'clearance' is missing in setB of the request body.",
            "target": "clearance"
        }, {
            "code": "InvalidRequestBody",
            "message": "Required property 'suppressTouching' is missing in the request body.",
            "target": "suppressTouching"
        }, {
            "code": "InvalidRequestBody",
            "message": "Required property 'touchingTolerance' is missing in the request body.",
            "target": "touchingTolerance"
        }, {
            "code": "InvalidRequestBody",
            "message": "Required property 'includeSubModels' is missing in the request body.",
            "target": "includeSubModels"
        }, {
            "code": "InvalidRequestBody",
            "message": "Required property 'suppressionRules' is missing in the request body.",
            "target": "suppressionRules"
        }, {
            "code": "InvalidRequestBody",
            "message": "The request body is not a valid JSON object."
        }, {
            "code": "InvalidRequestBody",
            "message": "The request is invalid."
        }, {
            "code": "InvalidRequestBody",
            "message": "Request body was not provided."
        }]
    }
}

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

retry-after

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

Definitions

Link

Hyperlink container.

href

String

Hyperlink container.

json

{
    "properties": {
        "href": {
            "type": "string",
            "description": "Hyperlink container."
        }
    },
    "description": "Hyperlink container."
}

Error

Contains error information.

code

String

One of a server-defined set of error codes.

target

String, null

The target of the error.

message

String

A human-readable representation of the error.

json

{
    "type": "object",
    "required": [
        "code",
        "message"
    ],
    "properties": {
        "code": {
            "type": "string",
            "description": "One of a server-defined set of error codes."
        },
        "target": {
            "type": "string",
            "nullable": true,
            "description": "The target of the error."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        }
    },
    "description": "Contains error information.",
    "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.

error

Error

Error information.

json

{
    "type": "object",
    "title": "Error Response",
    "required": [
        "error"
    ],
    "properties": {
        "error": {
            "$ref": "#/components/schemas/Error",
            "description": "Error information."
        }
    },
    "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.",
    "additionalProperties": false
}

Clash Detection Test Set

Criteria set for clash test.

query

Object

EC Sql query expression to select elements for the test set.

modelIds

String[]

The ids of the models to include in the clash test.

clearance

Number

The clearance between elements.

queryName

Object

Name of EC Sql query expression to select elements for the test set.

selfCheck

Boolean

Flag to perform self-check on the test set.

categoryIds

String[]

The ids of the categories to include in the clash test.

json

{
    "type": "object",
    "title": "Clash Detection Test Set",
    "properties": {
        "query": {
            "description": "EC Sql query expression to select elements for the test set."
        },
        "modelIds": {
            "type": "array",
            "items": {
                "type": "string",
                "description": "The model id."
            },
            "description": "The ids of the models to include in the clash test."
        },
        "clearance": {
            "type": "number",
            "description": "The clearance between elements."
        },
        "queryName": {
            "description": "Name of EC Sql query expression to select elements for the test set."
        },
        "selfCheck": {
            "type": "boolean",
            "description": "Flag to perform self-check on the test set."
        },
        "categoryIds": {
            "type": "array",
            "items": {
                "type": "string",
                "description": "The category id."
            },
            "description": "The ids of the categories to include in the clash test."
        }
    },
    "description": "Criteria set for clash test."
}

Clash Detection Test

String

The id of the test.

setA

clash-detection-test-set

setB

clash-detection-test-set

_links

clash-detection-test-response-link

description

String

The description of the test.

displayName

String

The name of the test.

advancedSettings

clash-detection-test-advanced-settings

includeSubModels

Boolean

Flag to include sub-models.

suppressTouching

Boolean

Flag to suppress touching.

suppressionRules

String[]

The ids of the suppression rules.

touchingTolerance

Number

The touching tolerance to be applied.

json

{
    "type": "object",
    "title": "Clash Detection Test",
    "properties": {
        "id": {
            "type": "string",
            "description": "The id of the test."
        },
        "setA": {
            "$ref": "#/components/schemas/clash-detection-test-set"
        },
        "setB": {
            "$ref": "#/components/schemas/clash-detection-test-set"
        },
        "_links": {
            "$ref": "#/components/schemas/clash-detection-test-response-link"
        },
        "description": {
            "type": "string",
            "description": "The description of the test."
        },
        "displayName": {
            "type": "string",
            "description": "The name of the test."
        },
        "advancedSettings": {
            "$ref": "#/components/schemas/clash-detection-test-advanced-settings"
        },
        "includeSubModels": {
            "type": "boolean",
            "description": "Flag to include sub-models."
        },
        "suppressTouching": {
            "type": "boolean",
            "description": "Flag to suppress touching."
        },
        "suppressionRules": {
            "type": "array",
            "items": {
                "type": "string",
                "description": "The id of the suppression rule."
            },
            "description": "The ids of the suppression rules."
        },
        "touchingTolerance": {
            "type": "number",
            "description": "The touching tolerance to be applied."
        }
    }
}