REST API for Big Data Spatial and Graph

List Spark spatial indexes

get

/spatialviewer/api/v1/spark/indexes

List the spatial indexes that were created using the Spark API and that have their metadata in the directory spark_index_metadata contained in the SpatialViewer local working directory (see SpatialViewer configuration).

Request

There are no request parameters for this operation.

Response

Supported Media Types

application/json

200 Response

successful request

Body

List of indexes metadata.

Root Schema : ListHadoopIndexesResponse

Type: object

List of indexes metadata.

Properties

o:successCode: Type: string

Example: SV-05001
response: Type: object response
status: Type: string

Example: success
title: Type: string

Example: Get indexes.

Nested Schema : response

Type: object

Properties

items: Type: array items

Nested Schema : items

Type: array

Items

Type: object HadoopIndexMetadata

Nested Schema : HadoopIndexMetadata

Type: object

Properties

attributesList: Type: array attributesList

Extra fields of the indexed records (see 2.8.2.1 Spatial Indexing Class Structure).
attributesListString: Type: string

Extra fields of the indexed records (see 2.8.2.1 Spatial Indexing Class Structure) in a string format.

Example: followers_count, friends_count, location, user_id
geodetic: Type: boolean

true if the geometries are geodetic, false otherwise.

Example: true
indexPath: Type: string

The index path.

Example: hdfs://hadoop.cluster.url:8020/user/oracle/spatialviewer/TweetsApril
mbr: Type: array mbr

MBR (Minimum Bounding Rectangle) of the indexed geometries.
name: Type: string

The index name.

Example: TweetsApril
srid: Type: integer (int32)

SRID of the indexed geometries.

Example: 8307
tolerance: Type: number (double)

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

Example: 0.05
userInputString: Type: string

Path of the file or files that were indexed. The path is as provided by the user.

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

Nested Schema : attributesList

Type: array

Extra fields of the indexed records (see 2.8.2.1 Spatial Indexing Class Structure).

Example


[
    "followers_count",
    "friends_count",
    "location",
    "user_id"
]

Items

Type: string

Nested Schema : mbr

Type: array

MBR (Minimum Bounding Rectangle) of the indexed geometries.

Example


[
    -179.58998,
    -78.46628,
    179.3833,
    82.48332
]

Items

Type: number (double)