Downloading a geoscience object

Introduction

This guide will walk you through the process of downloading a geoscience object from Evo. You can download a geoscience object either by its path or by its UUID.

Endpoints

• GET /geoscience-object/orgs/{org_id}/workspaces/{workspace_id}/objects/path/{path}
• GET /geoscience-object/orgs/{org_id}/workspaces/{workspace_id}/objects/{object_id}

These endpoints allow you to download a geoscience object. If required, the object can be compressed using gzip. To receive a compressed payload, set the header Accept-Encoding: gzip in your request.

Download by path

The request parameters must include the path to the geoscience object. The URL must be encoded if it contains unsafe characters.

Example of a request URL:

GET /orgs/76185fcc-3066-4bfd-b8db-02e7f08d098c/workspaces/e20c50af-745f-4c4c-8046-00b8593181a2/objects/path/pointset_demo.json

Download by UUID

The request parameters should include the UUID of the geoscience object.

Example request URL:

GET /orgs/68e373ad-9d0e-4638-a39f-5344bd677bd2/workspaces/76185fcc-3066-4bfd-b8db-02e7f08d098c/objects/9fd1cb16-ac0b-40a6-b9ee-89a5d702bce0

Response

The response will be a JSON object containing the properties of the requested geoscience object along with its metadata.

Example:

{
    "object_path": "pointset_demo.json",
    "object_id": "9fd1cb16-ac0b-40a6-b9ee-89a5d702bce0",
    "object": {
        "schema": "/objects/pointset/1.0.0/pointset.schema.json",
        "uuid": "9fd1cb16-ac0b-40a6-b9ee-89a5d702bce0",
        "name": "Example pointset.",
        "description": "This is an example of a pointset Geoscience object.",
        "locations": {
            "coordinates": {
                "width": 3,
                "data_type": "float64",
                "length": 50,
                "data": "35b8b8ba5479a34e905a1b9e212e1cb4a52ec484b969359f2c28f5a00311dbca"
            }
        },
        "bounding_box": {
            "min_y": -5550857.067070156,
            "max_y": -5309927.430829638,
            "min_x": 19108070.856018253,
            "max_x": 19338143.530560993,
            "min_z": 0,
            "max_z": 0
        },
        "coordinate_reference_system": {
            "epsg_code": 3857
        },
        "tags": {
            "location": "location"
        }
    },
    "version_id": "1720043136271901142",
    "created_at": "2024-07-03T21:45:36Z",
    "created_by": {
        "id": "19d415c0-d8b8-4d19-bbde-f86e3c74d9cd",
        "name": "Example User",
        "email": "example.user@example.com"
    },
    "etag": "61e87e4f5a34dcfa7d761120c972ef5339777cbf",
    "geojson_bounding_box": {
        "type": "Polygon",
        "coordinates": [
            [
                [
                    171.65072,
                    -44.54938
                ],
                [
                    173.7175,
                    -44.54938
                ],
                [
                    173.7175,
                    -42.98657
                ]
            ]
        ]
    },
    "links": {
        "download": "https://<host>/<download_url_details>",
        "data": [
            {
                "id": "81048210-978e-4b8e-9e37-60b1bdf22a62",
                "name": "35b8b8ba5479a34e905a1b9e212e1cb4a52ec484b969359f2c28f5a00311dbca",
                "download_url": "https://<host>/<remaining_download_url_details>"
            }
        ]
    }
}

This response example reflects the properties of the requested geoscience object, along with its metadata.

Summary

1. Prepare the path or the UUID of the geoscience object that you want to download.
2. Make a GET request with the path or UUID in the URL.
3. The response will include the properties of the requested geoscience object along with its metadata.