Block Model API

Version: 1.25.0

Update a Report Specification

PATCH

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

Update a Report Specification for the block model.

Changes to any properties other than name, description, and autorun will incrememnt the revision number on the Report Specification, as results based on older revisions may no longer be comparable.

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.

Query parameters

run_nowboolean

Whether to trigger a Reporting Job immediately after the update of the Report Specification

Body parameters

Required

autorunboolean

Default: true

Whether to automatically run this Report Specification when a new version is published

bboxBBox | BBoxXYZ | null

Example: {"i_minmax":{"max":1,"min":0},"j_minmax":{"max":1,"min":0},"k_minmax":{"max":1,"min":0}}

Bounding box for the report

Any of:

One of:

BBoxobject

i_minmaxIntRange

Required

Minimum and maximum values for the i column in the file

maxinteger

Required

Maximum value for the column

mininteger

Required

Minimum value for the column

j_minmaxIntRange

Required

Minimum and maximum values for the j column in the file

maxinteger

Required

Maximum value for the column

mininteger

Required

Minimum value for the column

k_minmaxIntRange

Required

Minimum and maximum values for the k column in the file

maxinteger

Required

Maximum value for the column

mininteger

Required

Minimum value for the column

BBoxXYZobject

x_minmaxFloatRange

Required

Minimum and maximum values for the x column in the file

maxnumber

Required

Maximum value for the column

minnumber

Required

Minimum value for the column

y_minmaxFloatRange

Required

Minimum and maximum values for the y column in the file

maxnumber

Required

Maximum value for the column

minnumber

Required

Minimum value for the column

z_minmaxFloatRange

Required

Minimum and maximum values for the z column in the file

maxnumber

Required

Maximum value for the column

minnumber

Required

Minimum value for the column

null

categoriesarray | null

Example: [{"col_id":"11c277c2-edc6-4a7a-8380-251dd19231f2","label":"Grade","values":["low","medium","high"]}]

Category columns within this Report Specification. If null or empty, the report will have a single total row for each cut-off.

columnsobject[]

Required

Example: [{"aggregation":"SUM","col_id":"abc277c2-edc6-4a7a-8380-251dd19231f2","label":"Au content","output_unit_id":"kg"}]

Columns within this Report Specification

aggregation"SUM" | "MASS_AVERAGE"

Examples: "SUM", "MASS_AVERAGE"

The aggregation method to use for the column

col_iduuid

Example: "13c277c2-edc6-4a7a-8380-251dd19231f2"

ID of the column in the block model

labelstring

<= 120 chars

Example: "Au Content"

The human-readable label used to identify the column

output_unit_idstring

Example: "kg"

ID of the unit to use for the column output

cutoff_col_idstring | null

Example: "13c277c2-edc6-4a7a-8380-251dd19231f2"

ID of the column to use for cut-off evaluation

cutoff_valuesarray | null

Example: [0.5,1.5,5]

Values to use for cut-off evaluation

density_col_idstring | null

Example: "24c277c2-edc6-4a7a-8380-251dd19231f2"

ID of the column to use for block density

density_unit_idstring | null

Example: "kg/m3"

ID of the unit to use for block density. The unit must be of type MASS_PER_VOLUME.

density_valuenumber | null

Example: 2.5

Value to use for block density

descriptionstring | null

<= 1,000 chars

Example: "Gold resource report for test purposes"

User-supplied description of the report

mass_unit_idstring

Required

Example: "t"

ID of the unit to use for total mass. The unit must be of type MASS

namestring

Required

<= 120 chars

The human-readable label used to identify the report

negative_values_policystring | null

Example: "USE"

Default: "IGNORE_BLOCK"

Policy for handling negative values in the report's cut-off or value columns

null_values_policystring | null

Example: "ZERO"

Default: "IGNORE_BLOCK"

Policy for handling null values in the report's cut-off or value columns

Example body

{
  "autorun": true,
  "bbox": {
    "i_minmax": {
      "max": 0,
      "min": 0
    },
    "j_minmax": {
      "max": 0,
      "min": 0
    },
    "k_minmax": {
      "max": 0,
      "min": 0
    }
  },
  "categories": [
    {
      "col_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "label": "string",
      "values": [
        "string"
      ]
    }
  ],
  "columns": [
    {
      "aggregation": "SUM",
      "col_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "label": "string",
      "output_unit_id": "string"
    }
  ],
  "cutoff_col_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "cutoff_values": [
    0
  ],
  "density_col_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "density_unit_id": "string",
  "density_value": 0,
  "description": "string",
  "mass_unit_id": "string",
  "name": "string",
  "negative_values_policy": "USE",
  "null_values_policy": "ZERO"
}

Responses

200

Successful Response

Response schema

autorunboolean

Default: true

Whether to automatically run this Report Specification when a new version is published

bboxBBox | BBoxXYZ | null

Example: {"i_minmax":{"max":1,"min":0},"j_minmax":{"max":1,"min":0},"k_minmax":{"max":1,"min":0}}

Bounding box for the report

Any of:

One of:

BBoxobject

i_minmaxIntRange

Minimum and maximum values for the i column in the file

maxinteger

Maximum value for the column

mininteger

Minimum value for the column

j_minmaxIntRange

Minimum and maximum values for the j column in the file

maxinteger

Maximum value for the column

mininteger

Minimum value for the column

k_minmaxIntRange

Minimum and maximum values for the k column in the file

maxinteger

Maximum value for the column

mininteger

Minimum value for the column

BBoxXYZobject

x_minmaxFloatRange

Minimum and maximum values for the x column in the file

maxnumber

Maximum value for the column

minnumber

Minimum value for the column

y_minmaxFloatRange

Minimum and maximum values for the y column in the file

maxnumber

Maximum value for the column

minnumber

Minimum value for the column

z_minmaxFloatRange

Minimum and maximum values for the z column in the file

maxnumber

Maximum value for the column

minnumber

Minimum value for the column

null

bm_uuiduuid

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

ID of the block model this Report Specification is associated with

categoriesarray | null

Example: [{"col_id":"11c277c2-edc6-4a7a-8380-251dd19231f2","label":"Grade","values":["low","medium","high"]}]

Category columns within this Report Specification. If null or empty, the report will have a single total row for each cut-off.

columnsobject[]

Example: [{"aggregation":"SUM","col_id":"abc277c2-edc6-4a7a-8380-251dd19231f2","label":"Au content","output_unit_id":"kg"}]

Columns within this Report Specification

aggregation"SUM" | "MASS_AVERAGE"

Examples: "SUM", "MASS_AVERAGE"

The aggregation method to use for the column

col_iduuid

Example: "13c277c2-edc6-4a7a-8380-251dd19231f2"

ID of the column in the block model

labelstring

<= 120 chars

Example: "Au Content"

The human-readable label used to identify the column

output_unit_idstring

Example: "kg"

ID of the unit to use for the column output

cutoff_col_idstring | null

Example: "13c277c2-edc6-4a7a-8380-251dd19231f2"

ID of the column to use for cut-off evaluation

cutoff_valuesarray | null

Example: [0.5,1.5,5]

Values to use for cut-off evaluation

density_col_idstring | null

Example: "24c277c2-edc6-4a7a-8380-251dd19231f2"

ID of the column to use for block density

density_unit_idstring | null

Example: "kg/m3"

ID of the unit to use for block density. The unit must be of type MASS_PER_VOLUME.

density_valuenumber | null

Example: 2.5

Value to use for block density

descriptionstring | null

<= 1,000 chars

Example: "Gold resource report for test purposes"

User-supplied description of the report

job_urlstring | null

>= 1 char

URL for the Reporting Job, if run_now was requested

mass_unit_idstring

Example: "t"

ID of the unit to use for total mass. The unit must be of type MASS

namestring

<= 120 chars

The human-readable label used to identify the report

negative_values_policystring | null

Example: "USE"

Default: "IGNORE_BLOCK"

Policy for handling negative values in the report's cut-off or value columns

null_values_policystring | null

Example: "ZERO"

Default: "IGNORE_BLOCK"

Policy for handling null values in the report's cut-off or value columns

report_specification_uuiduuid

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

ID of the Report Specification

revisioninteger

Revision number of this Report Specification

Example response

{
  "autorun": true,
  "bbox": {
    "i_minmax": {
      "max": 0,
      "min": 0
    },
    "j_minmax": {
      "max": 0,
      "min": 0
    },
    "k_minmax": {
      "max": 0,
      "min": 0
    }
  },
  "bm_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "categories": [
    {
      "col_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "label": "string",
      "values": [
        "string"
      ]
    }
  ],
  "columns": [
    {
      "aggregation": "SUM",
      "col_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "label": "string",
      "output_unit_id": "string"
    }
  ],
  "cutoff_col_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "cutoff_values": [
    0
  ],
  "density_col_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "density_unit_id": "string",
  "density_value": 0,
  "description": "string",
  "job_url": "string",
  "mass_unit_id": "string",
  "name": "string",
  "negative_values_policy": "USE",
  "null_values_policy": "ZERO",
  "report_specification_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "revision": 0
}

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"
}

409

Conflict

Response schema

detailstring

Example: "Block model name test-model already exists."

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

statusinteger

Example: 409

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

titlestring

Example: "Name Conflict"

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

typestring

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

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"
}