Block Model API
Advise that the update file has finished uploading
Signals that you have finished uploading the update file to the server blob storage indicated by the upload_url
, and that the update can continue. This moves the job_status
from PENDING_UPLOAD
to QUEUED
.
After this endpoint is called, the job_url
should then be polled with a GET request to wait for the job_status
field of the job to become either FAILED
or COMPLETE
. On workflow success, a new version of the block model will be created that will contain the changes specified in the update request.
Note that this endpoint still needs to be hit even when an update does not require a file upload.
A minimum workspace role of Editor is required to use this endpoint.
Request
Responses
201
Successful Response
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: "The requested resource is deleted."
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: "Workspace not found."
A short, human-readable summary of the problem type.
Example: "https://seequent.com/error-codes/workspace/not-found"
A URI reference that is the primary identifier of the problem type.
409
Conflict
Example: "A file has already been uploaded for this update."
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: "File Conflict"
A short, human-readable summary of the problem type.
Example: "https://seequent.com/error-codes/block-model-service/file-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: "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.