Service to classify the data into hierarchical entities

post

/spatialviewer/api/v1/categorizationJob

This service provides a way to classify the data into hierarchical entities. In a given set of catalogs with a defined level of boundaries such as continents, countries and states, it is possible to join a record of the user data to a record of each level of the hierarchy data set. For example it can be used to show all the twitters from specified HDFS files in the hierarchy World Continents/World Countries/World State Provinces/World Cities.

• Request
• Response

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 : CategorizationJobInfo

Type: object

Properties

dataPath

Type: string

Path of the file or files in HDFS to categorize. Specify this property if useIndex is false.

Example: /user/oracle/spatialviewer/tweetsJune.json

indexName

Type: string

The index name. Specify this property if useIndex is true.

Example: TweetsJune

inputFormatClass

Type: string

The input format class. Specify this property if useIndex is false.

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 that can be set if if useIndex is false.

Example: myjar.jar

jobtemplates

Type: string

The templates to create the thematic maps (file names). The examples in the folder /opt/oracle/oracle-spatial-graph/spatial/vector/examples provide commonly used templates like countries or world regions templates.

Example: world_continents,world_countries,world_states_provinces

outputPath

Type: string

The Hadoop job output path.

Example: /user/oracle/spatialviewer/catResult

recordInfoProviderClass

Type: string

The class that provides the spatial information. Specify this property if useIndex is false.

Example: oracle.spatial.hadoop.vector.geojson.GeoJsonRecordInfoProvider

resultName

Type: string

The result name.

Example: Categorization TweetsJune

useIndex

Type: boolean

true if an index is used as input, false otherwise

Example: true

useMVSuggest

Type: string

If the MVSuggest service has to be used or not. If the geometry must be found from a location string, then use the MVSuggest service. In this case the provided RecordInfoProvider has to implement the interface oracle.spatial.hadoop.vector.LocalizableRecordInfoProvider. See examples on how to use the MVSuggest (data enrichment service) in the folder /opt/oracle/oracle-spatial-graph/spatial/vector/examples. Specify this property if useIndex is false.

Example: false

Response

Supported Media Types

• application/json

200 Response

Successful request.

The response contains the location of the results in HDFS.

Additionally When the job finishes the results will be saved in the folder categorization_results contained in the SpatialViewer local working directory (see SpatialViewer configuration).

Body

Root Schema : CategorizationJobResponse

Type: object

Properties

o:successCode

Type: string

The success code.

Example: SV-05003

response

Type: string

The response contains the location of the results in HDFS.

Example: hdfs://<namenode>:8020/user/oracle/spatialviewer/catResult

status

Type: string

success or error

Example: success

title

Type: string

Service title.

Example: Create categorization 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 categorization_results contained in the SpatialViewer local working directory (see SpatialViewer configuration).

Body

Root Schema : AsyncCategorizationJobResponse

Type: object

Properties

o:successCode

Type: string

The success code.

Example: SV-05003

response

Type: string

The response contains the location of the resource manager web application URL to track the job (see in the configuration the Hadoop parameter 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 categorization job.