Skip to content

OGCAPIApi.md

Latest commit

 

History

History
721 lines (510 loc) · 23.5 KB

OGCAPIApi.md

File metadata and controls

721 lines (510 loc) · 23.5 KB
Raw

OGCAPIApi

All URIs are relative to https://geoengine.io/api

Method HTTP request Description
collection GET /ogc/{dataConnectorId}/{layerId}/collections/{layerId} OGC API Collection Metadata
collectionTileset GET /ogc/{dataConnectorId}/{layerId}/collections/{layerId}/map/tiles/{tileMatrixSetId} OGC API Collection Tileset Metadata
collectionTilesets GET /ogc/{dataConnectorId}/{layerId}/collections/{layerId}/map/tiles OGC API Collection Tilesets List
collections GET /ogc/{dataConnectorId}/{layerId}/collections OGC API Collections List
conformance GET /ogc/{dataConnectorId}/{layerId}/conformance OGC API Conformance Classes
landingPage GET /ogc/{dataConnectorId}/{layerId}/ OGC API Landing Page
tile GET /ogc/{dataConnectorId}/{layerId}/collections/{layerId}/map/tiles/{tileMatrixSetId}/{tileMatrix}/{tileRow}/{tileCol} OGC API Tile
tileMatrixSet GET /ogc/{dataConnectorId}/{layerId}/tileMatrixSets/{tileMatrixSetId} OGC API Tile Matrix Set Definition
tileMatrixSets GET /ogc/{dataConnectorId}/{layerId}/tileMatrixSets OGC API Tile Matrix Set List

collection

Collection collection(dataConnectorId, layerId)

OGC API Collection Metadata

Cf. OGC API - Common - Part 2: Collections.

Example

import {
  Configuration,
  OGCAPIApi,
} from '@geoengine/api-client';
import type { CollectionRequest } from '@geoengine/api-client';

async function example() {
  console.log("🚀 Testing @geoengine/api-client SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: session_token
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new OGCAPIApi(config);

  const body = {
    // string | ID of the data connector
    dataConnectorId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
    // string | ID of the layer, which is used as collection ID
    layerId: layerId_example,
  } satisfies CollectionRequest;

  try {
    const data = await api.collection(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

Name Type Description Notes
dataConnectorId string ID of the data connector [Defaults to undefined]
layerId string ID of the layer, which is used as collection ID [Defaults to undefined]

Return type

Collection

Authorization

session_token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

collectionTileset

TileSet collectionTileset(dataConnectorId, layerId, tileMatrixSetId)

OGC API Collection Tileset Metadata

Cf. OGC API - Tiles - Part 1: Core.

Example

import {
  Configuration,
  OGCAPIApi,
} from '@geoengine/api-client';
import type { CollectionTilesetRequest } from '@geoengine/api-client';

async function example() {
  console.log("🚀 Testing @geoengine/api-client SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: session_token
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new OGCAPIApi(config);

  const body = {
    // string | ID of the data connector
    dataConnectorId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
    // string | ID of the layer, which is used as collection ID
    layerId: layerId_example,
    // TileMatrixSetId | Tile matrix set identifier
    tileMatrixSetId: ...,
  } satisfies CollectionTilesetRequest;

  try {
    const data = await api.collectionTileset(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

Name Type Description Notes
dataConnectorId string ID of the data connector [Defaults to undefined]
layerId string ID of the layer, which is used as collection ID [Defaults to undefined]
tileMatrixSetId Tile matrix set identifier [Defaults to undefined]

Return type

TileSet

Authorization

session_token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
404 Collection or tile matrix set not found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

collectionTilesets

TileSets collectionTilesets(dataConnectorId, layerId)

OGC API Collection Tilesets List

Cf. OGC API - Tiles - Part 1: Core.

Example

import {
  Configuration,
  OGCAPIApi,
} from '@geoengine/api-client';
import type { CollectionTilesetsRequest } from '@geoengine/api-client';

async function example() {
  console.log("🚀 Testing @geoengine/api-client SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: session_token
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new OGCAPIApi(config);

  const body = {
    // string | ID of the data connector
    dataConnectorId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
    // string | ID of the layer, which is used as collection ID
    layerId: layerId_example,
  } satisfies CollectionTilesetsRequest;

  try {
    const data = await api.collectionTilesets(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

Name Type Description Notes
dataConnectorId string ID of the data connector [Defaults to undefined]
layerId string ID of the layer, which is used as collection ID [Defaults to undefined]

Return type

TileSets

Authorization

session_token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
404 Collection not found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

collections

Collections collections(dataConnectorId, layerId, datetime, bbox, limit, f)

OGC API Collections List

Cf. OGC API - Common - Part 2: Collections. Inside Geo Engine, every [`Layer`] gets its own OGC API endpoint. Inside this endpoint, this [`Layer`] is represented as a single `Collection`. Therefore, the list of collections for a given layer will always contain exactly one collection, and the `collectionId` will always be the same as the [`LayerId`].

Example

import {
  Configuration,
  OGCAPIApi,
} from '@geoengine/api-client';
import type { CollectionsRequest } from '@geoengine/api-client';

async function example() {
  console.log("🚀 Testing @geoengine/api-client SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: session_token
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new OGCAPIApi(config);

  const body = {
    // string | ID of the data connector
    dataConnectorId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
    // string | ID of the layer, which is used as collection ID
    layerId: layerId_example,
    // string | Either a date-time or an interval, half-bounded or bounded. Date and time expressions adhere to RFC 3339. Half-bounded intervals use double dots (`..`). (optional)
    datetime: 2018-02-12T23:20:50Z,
    // string | Only features with geometries intersecting the bounding box are selected. Provide four or six comma-separated numbers in CRS84 order: minLon,minLat,maxLon,maxLat (optionally with vertical min/max). (optional)
    bbox: -180,-90,180,90,
    // number | Optional limit for the number of first-level collections returned (minimum: 1, maximum: 10000, default: 10). (optional)
    limit: 10,
    // CollectionsResponseFormat | Response format. If omitted, the `Accept` header is used. (optional)
    f: json,
  } satisfies CollectionsRequest;

  try {
    const data = await api.collections(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

Name Type Description Notes
dataConnectorId string ID of the data connector [Defaults to undefined]
layerId string ID of the layer, which is used as collection ID [Defaults to undefined]
datetime string Either a date-time or an interval, half-bounded or bounded. Date and time expressions adhere to RFC 3339. Half-bounded intervals use double dots (`..`). [Optional] [Defaults to undefined]
bbox string Only features with geometries intersecting the bounding box are selected. Provide four or six comma-separated numbers in CRS84 order: minLon,minLat,maxLon,maxLat (optionally with vertical min/max). [Optional] [Defaults to undefined]
limit number Optional limit for the number of first-level collections returned (minimum: 1, maximum: 10000, default: 10). [Optional] [Defaults to undefined]
f CollectionsResponseFormat Response format. If omitted, the `Accept` header is used. [Optional] [Defaults to undefined] [Enum: json]

Return type

Collections

Authorization

session_token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

conformance

Conformance conformance(dataConnectorId, layerId)

OGC API Conformance Classes

Cf. OGC API - Common - Part 1: Core.

Example

import {
  Configuration,
  OGCAPIApi,
} from '@geoengine/api-client';
import type { ConformanceRequest } from '@geoengine/api-client';

async function example() {
  console.log("🚀 Testing @geoengine/api-client SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: session_token
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new OGCAPIApi(config);

  const body = {
    // string | ID of the data connector
    dataConnectorId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
    // string | ID of the layer, which is used as collection ID
    layerId: layerId_example,
  } satisfies ConformanceRequest;

  try {
    const data = await api.conformance(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

Name Type Description Notes
dataConnectorId string ID of the data connector [Defaults to undefined]
layerId string ID of the layer, which is used as collection ID [Defaults to undefined]

Return type

Conformance

Authorization

session_token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

landingPage

LandingPage landingPage(dataConnectorId, layerId)

OGC API Landing Page

Cf. OGC API - Common - Part 1: Core.

Example

import {
  Configuration,
  OGCAPIApi,
} from '@geoengine/api-client';
import type { LandingPageRequest } from '@geoengine/api-client';

async function example() {
  console.log("🚀 Testing @geoengine/api-client SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: session_token
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new OGCAPIApi(config);

  const body = {
    // string | ID of the data connector
    dataConnectorId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
    // string | ID of the layer, which is used as collection ID
    layerId: layerId_example,
  } satisfies LandingPageRequest;

  try {
    const data = await api.landingPage(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

Name Type Description Notes
dataConnectorId string ID of the data connector [Defaults to undefined]
layerId string ID of the layer, which is used as collection ID [Defaults to undefined]

Return type

LandingPage

Authorization

session_token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tile

Blob tile(dataConnectorId, layerId, tileMatrixSetId, tileMatrix, tileRow, tileCol, datetime)

OGC API Tile

Cf. OGC API - Tiles - Part 1: Core. ## Sketch ```text pointOfOrigin (cornerOfOrigin=topLeft) tileMatrixMinX, tileMatrixMaxY tileMatrixMaxX | | v v +---------------------------+---------------------------+-----+---------------------------+ ---> tileCol axis | 0,0 | 1,0 | ... | matrixWidth-1,0 | | | | | | +---------------------------+---------------------------+-----+---------------------------+ | 0,1 | 1,1 | ... | matrixWidth-1,1 | | | | | | +---------------------------+---------------------------+-----+---------------------------+ | ... | ... | ... | ... | | | | | | +---------------------------+---------------------------+-----+---------------------------+ | 0, | 1, | ... | matrixWidth-1, | v | matrixHeight-1 | matrixHeight-1 | | matrixHeight-1 | --+ tileHeight tileMatrixMinY | | | | | (in pixels) +---------------------------+---------------------------+-----+---------------------------+ --+ | |<- tileWidth ->| v | (in pixels) | tileRow axis ```

Example

import {
  Configuration,
  OGCAPIApi,
} from '@geoengine/api-client';
import type { TileRequest } from '@geoengine/api-client';

async function example() {
  console.log("🚀 Testing @geoengine/api-client SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: session_token
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new OGCAPIApi(config);

  const body = {
    // string | ID of the data connector
    dataConnectorId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
    // string | ID of the layer, which is used as collection ID
    layerId: layerId_example,
    // TileMatrixSetId | Tile matrix set identifier
    tileMatrixSetId: ...,
    // number | Tile matrix level
    tileMatrix: 56,
    // number | Tile row
    tileRow: 789,
    // number | Tile column
    tileCol: 789,
    // string | Either a date-time or an interval, half-bounded or bounded. Date and time expressions adhere to RFC 3339. Half-bounded intervals use double dots (`..`). (optional)
    datetime: 2018-02-12T23:20:50Z,
  } satisfies TileRequest;

  try {
    const data = await api.tile(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

Name Type Description Notes
dataConnectorId string ID of the data connector [Defaults to undefined]
layerId string ID of the layer, which is used as collection ID [Defaults to undefined]
tileMatrixSetId Tile matrix set identifier [Defaults to undefined]
tileMatrix number Tile matrix level [Defaults to undefined]
tileRow number Tile row [Defaults to undefined]
tileCol number Tile column [Defaults to undefined]
datetime string Either a date-time or an interval, half-bounded or bounded. Date and time expressions adhere to RFC 3339. Half-bounded intervals use double dots (`..`). [Optional] [Defaults to undefined]

Return type

Blob

Authorization

session_token

HTTP request headers

  • Content-Type: Not defined
  • Accept: image/png

HTTP response details

Status code Description Response headers
200 PNG Image -
400 Invalid tile coordinates or datetime -
404 Collection or tile matrix set not found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tileMatrixSet

TileMatrixSet tileMatrixSet(dataConnectorId, layerId, tileMatrixSetId)

OGC API Tile Matrix Set Definition

Cf. OGC API - Tiles - Part 1: Core. Cf. OGC Two Dimensional Tile Matrix Set and Tile Set Metadata.

Example

import {
  Configuration,
  OGCAPIApi,
} from '@geoengine/api-client';
import type { TileMatrixSetRequest } from '@geoengine/api-client';

async function example() {
  console.log("🚀 Testing @geoengine/api-client SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: session_token
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new OGCAPIApi(config);

  const body = {
    // string | ID of the data connector
    dataConnectorId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
    // string | ID of the layer, which is used as collection ID
    layerId: layerId_example,
    // TileMatrixSetId | Tile matrix set identifier
    tileMatrixSetId: ...,
  } satisfies TileMatrixSetRequest;

  try {
    const data = await api.tileMatrixSet(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

Name Type Description Notes
dataConnectorId string ID of the data connector [Defaults to undefined]
layerId string ID of the layer, which is used as collection ID [Defaults to undefined]
tileMatrixSetId Tile matrix set identifier [Defaults to undefined]

Return type

TileMatrixSet

Authorization

session_token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
404 Tile matrix set not found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tileMatrixSets

TileMatrixSets tileMatrixSets(dataConnectorId, layerId)

OGC API Tile Matrix Set List

Cf. OGC API - Tiles - Part 1: Core. Cf. OGC Two Dimensional Tile Matrix Set and Tile Set Metadata.

Example

import {
  Configuration,
  OGCAPIApi,
} from '@geoengine/api-client';
import type { TileMatrixSetsRequest } from '@geoengine/api-client';

async function example() {
  console.log("🚀 Testing @geoengine/api-client SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: session_token
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new OGCAPIApi(config);

  const body = {
    // string | ID of the data connector
    dataConnectorId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
    // string | ID of the layer, which is used as collection ID
    layerId: layerId_example,
  } satisfies TileMatrixSetsRequest;

  try {
    const data = await api.tileMatrixSets(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

Name Type Description Notes
dataConnectorId string ID of the data connector [Defaults to undefined]
layerId string ID of the layer, which is used as collection ID [Defaults to undefined]

Return type

TileMatrixSets

Authorization

session_token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -

[Back to top] [Back to API list] [Back to Model list] [Back to README]