Block Model API
Run a Reporting Job
Run a new Reporting Job.
The Reporting Job will generate a Report Result for the provided block model version using the latest revision of the Report Specification.
Request
Responses
200
OK
Example: "e3c277c2-edc6-4a7a-8380-251dd19231f2"
ID of the block model
Example: "e3c277c2-edc6-4a7a-8380-251dd19231f2"
ID of the Reporting Job.
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
201
Successful Response
Example: "e3c277c2-edc6-4a7a-8380-251dd19231f2"
ID of the block model
Example: "e3c277c2-edc6-4a7a-8380-251dd19231f2"
ID of the Reporting Job.
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
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: "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.
