Getting a block model

Get the block model with ID bm_id in the workspace workspace_id using the Get a block model's metadata endpoint.

Request

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

Query parameters

Query parameter	Description
deleted	Optional. You must set the boolean parameter deleted to true when retrieving a block model 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 block model has been deleted and you did not provide the query parameter deleted=true, the API will respond with the status code 410 Gone.

Example: Getting a deleted block model

A deleted block model 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, and the response body contains the block model.