Geostatistics Compute Tasks

Version: 0.0.1

Profit calc

POST

/compute/orgs/{org_id}/geostat/profit-calc

For more information, please read the guide

Request

Path parameters

org_iduuid

Required

The organisation identifier

Body parameters

material_categoriesobject[]

Required

cutoff_gradenumber

metal_pricenumber

labelstring

processing_costnumber

Required

mining_waste_costnumber

Required

mining_ore_costnumber

Required

metal_recovery_fractionnumber

Range: [0.01, 1]

Default: 1

sourceGradeCalculationSource

Required

Attribute where the estimation results were saved

type"geoscience-object-reference"

Default: "geoscience-object-reference"

keystring | null

key of the attribute you want to save/retrieve the data to/from.

object_referencestring

Required

A Geoscience object:

• Regular3DGrid_V1_0_1
• Regular3DGrid_V1_1_0
• Regular3DGrid_V1_2_0
• Regular3DGrid_V1_3_0
• RegularMasked3DGrid_V1_0_1
• RegularMasked3DGrid_V1_1_0
• RegularMasked3DGrid_V1_2_0
• RegularMasked3DGrid_V1_3_0

object_elementobject[]

Required

A Geoscience object:

• ContinuousEnsemble

type"element"

Default: "element"

pathstring

The attribute path that contains the values to be processed. It must contain the full path and the filter e.g:

• /cell_attributes/@name=attr-name
• /locations/attributes/@name=attr-name

targetGradeCalculationTarget

Required

Attribute where the value calculation results will be saved

type"geoscience-object-reference"

Default: "geoscience-object-reference"

keystring | null

key of the attribute you want to save/retrieve the data to/from.

object_referencestring

Required

A Geoscience object:

• Regular3DGrid_V1_0_1
• Regular3DGrid_V1_1_0
• Regular3DGrid_V1_2_0
• Regular3DGrid_V1_3_0
• RegularMasked3DGrid_V1_0_1
• RegularMasked3DGrid_V1_1_0
• RegularMasked3DGrid_V1_2_0
• RegularMasked3DGrid_V1_3_0

object_elementobject[]

Required

A Geoscience object:

• StringAttribute

type"element"

Default: "element"

pathstring

The attribute path that contains the values to be processed. It must contain the full path and the filter e.g:

• /cell_attributes/@name=attr-name
• /locations/attributes/@name=attr-name

Example body

{
  "material_categories": [
    {
      "cutoff_grade": 0,
      "metal_price": 0,
      "label": "string"
    }
  ],
  "processing_cost": 0,
  "mining_waste_cost": 0,
  "mining_ore_cost": 0,
  "metal_recovery_fraction": 1,
  "source": {
    "type": "geoscience-object-reference",
    "key": "string",
    "object_reference": "string",
    "object_element": [
      {
        "type": "element",
        "path": "string"
      }
    ]
  },
  "target": {
    "type": "geoscience-object-reference",
    "key": "string",
    "object_reference": "string",
    "object_element": [
      {
        "type": "element",
        "path": "string"
      }
    ]
  }
}

Responses

200

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

Response schema

messagestring

Concise summary of the completed job

object_modifiedModifiedResult

Modified geoscience object

type"geoscience-object-reference"

Default: "geoscience-object-reference"

keystring | null

key of the attribute you want to save/retrieve the data to/from.

object_referencestring

object_elementarray | null

Example response

{
  "message": "string",
  "object_modified": {
    "type": "geoscience-object-reference",
    "key": "string",
    "object_reference": "string",
    "object_element": [
      {
        "type": "element",
        "path": "string"
      }
    ]
  }
}

303

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