Block Model API
Get a comparison between two Report Results
Get a comparison of two Report Results for a Report Specification
Request
Responses
200
Successful Response
Example: "bbb277c2-edc6-4a7a-8380-251dd19231f2"
ID of the block model that the report was run on
Example: {"col_id":"ddd277c2-edc6-4a7a-8380-251dd19231f2","label":"Rock type"}
List of categories used in the report
Example: "ddd277c2-edc6-4a7a-8380-251dd19231f2"
ID of the block model column
Example: "Rock type"
Label of the column
Example: "ccc277c2-edc6-4a7a-8380-251dd19231f2"
ID of the column that was used for cut-off evaluation
Example: "eee277c2-edc6-4a7a-8380-251dd19231f2"
ID of the block model column
Example: "Utf8"
Data type of the referenced column in the Report Result
Example: "Something"
Title of the referenced column
Example: "ppm[mass]"
ID of the unit of the column
Example: "ccc277c2-edc6-4a7a-8380-251dd19231f2"
Version UUID of the version of block model that the unid was from
Example: "2021-01-01T00:00:00Z"
Creation date of the Report Result
Example: "ccc277c2-edc6-4a7a-8380-251dd19231f2"
ID of the Report Result
Example: "Updated density"
Comment of the version of the block model that the report was run on
Example: "2021-01-01T00:00:00Z"
Creation date of the version of the block model that the report was run on
User who created the version of the block model that the report was run on
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: 2
Version ID of the version of the block model that the report was run on
Example: "ccc277c2-edc6-4a7a-8380-251dd19231f2"
Version UUID of the version of block model that the report was run on
Example: "A report to show the density of the block model"
Description of the Report Specification that was run
Example: "Density Report"
Name of the Report Specification that was run
Example: 1
Revision of the Report Specification that was run
Example: "e3c277c2-edc6-4a7a-8380-251dd19231f2"
ID of the Report Specification that was run
Example: 1
Cut-off value used in the report
Example: {"categories":["Granite"],"values":[2.7,0.3]}
List of rows in the Report Result
Example: ["Granite"]
List of category values. null indicates a total for that category column.
Example: [2.7,0.3]
List of values for the value columns
Example: "eee277c2-edc6-4a7a-8380-251dd19231f2"
ID of the block model column
Example: "Utf8"
Data type of the referenced column in the Report Result
Example: "Something"
Title of the referenced column
Example: "ppm[mass]"
ID of the unit of the column
Example: "ccc277c2-edc6-4a7a-8380-251dd19231f2"
Version UUID of the version of block model that the unid was from
Example: "2021-01-01T00:00:00Z"
Creation date of the Report Result
Example: "ccc277c2-edc6-4a7a-8380-251dd19231f2"
ID of the Report Result
Example: "Updated density"
Comment of the version of the block model that the report was run on
Example: "2021-01-01T00:00:00Z"
Creation date of the version of the block model that the report was run on
User who created the version of the block model that the report was run on
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: 2
Version ID of the version of the block model that the report was run on
Example: "ccc277c2-edc6-4a7a-8380-251dd19231f2"
Version UUID of the version of block model that the report was run on
Example: {"col_id":"eee277c2-edc6-4a7a-8380-251dd19231f2","label":"Average gold content","unit_id":"ppm[mass]"}
List of value columns used in the report
Example: "eee277c2-edc6-4a7a-8380-251dd19231f2"
ID of the block model column, if applicable. This will be null for system-calculated columns such as 'Mass'
Example: "Average gold content"
Label of the column
Example: "ppm[mass]"
ID of the unit of the column
Example: "Density value was null, or less than or equal to 0. The default density value of 2.7 was used."
Warning message
Example: 1
Number of occurrences of the warning
Example: "INVALID_DENSITY_VALUE"
Type of warning
Example: "Density value was null, or less than or equal to 0. The default density value of 2.7 was used."
Warning message
Example: 1
Number of occurrences of the warning
Example: "INVALID_DENSITY_VALUE"
Type of warning
Example: "Density value was null, or less than or equal to 0. The default density value of 2.7 was used."
Warning message
Example: 1
Number of occurrences of the warning
Example: "INVALID_DENSITY_VALUE"
Type of warning
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.
