This endpoint is deprecated. Please see the latest version.
Removes an area or location record from a static DataFilter.
URL: /data/v1/removeFilter
Method: POST
Method Parameters
|
Name |
Type |
Required |
Description |
|
apiKey |
string |
Yes |
The API Key for your Organisation. |
|
model |
object |
Yes |
The object detailing the specified values. See Model Object Properties. |
Model Object Properties
|
Name |
Type |
Required |
Description |
|
recordKey |
string |
Yes |
The Key of a record. |
|
dataFieldKey |
string |
Yes |
The ClientKey matching the DataField in which the recordKey value is stored. The specified DataField should be of SystemLink type. |
|
dataFilterKey |
string |
Yes |
A ClientKey matching the DataFilter you wish to remove the record from. The specified DataFilter should be of static type. |
Response
The following responses may be returned in addition to the standard ones specified under Common Information.
|
Code |
Error Message |
Description |
|
400 |
This Filter cannot be removed. Only Static Filters can be removed through the API. |
The DataFilter specified by dataFilterKey is not of static type. |
Example call
URL: https://api.vision-mapping.com/data/v1/removeFilter?apiKey=INSERT_YOUR_KEY_HERE
Body:
{"recordKey":"abc","dataFieldKey":"abc","dataFilterKey":"abc"}
Comments
0 comments
Article is closed for comments.