openapi: 3.0.1 info: version: 0.7.15 title: SOFP OGC API Features server license: name: MIT servers: - url: 'https://geo.stat.fi:443/inspire/ogc/api/pf' description: This server paths: /: get: summary: OGC API Features Landing page operationId: getLandingPage tags: - Capabilities responses: '200': description: links to the API capabilities content: application/json: schema: $ref: '#/components/schemas/root' example: ! '' default: description: an error occurred content: application/json: schema: $ref: '#/components/schemas/exception' example: ! '' /conformance: get: summary: information about standards that this API conforms to description: >- list all requirements classes specified in a standard (e.g., WFS 3.0 Part 1: Core) that the server conforms to operationId: getRequirementsClasses tags: - Capabilities responses: '200': description: the URIs of all requirements classes supported by the server content: application/json: schema: $ref: '#/components/schemas/req-classes' example: ! '' default: description: an error occurred content: application/json: schema: $ref: '#/components/schemas/exception' example: ! '' /collections: get: summary: describe the feature collections in the dataset operationId: describeCollections tags: - Capabilities responses: '200': description: metadata about the feature collections shared by this API content: application/json: schema: $ref: '#/components/schemas/content' example: ! '' default: description: an error occurred content: application/json: schema: $ref: '#/components/schemas/exception' example: ! '' /collections/ProductionFacility_EPSG_3067: get: summary: 'describe the INSPIRE PF ProductionFacility EPSG:3067 feature collection' description: 'INSPIRE PF ProductionFacility in Finland EPSG:3067' operationId: describeCollection_ProductionFacility_EPSG_3067 tags: - Capabilities responses: '200': description: metadata about the ProductionFacility_EPSG_3067 collection content: application/json: schema: $ref: '#/components/schemas/collectionInfo' example: ! '' default: description: an error occurred content: application/json: schema: $ref: '#/components/schemas/exception' example: ! '' /collections/ProductionFacility_EPSG_3067/items: get: summary: retrieve features of ProductionFacility_EPSG_3067 feature collection description: 'INSPIRE PF ProductionFacility in Finland EPSG:3067' operationId: getFeatures_ProductionFacility_EPSG_3067 tags: - Features parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/bbox' - $ref: '#/components/parameters/datetime' - name: gid in: query schema: type: string required: false description: Filters returned features based on feature properties. - name: featureType in: query schema: type: string required: false description: Filters returned features based on feature properties. - name: inspireId_localId in: query schema: type: string required: false description: Filters returned features based on feature properties. - name: inspireId_versionId in: query schema: type: string required: false description: Filters returned features based on feature properties. - name: inspireId_namespace in: query schema: type: string required: false description: Filters returned features based on feature properties. - name: thematicId in: query schema: type: string required: false description: Filters returned features based on feature properties. - name: function_activity_naceValue in: query schema: type: string required: false description: Filters returned features based on feature properties. - name: function_activity_naceValue_label_fi in: query schema: type: string required: false description: Filters returned features based on feature properties. - name: beginLifespanVersion in: query schema: type: date required: false description: Filters returned features based on feature properties. - name: endLifespanVersion in: query schema: type: date required: false description: Filters returned features based on feature properties. responses: '200': description: >- Information about the feature collection plus the first features matching the selection parameters. content: application/json: schema: $ref: >- #/components/schemas/ProductionFacility_EPSG_3067FeatureCollectionGeoJSON example: ! '' default: description: an error occurred content: application/json: schema: $ref: '#/components/schemas/exception' example: ! '' '/collections/ProductionFacility_EPSG_3067/items/{featureId}': get: summary: >- retrieve single feature from feature collection ProductionFacility_EPSG_3067 operationId: getFeature_ProductionFacility_EPSG_3067 tags: - Features parameters: - $ref: '#/components/parameters/featureId' responses: '200': description: A feature content: application/json: schema: $ref: >- #/components/schemas/ProductionFacility_EPSG_3067FeatureGeoJSON example: ! '' default: description: an error occurred content: application/json: schema: $ref: '#/components/schemas/exception' example: ! '' /collections/ProductionFacility_EPSG_4326: get: summary: 'describe the INSPIRE PF ProductionFacility EPSG:4326 feature collection' description: 'INSPIRE PF ProductionFacility in Finland EPSG:4326' operationId: describeCollection_ProductionFacility_EPSG_4326 tags: - Capabilities responses: '200': description: metadata about the ProductionFacility_EPSG_4326 collection content: application/json: schema: $ref: '#/components/schemas/collectionInfo' example: ! '' default: description: an error occurred content: application/json: schema: $ref: '#/components/schemas/exception' example: ! '' /collections/ProductionFacility_EPSG_4326/items: get: summary: retrieve features of ProductionFacility_EPSG_4326 feature collection description: 'INSPIRE PF ProductionFacility in Finland EPSG:4326' operationId: getFeatures_ProductionFacility_EPSG_4326 tags: - Features parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/bbox' - $ref: '#/components/parameters/datetime' - name: gid in: query schema: type: string required: false description: Filters returned features based on feature properties. - name: featureType in: query schema: type: string required: false description: Filters returned features based on feature properties. - name: inspireId_localId in: query schema: type: string required: false description: Filters returned features based on feature properties. - name: inspireId_versionId in: query schema: type: string required: false description: Filters returned features based on feature properties. - name: inspireId_namespace in: query schema: type: string required: false description: Filters returned features based on feature properties. - name: thematicId in: query schema: type: string required: false description: Filters returned features based on feature properties. - name: function_activity_naceValue in: query schema: type: string required: false description: Filters returned features based on feature properties. - name: function_activity_naceValue_label_fi in: query schema: type: string required: false description: Filters returned features based on feature properties. - name: beginLifespanVersion in: query schema: type: date required: false description: Filters returned features based on feature properties. - name: endLifespanVersion in: query schema: type: date required: false description: Filters returned features based on feature properties. responses: '200': description: >- Information about the feature collection plus the first features matching the selection parameters. content: application/json: schema: $ref: >- #/components/schemas/ProductionFacility_EPSG_4326FeatureCollectionGeoJSON example: ! '' default: description: an error occurred content: application/json: schema: $ref: '#/components/schemas/exception' example: ! '' '/collections/ProductionFacility_EPSG_4326/items/{featureId}': get: summary: >- retrieve single feature from feature collection ProductionFacility_EPSG_4326 operationId: getFeature_ProductionFacility_EPSG_4326 tags: - Features parameters: - $ref: '#/components/parameters/featureId' responses: '200': description: A feature content: application/json: schema: $ref: >- #/components/schemas/ProductionFacility_EPSG_4326FeatureGeoJSON example: ! '' default: description: an error occurred content: application/json: schema: $ref: '#/components/schemas/exception' example: ! '' components: parameters: limit: name: limit in: query description: >- The optional limit parameter limits the number of items that are presented in the response document. Only items are counted that are on the first level of the collection in the response document. Nested objects contained within the explicitly requested items shall not be counted. required: false schema: type: integer minimum: 1 maximum: 10000 default: 10 style: form explode: false bbox: name: bbox in: query description: >- Only features that have a geometry that intersects the bounding box are selected. The bounding box is provided as four numbers: * Lower left corner, coordinate axis 1 * Lower left corner, coordinate axis 2 * Lower left corner, coordinate axis 3 (optional) * Upper right corner, coordinate axis 1 * Upper right corner, coordinate axis 2 * Upper right corner, coordinate axis 3 (optional) The coordinate reference system of the values is WGS84 longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84) unless a different coordinate reference system is specified in the parameter `bbox-crs`. For WGS84 longitude/latitude the values are in most cases the sequence of minimum longitude, minimum latitude, maximum longitude and maximum latitude. However, in cases where the box spans the antimeridian the first value (west-most box edge) is larger than the third value (east-most box edge). If a feature has multiple spatial geometry properties, it is the decision of the server whether only a single spatial geometry property is used to determine the extent or all relevant geometries. required: false schema: type: array minItems: 4 maxItems: 6 items: type: number style: form explode: false datetime: name: datetime in: query description: >- Either a date-time or a period string that adheres to RFC 3339. Examples: * A date-time: "2018-02-12T23:20:50Z" * A period: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z" or "2018-02-12T00:00:00Z/P1M6DT12H31M12S" Only features that have a temporal property that intersects the value of `datetime` are selected. If a feature has multiple temporal properties, it is the decision of the server whether only a single temporal property is used to determine the extent or all relevant temporal properties. required: false schema: type: string style: form explode: false featureId: name: featureId in: path description: Local identifier of a specific feature required: true schema: type: string schemas: exception: type: object required: - code properties: code: type: string description: type: string root: type: object required: - links properties: links: type: array items: $ref: '#/components/schemas/link' req-classes: type: object required: - conformsTo properties: conformsTo: type: array items: type: string example: - 'http://www.opengis.net/spec/wfs-1/3.0/req/core' - 'http://www.opengis.net/spec/wfs-1/3.0/req/oas30' - 'http://www.opengis.net/spec/wfs-1/3.0/req/html' - 'http://www.opengis.net/spec/wfs-1/3.0/req/geojson' link: type: object required: - href properties: href: type: string rel: type: string example: prev type: type: string example: application/geo+json hreflang: type: string example: en content: type: object required: - links - collections properties: links: type: array items: $ref: '#/components/schemas/link' collections: type: array items: $ref: '#/components/schemas/collectionInfo' collectionInfo: type: object required: - id - links properties: id: description: 'identifier of the collection used, for example, in URIs' type: string title: description: human readable title of the collection type: string description: description: a description of the features in the collection type: string links: type: array items: $ref: '#/components/schemas/link' extent: $ref: '#/components/schemas/extent' crs: description: >- The coordinate reference systems in which geometries may be retrieved. Coordinate reference systems are identified by a URI. The first coordinate reference system is the coordinate reference system that is used by default. This is always "http://www.opengis.net/def/crs/OGC/1.3/CRS84", i.e. WGS84 longitude/latitude. type: array items: type: string default: - 'http://www.opengis.net/def/crs/OGC/1.3/CRS84' extent: type: object properties: crs: description: >- Coordinate reference system of the coordinates in the spatial extent (property `spatial`). In the Core, only WGS84 longitude/latitude is supported. Extensions may support additional coordinate reference systems. type: string enum: - 'http://www.opengis.net/def/crs/OGC/1.3/CRS84' default: 'http://www.opengis.net/def/crs/OGC/1.3/CRS84' spatial: description: >- West, north, east, south edges of the spatial extent. The minimum and maximum values apply to the coordinate reference system WGS84 longitude/latitude that is supported in the Core. If, for example, a projected coordinate reference system is used, the minimum and maximum values need to be adjusted. type: array minItems: 4 maxItems: 4 items: type: number example: - -180 - -90 - 180 - 90 trs: description: >- Temporal reference system of the coordinates in the temporal extent (property `temporal`). In the Core, only the Gregorian calendar is supported. Extensions may support additional temporal reference systems. type: string enum: - 'http://www.opengis.net/def/uom/ISO-8601/0/Gregorian' default: 'http://www.opengis.net/def/uom/ISO-8601/0/Gregorian' temporal: description: Begin and end times of the temporal extent. type: array minItems: 2 maxItems: 2 items: type: string format: dateTime example: - '2011-11-11T12:22:11Z' - '2012-11-24T12:32:43Z' geometryGeoJSON: type: object required: - type properties: type: type: string enum: - Point - MultiPoint - LineString - MultiLineString - Polygon - MultiPolygon - GeometryCollection ProductionFacility_EPSG_3067FeatureCollectionGeoJSON: type: object required: - type - features properties: type: type: string enum: - FeatureCollection features: type: array items: $ref: '#/components/schemas/ProductionFacility_EPSG_3067FeatureGeoJSON' links: type: array items: $ref: '#/components/schemas/link' timeStamp: type: string format: dateTime numberMatched: type: integer minimum: 0 numberReturned: type: integer minimum: 0 ProductionFacility_EPSG_3067FeatureGeoJSON: type: object required: - type - geometry - properties properties: type: type: string enum: - Feature geometry: $ref: '#/components/schemas/geometryGeoJSON' properties: type: object properties: gid: type: string description: ! '' featureType: type: string description: ! '' inspireId_localId: type: string description: ! '' inspireId_versionId: type: string description: ! '' inspireId_namespace: type: string description: ! '' thematicId: type: string description: ! '' function_activity_naceValue: type: string description: ! '' function_activity_naceValue_label_fi: type: string description: ! '' beginLifespanVersion: type: date description: ! '' endLifespanVersion: type: date description: ! '' id: oneOf: - type: string - type: integer ProductionFacility_EPSG_4326FeatureCollectionGeoJSON: type: object required: - type - features properties: type: type: string enum: - FeatureCollection features: type: array items: $ref: '#/components/schemas/ProductionFacility_EPSG_4326FeatureGeoJSON' links: type: array items: $ref: '#/components/schemas/link' timeStamp: type: string format: dateTime numberMatched: type: integer minimum: 0 numberReturned: type: integer minimum: 0 ProductionFacility_EPSG_4326FeatureGeoJSON: type: object required: - type - geometry - properties properties: type: type: string enum: - Feature geometry: $ref: '#/components/schemas/geometryGeoJSON' properties: type: object properties: gid: type: string description: ! '' featureType: type: string description: ! '' inspireId_localId: type: string description: ! '' inspireId_versionId: type: string description: ! '' inspireId_namespace: type: string description: ! '' thematicId: type: string description: ! '' function_activity_naceValue: type: string description: ! '' function_activity_naceValue_label_fi: type: string description: ! '' beginLifespanVersion: type: date description: ! '' endLifespanVersion: type: date description: ! '' id: oneOf: - type: string - type: integer tags: - name: Capabilities description: Essential characteristics of this API including information about the data - name: Features description: Access to data (features).