Block Model API
Update a Report Specification
Update a Report Specification for the block model.
Changes to any properties other than name, description, and autorun will incrememnt the revision number on the Report
Specification, as results based on older revisions may no longer be comparable.
Request
Responses
200
Successful Response
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
URL for the Reporting Job, if run_now was requested
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
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.
409
Conflict
Example: "Block model name test-model already exists."
A human-readable explanation specific to this occurrence of the problem.
Example: 409
The HTTP status code generated by the origin server for this occurrence of the problem.
Example: "Name Conflict"
A short, human-readable summary of the problem type.
Example: "https://seequent.com/error-codes/block-model-service/name-conflict"
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: "Column id '11111111-2222-3333-4444-555555555555' does not match any column"
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: "Column Not Found"
A short, human-readable summary of the problem type.
Example: "https://seequent.com/error-codes/block-model-service/column-not-found"
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.
