Block Model API

Version: 1.17.0

Delete a block model

DELETE

/blockmodel/orgs/{org_id}/workspaces/{workspace_id}/block-models/{bm_id}

Deletes the block model identified by bm_id.

A minimum workspace role of Editor is required to use this endpoint.

Request

Path parameters

bm_iduuid

Required

Example: "e3c277c2-edc6-4a7a-8380-251dd19231f2"

ID of the block model this call is scoped to. Represented as a v4 UUID.

workspace_iduuid

Required

Example: "860be2f5-fe06-4c1b-ac8b-7d34d2b6d2ef"

ID of the workspace this call is scoped to. Represented as a v4 UUID.

org_iduuid

Required

Example: "bf1a040c-8c58-4bc2-bec2-c5ae7de8bd84"

ID of the organization this call is scoped to. Represented as a v4 UUID.

Responses

204

Successful Response

401

Unauthorized

Response schema

detailstring

Example: "Invalid authentication credentials"

A human-readable explanation specific to this occurrence of the problem.

statusinteger

Example: 401

The HTTP status code generated by the origin server for this occurrence of the problem.

titlestring

Example: "Invalid authentication credentials"

A short, human-readable summary of the problem type.

typestring

Example: "https://seequent.com/error-codes/block-model-service/auth/unauthorized"

A URI reference that is the primary identifier of the problem type.

403

Forbidden

Response schema

detailstring

Example: "Permission denied"

A human-readable explanation specific to this occurrence of the problem.

statusinteger

Example: 403

The HTTP status code generated by the origin server for this occurrence of the problem.

titlestring

Example: "Permission Denied"

A short, human-readable summary of the problem type.

typestring

Example: "https://seequent.com/error-codes/block-model-service/auth/forbidden"

A URI reference that is the primary identifier of the problem type.

404

Not Found

Response schema

detailstring

Example: "Block model 11111111-2222-3333-4444-555555555555 not found."

A human-readable explanation specific to this occurrence of the problem.

statusinteger

Example: 404

The HTTP status code generated by the origin server for this occurrence of the problem.

titlestring

Example: "Resource Not Found"

A short, human-readable summary of the problem type.

typestring

Example: "https://seequent.com/error-codes/block-model-service/not-found"

A URI reference that is the primary identifier of the problem type.

410

Gone

Response schema

detailstring

Example: "The requested resource was not found."

A human-readable explanation specific to this occurrence of the problem.

statusinteger

Example: 410

The HTTP status code generated by the origin server for this occurrence of the problem.

titlestring

Example: "Workspace soft deleted."

A short, human-readable summary of the problem type.

typestring

Example: "https://seequent.com/error-codes/workspace/gone"

A URI reference that is the primary identifier of the problem type.

422

Unprocessable Entity

Response schema

detailstring

Example: "1 validation error for 'HTTP Request' body -> block_rotation value is not a valid list (type=type_error.list)"

A human-readable explanation specific to this occurrence of the problem.

statusinteger

Example: 422

The HTTP status code generated by the origin server for this occurrence of the problem.

titlestring

Example: "1 validation error for Request"

A short, human-readable summary of the problem type.

typestring

Example: "https://seequent.com/error-codes/block-model-service/validation"

A URI reference that is the primary identifier of the problem type.

500

Internal Server Error

Response schema

detailstring

Example: "An error occurred"

A human-readable explanation specific to this occurrence of the problem.

statusinteger

Example: 500

The HTTP status code generated by the origin server for this occurrence of the problem.

titlestring

Example: "Service Error"

A short, human-readable summary of the problem type.

typestring

Example: "https://seequent.com/error-codes/block-model-service/service"

A URI reference that is the primary identifier of the problem type.