1. REST API for Big Data Spatial and Graph
  2. Tasks
  3. Raster API

Retrieves the supported mathematical operations

get

/spatialviewer/api/v1/raster/rasterOperations

Request

Query Parameters
  • Filter the operations that are complex. Only works if the passed value is true. It is false by default.
  • Filter the operations that supports the passed data types. Supports multiple values separated by commas.
  • Filter the operations that supports the passed process types. Supports multiple values separated by commas.
  • Sort the operations by name if the passed value is descendant. It is ascendant by default.
Back to Top

Response

Supported Media Types

200 Response

successful request
Body ()
Root Schema : RasterProcessOperationsSuccessResponse
Type: object
Show Source
Nested Schema : response
Type: object
Response details
Show Source
Nested Schema : operation
Type: object
Additional Properties Allowed
Show Source
Individual operation details
Show Source
Nested Schema : additionalProperties
Type: object
Show Source
Nested Schema : config
Type: array
Operation configuration details
Show Source
Nested Schema : operators
Type: array
Show Source
Nested Schema : params
Type: array
Parameters details array
Show Source
Nested Schema : supportedDataTypes
Type: array
Specifies the data types of rasters in which this operation can be applied
Show Source
Nested Schema : supportedProcessTypes
Type: array
Specifies the types of process in which this operation can be applied
Show Source
Nested Schema : items
Type: object
Show Source
  • Default value for the parameter.
    Example: 0
  • Index of the configuration details from the source array in which the details of this parameter are set. Wilcards like * can be read here, that indicates that the parameter is a selector.
    Example: *
  • Indicates the source property (an array) in which the details of the parameter are set. This property is an attribute of the operation.
    Example: operators
Nested Schema : items
Type: object
Show Source
  • Unique identifier for the parameter.
    Example: operand
  • Informative name of the parameter.
    Example: Operator
  • Identify the parameter as required or optional.
    Example: true
  • Type of the parameter. Util for validation.
    Example: int

404 Response

raster operations details not found in server
Body ()
Root Schema : RasterProcessOperationsNotFoundResponse
Type: object
Show Source

406 Response

provided parameters are not correct
Body ()
Root Schema : RasterProcessOperationsInvalidParametersResponse
Type: object
Show Source

417 Response

raster operations details are corrupt in server
Body ()
Root Schema : RasterProcessOperationsCorruptFileResponse
Type: object
Show Source

500 Response

unknow error
Body ()
Root Schema : RasterErrorGenericResponse
Type: object
Show Source
Back to Top

Examples

Retrieves the supported mathematical operations that can be applied to a raster process.

The following example shows how to get some of the mathematical operations details by submitting a GET request on the REST resource using cURL with some parameter values to filter and sort the operations.

curl -X GET "http://localhost:8045/spatialviewer/api/v1/raster/rasterOperations?dataTypes=1&complex=false&sort=descendant" -H "accept: application/json"

Example of Response Header

Example of Response Header

HTTP/1.1 200 OK Date: Wed, 22 Aug 2018 21:41:26 GMT Content-Type: application/json Access-Control-Allow-Origin: * Access-Control-Allow-Credentials: true Access-Control-Allow-Methods: GET, POST, DELETE, PUT Access-Control-Allow-Headers: Content-Type, Accept Transfer-Encoding: chunked

Example of the Response Body

The following example shows the contents of the response body in JSON format

{ "status" : "success", "title" : "Raster process configuration loaded correctly.", "o:successCode" : "SVR-00203", "response" : { "localnot" : { "name" : "Local Not", "enabled" : true, "complex" : false, "supportedDataTypes" : [ 1, 2, 3, 4, 5 ] } } }
Back to Top