API docs by Redocly

OGC API - Records - Part 1: Core (1.0.0)

Download OpenAPI specification:

CubeWerx Inc.: pvretano@cubewerx.com URL: https://www.cubewerx.com License: CC-BY 4.0 license

This is a sample OpenAPI definition that conforms to the conformance classes "Core", "GeoJSON", "HTML" and "OpenAPI 3.0" of the draft standard "OGC API - Records - Part 1: Core".

This example is a generic OGC API - Records definition that uses path parameters to describe all record collections and all records. The generic OpenAPI definition does not provide any details on the collections or the record content. This information is only available from accessing the record collection resources.

There is another example that specifies each collection explicitly.

Capabilities

essential characteristics of this API

landing page

The landing page provides links to the API definition, the conformance statements and to the record collections in this dataset.

Authorizations:
openIdConnect

Responses

Response samples

Content type
{
  • "title": "string",
  • "description": "string",
  • "links": [
    ],
  • "linkTemplates": [
    ]
}

Conformance

list of conformance classes implemented by this API

information about specifications that this API conforms to

A list of all conformance classes specified in a standard that the server conforms to.

Authorizations:
openIdConnect

Responses

Response samples

Content type
{
  • "conformsTo": [
    ]
}

Collections

list of catalogs offered by this API

the record collections

Fetch list of catalogs offered by this API

Authorizations:
openIdConnect

Responses

Response samples

Content type
{
  • "links": [
    ],
  • "collections": [
    ],
  • "linkTemplates": [
    ]
}

Collection

description of a catalog offered by this API

describe the record collection with id `catalogId`

Fetch a detailed description of a catalog or collection of records with id catalogId.

Authorizations:
openIdConnect
path Parameters
catalogId
required
string

Responses

Response samples

Content type
{
  • "id": "string",
  • "title": "string",
  • "description": "string",
  • "links": [
    ],
  • "extent": {},
  • "itemType": "record",
  • "crs": [],
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "type": "Collection",
  • "keywords": [
    ],
  • "themes": [
    ],
  • "language": {
    },
  • "languages": [
    ],
  • "resourceLanguages": [
    ],
  • "externalIds": [
    ],
  • "formats": [
    ],
  • "contacts": [
    ],
  • "license": "string",
  • "rights": "string",
  • "conformsTo": [
    ],
  • "recordsArrayName": "records",
  • "records": [
    ],
  • "linkTemplates": [
    ],
  • "schemes": [
    ]
}

Sortables

list of record properties by which responses can be sorted

get the list of sortable properties

Fetch the list of properties which can be used to sort the getRecords response.

Authorizations:
openIdConnect
path Parameters
catalogId
required
string

Responses

Response samples

Content type
{ }

Records

access to records

fetch records

Fetch records from the record collection with id catalogId.

Every record in a dataset belongs to a collection. A dataset may consist of multiple record collections. A record collection is often a collection of records of a similar type, based on a common schema.

Use content negotiation to request HTML or GeoJSON.

Authorizations:
openIdConnect
path Parameters
catalogId
required
string
query Parameters
Array of numbers or Array of numbers
datetime
string
limit
integer [ 1 .. 10000 ]
Default: 10
q
Array of strings
type
Array of strings
externalId
Array of strings
ids
Array of strings
sortby
Array of strings non-empty [ items[+|-]?[A-Za-z_].* ]

Responses

Response samples

Content type
{
  • "type": "FeatureCollection",
  • "features": [
    ],
  • "links": [
    ],
  • "linkTemplates": [
    ],
  • "timeStamp": "2019-08-24T14:15:22Z",
  • "numberMatched": 0,
  • "numberReturned": 0
}

Record

access to a single record

fetch a single record

Fetch the record with id recordId from the record collection with id catalogId.

Use content negotiation to request HTML or GeoJSON.

Authorizations:
openIdConnect
path Parameters
catalogId
required
string
recordId
required
string

Responses

Response samples

Content type
{
  • "id": "string",
  • "type": "Feature",
  • "time": { },
  • "geometry": { },
  • "conformsTo": [
    ],
  • "properties": {
    },
  • "links": [
    ],
  • "linkTemplates": [
    ]
}