Get Dataset Collection

GET

/collections/{dataset_id}

const url = 'https://example.com/collections/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET'};

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/collections/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0

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

Authorizations

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: ‘feature’ for vector feature collections, ‘coverage’ for raster/VRT collections (which expose tiles instead of feature items).

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

application/problem+json

ProblemDetail

object

type

Type

string

default: about:blank

title

required

Title

string

status

required

Status

integer

detail

required

Any of:

string

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

401

Unauthenticated — a credential was supplied and could not be resolved (expired, revoked, or malformed). Sending no credential at all is not an error on these operations; they answer anonymously with the public subset. Neither is sending an unresolvable credential alongside a capability that authorizes the request on its own — a valid X-Embed-Token or a valid signed tile template (sig, exp, scope). Those are served and the unrelated credential is ignored.

application/problem+json

ProblemDetail

object

type

Type

string

default: about:blank

title

required

Title

string

status

required

Status

integer

detail

required

Any of:

string

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

404

Not found

application/problem+json

ProblemDetail

object

type

Type

string

default: about:blank

title

required

Title

string

status

required

Status

integer

detail

required

Any of:

string

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

429

Too many requests — retry after the advertised interval

application/problem+json

ProblemDetail

object

type

Type

string

default: about:blank

title

required

Title

string

status

required

Status

integer

detail

required

Any of:

string

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

Headers

Retry-After

integer

Seconds until the request may be retried

500

Internal server error

application/problem+json

ProblemDetail

object

type

Type

string

default: about:blank

title

required

Title

string

status

required

Status

integer

detail

required

Any of:

string

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

503

Service unavailable — the database could not serve the request

application/problem+json

ProblemDetail

object

type

Type

string

default: about:blank

title

required

Title

string

status

required

Status

integer

detail

required

Any of:

string

Example

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

Privacy Apache 2.0 getgeolens.com