Block Model API
List version metadata for all versions of a block model
Gets all versions of the block model bm_id.
The list is ordered from the newest version to the oldest version.
This endpoint is paginated, therefore by default this lists, at most, the first 50 versions. To get other versions, use
the offset and limit query parameters to select the desired part of the list. An offset beyond the total number of
versions for the block model will result in an empty results list. The limit must be an integer from 1 to 100.
The response includes total, which is the total number of versions within the list.
All workspace roles can use this endpoint.
Request
Responses
200
Successful Response
Number of results returned in results
Maximum number of items requested
Index of the first item in results with respect to the full list without pagination
List of all units referenced in the results
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
List of results
Example: 4
Version the update was applied to. This will be the same as parent_version_id, except for
updates made by Leapfrog, where it is the current local version when the block model is published. This is null if this
is the first version.
Bounding box of data updated between this version and last version. Will be None for the initial version, and updates that only delete and rename columns.
Example: "e3c277c2-edc6-4a7a-8380-251dd19231f2"
ID of the block model
User-supplied comment
When the version was created
User who performed the action that created the version
Example: "kim@example.test"
The primary email address of the user. Can be null if an error occurred while retrieving this information.
Example: "59b73891-5538-4e45-ae67-f8c5b00d7405"
The ID of the user
Example: "Kim Kim"
The full name of the user. Can be null if an error occurred while retrieving this information.
Example: "1234567890"
ID of the Geoscience Object Service object version associated with this block model version
Columns within this version
Example: "618d6339-2fa7-4dfd-9c7f-c0b12016639e"
The ID of the column, a UUID for non-system columns
Capitalized list of supported PyArrow datatypes outlined in https://arrow.apache.org/docs/python/api/datatypes.html.
Timestamp datatype is expected to be used with unit measured in "us" and timezone set to "UTC" inside of parquet column header schema or it won't be accepted; an example for PyArrow binding would look like this: pa.timestamp("us", tz="UTC")
The human-readable label used to identify the column
The ID of the column's unit
Example: 4
Previous version. 0 if this is the first version.
Example: 5
Identifier for the version within a block model as a monotonically increasing integer, where 1 is
the version_id for the version created upon creation of the block model.
Example: "3e9ce8de-f6ba-4920-8c6e-0882e90f0ed7"
A universally unique identifier for the version
Total number of items within the full list without pagination
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.
404
Not Found
Example: "Block model 11111111-2222-3333-4444-555555555555 not found."
A human-readable explanation specific to this occurrence of the problem.
Example: 404
The HTTP status code generated by the origin server for this occurrence of the problem.
Example: "Resource Not Found"
A short, human-readable summary of the problem type.
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
Example: "The requested resource was not found."
A human-readable explanation specific to this occurrence of the problem.
Example: 410
The HTTP status code generated by the origin server for this occurrence of the problem.
Example: "Workspace soft deleted."
A short, human-readable summary of the problem type.
Example: "https://seequent.com/error-codes/workspace/gone"
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.
