2026-10-23 12.00 UTC - There are currently no active events. All systems operational.

Delete Survey Line String

Prev Next
Delete
/survey-lines/{id}/

Operation is used to delete a Survey Line String. Available from product version 2024.3.

Operation actually deletes the Survey Line String and they cannot be restored.

The Survey Line String's Survey Results and the network objects created from them are deleted only on request (deleteSurveyResult, deleteNetworkObjects), in one transaction with the Survey Line String.

Security
API Key: Token
Header parameter nameAuthorization

Token issued for API consumer.

Path parameters
id
integerRequired

ID of Survey Line String to delete

Query parameters
deleteSurveyResult
boolean

true also deletes the Survey Results of the Survey Line String (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.

Defaultfalse
deleteNetworkObjects
boolean

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.

Defaultfalse
Responses
204

Object deleted

400

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).

Expand All
object
detail
string

Why nothing was deleted

failedItems
Array of object

Network objects that could not be deleted

object
detail
string

Error message of a failed delete

objectId
integer

Id of the network object

objectTableName
string

Table of the network object, as stored on the Survey Result

reason
string

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.

Valid values[ "model_not_found", "not_found", "delete_failed" ]
property*
Array of string additionalProperties

Validation error messages for this query parameter

string
401

Authentication credentials are missing or invalid

{
  "details": "Authentication credentials were not provided"
}
object

Standard error response payload

details
string

Detailed description of error

403

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.

object

Standard error response payload

details
string

Detailed description of error