Geostatistics Task API

Version: 0.1.4

Preview

Profit calc

POST

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

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.

For more information, please read the guide

Request

Path parameters

org_iduuid

Required

The organisation identifier

Body parameters

material_categoriesMaterialCategories[]

Required

cutoff_gradenumber

Examples: 13.833174489085586, 36.199644371361096, 49.3515834889631, 75.57821575337378, 99.7325777989161

metal_pricenumber

Examples: 15.28, 16, 59.64, 68.05, 86.11

labelstring

Examples: "example string", "another example"

processing_costnumber

Required

Examples: 48.86, 59.89, 91.85, 92.24, 95.35

mining_waste_costnumber

Required

Examples: 11.19, 23.95, 36.3, 80.68, 98.53

mining_ore_costnumber

Required

Examples: 7.88, 24.09, 56.74, 73.19, 81.6

metal_recovery_fractionnumber

Range: [0.01, 1]

Examples: 0.1345029064052369, 0.5373791078342205, 0.6631533145198938, 0.947380192907941, 0.9782046487405609

Default: 1

sourceGradeCalculationSource

Required

Attribute where the estimation results were saved

type"geoscience-object-reference"

Examples: "example string", "another example"

Default: "geoscience-object-reference"

keystring | null

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

object_referencestring

Required

Examples: "example string", "another example"

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_elementGORefElement[]

Required

A Geoscience object:

• ContinuousEnsemble

type"element"

Examples: "example string", "another example"

Default: "element"

pathstring

Examples: "example string", "another example"

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"

Examples: "example string", "another example"

Default: "geoscience-object-reference"

keystring | null

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

object_referencestring

Required

Examples: "example string", "another example"

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_elementGORefElement[]

Required

A Geoscience object:

• StringAttribute

type"element"

Examples: "example string", "another example"

Default: "element"

pathstring

Examples: "example string", "another example"

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

Examples: "example string", "another example"

Concise summary of the completed job

object_modifiedModifiedResult

Modified geoscience object

type"geoscience-object-reference"

Examples: "example string", "another example"

Default: "geoscience-object-reference"

keystring | null

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

object_referencestring

Examples: "example string", "another example"

object_elementGORefElement[] | 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