Get Single Dataset

GET

/datasets/{dataset_id}

const url = 'https://example.com/api/datasets/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/datasets/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Get a single dataset by ID with visibility check.

Authorizations

OAuth2PasswordBearer

Parameters

Path Parameters

dataset_id

required

Dataset Id

string format: uuid

Responses

200

Successful Response

application/json

DatasetResponse

object

required

string format: uuid

record_id

required

Record Id

Parent catalog record UUID

string format: uuid

table_name

required

Table Name

Internal PostGIS table name

string

title

required

Title

string

summary

required

Any of:

string
null

string

srid

Any of:

integer
null

integer

geometry_type

Any of:

string
null

string

is_3d

Any of:

boolean
null

boolean

n_dims

Any of:

integer
null

integer

z_min

Any of:

number
null

number

z_max

Any of:

number
null

number

feature_count

required

Any of:

integer
null

integer

extent_bbox

Any of:

Array<number>
null

Array<number>

column_info

Any of:

Array<object>
null

Array<object>

ColumnInfo

Describes a single column in a dataset’s attribute table.

object

name

required

Name

string

type

required

Type

string

semantic_role

Any of:

string
null

string

domain_type

Any of:

string
null

string

sample_values

Any of:

Array
null

Array

stats

Any of:

object
null

object

key

additional properties

any

license

Any of:

string
null

string

source_organization

Any of:

string
null

string

data_vintage_start

Any of:

string
null

string format: date

data_vintage_end

Any of:

string
null

string format: date

quality_detail

Any of:

QualityDetail
null

QualityDetail

Automated quality assessment results.

object

overall

required

Overall

number

<= 100

metadata_completeness

required

Metadata Completeness

number

<= 100

geometry_validity

Any of:

number
null

number

<= 100

attribute_completeness

required

Attribute Completeness

number

<= 100

crs_defined

Any of:

number
null

number

<= 100

computed_at

Any of:

string
null

string format: date-time

source_format

Any of:

string
null

string

source_filename

required

Any of:

string
null

string

original_srid

Any of:

integer
null

integer

current_version

Current Version

Monotonic version counter

integer

default: 1

source_url

Any of:

string
null

string

<= 2000 characters

quality_statement

Any of:

string
null

string

visibility

required

Visibility

Access level: private, restricted, internal, public

string

created_by

required

Any of:

string
null

string format: uuid

created_by_display

required

Created By Display

string

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

last_edited_by_display

Any of:

string
null

string

last_edited_at

Any of:

string
null

string format: date-time

collections

Any of:

Array<object>
null

Array<object>

CollectionRef

Minimal reference to a collection a dataset belongs to.

object

required

string format: uuid

name

required

Name

string

record_status

Record Status

Lifecycle status: draft, ready, published

string

default: draft

lineage_summary

Any of:

string
null

string

update_frequency

Any of:

string
null

string

usage_constraints

Any of:

string
null

string

access_constraints

Any of:

string
null

string

sensitivity_classification

Any of:

string
null

string

theme_category

Any of:

Array<string>
null

Array<string>

owner_org

Any of:

string
null

string

published_at

Any of:

string
null

string format: date-time

updated_by

Any of:

string
null

string format: uuid

record_type

Record Type

Record type: ‘vector_dataset’ (spatial features), ‘raster_dataset’ (single COG), ‘vrt_dataset’ (VRT mosaic), ‘table’ (non-spatial tabular), ‘map’ (saved map), ‘service’ (catalogued remote service), ‘collection’ (flat dataset group).

string

default: vector_dataset

raster

Any of:

RasterMetadata
null

RasterMetadata

object

epsg

Any of:

integer
null

integer

res_x

Any of:

number
null

number

res_y

Any of:

number
null

number

band_count

Any of:

integer
null

integer

nodata

Any of:

string
null

string

compression

Any of:

string
null

string

width

Any of:

integer
null

integer

height

Any of:

integer
null

integer

size_bytes

Any of:

integer
null

integer

tile_url

Any of:

string
null

string

bands

Bands

Array<object>

default:

RasterBandInfo

object

index

required

Index

1-based band index

integer

dtype

required

Dtype

Pixel data type, e.g. uint8, float32

string

nodata

Any of:

string
null

string

color_interp

Any of:

string
null

string

connect

Any of:

RasterConnect
null

RasterConnect

object

download_url

Any of:

string
null

string

tile_url

required

Tile Url

Titiler tile endpoint for this raster

string

s3_uri

Any of:

string
null

string

status

Any of:

string
null

string

vrt_type

Any of:

string
null

string

source_count

Any of:

integer
null

integer

resolution_strategy

Any of:

string
null

string

stac_assets

Any of:

object
null

object

key

additional properties

StacAsset

object

href

required

Href

string

type

Any of:

string
null

string

title

Any of:

string
null

string

description

Any of:

string
null

string

roles

Any of:

Array<string>
null

Array<string>

size_bytes

Any of:

integer
null

integer

stac_extensions

Any of:

Array<string>
null

Array<string>

language

Any of:

string
null

string

Example

{
  "current_version": 1,
  "record_status": "draft",
  "record_type": "vector_dataset",
  "raster": {
    "bands": []
  }
}

422

Validation Error

application/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example ^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}

Get Single Dataset

Authorizations

Parameters

Path Parameters

Responses

200

Example

422

Example generated

Example ^generated