Function: cop.Set

Syntax

• JSON
• C++
• C#
• Typescript

{
	"method": "cop.Set",
	"params": {
		"id": "...",
		"props": "...",
	},
	"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
}

AdvFuture<bool> Set( AdvGuid id, AdvObject props );

public Task<bool> SetAsync(Guid id, IDictionary<string, object?> props, CancellationToken ct = default);

set(id: string, props: Map<string, Object>): Promise<boolean>;

Parameters

id : guid

Id of the COP to modify.

props : value{}

List of properties that should be set. Property paths may be used as ids to address any partial aspect of the Object.

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:

Remarks

This method requires API write access.