Jump to

• Request
• Response
• Examples

Delete a spatial index

delete

/spatialviewer/api/v1/spark/indexes/{indexName}

Request

Path Parameters

• indexName: string
  The index name.

Back to Top

Response

Supported Media Types

• application/json

200 Response

successful request

Body ()

Root Schema : DeleteSparkIndexJobResponse

Type: object

Show Source

• o:successCode(optional): string
  The success code.

  Example: SV-05008
• response(optional): string
  Name of the deleted index.

  Example: TweetsJune
• status(optional): string
  success or error

  Example: success
• title(optional): string
  Service title.

  Example: Delete Spark index.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"success or error",
            "example":"success"
        },
        "title":{
            "type":"string",
            "description":"Service title.",
            "example":"Delete Spark index."
        },
        "o:successCode":{
            "type":"string",
            "description":"The success code.",
            "example":"SV-05008"
        },
        "response":{
            "type":"string",
            "description":"Name of the deleted index.",
            "example":"TweetsJune"
        }
    }
}

Back to Top

Examples

The following example shows how to delete a Spark index named TweetsJune by submitting a DELETE request on the REST resource using cURL.

curl -v -X DELETE "http://localhost:8045/spatialviewer/api/v1/spark/indexes/TweetsJune" -H  "accept: application/json" 

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK Date: Wed, 15 Nov 2017 17:50:38 GMT 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  Content-Type: application/json

Example of Response Body

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

{"status" : "success", "title" : "Delete Spark index.", "o:successCode" : "SV-05008", "response" : "TweetsJune"} 

Back to Top