Block Model API

Version: 1.28.0

Run a Reporting Job

POST

/blockmodel/orgs/{org_id}/workspaces/{workspace_id}/block-models/{bm_id}/report-specifications/{rs_id}/jobs

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

Path parameters

rs_iduuid

Required

Example: "e478e8de-f6ba-4920-8c6e-0882e90f00e2"

ID of the Report Specification that this call is scoped to. Represented as a v4 UUID.

workspace_iduuid

Required

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

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

org_iduuid

Required

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

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

bm_iduuid

Required

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

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

Body parameters

Required

version_uuiduuid | null

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

ID of the block model version to run the report against. If not provided, the latest will be used.

Example body

{
  "version_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Responses

200

OK

Response schema

bm_uuiduuid

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

ID of the block model

job_urluri

>= 1 char

job_uuiduuid

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

ID of the Reporting Job.

report_specification_uuiduuid

version_idinteger

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.

version_uuiduuid

Example: "3e9ce8de-f6ba-4920-8c6e-0882e90f0ed7"

A universally unique identifier for the version

Example response

{
  "bm_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "job_url": "string",
  "job_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "report_specification_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "version_id": 0,
  "version_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

201

Successful Response

Response schema

bm_uuiduuid

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

ID of the block model

job_urluri

>= 1 char

job_uuiduuid

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

ID of the Reporting Job.

report_specification_uuiduuid

version_idinteger

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.

version_uuiduuid

Example: "3e9ce8de-f6ba-4920-8c6e-0882e90f0ed7"

A universally unique identifier for the version

Example response

{
  "bm_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "job_url": "string",
  "job_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "report_specification_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "version_id": 0,
  "version_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

401

Unauthorized

Response schema

detailstring

Example: "Invalid authentication credentials"

A human-readable explanation specific to this occurrence of the problem.

statusinteger

Example: 401

The HTTP status code generated by the origin server for this occurrence of the problem.

titlestring

Example: "Invalid authentication credentials"

A short, human-readable summary of the problem type.

typestring

Example: "https://seequent.com/error-codes/block-model-service/auth/unauthorized"

A URI reference that is the primary identifier of the problem type.

Example response

{
  "detail": "string",
  "status": 0,
  "title": "string",
  "type": "string"
}

403

Forbidden

Response schema

detailstring

Example: "Permission denied"

A human-readable explanation specific to this occurrence of the problem.

statusinteger

Example: 403

The HTTP status code generated by the origin server for this occurrence of the problem.

titlestring

Example: "Permission Denied"

A short, human-readable summary of the problem type.

typestring

Example: "https://seequent.com/error-codes/block-model-service/auth/forbidden"

A URI reference that is the primary identifier of the problem type.

Example response

{
  "detail": "string",
  "status": 0,
  "title": "string",
  "type": "string"
}

404

Not Found

Response schema

detailstring

Example: "Block model 11111111-2222-3333-4444-555555555555 not found."

A human-readable explanation specific to this occurrence of the problem.

statusinteger

Example: 404

The HTTP status code generated by the origin server for this occurrence of the problem.

titlestring

Example: "Resource Not Found"

A short, human-readable summary of the problem type.

typestring

Example: "https://seequent.com/error-codes/block-model-service/not-found"

A URI reference that is the primary identifier of the problem type.

Example response

{
  "detail": "string",
  "status": 0,
  "title": "string",
  "type": "string"
}

410

Gone

Response schema

detailstring

Example: "The requested resource was not found."

A human-readable explanation specific to this occurrence of the problem.

statusinteger

Example: 410

The HTTP status code generated by the origin server for this occurrence of the problem.

titlestring

Example: "Workspace soft deleted."

A short, human-readable summary of the problem type.

typestring

Example: "https://seequent.com/error-codes/workspace/gone"

A URI reference that is the primary identifier of the problem type.

Example response

{
  "detail": "string",
  "status": 0,
  "title": "string",
  "type": "string"
}

422

Unprocessable Content

Response schema

detailstring

Example: "Column id '11111111-2222-3333-4444-555555555555' does not match any column"

A human-readable explanation specific to this occurrence of the problem.

statusinteger

Example: 422

The HTTP status code generated by the origin server for this occurrence of the problem.

titlestring

Example: "Column Not Found"

A short, human-readable summary of the problem type.

typestring

Example: "https://seequent.com/error-codes/block-model-service/column-not-found"

A URI reference that is the primary identifier of the problem type.

Example response

{
  "detail": "string",
  "status": 0,
  "title": "string",
  "type": "string"
}

500

Internal Server Error

Response schema

detailstring

Example: "An error occurred"

A human-readable explanation specific to this occurrence of the problem.

statusinteger

Example: 500

The HTTP status code generated by the origin server for this occurrence of the problem.

titlestring

Example: "Service Error"

A short, human-readable summary of the problem type.

typestring

Example: "https://seequent.com/error-codes/block-model-service/service"

A URI reference that is the primary identifier of the problem type.

Example response

{
  "detail": "string",
  "status": 0,
  "title": "string",
  "type": "string"
}