Updating block model metadata
Update the metadata of the block model bm_id in the workspace workspace_id using the Update a block model's metadata endpoint. Currently, the only metadata that can be modified using this endpoint is the block model name, description, and size_unit_id.
Request
| Method | Request URL |
|---|---|
| PATCH | /orgs/{org_id}/workspaces/{workspace_id}/block-models/{bm_id} |
Request Body
{
"description": "string",
"name": "string",
"coordinate_reference_system": "string",
"size_unit_id": "string"
}
| Schema field | Description |
|---|---|
| description | Optional. New description for the block model. Maximum 500 characters. |
| name | Optional. New name for the block model, must be between 3 and 100 characters (inclusive). |
| coordinate_reference_system | Optional. The coordinate reference system used for the block model definition. See Coordinate reference systems for more information. |
| size_unit_id | Optional. The ID of the unit that block sizes are measured in. |
name, description, and size_unit_id are all optional. However, if none of them are provided, the API will respond with the HTTP status code 422 Unprocessable Entity.
Response
On success, the API will respond with HTTP status code 200 OK, and a response body containing the updated BlockModel object.
If another block model exists in the workspace workspace_id with the same name as name, the request will fail with an HTTP status code of 409 Conflict.
Example: Updating the name of a block model
The name of a block model bm_id can be modified using the following request.
| Method | Request URL |
|---|---|
| PATCH | /orgs/{org_id}/workspaces/{workspace_id}/block-models/{bm_id} |
{
"name": "My new block model name"
}
The new name is not currently in use by another block model, so the request succeeds with the status 200 OK. The BlockModel object is returned in the response body with the updated value in the name field.
