Sign in

v1

latestOpenAPI 3.0.02026-08-0455133277.1 KB
Catalog

Get a catalog

Get a single catalog by ID

get/v0/catalogs/{id}

Path parameters

idstring required

Catalog ID

Response

OK

areanumber

area of the catalog in sq. km

bandset_idstring

id of the bandset present in the catalog

created_atstring

timestamp of the creation of the catalog

created_bystring

uuid of the user who created the catalog

delivery_status'UNSPECIFIED' | 'CREATED' | 'FAILED' | 'IN_PROGRESS' | 'SUCCESS'
idstring

id of the catalog

org_idstring

id of the workspace to which the catalog belongs

task_idstring

id of the task, whose catalog this resource tracks

updated_atstring

timestamp of the last update of the catalog

updated_bystring

uuid of the user who last updated the catalog

Example response

{
  "area": 100,
  "bandset_id": "47435e2b-d8c4-41ff-9de9-2be3bfc92277",
  "created_at": "2024-05-27T06:50:20.056549Z",
  "created_by": "0d7b3c5e-3b2a-4e77-bedb-5e0d2257cdb6",
  "details": {
    "geometry": {
      "type": "Polygon"
    }
  },
  "id": "47435e2b-d8c4-41ff-9de9-2be3bfc92276",
  "org_id": "e31ab6f8-d359-4c6a-83c6-bfa322 29bb01",
  "task_id": "ef8195b7-5ca6-4aca-a3fc-df6ffd58892d",
  "updated_at": "2024-05-27T06:50:20.056549Z",
  "updated_by": "0ada9483-e3ed-4f31-8a69-372686966451"
}