Geostatistics Task API

Version: 0.1.9

Preview

Continuous distribution

POST

/compute/orgs/{org_id}/geostatistics/continuous-distribution

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 data to create the distribution from.

objecturi

Required

Object containing the data to create a distribution from. 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]

attributestring

Required

The attribute containing the values to create a distribution from.

weightsobject | null

Optional weights for creating a weighted (declustered) distribution.

objecturi

Required

Object containing the weights data. 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]

attributestring

Required

The attribute containing the weights values.

tail_extrapolationobject | null

Optional tail extrapolation parameters for extending the distribution beyond the data range.

upperUpper tail extrapolation

Required

Power model for extrapolating the upper tail of the distribution.

powernumber

Required

Denominator of the exponent for the power model (between 0 exclusive and 1 inclusive).

maxnumber

Required

Maximum extent of tail, must be greater than the maximum value in the data.

lowerobject | null

Power model for lower tail extrapolation. The min value must be less than the minimum value in the data.

powernumber

Required

Denominator of the exponent for the power model (between 0 exclusive and 1 inclusive).

minnumber

Required

Minimum extent of tail, must be less than the minimum value in the data.

targetTarget

Required

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

Target specifying where to create the continuous distribution object.

referenceuri

Required

Reference to the targeted object. Supported schemas: non-parametric-continuous-cumulative-distribution/[>=1.0,<2]

overwriteboolean

Whether to overwrite the existing object.

descriptionstring | null

Description to put into the target object.

tagsTags

Tags to put into the target object.

Additional propertiesstring

This schema accepts user-defined additional properties along with the documented schema. The additional properties must match the specified type where one is provided.

Example body

{
  "source": {
    "object": "https://example.com",
    "attribute": "string"
  },
  "target": {
    "reference": "https://example.com",
    "overwrite": false,
    "tags": {
      "Additional properties": "string",
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "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"

A message describing the result of the task.

distributionDistribution

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

Reference to the created continuous distribution object.

referenceuri

Reference to a geoscience object. Supported schemas: non-parametric-continuous-cumulative-distribution/[>=1.0,<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.

Example response

{
  "message": "string",
  "distribution": {
    "reference": "https://example.com",
    "name": "string",
    "schema_id": "string"
  }
}

303

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