REST API for Big Data Spatial and Graph

This service is used to find spatial clusters in a data set

post

/spatialviewer/api/v1/clusteringJob

The service uses a distributed version of the K-means algorithm.

Request

Supported Media Types

application/json

Query Parameters

asynchronous

Type: boolean

if true the operation is runned asynchronously.

Default Value

false

Body Parameter

Job details

Root Schema : ClusteringJobInfo

Type: object

Properties

dataPath: Type: string

Path of the file or files in HDFS.

Example: /user/oracle/spatialviewer/tweetsJune.json
inputFormatClass: Type: string

The input format class.

Example: oracle.spatial.hadoop.vector.geojson.mapred.GeoJsonInputFormat
jarWithNeededClasses: Type: string

jar name with the user-defined classes like custom RecordInfoProvider or InputFormat. If the InputFormat class or the RecordInfoProvider class is not in the API, or in the hadoop API classes, then a jar with the user-defined classes must be provided. To be able to use this jar the user must add it in the /opt/oracle/oracle-spatial-graph/spatial/web-server/spatialviewer/WEB-INF/lib directory and restart the server. Optional property.

Example: myjar.jar
numberOfClusters: Type: integer (int32)

Number of clusters to be found.

Example: 4
outputPath: Type: string

The Hadoop job output path.

Example: /user/oracle/spatialviewer/clusteringResult
recordInfoProviderClass: Type: string

The class that provides the spatial information.

Example: oracle.spatial.hadoop.vector.geojson.GeoJsonRecordInfoProvider
resultName: Type: string

The result name.

Example: Clustering Tweets June
srid: Type: integer (int32)

SRID of the geometries.

Example: 8307
tolerance: Type: number (double)

Double value that represents the tolerance used when performing spatial operations.

Example: 0.05

Response

Supported Media Types

application/json

200 Response

Successful request.

The response contains the location of the results in HDFS.

When the job finish the results will be saved in the folder clustering_results contained in the SpatialViewer local working directory (see SpatialViewer configuration). The result can be used as data source of the Map API VectorLayer (OM.layer.VectorLayer) for display.

Body

Root Schema : ClusteringJobResponse

Type: object

Properties

o:successCode: Type: string

The success code.

Example: SV-05005
response: Type: string

The response contains the location of the results in HDFS.

Example: hdfs://<namenode>:8020/user/oracle/spatialviewer/clusteringResult
status: Type: string

success or error

Example: success
title: Type: string

Service title.

Example: Create clustering job.

202 Response

accepted asynchronous request.

The response contains the resource manager web application URL to track the job.

Additionally When the job finishes the results will be saved in the folder clustering_results contained in the SpatialViewer local working directory (see SpatialViewer configuration). The result can be used as data source of the Map API VectorLayer (OM.layer.VectorLayer) for display.

Body

Root Schema : AsyncClusteringJobResponse

Type: object

Properties

o:successCode: Type: string

The success code.

Example: SV-05005
response: Type: string

The response contains the resource manager web application URL to track the job. See this value in the SpatialViewer Hadoop configuration (refer to user's guide chapter 1.8.4 Configuring the Oracle SpatialViewer on Oracle Big Data Appliance). The parameter is yarn.resourcemanager.webapp.address.

Example: http://resource.mananger.webapp:8088
status: Type: string

success or error

Example: success
title: Type: string

Service title.

Example: Create clustering job.