The approved standard OpenAPI description OGC itself publishes for OGC API - Moving Features. This is the STANDARD'S contract, not any one deployment of it — the servers block is a template, so it describes what a conformant implementation must offer rather than a callable host.
openapi: 3.0.3
info:
title: 'Building Blocks specified in OGC API - Moving Features - Part 1: Core'
version: 1.0.0
description: 'This is the OpenAPI definition of the OGC API - Moving Features - Part 1: Core Standard. The API also implements the OGC Moving Features Encoding Extension - JSON Standard.'
contact:
name: Open Geospatial Consortium
email: info@ogc.org
license:
name: OGC License
url: https://www.ogc.org/legal/
x-logo:
url: https://www.ogc.org/pub/www/files/OGC_Logo_2D_Blue_x_0_0.png
tags:
- name: Capabilities
description: Essential characteristics of the information available from the API.
- name: MovingFeatureCollection
description: Collections of moving features to be logically managed by a user.
- name: MovingFeatures
description: Moving feature data, including the temporal geometry, temporal properties, etc.
- name: TemporalGeometry
description: The spatial change over time (temporal geometry), representing the movement of the rigid or nonrigid body of a feature.
- name: TemporalGeometryQuery
description: Queryable resources for the temporal primitive geometry.
- name: TemporalProperty
description: The thematic change over time (temporal property), representing the variation of the value of any descriptive characteristic of a feature.
paths:
/:
get:
operationId: getLandingPage
summary: Landing page
description: The landing page provides links to the API definition, the conformance statements and to the feature collections in this dataset.
tags:
- Capabilities
responses:
'200':
$ref: '#/components/responses/LandingPage'
'500':
$ref: '#/components/responses/ServerError'
/conformance:
get:
operationId: getConformance
summary: Information about specifications that this API conforms to
description: A list of all conformance classes specified in a standard that the server conforms to.
tags:
- Capabilities
responses:
'200':
$ref: '#/components/responses/Conformance'
'500':
$ref: '#/components/responses/ServerError'
/api:
get:
operationId: getAPIList
summary: API definition
description: A list of all API definition
tags:
- Capabilities
responses:
'500':
$ref: '#/components/responses/ServerError'
/collections:
get:
operationId: searchCatalog
summary: Retrieve catalogs of moving features collection
description: |
A user can retrieve catalogs to access collections by simple filtering and a limit.
tags:
- Capabilities
responses:
'200':
$ref: '#/components/responses/Collections'
'500':
$ref: '#/components/responses/ServerError'
post:
operationId: registerMetadata
summary: Register metadata about a collection of moving features
description: |
A user SHOULD register metadata about a collection of moving features into the system.
tags:
- MovingFeatureCollection
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/collection-body'
example:
title: moving_feature_collection_sample
updateFrequency: 1000
description: example
itemType: movingfeature
responses:
'201':
description: Successful create a collection to manage moving features.
headers:
Location:
description: A URI of the newly added resource
schema:
type: string
example: https://data.example.org/collections/mfc-1
'500':
$ref: '#/components/responses/ServerError'
/collections/{collectionId}:
get:
operationId: accessMetadata
summary: Access metadata about the collection
description: |
A user can access metadata with id `collectionId`.
tags:
- MovingFeatureCollection
parameters:
- $ref: '#/components/parameters/collectionId'
responses:
'200':
$ref: '#/components/responses/Collection'
'404':
description: A collection with the specified id was not found.
'500':
$ref: '#/components/responses/ServerError'
delete:
operationId: deleteCollection
summary: Delete the collection
description: |
The collection catalog with id `collectionId` and including metadata and moving features SHOULD be deleted.
tags:
- MovingFeatureCollection
parameters:
- $ref: '#/components/parameters/collectionId'
responses:
'204':
description: Successfully deleted.
'404':
description: A collection with the specified name was not found.
'500':
$ref: '#/components/responses/ServerError'
put:
operationId: replaceMetadata
summary: Replace metadata about the collection
description: |
A user SHOULD replace metadata with id `collectionId`.
The request body schema is the same the POST's one.
However, `updateFrequency` property is NOT updated.
tags:
- MovingFeatureCollection
parameters:
- $ref: '#/components/parameters/collectionId'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/collection-body'
example:
title: moving_feature_collection_sample
updateFrequency: 1000
description: example
itemType: movingfeature
responses:
'204':
description: Successfully replaced.
'404':
description: A collection with the specified name was not found.
'500':
$ref: '#/components/responses/ServerError'
/collections/{collectionId}/items:
get:
operationId: retrieveMovingFeatures
summary: Retrieve moving feature collection
description: |
A user can retrieve moving feature collection to access the static information of the moving feature by simple filtering and a limit.
Specifically, if the `subTrajectory` parameter is "true", it will return the temporal geometry within the time interval specified by `datetime` parameter.
tags:
- MovingFeatures
parameters:
- $ref: '#/components/parameters/collectionId'
- $ref: '#/components/parameters/bbox'
- $ref: '#/components/parameters/datetime'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/subtrajectory'
responses:
'200':
$ref: '#/components/responses/MovingFeatures'
'404':
description: A collection with the specified id was not found.
'500':
$ref: '#/components/responses/ServerError'
post:
operationId: insertMovingFeatures
summary: Insert moving features
description: |
A user SHOULD insert a set of moving features or a moving feature into a collection with id `collectionId`.
The request body schema SHALL follows the [MovingFeature object](https://docs.opengeospatial.org/is/19-045r3/19-045r3.html#mfeature) or
[MovingFeatureCollection object](https://docs.opengeospatial.org/is/19-045r3/19-045r3.html#mfeaturecollection) in the OGC MF-JSON.
tags:
- MovingFeatures
parameters:
- $ref: '#/components/parameters/collectionId'
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/movingFeature-mfjson'
- $ref: '#/components/schemas/movingFeatureCollection'
example:
type: Feature
crs:
type: Name
properties:
name: urn:ogc:def:crs:OGC:1.3:CRS84
trs:
type: Link
properties:
type: OGCDEF
href: http://www.opengis.net/def/uom/ISO-8601/0/Gregorian
temporalGeometry:
type: MovingPoint
datetimes:
- '2011-07-14T22:01:01Z'
- '2011-07-14T22:01:02Z'
- '2011-07-14T22:01:03Z'
- '2011-07-14T22:01:04Z'
- '2011-07-14T22:01:05Z'
coordinates:
- - 139.757083
- 35.627701
- 0.5
- - 139.757399
- 35.627701
- 2
- - 139.757555
- 35.627688
- 4
- - 139.757651
- 35.627596
- 4
- - 139.757716
- 35.627483
- 4
interpolation: Linear
base:
type: glTF
href: http://www.opengis.net/spec/movingfeatures/json/1.0/prism/example/car3dmodel.gltf
orientations:
- scales:
- 1
- 1
- 1
angles:
- 0
- 0
- 0
- scales:
- 1
- 1
- 1
angles:
- 0
- 355
- 0
- scales:
- 1
- 1
- 1
angles:
- 0
- 0
- 330
- scales:
- 1
- 1
- 1
angles:
- 0
- 0
- 300
- scales:
- 1
- 1
- 1
angles:
- 0
- 0
- 270
temporalProperties:
- datetimes:
- '2011-07-14T22:01:01.450Z'
- '2011-07-14T23:01:01.450Z'
- '2011-07-15T00:01:01.450Z'
length:
type: Measure
form: http://qudt.org/vocab/quantitykind/Length
values:
- 1
- 2.4
- 1
interpolation: Linear
discharge:
type: Measure
form: MQS
values:
- 3
- 4
- 5
interpolation: Step
- datetimes:
- 1465621816590
- 1465711526300
camera:
type: Image
values:
- http://www.opengis.net/spec/movingfeatures/json/1.0/prism/example/image1
- iVBORw0KGgoAAAANSUhEU......
interpolation: Discrete
labels:
type: Text
values:
- car
- human
interpolation: Discrete
geometry:
type: LineString
coordinates:
- - 139.757083
- 35.627701
- 0.5
- - 139.757399
- 35.627701
- 2
- - 139.757555
- 35.627688
- 4
- - 139.757651
- 35.627596
- 4
- - 139.757716
- 35.627483
- 4
properties:
name: car1
state: test1
video: http://www.opengis.net/spec/movingfeatures/json/1.0/prism/example/video.mpeg
bbox:
- 139.757083
- 35.627483
- 0
- 139.757716
- 35.627701
- 4.5
time:
- '2011-07-14T22:01:01Z'
- '2011-07-15T01:11:22Z'
id: mf-1
responses:
'201':
description: |
Successful create a set of moving features or a moving feature into a specific collection.
headers:
Locations:
description: A list of URI of the newly added resources
schema:
type: array
items:
type: string
example:
- https://data.example.org/collections/mfc-1/items/mf-1
- https://data.example.org/collections/mfc-1/items/109301273
'400':
description: A query parameter was not validly used.
'404':
description: A collection with the specified id was not found.
'500':
$ref: '#/components/responses/ServerError'
/collections/{collectionId}/items/{mFeatureId}:
get:
operationId: accessMovingFeature
summary: Access the static data of the moving feature
description: |
A user can access a static data of a moving feature with id `mFeatureId`.
The static data of a moving feature is not included temporal geometries and temporal properties.
tags:
- MovingFeatures
parameters:
- $ref: '#/components/parameters/collectionId'
- $ref: '#/components/parameters/mFeatureId'
responses:
'200':
$ref: '#/components/responses/MovingFeature'
'404':
description: |
- A collection with the specified id was not found.
- Or a moving feature with the specified id was not found.
'500':
$ref: '#/components/responses/ServerError'
delete:
operationId: deleteMovingFeature
summary: Delete a single moving feature
description: |
The moving feature with id `mFeatureId` and including temporal geometries and properties SHOULD be deleted.
tags:
- MovingFeatures
parameters:
- $ref: '#/components/parameters/collectionId'
- $ref: '#/components/parameters/mFeatureId'
responses:
'204':
description: Successfully deleted.
'404':
description: |
- A collection with the specified id was not found.
- Or a moving feature with the specified id was not found.
'500':
$ref: '#/components/responses/ServerError'
/collections/{collectionId}/items/{mFeatureId}/tgsequence:
get:
operationId: retrieveTemporalGeometrySequence
summary: Retrieve the movement data of the single moving feature
description: |
A user can retrieve only the movement data of a moving feature with id `mFeatureId` by simple filtering and a limit.
tags:
- TemporalGeometry
parameters:
- $ref: '#/components/parameters/collectionId'
- $ref: '#/components/parameters/mFeatureId'
- $ref: '#/components/parameters/bbox'
- $ref: '#/components/parameters/datetime'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/leaf'
- $ref: '#/components/parameters/subtrajectory'
responses:
'200':
$ref: '#/components/responses/TemporalGeometrySequence'
'500':
$ref: '#/components/responses/ServerError'
post:
operationId: insertTemporalPrimitiveGeometry
summary: Add movement data into the moving feature
description: |
A user SHOULD add more movement data into a moving feature with id `mFeatureId`.
The request body schema SHALL follows the [TemporalPrimitiveGeometry object](https://docs.ogc.org/is/19-045r3/19-045r3.html#tprimitive) in the OGC MF-JSON.
tags:
- TemporalGeometry
parameters:
- $ref: '#/components/parameters/collectionId'
- $ref: '#/components/parameters/mFeatureId'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/temporalPrimitiveGeometry'
example:
type: MovingPoint
datetimes:
- '2011-07-14T22:01:06Z'
- '2011-07-14T22:01:07Z'
- '2011-07-14T22:01:08Z'
- '2011-07-14T22:01:09Z'
- '2011-07-14T22:01:10Z'
coordinates:
- - 139.757083
- 35.627701
- 0.5
- - 139.757399
- 35.627701
- 2
- - 139.757555
- 35.627688
- 4
- - 139.757651
- 35.627596
- 4
- - 139.757716
- 35.627483
- 4
interpolation: Linear
base:
type: glTF
href: https://www.opengis.net/spec/movingfeatures/json/1.0/prism/example/car3dmodel.gltf
orientations:
- scales:
- 1
- 1
- 1
angles:
- 0
- 0
- 0
- scales:
- 1
- 1
- 1
angles:
- 0
- 355
- 0
- scales:
- 1
- 1
- 1
angles:
- 0
- 0
- 330
- scales:
- 1
- 1
- 1
angles:
- 0
- 0
- 300
- scales:
- 1
- 1
- 1
angles:
- 0
- 0
- 270
responses:
'201':
description: |
Successful add more movement data into a specified moving feature.
headers:
Location:
description: A URI of the newly added resource
schema:
type: string
example: https://data.example.org/collections/mfc-1/items/mf-1/tgsequence/tg-2
'400':
description: A query parameter was not validly used.
'404':
description: |
- A collection with the specified id was not found.
- Or a moving feature with the specified id was not found.
'500':
$ref: '#/components/responses/ServerError'
/collections/{collectionId}/items/{mFeatureId}/tgsequence/{tGeometryId}:
delete:
operationId: deleteTemporalPrimitiveGeometry
summary: Delete a singe temporal primitive geometry
description: |
The temporal primitive geometry with id `tGeometryId` SHOULD be deleted.
tags:
- TemporalGeometry
parameters:
- $ref: '#/components/parameters/collectionId'
- $ref: '#/components/parameters/mFeatureId'
- $ref: '#/components/parameters/tGeometryId'
responses:
'204':
description: Successfully deleted.
'404':
description: |
- A collection with the specified id was not found.
- Or a moving feature with the specified id was not found.
- Or a temporal primitive geometry with the specified id was not found.
'500':
$ref: '#/components/responses/ServerError'
/collections/{collectionId}/items/{mFeatureId}/tgsequence/{tGeometryId}/distance:
get:
operationId: getDistanceOfTemporalPrimitiveGeometry
summary: Get a time-to-distance curve of a temporal primitive geometry
description: |
A user can get time-to-distance curve of a temporal primitive geometry with id `tGeometryId`.
# When `date-time` query parameter is provided, this operation will return a single distance value according to the specified date and time in the `data-time` parameter.
tags:
- TemporalGeometryQuery
parameters:
- $ref: '#/components/parameters/collectionId'
- $ref: '#/components/parameters/mFeatureId'
- $ref: '#/components/parameters/tGeometryId'
- $ref: '#/components/parameters/datetime'
- $ref: '#/components/parameters/leaf'
- $ref: '#/components/parameters/subtemporalvalue'
responses:
'200':
$ref: '#/components/responses/DistanceQuery'
'400':
description: A query parameter was not validly used.
'500':
$ref: '#/components/responses/ServerError'
/collections/{collectionId}/items/{mFeatureId}/tgsequence/{tGeometryId}/velocity:
get:
operationId: getVelocityOfTemporalPrimitiveGeometry
summary: Get a time-to-velocity curve of a temporal primitive geometry
description: |
A user can get time-to-velocity curve of a temporal primitive geometry with id `tGeometryId`.
# When `date-time` query parameter is provided, this operation will return a single velocity value according to the specified date and time in the `data-time` parameter.
tags:
- TemporalGeometryQuery
parameters:
- $ref: '#/components/parameters/collectionId'
- $ref: '#/components/parameters/mFeatureId'
- $ref: '#/components/parameters/tGeometryId'
- $ref: '#/components/parameters/datetime'
- $ref: '#/components/parameters/leaf'
- $ref: '#/components/parameters/subtemporalvalue'
responses:
'200':
$ref: '#/components/responses/VelocityQuery'
'400':
description: A query parameter was not validly used.
'500':
$ref: '#/components/responses/ServerError'
/collections/{collectionId}/items/{mFeatureId}/tgsequence/{tGeometryId}/acceleration:
get:
operationId: getAccelerationOfTemporalPrimitiveGeometry
summary: Get a time-to-acceleration curve of a temporal primitive geometry
description: |
A user can get time-to-acceleration curve of a temporal primitive geometry with id `tGeometryId`.
# When `date-time` query parameter is provided, this operation will return a single acceleration value according to the specified date and time in the `data-time` parameter.
tags:
- TemporalGeometryQuery
parameters:
- $ref: '#/components/parameters/collectionId'
- $ref: '#/components/parameters/mFeatureId'
- $ref: '#/components/parameters/tGeometryId'
- $ref: '#/components/parameters/datetime'
- $ref: '#/components/parameters/leaf'
- $ref: '#/components/parameters/subtemporalvalue'
responses:
'200':
$ref: '#/components/responses/AccelerationQuery'
'400':
description: A query parameter was not validly used.
'500':
$ref: '#/components/responses/ServerError'
/collections/{collectionId}/items/{mFeatureId}/tproperties:
get:
operationId: retrieveTemporalProperties
summary: Retrieve a set of the temporal property data
description: |
A user can retrieve the static information of the temporal property data that included a single moving feature with id `mFeatureId`.
The static data of a temporal property is not included temporal values (property `valueSequence`).
Also a user can retrieve the sub sequence of the temporal information of the temporal property data for the specified time interval with `subTemporalValue` query parameter.
In this case, `temporalProperties` property schema SHALL follows the [TemporalProperties object](https://docs.ogc.org/is/19-045r3/19-045r3.html#tproperties) in the OGC MF-JSON.
tags:
- TemporalProperty
parameters:
- $ref: '#/components/parameters/collectionId'
- $ref: '#/components/parameters/mFeatureId'
- $ref: '#/components/parameters/datetime'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/subtemporalvalue'
responses:
'200':
$ref: '#/components/responses/TemporalProperties'
'400':
description: A query parameter was not validly used.
'500':
$ref: '#/components/responses/ServerError'
post:
operationId: insertTemporalProperty
summary: Add temporal property data
description: |
A user SHOULD add new temporal property data into a moving feature with id `mFeatureId`.
The request body schema SHALL follows the [TemporalProperties object](https://docs.opengeospatial.org/is/19-045r3/19-045r3.html#tproperties) in the OGC MF-JSON.
tags:
- TemporalProperty
parameters:
- $ref: '#/components/parameters/collectionId'
- $ref: '#/components/parameters/mFeatureId'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/temporalProperties-mfjson'
example:
- datetimes:
- '2011-07-14T22:01:01.450Z'
- '2011-07-14T23:01:01.450Z'
- '2011-07-15T00:01:01.450Z'
length:
type: Measure
form: http://qudt.org/vocab/quantitykind/Length
values:
- 1
- 2.4
- 1
interpolation: Linear
discharge:
type: Measure
form: MQS
values:
- 3
- 4
- 5
interpolation: Step
- datetimes:
- '2011-07-14T22:01:01.450Z'
- '2011-07-14T23:01:01.450Z'
camera:
type: Image
values:
- http://www.opengis.net/spec/movingfeatures/json/1.0/prism/example/image1
- iVBORw0KGgoAAAANSUhEU......
interpolation: Discrete
labels:
type: Text
values:
- car
- human
interpolation: Discrete
responses:
'201':
description: |
Successful add more temporal property into a specified moving feature.
headers:
Locations:
description: A list of URI of the newly added resources
schema:
type: array
items:
type: string
example:
- https://data.example.org/collections/mfc-1/items/mf-1/tproperties/length
- https://data.example.org/collections/mfc-1/items/mf-1/tproperties/discharge
- https://data.example.org/collections/mfc-1/items/mf-1/tproperties/camera
- https://data.example.org/collections/mfc-1/items/mf-1/tproperties/labels
'404':
description: |
- A collection with the specified id was not found.
- Or a moving feature with the specified id was not found.
'500':
$ref: '#/components/responses/ServerError'
/collections/{collectionId}/items/{mFeatureId}/tproperties/{tPropertyName}:
get:
operationId: retrieveTemporalProperty
summary: Retrieve a temporal property
description: |
A user can retrieve only the temporal values with a specified name `tPropertyName` of temporal property.
tags:
- TemporalProperty
parameters:
- $ref: '#/components/parameters/collectionId'
- $ref: '#/components/parameters/mFeatureId'
- $ref: '#/components/parameters/tPropertyName'
- $ref: '#/components/parameters/datetime'
- $ref: '#/components/parameters/leaf'
- $ref: '#/components/parameters/subtemporalvalue'
responses:
'200':
$ref: '#/components/responses/TemporalProperty'
'400':
description: A query parameter was not validly used.
'500':
$ref: '#/components/responses/ServerError'
post:
operationId: insertTemporalPrimitiveValue
summary: Add temporal primitive value data
description: |
A user SHOULD add more temporal primitive value data into a temporal property with id `tPropertyName`.
tags:
- TemporalProperty
parameters:
- $ref: '#/components/parameters/collectionId'
- $ref: '#/components/parameters/mFeatureId'
- $ref: '#/components/parameters/tPropertyName'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/temporalPrimitiveValue'
example:
datetimes:
- '2011-07-15T08:00:00Z'
- '2011-07-15T08:00:01Z'
- '2011-07-15T08:00:02Z'
values:
- 0
- 20
- 50
interpolation: Linear
responses:
'201':
description: |
Successful add more temporal primitive value data into a specified temporal property.
headers:
Location:
description: A URI of the newly added resource
schema:
type: string
example: https://data.example.org/collections/mfc-1/items/mf-1/tproperties/tvalue/tpv-1
'404':
description: |
- A collection with the specified id was not found.
- Or a moving feature with the specified id was not found.
- Or a temporal property with the specified id was not found.
'500':
$ref: '#/components/responses/ServerError'
delete:
operationId: deleteTemporalProperty
summary: Delete a specified temporal property
description: |
The temporal property with id `tPropertyName` SHOULD be deleted.
tags:
- TemporalProperty
parameters:
- $ref: '#/components/parameters/collectionId'
- $ref: '#/components/parameters/mFeatureId'
- $ref: '#/components/parameters/tPropertyName'
responses:
'204':
description: Successfully deleted.
'404':
description: |
- A collection with the specified id was not found.
- Or a moving feature with the specified id was not found.
- Or a temporal property with the specified id was not found.
'500':
$ref: '#/components/responses/ServerError'
/collections/{collectionId}/items/{mFeatureId}/tproperties/{tPropertyName}/{tValueId}:
delete:
operationId: deleteTemporalPrimitiveValue
summary: Delete a singe temporal primitive value
description: |
The temporal primitive value with id `tValueId` SHOULD be deleted.
tags:
- TemporalProperty
parameters:
- $ref: '#/components/parameters/collectionId'
- $ref: '#/components/parameters/mFeatureId'
- $ref: '#/components/parameters/tPropertyName'
- $ref: '#/components/parameters/tValueId'
responses:
'204':
description: Successfully deleted.
'404':
description: |
- A collection with the specified id was not found.
- Or a moving feature with the specified id was not found.
- Or a temporal property with the specified id was not found.
- Or a temporal primitive primitive with the specified id was not found.
'500':
$ref: '#/components/responses/ServerError'
components:
schemas:
link:
type: object
required:
- href
- rel
properties:
href:
type: string
example: http://data.example.com/buildings/123
rel:
type: string
example: alternate
type:
type: string
example: application/geo+json
hreflang:
type: string
example: en
# --- truncated at 32 KB (81 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ogc/refs/heads/main/openapi/_original/ogc-movingfeatures-part1-1-0-openapi-ogcapi-movingfeatures-1-bundled.yaml