system.mes.location.deletePropertyValue
Description
Deletes a Location Property Values record by its ID. This cannot delete a location property value with references to it.
Permissions
This method requires the LOCATION.WRITE.DELETE permission.
Syntax
system.mes.location.deletePropertyValue(id)
Parameters
| Parameter | Type | Nullable | Description |
|---|---|---|---|
id | String (ULID) | False | The ID of the location property value to delete. |
Returns
If successful, an ApiResponse Object is returned with the success bool set True. If unsuccessful, an InUseException, IllegalArgumentException or ConstraintViolationException is thrown. If the property value that's being deleted has a reference, an ApiResponse Object is returned with details about the encountered error.
| Name | Type | Description |
|---|---|---|
success | Boolean | Indicates if the delete was successful. |
message | String | The reason why the deletion was successful or unsuccessful. |
data | String | The data associated with the deletion. |
error | String | The errors associated with the deletion. |
Code Examples
# Delete a location property value by ID
system.mes.location.deletePropertyValue('01JJ7AFN0V-ZZS5XSAR-05CGEXBW')