Function: cop.Delete

Deletes a COP Object. Returns true if successfully deleted or if no such Object existed to begin with.

Syntax

{
	"method": "cop.Delete",
	"params": {
		"id": "...",
	},
	"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
}
AdvFuture<bool> Delete( AdvGuid id );
public Task<bool> DeleteAsync(Guid id, CancellationToken ct = default);
delete(id: string): Promise<boolean>;

Parameters

id : guid

Id of the COP to delete.

Result : bool

True if successful or no COP with the provided id found.

Errors

Call.Failure ≥wg 0.4.14

An unspecified error (e.g., an unhandled exception) has occured while executing the called function. For additional information, see Call.Failure.

Call.Param.Value ≥wg 0.4.14

A parameter has the wrong value, e.g. it is out of the valid range or in case of enums does not map to value within that enum. For additional information, see Call.Param.Value.

Data.Forbidden ≥wg 0.4.14

The caller does not have the required permissions to access the data. For additional information, see Data.Forbidden.

Remarks

This method requires API write access.