Skip to main content

Block Model API

Version: 1.17.0

Advise that the update file has finished uploading

POST
/blockmodel/orgs/{org_id}/workspaces/{workspace_id}/block-models/{bm_id}/jobs/{job_id}/uploaded

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

Path parameters

Example: "ff0b8078-c7ec-41ab-87fb-f3eb32812b32"

ID of the job this call is scoped to. Represented as a v4 UUID.

Example: "860be2f5-fe06-4c1b-ac8b-7d34d2b6d2ef"

ID of the workspace this call is scoped to. Represented as a v4 UUID.

Example: "bf1a040c-8c58-4bc2-bec2-c5ae7de8bd84"

ID of the organization this call is scoped to. Represented as a v4 UUID.

Example: "e3c277c2-edc6-4a7a-8380-251dd19231f2"

ID of the block model this call is scoped to. Represented as a v4 UUID.

Responses

201

Successful Response

job_urluri

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.


© Seequent, The Bentley Subsurface Company