Access Design Element Classification machine learning model.  
Create and manage classification runs.

designelementclassification

Reporting & Insights

Technology Preview

---

Cancels a Design Element Classification run.

### 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](https://developer.bentley.com/apis/overview/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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

---

mcl-run-cancel

runid

OAuth access token with scope `designelementclassification:modify`

Authorization

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

Accept

Design Element Classification run was successfully canceled.

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.

Design Element Classification run was not found.

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

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

retry-after

---

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](https://developer.bentley.com/apis/overview/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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

---

mcl-run-create

Design Element Classification run was successfully created.

Design Element Classification model was not found.

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

---

Deletes a Design Element Classification run.

### 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](https://developer.bentley.com/apis/overview/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](https://communities.bentley.com/communities/other_communities/licensing_cloud_and_web_services/w/wiki/50711/user-management-2-0) wiki page.

---

mcl-run-delete

Design Element Classification run was successfully deleted.

---

Returns list of all available Design Element Classification model versions.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `designelementclassification:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

mcl-model-list

OAuth access token with scope `designelementclassification:read`

---

Download Design Element Classification run result file.

### Notes

This endpoint returns a 302 status code. On success the Location header contains a link to the requested
file. Redirection is not supported by the developer portal and you are likely to run into an error when 
using the 'Try it now' feature for this endpoint. Most popular http clients will handle the 302 response
appropriately and download the file contents automatically. If your http client does not do this, then
use the link provided in the response Location header to download your requested file.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `designelementclassification:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

mcl-run-result-get

filename

Retrieved Design Element Classification run successfully.

Design Element Classification run result file was not found.

---

Returns a list of result files for Design Element Classification run.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `designelementclassification:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

mcl-run-result-list

Retrieved Design Element Classification run result list successfully.

---

Returns a Design Element Classification run.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `designelementclassification:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

mcl-run-get

---

Queries Design Element Classification run status.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `designelementclassification:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

mcl-run-status

Retrieve Design Element Classification status successfully.

---

Returns all Design Element Classification runs in a project.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `designelementclassification:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

mcl-run-list

projectid

Retrieved Design Element Classification run result successfully.

Design Element Classification

Authentication

Request

Request headers

Response

Response 200 OK

Response 401 Unauthorized

Response 429 Too many requests