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:

GET https://sampleHostName/designelementclassification/runs/{runid}/results/{filename}

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 page.


Request parameters

Name
In
Required?
Description
runid
template
Yes
filename
template
Yes

Request headers

Name
Required?
Description
Authorization
Yes

OAuth access token with scope designelementclassification:read

Accept
No

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

Response 200 OK

Retrieved Design Element Classification run successfully.

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 run result file was not found.

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.