Get BlockModel

Get the BlockModel with ID bm_id in the workspace workspace_id.

Request

Method	Request URL
GET	/orgs/{org_id}/workspaces/{workspace_id}/block-models/{bm_id}

Query parameters

Query parameter	Description
deleted	Optional. The boolean parameter deleted must be set to true when retrieving a BlockModel that has been deleted via the Delete BlockModel endpoint. Default value is false.

Response

On success, the API will respond with HTTP status code 200 OK along with the BlockModel object in the response body.

If the BlockModel has been soft-deleted and the query parameter deleted=true has not been provided, the API will respond with status code 410 Gone.

Example: Get a Deleted BlockModel

A soft-deleted BlockModel bm_id can be retrieved using the following request.

Method	Request URL
GET	/orgs/{org_id}/workspaces/{workspace_id}/block-models/{bm_id}?deleted=true

The request succeeds with HTTP status code 200 OK, the response body contains the BlockModel.