Geostatistics compute tasks
API-Preview: opt-in to opt into using this endpoint.This is a collection of geostatistics functions you can run on the cloud. They read geoscience objects. They write geoscience objects and files.
How do you run a geostatistics compute task?
It takes three steps to run a task.
- Start the task.
- Wait for it to finish.
- Get the result.
You can use the Task API for each step.
How do you start a task?
You can start a task by sending a POST request to the Task API.
POST https://{hub}.api.seequent.com/compute/orgs/{org_id}/geostat/{task}
That URL has three placeholders you need to fill in.
- Replace
{hub}with the hub code for the hub you are using. - Replace
{org_id}with the UUID for your organization. - Replace
{task}with the name of the task you want to use.
Send a request body that has a parameter field with your task parameters. The parameters are different for each task.
{
"parameters": {
...
}
}
How do you know when the task is done?
When you start the task, the Task API will respond with HTTP code 303 and a header called Location. The value inside the Location header is a status endpoint you can use to check the status of your job. You can send GET requests to that endpoint over and over until it says your job is done.
How do you get the results?
When your task is done, the status endpoint response has a result link in the links section. Make a GET request to the result link, and it tells you what geoscience objects and files were created or modified by the task.
{
"message": "Your task is done!",
"object_modified": {
...
}
}
Geoscience object references
Usually, geostatistics compute tasks read some data from one or more geoscience objects. They usually write some data to a geoscience object, too. Since they work with geoscience objects so much, there's a special parameter format that you can use to tell the task what objects you want to use.
{
"type": "geoscience-object-reference",
"object_reference": "https://{hub}.api.seequent.com/geoscience-object/orgs/{org_id}/workspaces/{workspace_id}/objects/path/{path}"
}
The reference can point to specific parts of an object, too.
{
"type": "geoscience-object-reference",
"object_reference": "https://{hub}.api.seequent.com/geoscience-object/orgs/{org_id}/workspaces/{workspace_id}/objects/path/{path}"
"object_element": [
"type": "element",
"path": "/attributes/@name=my-attribute"
]
}
That reference points specifically to an attribute called "my-attribute" inside the object.
