Weaver REST API – OGC API – Processes

Version:
6.9.0-dev3

Process:
EchoProcess
1.0.0

(OGC JSON, WPS XML)
No description available.

Metadata

No metadata provided.

Inputs

stringInput
— stringInput
Schema:
minOccurs = 1
,
maxOccurs = 1
{
  "type": "string",
  "enum": [
    "Value1",
    "Value2",
    "Value3"
  ]
}
Additional Details:
literalDataDomains:
[
  {
    "default": true,
    "dataType": {
      "name": "string"
    },
    "valueDefinition": [
      "Value1",
      "Value2",
      "Value3"
    ]
  }
]
measureInput
— Numerical Value with UOM Example
Description:
This is an example of a NUMERIC literal with an associated unit of measure.
Schema:
minOccurs = 1
,
maxOccurs = 1
{
  "oneOf": [
    {
      "type": "object",
      "required": [
        "measurement",
        "uom"
      ],
      "properties": {
        "measurement": {
          "type": "number"
        },
        "uom": {
          "type": "string",
          "enum": [
            "m/s\u00b2",
            "km/min\u00b2"
          ]
        },
        "reference": {
          "type": "string",
          "format": "uri"
        }
      }
    },
    {
      "type": "number",
      "format": "float"
    }
  ]
}
Additional Details:
literalDataDomains:
[
  {
    "default": true,
    "dataType": {
      "name": "float"
    },
    "valueDefinition": {
      "anyValue": false
    },
    "UOMs": {
      "supported": [
        {
          "uom": "m/s\u00b2"
        },
        {
          "uom": "km/min\u00b2"
        }
      ],
      "default": {
        "uom": "m/s\u00b2"
      }
    }
  }
]
dateInput
— Date Literal Input Example
Description:
This is an example of a DATE literal input.
Schema:
minOccurs = 1
,
maxOccurs = 1
{
  "type": "string",
  "format": "date-time"
}
Additional Details:
literalDataDomains:
[
  {
    "default": true,
    "dataType": {
      "name": "dateTime"
    },
    "valueDefinition": {
      "anyValue": false
    }
  }
]
doubleInput
— Bounded Double Literal Input Example
Description:
This is an example of a DOUBLE literal input that is bounded between a value greater than 0 and 10. The default value is 5.
Schema:
minOccurs = 1
,
maxOccurs = 1
{
  "type": "number",
  "format": "double"
}
Additional Details:
literalDataDomains:
[
  {
    "default": true,
    "dataType": {
      "name": "float"
    },
    "valueDefinition": {
      "anyValue": false
    }
  }
]
arrayInput
— Array Input Example
Description:
This is an example of a single process input that is an array of values. In this case, the input array would be interpreted as a single value and not as individual inputs.
Schema:
minOccurs = 2
,
maxOccurs = 10
{
  "type": "array",
  "items": {
    "type": "integer"
  },
  "minItems": 2,
  "maxItems": 10
}
Additional Details:
literalDataDomains:
[
  {
    "default": true,
    "dataType": {
      "name": "integer"
    },
    "valueDefinition": {
      "anyValue": false
    }
  }
]
complexObjectInput
— Complex Object Input Example
Description:
This is an example of a complex object input.
Schema:
minOccurs = 1
,
maxOccurs = 1
{
  "oneOf": [
    {
      "type": "string",
      "contentMediaType": "application/json"
    },
    {
      "type": "object",
      "required": [
        "property1",
        "property5"
      ],
      "properties": {
        "property1": {
          "type": "string"
        },
        "property2": {
          "type": "string",
          "format": "uri"
        },
        "property3": {
          "type": "number"
        },
        "property4": {
          "type": "string",
          "format": "date-time"
        },
        "property5": {
          "type": "boolean"
        }
      }
    }
  ]
}
Additional Details:
formats:
[
  {
    "default": true,
    "mediaType": "application/json"
  }
]
geometryInput
— Geometry input
Description:
This is an example of a geometry input. In this case the geometry can be expressed as a GML of GeoJSON geometry.
Schema:
minOccurs = 2
,
maxOccurs = 5
{
  "type": "array",
  "items": {
    "oneOf": [
      {
        "type": "string",
        "contentMediaType": "application/gml+xml; version=3.2",
        "contentSchema": "https://schemas.opengis.net/gml/3.2.1/geometryBasic2d.xsd"
      },
      {
        "type": "string",
        "contentMediaType": "application/json",
        "contentSchema": "http://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/geometryGeoJSON.yaml"
      },
      {
        "type": "string",
        "format": "binary",
        "contentMediaType": "application/geo+json",
        "contentEncoding": "base64",
        "contentSchema": "https://geojson.org/schema/GeoJSON.json"
      },
      {
        "type": "string",
        "contentMediaType": "application/json",
        "contentSchema": "https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/geometryGeoJSON.yaml"
      },
      {
        "allOf": [
          {
            "format": "geojson-geometry"
          },
          {
            "$ref": "http://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/geometryGeoJSON.yaml"
          }
        ]
      }
    ]
  },
  "minItems": 2,
  "maxItems": 5
}
Additional Details:
formats:
[
  {
    "default": true,
    "mediaType": "application/gml+xml; version=3.2",
    "schema": "https://schemas.opengis.net/gml/3.2.1/geometryBasic2d.xsd"
  },
  {
    "default": false,
    "mediaType": "application/json",
    "schema": "http://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/geometryGeoJSON.yaml"
  },
  {
    "default": false,
    "mediaType": "application/geo+json",
    "schema": "https://geojson.org/schema/GeoJSON.json"
  },
  {
    "default": false,
    "mediaType": "application/json",
    "schema": "https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/geometryGeoJSON.yaml"
  }
]
boundingBoxInput
— Bounding Box Input Example
Description:
This is an example of an image input. In this case, the input is an array of up to 150 images that might, for example, be a set of tiles. The oneOf[] conditional is used to indicate the acceptable image content types; GeoTIFF and JPEG 2000 in this case. Each input image in the input array can be included inline in the execute request as a base64-encoded string or referenced using the link.yaml schema. The use of a base64-encoded string is implied by the specification and does not need to be specified in the definition of the input.
Schema:
minOccurs = 1
,
maxOccurs = 1
{
  "oneOf": [
    {
      "type": "object",
      "format": "ogc-bbox",
      "required": [
        "bbox"
      ],
      "properties": {
        "crs": {
          "type": "string",
          "format": "uri",
          "default": "http://www.opengis.net/def/crs/OGC/1.3/CRS84",
          "enum": [
            "epsg:4326"
          ]
        },
        "bbox": {
          "type": "array",
          "items": "number",
          "oneOf": [
            {
              "minItems": 4,
              "maxItems": 4
            },
            {
              "minItems": 6,
              "maxItems": 6
            }
          ]
        }
      }
    },
    {
      "type": "string",
      "format": "ogc-bbox",
      "contentSchema": "https://schemas.opengis.net/ogcapi/processes/part1/1.0/openapi/schemas/bbox.yaml"
    }
  ]
}
imagesInput
— Inline Images Value Input
Description:
This is an example of an image input. In this case, the input is an array of up to 150 images that might, for example, be a set of tiles. The oneOf[] conditional is used to indicate the acceptable image content types; GeoTIFF and JPEG 2000 in this case. Each input image in the input array can be included inline in the execute request as a base64-encoded string or referenced using the link.yaml schema. The use of a base64-encoded string is implied by the specification and does not need to be specified in the definition of the input.
Schema:
minOccurs = 1
,
maxOccurs = 150
{
  "oneOf": [
    {
      "type": "string",
      "format": "binary",
      "contentMediaType": "image/tiff; application=geotiff",
      "contentEncoding": "base64"
    },
    {
      "type": "string",
      "format": "binary",
      "contentMediaType": "image/jp2",
      "contentEncoding": "base64"
    },
    {
      "type": "array",
      "items": {
        "oneOf": [
          {
            "type": "string",
            "format": "binary",
            "contentMediaType": "image/tiff; application=geotiff",
            "contentEncoding": "base64"
          },
          {
            "type": "string",
            "format": "binary",
            "contentMediaType": "image/jp2",
            "contentEncoding": "base64"
          }
        ]
      },
      "minItems": 1,
      "maxItems": 150
    }
  ]
}
Additional Details:
formats:
[
  {
    "default": true,
    "mediaType": "image/tiff; application=geotiff",
    "encoding": "base64"
  },
  {
    "default": false,
    "mediaType": "image/jp2",
    "encoding": "base64"
  }
]
featureCollectionInput
— Feature Collection Input Example
Description:
This is an example of an input that is a feature collection that can be encoded in one of three ways. As a GeoJSON feature collection, as a GML feature collection retrieved from a WFS or as a KML document.
Schema:
minOccurs = 1
,
maxOccurs = 1
{
  "oneOf": [
    {
      "type": "string",
      "contentMediaType": "application/gml+xml; version=3.2"
    },
    {
      "type": "string",
      "contentMediaType": "application/vnd.google-earth.kml+xml",
      "contentSchema": "https://schemas.opengis.net/kml/2.3/ogckml23.xsd"
    },
    {
      "type": "string",
      "contentMediaType": "application/json",
      "contentSchema": "https://geojson.org/schema/FeatureCollection.json"
    },
    {
      "type": "string",
      "format": "binary",
      "contentMediaType": "application/geo+json",
      "contentEncoding": "base64",
      "contentSchema": "https://geojson.org/schema/FeatureCollection.json"
    },
    {
      "allOf": [
        {
          "format": "geojson-feature-collection"
        },
        {
          "$ref": "https://geojson.org/schema/FeatureCollection.json"
        }
      ]
    }
  ]
}
Additional Details:
formats:
[
  {
    "default": true,
    "mediaType": "application/gml+xml; version=3.2"
  },
  {
    "default": false,
    "mediaType": "application/vnd.google-earth.kml+xml",
    "schema": "https://schemas.opengis.net/kml/2.3/ogckml23.xsd"
  },
  {
    "default": false,
    "mediaType": "application/json",
    "schema": "https://geojson.org/schema/FeatureCollection.json"
  },
  {
    "default": false,
    "mediaType": "application/geo+json",
    "schema": "https://geojson.org/schema/FeatureCollection.json"
  }
]

Outputs

stringOutput
Schema:
{
  "type": "string",
  "enum": [
    "Value1",
    "Value2",
    "Value3"
  ]
}
measureOutput
Schema:
{
  "oneOf": [
    {
      "type": "object",
      "required": [
        "measurement",
        "uom"
      ],
      "properties": {
        "measurement": {
          "type": "number"
        },
        "uom": {
          "type": "string",
          "enum": [
            "m/s\u00b2",
            "km/min\u00b2"
          ]
        },
        "reference": {
          "type": "string",
          "format": "uri"
        }
      }
    },
    {
      "type": "number",
      "format": "float"
    }
  ]
}
dateOutput
Schema:
{
  "type": "string",
  "format": "date-time"
}
doubleOutput
Schema:
{
  "type": "number",
  "format": "double"
}
arrayOutput
Schema:
{
  "type": "array",
  "items": {
    "type": "integer"
  },
  "minItems": 2,
  "maxItems": 10
}
complexObjectOutput
Schema:
{
  "oneOf": [
    {
      "type": "string",
      "contentMediaType": "application/json"
    },
    {
      "type": "object",
      "required": [
        "property1",
        "property5"
      ],
      "properties": {
        "property1": {
          "type": "string"
        },
        "property2": {
          "type": "string",
          "format": "uri"
        },
        "property3": {
          "type": "number"
        },
        "property4": {
          "type": "string",
          "format": "date-time"
        },
        "property5": {
          "type": "boolean"
        }
      }
    }
  ]
}
geometryOutput
Schema:
{
  "oneOf": [
    {
      "type": "string",
      "contentMediaType": "application/gml+xml",
      "contentSchema": "http://schemas.opengis.net/gml/3.2.1/geometryBasic2d.xsd"
    },
    {
      "type": "string",
      "contentMediaType": "application/json",
      "contentSchema": "http://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/geometryGeoJSON.yaml"
    },
    {
      "type": "string",
      "format": "binary",
      "contentMediaType": "application/geo+json",
      "contentEncoding": "base64",
      "contentSchema": "https://geojson.org/schema/GeoJSON.json"
    },
    {
      "type": "string",
      "contentMediaType": "application/json",
      "contentSchema": "https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/geometryGeoJSON.yaml"
    },
    {
      "allOf": [
        {
          "format": "geojson-geometry"
        },
        {
          "$ref": "http://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/geometryGeoJSON.yaml"
        }
      ]
    }
  ]
}
boundingBoxOutput
Schema:
{
  "oneOf": [
    {
      "type": "object",
      "format": "ogc-bbox",
      "required": [
        "bbox"
      ],
      "properties": {
        "crs": {
          "type": "string",
          "format": "uri",
          "default": "http://www.opengis.net/def/crs/OGC/1.3/CRS84",
          "enum": [
            "http://www.opengis.net/def/crs/OGC/1.3/CRS84",
            "http://www.opengis.net/def/crs/OGC/0/CRS84h"
          ]
        },
        "bbox": {
          "type": "array",
          "items": "number",
          "oneOf": [
            {
              "minItems": 4,
              "maxItems": 4
            },
            {
              "minItems": 6,
              "maxItems": 6
            }
          ]
        }
      }
    },
    {
      "type": "string",
      "format": "ogc-bbox",
      "contentSchema": "https://schemas.opengis.net/ogcapi/processes/part1/1.0/openapi/schemas/bbox.yaml"
    }
  ]
}
imagesOutput
Schema:
{
  "oneOf": [
    {
      "type": "string",
      "format": "binary",
      "contentMediaType": "image/tiff; application=geotiff",
      "contentEncoding": "base64"
    },
    {
      "type": "string",
      "format": "binary",
      "contentMediaType": "image/jp2",
      "contentEncoding": "base64"
    }
  ]
}
featureCollectionOutput
Schema:
{
  "oneOf": [
    {
      "type": "string",
      "contentMediaType": "application/gml+xml; version=3.2"
    },
    {
      "type": "string",
      "contentMediaType": "application/vnd.google-earth.kml+xml",
      "contentSchema": "https://schemas.opengis.net/kml/2.3/ogckml23.xsd"
    },
    {
      "type": "string",
      "contentMediaType": "application/json",
      "contentSchema": "https://geojson.org/schema/FeatureCollection.json"
    },
    {
      "type": "string",
      "format": "binary",
      "contentMediaType": "application/geo+json",
      "contentEncoding": "base64",
      "contentSchema": "https://geojson.org/schema/FeatureCollection.json"
    },
    {
      "allOf": [
        {
          "format": "geojson-feature-collection"
        },
        {
          "$ref": "https://geojson.org/schema/FeatureCollection.json"
        }
      ]
    }
  ]
}
self
Current process description.
https://hirondelle.crim.ca/weaver/processes/EchoProcess:1.0.0
Language:
en-CA
Media-Type:
application/json
profile
Process response profile.
http://www.opengis.net/def/profile/OGC/0/ogc-process-description
Language:
en-CA
Media-Type:
application/json
alternate
Alternate process description.
https://hirondelle.crim.ca/weaver/processes/EchoProcess?f=xml
Language:
en-CA
Media-Type:
application/xml
process-meta
Process definition.
https://hirondelle.crim.ca/weaver/processes/EchoProcess
Language:
en-CA
Media-Type:
application/json
http://www.opengis.net/def/rel/ogc/1.0/execute
Process execution endpoint for job submission.
https://hirondelle.crim.ca/weaver/processes/EchoProcess/execution
Language:
en-CA
Media-Type:
application/json
http://www.opengis.net/def/rel/ogc/1.0/processes
List of registered processes.
https://hirondelle.crim.ca/weaver/processes
Language:
en-CA
Media-Type:
application/json
http://www.opengis.net/def/rel/ogc/1.0/job-list
List of job executions corresponding to this process.
https://hirondelle.crim.ca/weaver/processes/EchoProcess/jobs
Language:
en-CA
Media-Type:
application/json
up
List of processes registered under the service.
https://hirondelle.crim.ca/weaver/processes
Language:
en-CA
Media-Type:
application/json
working-copy
Tagged version of this process description.
https://hirondelle.crim.ca/weaver/processes/EchoProcess:1.0.0
Language:
en-CA
Media-Type:
application/json
latest-version
Most recent revision of this process.
https://hirondelle.crim.ca/weaver/processes/EchoProcess
Language:
en-CA
Media-Type:
application/json
version-history
Listing of all revisions of this process.
https://hirondelle.crim.ca/weaver/processes?detail=false&revisions=true&process=EchoProcess
Language:
en-CA
Media-Type:
application/json