Block Model API
List Report Specifications for a block model
Gets all Report Specifications for the block model bm_id.
The list is ordered alphabetically in ascending order.
This endpoint is paginated, therefore by default this lists, at most, the first 50 items. To get other items, use
the offset and limit query parameters to select the desired part of the list.
An offset beyond the total number of Report Specifications 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 items 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
trueWhether to automatically run this Report Specification when a new version is published
Example: {"i_minmax":{"max":1,"min":0},"j_minmax":{"max":1,"min":0},"k_minmax":{"max":1,"min":0}}
Bounding box for the report
Minimum and maximum values for the i column in the file
Maximum value for the column
Minimum value for the column
Minimum and maximum values for the j column in the file
Maximum value for the column
Minimum value for the column
Minimum and maximum values for the k column in the file
Maximum value for the column
Minimum value for the column
Minimum and maximum values for the x column in the file
Maximum value for the column
Minimum value for the column
Minimum and maximum values for the y column in the file
Maximum value for the column
Minimum value for the column
Minimum and maximum values for the z column in the file
Maximum value for the column
Minimum value for the column
Example: "e3c277c2-edc6-4a7a-8380-251dd19231f2"
ID of the block model this Report Specification is associated with
Example: [{"col_id":"11c277c2-edc6-4a7a-8380-251dd19231f2","label":"Grade","values":["low","medium","high"]}]
Category columns within this Report Specification. If null or empty, the report will have a single total row for each cut-off.
Example: [{"aggregation":"SUM","col_id":"abc277c2-edc6-4a7a-8380-251dd19231f2","label":"Au content","output_unit_id":"kg"}]
Columns within this Report Specification
Examples: "SUM", "MASS_AVERAGE"
The aggregation method to use for the column
Example: "13c277c2-edc6-4a7a-8380-251dd19231f2"
ID of the column in the block model
Example: "Au Content"
The human-readable label used to identify the column
Example: "kg"
ID of the unit to use for the column output
Example: "13c277c2-edc6-4a7a-8380-251dd19231f2"
ID of the column to use for cut-off evaluation
Example: [0.5,1.5,5]
Values to use for cut-off evaluation
Example: "24c277c2-edc6-4a7a-8380-251dd19231f2"
ID of the column to use for block density
Example: "kg/m3"
ID of the unit to use for block density. The unit must be of type MASS_PER_VOLUME.
Example: 2.5
Value to use for block density
Example: "Gold resource report for test purposes"
User-supplied description of the report
Example: "2021-01-01T00:00:00Z"
Creation date of the Report Result
Example: 2
Version ID of the version of the block model that the report was run on
Example: "t"
ID of the unit to use for total mass. The unit must be of type MASS
The human-readable label used to identify the report
Example: "USE"
"IGNORE_BLOCK"Policy for handling negative values in the report's cut-off or value columns
Example: "ZERO"
"IGNORE_BLOCK"Policy for handling null values in the report's cut-off or value columns
Example: "e3c277c2-edc6-4a7a-8380-251dd19231f2"
ID of the Report Specification
Revision number of this Report Specification
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.
