Skip to main content

Block Model API

Version: 1.17.0

Request a list of units

GET
/blockmodel/orgs/{org_id}/units

Get the list of available units

Request

Path parameters

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

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

Responses

200

Successful Response

Examples: 1, 1000

Conversion factor to convert to the reference unit for this unit type

Examples: "Metres", "Kilograms per cubic metre"

Description of the unit

Examples: "m", "kg/m³"

Display symbol for the unit

Examples: "m", "kg/m3"

ID of the unit

Examples: "LENGTH", "MASS_PER_VOLUME"

Type of the unit

401

Unauthorized

Example: "Invalid authentication credentials"

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

Example: 401

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

Example: "Invalid authentication credentials"

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

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

Example: "Permission denied"

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

Example: 403

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

Example: "Permission Denied"

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

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

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

422

Unprocessable Entity

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.

Example: 422

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

Example: "1 validation error for Request"

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

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

Example: "An error occurred"

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

Example: 500

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

Example: "Service Error"

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

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

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


© Seequent, The Bentley Subsurface Company