Service: COP

Reading, modifying and operating COPs

Provides read/write access to the COP Data Objects and allows to control them.

Functions

Result	Name / Params			Comment
GetResult	cop.Get			Returns a filtered list of COP Object.
		filter	string	(Optional) Filter expression which determines the result set.
		select	string[]	(Optional) List of properties that should be contained in the result objects.
		startTime	time	(Optional) Start time to use when determining the result set. If not set, the current time is used.
		scroll	int	(Optional) Direction the data should be fetched (only 'Next', 'Prev' are supported). See EnumPaginationScroll.
		limit	int	(Optional) Maximum amount of Objects that should be returned.
GetResult	cop.Get			Returns a filtered list of COP Object.
		scroll	int	Scrolls through the result set with 'Next' or 'Prev'. Used for pagination. See EnumPaginationScroll.
		context	string	The context received within the last get result. Mandatory for subsequent get calls with pagination.
		limit	int	(Optional) Maximum amount of Objects that should be returned.
COP	cop.GetOne			Returns a single COP Object identified by the given id.
		id	guid	The COP's id.
		select	string[]	(Optional) List of properties that should be contained in the result object.
guid	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.
guid		object	COP	The COP to create.
bool	cop.Update			Updates a COP with data from the provided Object.
bool		object	COP	COP to update
bool	cop.Set			Sets specific properties of a COP Object.
		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.
bool	cop.Delete			Deletes a COP Object. Returns true if successfully deleted or if no such Object existed to begin with.
bool		id	guid	Id of the COP to delete.
bool	cop.BulkModify			Performs a bulk of changes at once.
		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.

Notifications

Name / Params			Comment
cop.Created			Notifies about new COP Objects.
	objects	COP[]	Newly created COP Objects.
cop.Updated			Notifies about updated COP Objects.
	objects	COP[]	Changed COP Objects.
cop.Deleted			Notifies about deleted COP Objects.
	ids	guid[]	Ids of the deleted COP Objects.

Objects

COP

Property	Type	Description
Id	guid	(Unique, Readonly) The unique id of the COP Data Object.
ParentId	guid	(Readonly) The id of the series definition, if this cop is part of a series.
SegmentId	guid	(Readonly) Assigned data segment, if appropriate.
HRId	string	(Unique, Readonly) Human readable id.
Type	int	Type of operation. See EnumCOPType.
OccurrenceTime	time	(Readonly) The planned start time.
OccurrenceEndTime ≥wg 0.4.5	time	(Readonly) The planned end time.
StartTime	time	Time, when operation has started.
EndTime	time	Time, when operation has ended.
Subject	string	(Localized) Short description of the operation.
Info	string	(Localized) Optional detailed description with line breaks.
OwnerSig	string	Identifies the owner of this operation, format ‘.’.
RecurrencePattern	RecurrencePattern	If set this COP is a serial definition.
DatapointIds	guid[]	List of the operated Datapoint ids.
ExecFlags	int	See EnumCOPExecFlags.
State	int	See EnumCOPState.
StateFlags	int	(Readonly) See EnumCOPStateFlags.
Station	int	Owner station where the operation is executed.
EditTime	time	(Readonly, Not in default set)
EditUser	string	(Readonly, Not in default set)

RecurrencePattern

Property	Type	Description
Type	int	See EnumRecurrencePatternType.
StartDate	string	The start date of the COP series as ‘YYYY-MM-DD’.
EndDate	string	The end date of the COP series as ‘YYYY-MM-DD’. If EndDate is empty, the COP series will not have an end.
TimeOfDay	string	The time of day when the COP occurs as ‘hh:mm’ or ‘hh:mm:ss’.
Duration	int	Duration of the COP in seconds.
TimeZoneId	string	The timezone ID for the given dates, which must match exactly the ones used in Windows.
DayType	int	Used and required for pattern ‘Daily’. See EnumRecurrencePatternDayType.
Interval	int	Used for pattern type ‘Weekly’ or ‘Monthly’. Specifies the weekly/monthly interval, e.g. every two, three, five or ten weeks/months.
WeekDayMask	int	Used and required for pattern type ‘Weekly’. Bit mask for representing the week days when the COP occurs. See EnumRecurrencePatternWeekDayFlags.
DayNumber	int	Used and required for pattern type ‘Monthly’.
CountFromEnd	bool	Used for pattern type ‘Monthly’. The DayNumber ist counted from the end of the month. (Hint: Currently only ‘1’ for DayNumber is supported, if CountFromEnd is set.)
WeekDay	int	Used for pattern type ‘Monthly’. DayNumber count only these days. See EnumRecurrencePatternWeekDay.
Schedule	string	Required for pattern type ‘Schedule’. Specifies the schedule’s name to use.

Enums

EnumCOPType

Name	Value	Description
Off	1
Revision	2
Arm	3
Disarm	4
Activate	5
Deactivate	6
Note	7
AlarmOff	8

EnumCOPExecFlags (Flags)

Name	Value	Description
ConfirmStart	0x1	The start of the operation has to be confirmed.
ConfirmEnd	0x2	The end of the operation has to be confirmed.
SetNote	0x4	This operation should sets a note at the Datapoint.

EnumCOPState

Name	Value	Description
Requested	0
Declined	1
Planned	2
Starting	3
Started	4
Ending	5
Ended	6
Disabled	7
Deleted	8

EnumCOPStateFlags (Flags)

Name	Value	Description
Error	0x1	Indicates that the destination state has not been reached after a certain amount of time.
WaitConfirm	0x2	Indicates that the operation is waiting for user input before continuing.
Past	0x4	Indicates the this operation lies in the past and will not be considered any more.

EnumRecurrencePatternType

Name	Value	Description
Daily	0	COP occurs daily.
Weekly	1	COP occurs weekly.
Monthly	2	COP occurs monthly.
Schedule	3	COP occurs according to a schedule.

EnumRecurrencePatternDayType

Name	Value	Description
EveryDay	0	COP occurs every day.
WorkDay	1	COP occurs only on work days.
FreeDay	2	COP occurs only on free days.

EnumRecurrencePatternWeekDayFlags (Flags)

Name	Value	Description
Sunday	0x1
Monday	0x2
Tuesday	0x4
Wednesday	0x8
Thursday	0x10
Friday	0x20
Saturday	0x40

EnumRecurrencePatternWeekDay

Name	Value	Description
Sunday	1
Monday	2
Tuesday	3
Wednesday	4
Thursday	5
Friday	6
Saturday	7

EnumPaginationScroll

Name	Value	Description
Offset	0	Scrolls to fixed position.
Next	1	Scrolls to next items for given context.
Prev	2	Scrolls to previous items for given context.

Last modified September 25, 2026