Geostatistics Task API

Version: 0.1.4

Preview

Location-wise quantiles

POST

/compute/orgs/{org_id}/geostat/location-wise-quantiles

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

sourceLocationWiseSummarySource

Required

Grid that contains the Continuous Ensemble

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

targetLocationWiseSummaryTarget

Required

Grid where the 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

quantilesnumber[]

Required

Examples: [0.16512695897412766,0.527673787418254,0.6065939174826289], [0.7552651966358055,0.9289134930021768,0.9643629060074552]

Quantiles to calculate

Example body

{
  "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"
  },
  "quantiles": [
    0
  ]
}

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