Block Model API
Run a Report Comparison Job
Request a Report Comparison between two versions.
This will either create a new comparison job, or return Report Result IDs for existing report results if both are already available.
Request
Example body
{
"from_version_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"to_version_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
Responses
200
OK
Example: "e3c277c2-edc6-4a7a-8380-251dd19231f2"
ID of the Report Result for the baseline version, or null if the result does not yet exist (and a job was created).
URL to the Report Comparison Job, if created. If both results already exist, no job will be created and this will be null.
Example: "e3c277c2-edc6-4a7a-8380-251dd19231f2"
ID of the Report Result for the version to compare, or null if the result does not yet exist (and a job was created).
{
"from_result_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"job_url": "string",
"to_result_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
201
Successful Response
Example: "e3c277c2-edc6-4a7a-8380-251dd19231f2"
ID of the Report Result for the baseline version, or null if the result does not yet exist (and a job was created).
URL to the Report Comparison Job, if created. If both results already exist, no job will be created and this will be null.
Example: "e3c277c2-edc6-4a7a-8380-251dd19231f2"
ID of the Report Result for the version to compare, or null if the result does not yet exist (and a job was created).
{
"from_result_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"job_url": "string",
"to_result_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
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.
{
"detail": "string",
"status": 0,
"title": "string",
"type": "string"
}
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.
{
"detail": "string",
"status": 0,
"title": "string",
"type": "string"
}
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.
{
"detail": "string",
"status": 0,
"title": "string",
"type": "string"
}
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.
{
"detail": "string",
"status": 0,
"title": "string",
"type": "string"
}
422
Unprocessable Content
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.
{
"detail": "string",
"status": 0,
"title": "string",
"type": "string"
}
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.
{
"detail": "string",
"status": 0,
"title": "string",
"type": "string"
}
