Skip to content

How to Run a dataset process

Run a dataset involves calculating the data for this dataset type in the specified area.

Steps to reproduce

  1. Log In to our platform (see Login).
  2. Create a New Project or use one created before.
  3. Create a New Dataset or use one created before.
  4. Get the id_dataset from the response
  5. Configure your dataset run info in the Run Dataset endpoint.
  6. After running your dataset, you can check it's execution status by getting the desired dataset's properties using the Get Dataset endpoint under the status property of the response.

Request example

Endpoint

POST /api/v1/dataset/run_dataset

Body

{
  "id_project": 1,
  "datasets": [
    {
      "id_project": 1,
      "id_dataset": 1,
    }
  ]
}

Successful Response

{
  "id_dataset": 1,
  "id_project": 1,
  "execution_state": "Executing dataset.",
  "celery_task_id": [
    "0660a008-d368-4c30-aa67-2f725fd28707"
  ]
}