Geostatistics Task API

Version: 0.1.9

Preview

Location-wise summary statistics

POST

/compute/orgs/{org_id}/geostatistics/location-wise-summary

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

sourceSource

Required

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

Source object and attribute containing ensemble values.

objecturi

Required

Spatial locations of known values. Supported schemas: regular-3d-grid/[>=1.2,<2], regular-masked-3d-grid/[>=1.2,<2], tensor-3d-grid/[>=1.2,<2]

attributestring

Required

Reference to the ensemble to be processed.

targetTarget

Required

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

Target object to save summary statistics.

objecturi

Required

Object to evaluate onto. Supported schemas: regular-3d-grid/[>=1.2,<2], regular-masked-3d-grid/[>=1.2,<2], tensor-3d-grid/[>=1.2,<2]

Example body

{
  "source": {
    "object": "https://example.com",
    "attribute": "string"
  },
  "target": {
    "object": "https://example.com"
  }
}

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"

A message that says what happened in the task.

targetTarget

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

The target that was created or updated.

referenceuri

Reference to a geoscience object. Supported schemas: 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.

attributesLocation-wise attribute[]

Computed location-wise values.

referencestring

Reference to the attribute in the geoscience object.

namestring

The name of the output attribute.

Example response

{
  "message": "string",
  "target": {
    "reference": "https://example.com",
    "name": "string",
    "schema_id": "string",
    "attributes": [
      {
        "reference": "string",
        "name": "string"
      }
    ]
  }
}

303

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