Geostatistics Task API

Version: 0.1.9

Preview

Profit calculation

POST

/compute/orgs/{org_id}/geostatistics/profit-calculation

Preview API

This API functionality is currently in preview. Preview APIs may be unstable within the preview period: they may change without notice. You must set the header API-Preview: opt-in to opt into using this functionality.

Calculate profit given block model and economic parameters

Request

Path parameters

org_iduuid

Required

The organisation identifier

Body parameters

sourceSource

Required

Examples: {"key":"value"}, {"another_key":123}

The source object and attribute containing known values.

objecturi

Required

Example: "https://{hub}.api.seequent.com/geoscience-object/orgs/{org_id}/workspaces/{workspace_id}/objects/path/my-grid.json"

The location of a regular or masked 3D grid with known values. Should be one of Regular3DGrid_V1_2_0, Regular3DGrid_V1_3_0, RegularMasked3DGrid_V1_2_0, or RegularMasked3DGrid_V1_3_0. Supported schemas: regular-3d-grid/[>=1.2,<2], regular-masked-3d-grid/[>=1.2,<2]

attributestring

Required

Example: "cell_attributes[?attribute_type=='ensemble_continuous']"

The original values, used to calculate grade categories.

targetTarget

Required

Examples: {"key":"value"}, {"another_key":123}

The target object and attribute to create or update with grade calculation results.

objecturi

Required

Example: "https://{hub}.api.seequent.com/geoscience-object/orgs/{org_id}/workspaces/{workspace_id}/objects/path/my-grid.json"

Object to evaluate onto. Can be the same as the source object. Should be one of Regular3DGrid_V1_2_0, Regular3DGrid_V1_3_0, RegularMasked3DGrid_V1_2_0, or RegularMasked3DGrid_V1_3_0. Supported schemas: regular-3d-grid/[>=1.2,<2], regular-masked-3d-grid/[>=1.2,<2]

attribute |

Required

Examples: {"name":"grade-category","operation":"create"}, {"name":"existing-grade-category","operation":"update"}

Name of the attribute to create or update on the target object.

One of:

object

operationunknown

Required

The operation to perform on the attribute.

namestring

Required

The name of the attribute to create.

object

operationunknown

Required

The operation to perform on the attribute.

referencestring

Required

Reference to an existing attribute to update.

material_categoriesMaterialCategories[]

Required

List of material categories, sorted from lowest to highest cutoff grade

cutoff_gradenumber

Examples: 0.16, 0.5, 0.9

The cutoff grade

metal_pricenumber

Examples: 134.23, 245.12, 9876.34

The metal price

labelstring

Examples: "ore", "waste"

Default: "waste"

The category label

processing_costnumber

Required

Examples: 16.15, 37.39, 91.85, 92.24, 95.35

Processing cost per unit of material

mining_waste_costnumber

Required

Examples: 11.19, 36.3, 48.86, 59.89, 98.53

Mining cost per unit of waste material

mining_ore_costnumber

Required

Examples: 7.88, 23.95, 24.09, 56.74, 80.68

Mining cost per unit of ore material

metal_recovery_fractionnumber

Required

Examples: 0.126, 0.533, 0.732, 0.816, 0.978

Fraction of metal expected to be recovered during processing

Example body

{
  "source": {
    "object": "https://example.com",
    "attribute": "string"
  },
  "target": {
    "object": "https://example.com",
    "attribute": {
      "name": "string"
    }
  },
  "material_categories": [
    {
      "cutoff_grade": 0,
      "metal_price": 0,
      "label": "waste"
    }
  ],
  "processing_cost": 0,
  "mining_waste_cost": 0,
  "mining_ore_cost": 0,
  "metal_recovery_fraction": 0
}

Responses

200

The task result returned by the Compute API Result endpoint when the task is done

Response schema

messagestring

Examples: "Success", "Failed"

Description of the result

targetobject | null

The target that was created or updated.

referenceuri

Reference to a geoscience object. Supported schemas: downhole-intervals/[>=1.2,<2], pointset/[>=1.2,<2], regular-3d-grid/[>=1.2,<2], regular-masked-3d-grid/[>=1.2,<2], tensor-3d-grid/[>=1.2,<2]

namestring

The name of the geoscience object.

descriptionstring | null

The description of the geoscience object.

schema_idstring

The ID of the Geoscience Object schema.

attributeAttribute

Attribute containing the material category results from the grade calculation.

referencestring

Reference to the attribute in the geoscience object.

namestring

The name of the output attribute.

Example response

{
  "message": "string"
}

303

303 response, see Compute API Execute Task documentation for more details