Operation is used to delete Survey Points. Available from product version 2024.3.
Operation actually deletes Survey Points and they cannot be restored.
The Survey Point's Survey Results and the network objects created from them are deleted only on request
(deleteSurveyResult, deleteNetworkObjects), in one transaction with the Survey Point.
Token issued for API consumer.
Id of Survey Point to delete
true also deletes the Survey Results of the Survey Point (needs the Survey Result delete permission).
Network objects created from them are kept unless deleteNetworkObjects is also true.
Only true and false are accepted (case-insensitive). The default is false; the instance can change it
with the KEYCONVERT_REST_DELETE_SURVEY_RESULT_DEFAULT setting.
true also deletes the network objects created from those Survey Results (needs the delete permission of
each network object's model). Requires deleteSurveyResult=true. If any network object cannot be deleted,
nothing is deleted and the response is 400 with the failed items.
Only true and false are accepted (case-insensitive). The default is false; the instance can change it
with the KEYCONVERT_REST_DELETE_NETWORK_OBJECTS_DEFAULT setting, which applies only when the Survey Results
are deleted too.
Object deleted
Nothing was deleted. Either a query parameter is invalid (not true/false, or deleteNetworkObjects=true
without deleteSurveyResult=true; errors by parameter name), or a network object could not be deleted
(detail and failedItems).
Why nothing was deleted
Network objects that could not be deleted
Error message of a failed delete
Id of the network object
Table of the network object, as stored on the Survey Result
model_not_found: the product has no model for the table.
not_found: no object with that id.
delete_failed: the delete raised an error, for example because other objects protect it.
Validation error messages for this query parameter
Authentication credentials are missing or invalid
{
"details": "Authentication credentials were not provided"
}Standard error response payload
Detailed description of error
Nothing was deleted. The user lacks the delete permission of the Survey Result or of a network object's model, or the network object lies outside the user's access area.
Standard error response payload
Detailed description of error