Get Dataset Collection

GET

/collections/{dataset_id}

const url = 'https://example.com/api/collections/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/collections/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Per-dataset OGC collection metadata with extent, CRS, and items link.

Authorizations

OAuth2PasswordBearer

Parameters

Path Parameters

dataset_id

required

Dataset Id

string format: uuid

Query Parameters

Any of:

string
null

string

Responses

200

Successful Response

application/json

OGCCollectionMetadata

Per-dataset collection metadata per OGC API Features.

object

required

Stable collection identifier (typically the dataset ID).

string

title

required

Title

Human-readable collection title.

string

description

Any of:

string
null

string

extent

Any of:

object
null

object

key

additional properties

any

itemType

Itemtype

Type of items in the collection. Always ‘feature’ for OGC API Features.

string

default: feature

crs

Crs

Coordinate reference systems supported for items in this collection.

Array<string>

default: http://www.opengis.net/def/crs/OGC/1.3/CRS84

links

required

Links

Collection navigation links (self, items, queryables, etc.).

Array<object>

OGCLink

object

href

required

Href

Target URL of the link.

string

rel

required

Rel

Link relation type per RFC 8288 (e.g. ‘self’, ‘next’, ‘prev’, ‘data’, ‘collection’).

string

type

required

Type

Media type of the linked resource (e.g. ‘application/json’, ‘application/geo+json’).

string

title

Any of:

string
null

string

Example

{
  "itemType": "feature",
  "crs": [
    "http://www.opengis.net/def/crs/OGC/1.3/CRS84"
  ]
}

400

Bad request — invalid query parameters or payload

ProblemDetail

object

type

Type

string

default: about:blank

title

required

Title

string

status

required

Status

integer

detail

required

Detail

string

Example

{
  "type": "about:blank"
}

404

Not found

ProblemDetail

object

type

Type

string

default: about:blank

title

required

Title

string

status

required

Status

integer

detail

required

Detail

string

Example

{
  "type": "about:blank"
}

422

Validation error

ProblemDetail

object

type

Type

string

default: about:blank

title

required

Title

string

status

required

Status

integer

detail

required

Detail

string

Example

{
  "type": "about:blank"
}

500

Internal server error

ProblemDetail

object

type

Type

string

default: about:blank

title

required

Title

string

status

required

Status

integer

detail

required

Detail

string

Example

{
  "type": "about:blank"
}