Function: cop.BulkModify
Syntax
{
"method": "cop.BulkModify",
"params": {
"create": "...",
"update": "...",
"set": "...",
"delete": "...",
},
"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
}AdvFuture<bool> BulkModify( std::optional<std::vector<COP>> create = std::nullopt
std::optional<std::vector<COP>> update = std::nullopt,
std::optional<std::vector<ObjectAspect>> set = std::nullopt,
std::optional<std::vector<AdvGuid>> _delete = std::nullopt );public Task<bool> BulkModifyAsync(IList<COP>? create = null,
IList<COP>? update = null,
IList<ObjectAspect>? set = null,
IList<Guid>? delete = null,
CancellationToken ct = default);bulkModify(toCreate?: COP[] | undefined, toUpdate?: COP[] | undefined, toSet?: ObjectAspect[] | undefined, toDelete?: string[] | undefined): Promise<boolean>;Parameters
create : COP[] optional
List of COP Objects to create.
update : COP[] optional
List of COP Objects to update.
set : ObjectAspect[] optional
List of COP Object properties to set.
delete : guid[] optional
List of COP ids to delete.
Result : bool
True if successful.
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.NotFound ≥wg 0.4.14
The requested data was not found or the caller does not have the required permission to access it. For additional information, see Data.NotFound.
Data.Forbidden ≥wg 0.4.14
The caller does not have the required permissions to access the data. For additional information, see Data.Forbidden.
Data.Validation ≥wg 0.4.14
One or more Properties within the submitted Data Object were invalid. For additional information, see Data.Validation.
Operation.NotAvailable ≥wg 0.4.14
The Operation is unavailable. This can be temporary or permanent. For additional information, see Operation.NotAvailable.
COP.ExecutingStation.Unreachable ≥wg 0.4.14
The executing station is unreachable. This can be temporary or permanent.Additional properties:
| Property | Type | Description |
|---|---|---|
| Station | string | Code of the station in question. |
Remarks
This method requires API write access.