...

• deviceId: this is read on the Point Data asset. It represents the container such as a Device asset, Equipment asset, Model asset. The deviceId value will always match one of these assets. (There is no link at all with the concept of "device")
• pointId: unique point identifier of the Point Data asset
• action: they are listed here: Point data type (SET/OVERRIDE/EMERGENCY_OVERRIDE/AUTO/EMERCY_AUTO
• value: the type of value will depend on the primary value of the point. You can read it from the tag "controlType"
• duration: the duration will only be used with the OVERRIDE action, otherwise it's useless.

...

{
  "type": "CREATE_RECURRING_EVENT",
  "deviceId": "<DeviceId>",
  "scheduleId": "<PointId><ScheduleId>",
  "payload": {
    "eventId": "<Your own id>",
    "weekday": "<weekday>",
    "startTime": "<startTime>",
    "endTime": "<endTime>",
    "value": <value>
  }
}

...

• deviceId: this is read on the Schedule Data asset. It represents the container such as a Device asset, Equipment asset, Model asset. The deviceId value will always match one of these assets. (There is no link at all with the concept of "device")
• scheduleId: unique schedule identifier of the Schedule Data asset
• eventId: Your own unique identifier for the event. It's useful to persist it on your side, if you want to delete it later or simply to read it among the other regular events.
• weekday: The target weekday (example: monday)
• startTime and endTime: ISO 8601 time to start the regular event. It's recommended to use UTC.
• value: The type of value will depend on the primary value of the point. You can read it from the tag "controlType"

...

Delete a schedule regular event

It's possible to delete a regular event on a Schedule if you know its unique id (the event id). See Schedule data type for more information about regular events.

The document syntax to do so is as follow:

{
  "type": "DELETE_RECURRING_EVENT",
  "deviceId": "<DeviceId>",
  "scheduleId": "<ScheduleId>",
  "eventId": "<Your own id>"
}

• deviceId: this is read on the Schedule Data asset. It represents the container such as a Device asset, Equipment asset, Model asset. The deviceId value will always match one of these assets. (There is no link at all with the concept of "device")
• scheduleId: unique schedule identifier of the Schedule Data asset
• eventId: Your own unique identifier for the event.

...

Create a schedule special event

It's possible to create special events on a Schedule. See Schedule data type for more information about special events.

The document syntax to do so is as follow:

{
  "type": "CREATE_SPECIAL_EVENT",
  "deviceId": "<DeviceId>",
  "scheduleId": "<ScheduleId>",
  "payload": {
    "eventId": "<Your own id>",
    "eventName": "<Your own event name>",
    "startDate": "<startDate>",
    "endDate": "<endDate>",
    "value": <value>
  }
}

• deviceId: this is read on the Schedule Data asset. It represents the container such as a Device asset, Equipment asset, Model asset. The deviceId value will always match one of these assets. (There is no link at all with the concept of "device")
• scheduleId: unique schedule identifier of the Schedule Data asset
• eventId: Your own unique identifier for the event. It's useful to persist it on your side, if you want to delete it later or simply to read it among the other special events.
• eventName: A name that the user will see in the BOS UI or through an app as the Supervision app.
• startDate and endDate: ISO 8601 date (not time) to start and end the special event. It's recommended to use UTC.
• value: The type of value will depend on the primary value of the point. You can read it from the tag "controlType"

...

Update a schedule special event

It's possible to update a special event if you know its unique id that was used to create it.

The document syntax to do so is as follow:

{
  "type": "UPDATE_SPECIAL_EVENT",
  "deviceId": "<DeviceId>",
  "scheduleId": "<ScheduleId>",
  "eventId": "<Your own id>",
    "payload": {
      "startDate": "<startDate>",
      "endDate": "<endDate>",
      "value": <value>
  }
}

• deviceId: this is read on the Schedule Data asset. It represents the container such as a Device asset, Equipment asset, Model asset. The deviceId value will always match one of these assets. (There is no link at all with the concept of "device")
• scheduleId: unique schedule identifier of the Schedule Data asset
• eventId: Your own unique identifier for the event. It's useful to persist it on your side, if you want to delete it later or simply to read it among the other special events.
• startDate and endDate: ISO 8601 date (not time) to start and end the special event. It's recommended to use UTC.
• value: The type of value will depend on the primary value of the point. You can read it from the tag "controlType"

...

Delete a schedule special event

It's possible to delete a special event on a Schedule if you know its unique id that was used to create it. See Schedule data type for more information about special events.

The document syntax to do so is as follow:

{
  "type": "DELETE_SPECIAL_EVENT",
  "deviceId": "<DeviceId>",
  "scheduleId": "<ScheduleId>",
  "eventId": "<Your own id>"
}

• deviceId: this is read on the Schedule Data asset. It represents the container such as a Device asset, Equipment asset, Model asset. The deviceId value will always match one of these assets. (There is no link at all with the concept of "device")
• scheduleId: unique schedule identifier of the Schedule Data asset
• eventId: Your own unique identifier for the event. It's useful to persist it on your side, if you want to delete it later or simply to read it among the other special events.