The API endpoint retrieves the complete OpenAPI definition for the API. The response is a machine-readable specification that describes all available endpoints, security configurations, and request and response schemas.
The API definition conforms to the OpenAPI 3.0.1 standard.
Request format
https://api.cloud.precisely.com/v1/ogcapi/enrich/apiRequest parameters
None
Example
Request:
https://api.cloud.precisely.com/v1/ogcapi/enrich/api Response:
{
"openapi": "3.0.1",
"info": {
"title": "OGCApiFeaturesEnrichService API",
"version": "1.0.0"
},
"servers": [
{
"url": "https://api.cloud.precisely.com/v1/ogcapi/enrich",
"description": "Generated server url"
}
],
"security": [
{
"bearerAuth": []
}
],
"paths": {
"/functions": {
"get": {
"operationId": "getFunctions",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FunctionResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/conformance": {
"get": {
"operationId": "conformanceDeclaration",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConformancePageResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
. . .
"/collections": {
"get": {
"operationId": "getCollectionsPage",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CollectionsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/collections/{collectionId}": {
"get": {
"operationId": "getCollection",
"parameters": [
{
"name": "collectionId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CollectionIdResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/collections/{collectionId}/schema": {
"get": {
"operationId": "getSchema",
"parameters": [
{
"name": "collectionId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/schema+json": {
"schema": {
"$ref": "#/components/schemas/DescribeCollectionResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/collections/{collectionId}/queryables": {
"get": {
"operationId": "getQueryables",
"parameters": [
{
"name": "collectionId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/schema+json": {
"schema": {
"$ref": "#/components/schemas/QueryableResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/collections/{collectionId}/items": {
"get": {
"operationId": "getCollectionItems",
"parameters": [
{
"name": "collectionId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "bbox",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"style": "form",
"explode": false
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/geo+json": {
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "byte"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/": {
"get": {
"operationId": "getLandingPage",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LandingPageResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"ErrorDetail": {
"type": "object"
},
"ErrorResponse": {
"type": "object",
"properties": {
"errorCode": {
"type": "integer",
"format": "int32"
},
"errorGroup": {
"type": "string"
},
"httpStatus": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string"
},
"stackTrace": {
"type": "string"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorDetail"
}
},
"timestamp": {
"type": "string"
},
"traceId": {
"type": "string"
}
}
},
"Argument": {
"type": "object",
"properties": {
"type": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Function": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"arguments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Argument"
}
},
"returns": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"FunctionResponse": {
"type": "object",
"properties": {
"functions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Function"
}
}
}
},
"ConformancePageResponse": {
"type": "object",
"properties": {
"conformsTo": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"CollectionsInfo": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"itemType": {
"type": "string"
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Link"
}
}
}
},
"CollectionsResponse": {
"type": "object",
"properties": {
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Link"
}
},
"collections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollectionsInfo"
}
}
}
},
"Link": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
},
"type": {
"type": "string"
},
"title": {
"type": "string"
}
}
},
"CollectionIdResponse": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"itemType": {
"type": "string"
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Link"
}
}
}
},
"DescribeCollectionResponse": {
"type": "object",
"properties": {
"schema": {
"type": "string"
},
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"properties": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/SchemaProperties"
}
}
}
},
"SchemaProperties": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"format": {
"type": "string"
}
}
},
"PropertyInfo": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"format": {
"type": "string"
}
}
},
"QueryableResponse": {
"type": "object",
"properties": {
"schema": {
"type": "string"
},
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"properties": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/PropertyInfo"
}
},
"additionalProperties": {
"type": "boolean"
}
}
},
"GetCollectionItemsRequest": {
"required": [
"collectionId"
],
"type": "object",
"properties": {
"collectionId": {
"type": "string"
},
"limit": {
"type": "integer",
"format": "int32"
},
"offset": {
"type": "integer",
"format": "int32"
},
"bbox": {
"maxItems": 4,
"minItems": 4,
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"filter": {
"type": "string"
}
}
},
"LandingPageResponse": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Link"
}
}
}
}
},
"securitySchemes": {
"bearerAuth": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT"
}
}
}
}