Read Event
Cloud Mock
Cloud Mock
GET
/v1/site/{siteId}/event/{id}
Request
Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.Example:
Authorization: Bearer ********************
Path Params
siteId
string
required
id
string
required
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://mock.apidog.com/m1/479670-0-default/v1/site//event/'
Responses
🟢200Success
application/json
Body
id
string <uuid>
read-onlyrequired
program_id
string <uuid>
required
site_id
string
required
starts_at
string <date-time>
read-onlyrequired
ends_at
string <date-time> | null
read-onlyrequired
duration_s
number | null
required
schedule
array [object {6}]
required
device_ids
array[string]
required
starts_at
string <date-time>
read-onlyrequired
ends_at
string <date-time> | null
read-onlyrequired
duration_s
number | null
read-onlyrequired
is_preparatory_action
boolean
read-onlyrequired
mode
enum<string>
required
Allowed values:
BACKUPCHARGEDISCHARGESAVINGSSELF_CONSUMPTIONSTANDBY
device_settings
array[object (EventBatterySettings) {3}]
deprecated
device_id
string
deprecated
backup_reserve_percentage
integer | null
deprecated
>= 0<= 100
maximum_charge_percentage
integer | null
deprecated
>= 0<= 100
status
enum<string>
read-onlyrequired
Allowed values:
ACTIVECANCELEDCOMPLETEDUPCOMING
is_participating
boolean
required
created_at
string <date-time>
read-onlyrequired
updated_at
string <date-time>
read-onlyrequired
Example
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"program_id": "70c1146b-e933-4cb2-a789-bbca5312b517",
"site_id": "string",
"starts_at": "2019-08-24T14:15:22Z",
"ends_at": "2019-08-24T14:15:22Z",
"duration_s": 0,
"schedule": [
{
"device_ids": [
"string"
],
"starts_at": "2019-08-24T14:15:22Z",
"ends_at": "2019-08-24T14:15:22Z",
"duration_s": 0,
"is_preparatory_action": true,
"mode": "BACKUP"
}
],
"device_settings": [
{
"device_id": "string",
"backup_reserve_percentage": 0,
"maximum_charge_percentage": 0
}
],
"status": "ACTIVE",
"is_participating": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
🟠404Record not found
Modified at 2025-03-24 11:33:45