Design Element Classification

This API is a Technical Preview and is available for testing purposes only. Do not use in production.

Design Element Classification

Download API definition:

POST https://sampleHostName/designelementclassification/runs

Creates and starts new Design Element Classification run for a specific model version.

Authentication

Requires Authorization header with valid Bearer token for scope designelementclassification:modify.

For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.

Authorization

User must have MLRunInference permission(s) assigned at the Project level.

Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities Licensing, Cloud, and Web Services wiki page.


Request headers

Name
Required?
Description
Authorization
Yes

OAuth access token with scope designelementclassification:modify

Accept
No

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

Request body

MisclassificationRun_Create

Name
Type
Required?
Description
No data.

Response 201 Created

Design Element Classification run was successfully created.

json

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.

json

Response 404 Not Found

Design Element Classification model was not found.

json

Response 422 Unprocessable Entity

Design Element Classification run can not be created. Missing details.

json

Response 429 Too many requests

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

json

Response headers

Name
Description
retry-after

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