Listing geoscience objects

Introduction

This guide will walk you through the process of fetching a list of geoscience objects in a given workspace.

Endpoint

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

This endpoint allows you to fetch a list of geoscience objects. The response will include all geoscience objects matching the given filters and will be the latest version of each object.

If there are no objects matching the given filters, an empty list is returned.

List objects

The request parameters should include the limit and offset for pagination, and any filters for the objects you want to fetch.

Example request URL:

GET /geoscience-object/orgs/{org_id}/workspaces/{workspace_id}/objects?limit=10&offset=0&filters={"name": "Example pointset."}

Response

The response will be a JSON object containing a list of the requested geoscience objects and the total count of the objects.

Example:

{
    "objects": [
        {
            "name": "pointset_demo.json",
            "path": "/",
            "object_id": "9fd1cb16-ac0b-40a6-b9ee-89a5d702bce0",
            "schema": "/objects/pointset/1.0.0/pointset.schema.json",
            "version_id": "1720050462228330272",
            "created_at": "2024-07-03T23:47:42Z",
            "created_by": {
                "id": "19d415c0-d8b8-4d19-bbde-f86e3c74d9cd",
                "name": "Example User",
                "email": "example.user@example.com"
            },
            "etag": "6fc4aec0b16857f0fe456163de9b6ecfd6906700",
            "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>"
            }
        }
    ],
    "links": {
        "next": null,
        "prev": null
    },
    "limit": 10,
    "offset": 0,
    "count": 1,
    "total": 1
}

Summary

1. Prepare the limit, offset, and any filters for the geoscience objects you want to fetch.
2. Make a GET request to the /geoscience-object/orgs/{org_id}/workspaces/{workspace_id}/objects endpoint with the limit, offset, and filters as query parameters.
3. The response will include a list of the requested geoscience objects and the total count of objects.