Extract schema info

REST API Overview

Reference

Changelog

Clash Detection

Download API definition:

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

Extract schema info

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

POST https://api.bentley.com/clashdetection/schemas/imodels/{id}

Extracts the schemas for the latest named version of an iModel.

A status of 202 is returned if the schema extraction was successfully started. The job completes asynchronously so the user can periodically call GET /clashdetection/schemas/imodels until a status of 'available' is returned with the response.
Discover iModel ids by calling GET /imodels

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

template

Yes

iModel id

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Request body

Extract Schema Info

projectId

String

Yes

The project id.

Example

json

{
    "projectId": "38b7e366-bc20-4bb1-9572-0797cf5221fd"
}

Response 202 Accepted

Accepted

json

{}

Response headers

Location

The resource location

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 iModel or project was not found.

json

{
    "error": {
        "code": "iModelNotFound",
        "message": "Requested iModel 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 'projectId' is missing in the request body.",
                "target": "projectId"
            },
            {
                "code": "InvalidRequestBody",
                "message": "Requested project ID is not valid."
            },
            {
                "code": "InvalidRequestBody",
                "message": "The request is invalid."
            },
            {
                "code": "InvalidRequestBody",
                "message": "Request body was not provided."
            },
            {
                "code": "InvalidRequestBody",
                "message": "The request body is not a valid JSON object."
            }
        ]
    }
}

Response 429 Too many requests

This response indicates that the user has sent too many requests in a given amount of time.

json

{
    "error": {
        "code": "TooManyRequests",
        "message": "More requests were received than the subscription rate-limit allows."
    }
}

Response headers

retry-after

The number of requests exceeds the rate-limit for the client subscription.

Definitions

Specify the project of the iModel to be requested for schema info extraction.

TableSchema

projectId

String

The project id.

Accepted Response

Accepted.

TableSchema

No data.

Error

Contains error information.

TableSchema

code

String

One of a server-defined set of error codes.

message

String

A human-readable representation of the error.

target

String

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.

TableSchema

error

Error

Error information.