<dataset_uri>/buffer[.<format>]
The datasetBufferResults resource supports buffer analysis on datasets and record sets.
Supported methods
Supported output formats: rjson, json, html, xml.
http://supermapiserver:8090/iserver/services/spatialanalyst-sample/restjsr/spatialanalyst/datasets/SamplesP@Interpolation/buffer.rjson
Gets a form for the POST request.
Performing a POST request on the resource with related parameters creates the resource of a buffer analysis result, i.e., performs a buffer analysis.
Performing a POST request on a resource is to perform buffer analysis on the objects.
Parameters in the URI are as follows:
| Field | Type | Definition |
| asynchronousReturn | boolean | Whether to employ asynchronous operation or not. If true, returns the URI of the new resource immediately after the client submits the request (returnContent setting doesn't work); if false, the server returns the description or the URI of the new resource URI according to the returnContent settings after analysis. The default is false. |
| returnContent | boolean | Returns the description or the URI of the new resource. If true, returns the description for the analysis result. If false, returns the URI. The default is false. |
Parameters in the request body are as follows:
| Field | Type | Definition |
| isAttributeRetained | boolean | Whether to retain the attribute fields. Effective only when isUnion is false. |
| isUnion | boolean | Whether to merge the resulted area objects. |
|
bufferAnalystParameter |
BufferAnalystParameter | Parameters for buffer analysis. It provides necessary information on parameters for buffer analysis, including the left buffer distance, the right buffer distance, the end point type, round buffer, flat buffer, the number of line segments at the arcs for a round buffer, etc. See BufferAnalystParameter for more details. Note : Dosen't support flat functionality. |
| filterQueryParameter | QueryParameter | The conditions used to filter geometric objects in a dataset. Only geometric objects that satisfy this condition will participate in buffer analysis. |
| dataReturnOption | DataReturnOption | The extraction result setting. |
Normal response code(s): 201. The response parameters are as follows:
| Name | Type | Description |
|
succeed |
boolean | Whether the analysis is successful. |
| newResourceID | string | ID of the resource resulted from the request. |
| postResultType | PostResultType | |
| newResourceLocation | string | The URI of the newly created resource. |
Below are the parameters for performing a POST request on a buffer resource: http://supermapiserver:8090/iserver/services/spatialanalyst-sample/restjsr/spatialanalyst/datasets/SamplesP@Interpolation/buffer.rjson:
{
"isAttributeRetained": false,
"isUnion": false,
"bufferAnalystParameter": {
"endType": "ROUND",
"semicircleLineSegment": 4,
"leftDistance": {
"value": 100
},
"rightDistance": {
"value": null
},
"radiusUnit":"METER"
},
"filterQueryParameter": {
"attributeFilter": ""
},
"dataReturnOption": {
"dataset": "SamplePbuffer",
"dataReturnMode": "DATASET_ONLY",
"expectCount": 100,
"deleteExistResultDataset": false
}
}
The returned resource description in rjson format is shown below:
{
"succeed": true,
"newResourceID": "1",
"postResultType": "createChild",
"newResourceLocation": "http://supermapiserver:8090/iserver/services/spatialanalyst-sample/restjsr/spatialanalyst/datasets/SamplesP@Interpolation/buffer/1"
}
Performing a GET request on http://supermapiserver:8090/iserver/services/spatialanalyst-sample/restjsr/spatialanalyst/datasets/SamplesP@Interpolation/buffer/1.rjson can retrieve detailed information about the buffer analysis result. Please see datasetBufferResult.
Gets the operations and content format supported by resource.
Asks for the response identical to the one that would correspond to a GET request, but without the response body. This is useful for retrieving meta-information written in response headers, without having to transport the entire content. The meta-information includes the media-type, content-encoding, transfer-encoding, content-length, etc.
HEAD request can be used to check if the datasetBufferResults resource exists, or if the resource can be accessed by clients. It can also determine if the datasetBufferResults resource supports an output format <format> if performed on a URI with .<format> included.