Function: cop.Create

Creates the COP in the system and returns the id of the COP. The COP must not have an id. If an id is set, a Data.Validation error is thrown.

Syntax

{
	"method": "cop.Create",
	"params": {
		"object": "...",
	},
	"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
}
AdvFuture<AdvGuid> Create( COP object );
public Task<Guid> CreateAsync(COP @object, CancellationToken ct = default);
create(object: COP): Promise<string>;

Parameters

object : COP

The COP to create.

Result : guid

Id of the newly created COP.

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.

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.