Newer
Older
# GeospatialDataApi
Method | HTTP request | Description
------------- | ------------- | -------------
[**deleteGeoDataByName**](GeospatialDataApi.md#deleteGeoDataByName) | **DELETE** /geodata/{assetName} | Delete geospatial data
[**getAssetData**](GeospatialDataApi.md#getAssetData) | **GET** /geodata | Get geospatial data
[**getDistanceGeoDataByName**](GeospatialDataApi.md#getDistanceGeoDataByName) | **POST** /geodata/{assetName}/distanceTo | Get distance between geospatial data points
[**getGeoDataByName**](GeospatialDataApi.md#getGeoDataByName) | **GET** /geodata/{assetName} | Get geospatial data
[**getGeoDataPowerValues**](GeospatialDataApi.md#getGeoDataPowerValues) | **POST** /geodata/cellularPower | Get RSRQ and RSRP values for a list of coordinates
[**getWithinRangeByName**](GeospatialDataApi.md#getWithinRangeByName) | **POST** /geodata/{assetName}/withinRange | Returns if a geospatial data points is within a specified distance from a location
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
[**updateGeoDataByName**](GeospatialDataApi.md#updateGeoDataByName) | **POST** /geodata/{assetName} | Create/Update geospatial data
<a name="deleteGeoDataByName"></a>
# **deleteGeoDataByName**
> deleteGeoDataByName(assetName)
Delete geospatial data
Delete geospatial data for the given asset
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**assetName** | **String**| Name of geospatial asset | [default to null]
### Return type
null (empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
<a name="getAssetData"></a>
# **getAssetData**
> GeoDataAssetList getAssetData(assetType, subType, excludePath)
Get geospatial data
Get geospatial data for all assets present in database
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**assetType** | **String**| Filter by asset type | [optional] [default to null] [enum: UE, POA, COMPUTE]
**subType** | **String**| Filter by asset sub type | [optional] [default to null] [enum: UE, POA, POA-4G, POA-5G, POA-WIFI, EDGE, FOG, CLOUD]
**excludePath** | **String**| Exclude UE paths in response (default: false) | [optional] [default to null] [enum: true, false]
### Return type
[**GeoDataAssetList**](../Models/GeoDataAssetList.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getDistanceGeoDataByName"></a>
# **getDistanceGeoDataByName**
> Distance getDistanceGeoDataByName(assetName, targetPoint)
Get distance between geospatial data points
Get distance between geospatial data for the given asset and another asset or geospatial coordinates
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**assetName** | **String**| Name of geospatial asset | [default to null]
**targetPoint** | [**TargetPoint**](../Models/TargetPoint.md)| Parameters of geospatial assets |
### Return type
[**Distance**](../Models/Distance.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
<a name="getGeoDataByName"></a>
# **getGeoDataByName**
> GeoDataAsset getGeoDataByName(assetName, excludePath)
Get geospatial data
Get geospatial data for the given asset
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**assetName** | **String**| Name of geospatial asset | [default to null]
**excludePath** | **String**| Exclude UE paths in response (default: false) | [optional] [default to null] [enum: true, false]
### Return type
[**GeoDataAsset**](../Models/GeoDataAsset.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
<a name="getGeoDataPowerValues"></a>
# **getGeoDataPowerValues**
> CoordinatePowerList getGeoDataPowerValues(coordinates)
Get RSRQ and RSRP values for a list of coordinates
Get RSRQ and RSRP values for a list of coordinates
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**coordinates** | [**GeoCoordinateList**](../Models/GeoCoordinateList.md)| List of geo coordinates |
### Return type
[**CoordinatePowerList**](../Models/CoordinatePowerList.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
<a name="getWithinRangeByName"></a>
# **getWithinRangeByName**
> WithinRange getWithinRangeByName(assetName, targetRange)
Returns if a geospatial data points is within a specified distance from a location
Get geospatial data for the given asset and if it is within range of another asset or geospatial coordinates
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**assetName** | **String**| Name of geospatial asset | [default to null]
**targetRange** | [**TargetRange**](../Models/TargetRange.md)| Parameters of geospatial assets |
### Return type
[**WithinRange**](../Models/WithinRange.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
<a name="updateGeoDataByName"></a>
# **updateGeoDataByName**
> updateGeoDataByName(assetName, geoData)
Create/Update geospatial data
Create/Update geospatial data for the given asset
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**assetName** | **String**| Name of geospatial asset | [default to null]
**geoData** | [**GeoDataAsset**](../Models/GeoDataAsset.md)| Geospatial data |
### Return type
null (empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: Not defined