ACL list
Lists all the UI modules for all the roles by default.
Sample OUTPUT
{
"message": "string",
"response": [
{
"components": [
{
"component_key": 0,
"component_name": "string"
}
],
"module_key": "string",
"module_name": "string",
"module_path": "string"
}
],
"response_code": 0
}
To get list of UI modules for a specific role, role_key
is accepted and query params.
Authorizations:
Responses
Response samples
- 200
- 400
- 500
{- "message": "string",
- "response": [
- {
- "components": [
- {
- "component_key": 0,
- "component_name": "string"
}
], - "module_key": "string",
- "module_name": "string",
- "module_path": "string"
}
], - "response_code": 0
}
Upload Excel/CSV
Takes in a file and stores the file.
Upload a file with form pram modulefile
Sample CSV file content
type,key,name,role,/channel/list,module_key
mod,dashboard,Dashboard,admin|user|viewer,/dashboard,
comp,28,DashboardCard,admin|user|viewer,,dashboard
mod,dashboard-old,Dashboard,admin|user|viewer,/dashboard-old,
comp,29,UseCaseCard,admin|user|viewer,,dashboard-old
Authorizations:
query Parameters
modulefile required | string Default: "test.csv" csv module file |
Responses
Response samples
- 200
- 400
- 500
{- "message": "string",
- "response": null,
- "response_code": 0
}
Alert Active
Alert Active API.
Sample INPUT
{
"channel_id": "string"
}
Sample OUTPUT
{
"message": "Active alert",
"response": [
{
"alert_actions": [
{
"action_access_id": "string",
"action_access_token": "string",
"action_auth_header": "string",
"action_external_link": "string",
"action_header": "string",
"action_is_auto_payload": true,
"action_is_secure": true,
"action_message": "string",
"action_method": "string",
"action_payload": "string",
"action_process_delay": 0,
"action_query": "string",
"action_subject": "string",
"action_to": "string",
"action_type": "string",
"action_url": "string"
}
],
"alert_frequency": 0,
"alert_id": "string",
"alert_name": "string",
"alert_priority": "string",
"alert_threshold": "string",
"alert_threshold_condition": "string",
"alert_threshold_key": "string",
"is_active": true
}
],
"response_code": 200
}
Authorizations:
Request Body schema: application/json
Alert ID Payload
channel_id required | string |
Responses
Request samples
- Payload
{- "channel_id": "string"
}
Response samples
- 200
- 400
- 500
{- "message": "string",
- "response": [
- {
- "alert_actions": [
- {
- "action_access_id": "string",
- "action_access_token": "string",
- "action_auth_header": "string",
- "action_external_link": "string",
- "action_header": "string",
- "action_is_auto_payload": true,
- "action_is_secure": true,
- "action_message": "string",
- "action_method": "string",
- "action_payload": "string",
- "action_process_delay": 0,
- "action_query": "string",
- "action_subject": "string",
- "action_to": "string",
- "action_type": "string",
- "action_url": "string"
}
], - "alert_frequency": 0,
- "alert_id": "string",
- "alert_name": "string",
- "alert_priority": "string",
- "alert_threshold": "string",
- "alert_threshold_condition": "string",
- "alert_threshold_key": "string",
- "is_active": true
}
], - "response_code": 0
}
Alert Create
Alert Create API.
Sample INPUT
{
"alert_actions": [
{
"action_access_id": "string",
"action_access_token": "string",
"action_auth_header": "string",
"action_external_link": "string",
"action_header": "string",
"action_is_auto_payload": true,
"action_is_secure": true,
"action_message": "string",
"action_method": "string",
"action_payload": "string",
"action_process_delay": 0,
"action_query": "string",
"action_subject": "string",
"action_to": "string",
"action_type": "string",
"action_url": "string",
"additionalProp1": {}
}
],
"alert_frequency": 0,
"alert_name": "string",
"alert_priority": "string",
"alert_threshold": "string",
"alert_threshold_condition": "string",
"alert_threshold_key": "string",
"channel_id": "string"
}
Sample OUTPUT
{
"message": "Alert created",
"response": null,
"response_code": 201
}
Authorizations:
Request Body schema: application/json
Alert Create Payload
required | Array of objects |
alert_frequency required | integer [ 0 .. 86400 ] |
alert_name required | string |
alert_priority required | string |
alert_threshold required | string |
alert_threshold_condition required | string |
alert_threshold_key required | string |
channel_id required | string |
Responses
Request samples
- Payload
{- "alert_actions": [
- {
- "action_access_id": "string",
- "action_access_token": "string",
- "action_auth_header": "string",
- "action_external_link": "string",
- "action_header": "string",
- "action_is_auto_payload": true,
- "action_is_secure": true,
- "action_message": "string",
- "action_method": "string",
- "action_payload": "string",
- "action_process_delay": 0,
- "action_query": "string",
- "action_subject": "string",
- "action_to": "string",
- "action_type": "string",
- "action_url": "string"
}
], - "alert_frequency": 86400,
- "alert_name": "string",
- "alert_priority": "string",
- "alert_threshold": "string",
- "alert_threshold_condition": "string",
- "alert_threshold_key": "string",
- "channel_id": "string"
}
Response samples
- 200
- 400
- 500
{- "message": "string",
- "response": null,
- "response_code": 0
}
Alert Delete
Alert Delete API
Sample INPUT
{
"alert_id": "string"
}
Sample OUTPUT
{
"message": "Alert deleted",
"response": null,
"response_code": 200
}
Authorizations:
Request Body schema: application/json
Alert Delete Payload
alert_id required | string |
Responses
Request samples
- Payload
{- "alert_id": "string"
}
Response samples
- 200
- 400
- 500
{- "message": "string",
- "response": null,
- "response_code": 0
}
Alert Disable
Alert De-Activate API.
Sample INPUT
{
"alert_id": "string"
}
Sample OUTPUT
{
"message": "Alert deactivated",
"response": null,
"response_code": 200
}
Authorizations:
Request Body schema: application/json
Alert Disable Payload
alert_id required | string |
channel_id required | string |
Responses
Request samples
- Payload
{- "alert_id": "string",
- "channel_id": "string"
}
Response samples
- 200
- 400
- 500
{- "message": "string",
- "response": {
- "alert_actions": [
- {
- "action_access_id": "string",
- "action_access_token": "string",
- "action_auth_header": "string",
- "action_external_link": "string",
- "action_header": "string",
- "action_is_auto_payload": true,
- "action_is_secure": true,
- "action_message": "string",
- "action_method": "string",
- "action_payload": "string",
- "action_process_delay": 0,
- "action_query": "string",
- "action_subject": "string",
- "action_to": "string",
- "action_type": "string",
- "action_url": "string"
}
], - "alert_frequency": 0,
- "alert_id": "string",
- "alert_name": "string",
- "alert_priority": "string",
- "alert_threshold": "string",
- "alert_threshold_condition": "string",
- "alert_threshold_key": "string",
- "is_active": true
}, - "response_code": 0
}
Alert Enable
Alert Activate API.
Sample INPUT
{
"alert_id": "string"
}
Sample OUTPUT
{
"message": "Alert activated",
"response": null,
"response_code": 200
}
Authorizations:
Request Body schema: application/json
Alert Enable Payload
alert_id required | string |
channel_id required | string |
Responses
Request samples
- Payload
{- "alert_id": "string",
- "channel_id": "string"
}
Response samples
- 200
- 400
- 500
{- "message": "string",
- "response": {
- "alert_actions": [
- {
- "action_access_id": "string",
- "action_access_token": "string",
- "action_auth_header": "string",
- "action_external_link": "string",
- "action_header": "string",
- "action_is_auto_payload": true,
- "action_is_secure": true,
- "action_message": "string",
- "action_method": "string",
- "action_payload": "string",
- "action_process_delay": 0,
- "action_query": "string",
- "action_subject": "string",
- "action_to": "string",
- "action_type": "string",
- "action_url": "string"
}
], - "alert_frequency": 0,
- "alert_id": "string",
- "alert_name": "string",
- "alert_priority": "string",
- "alert_threshold": "string",
- "alert_threshold_condition": "string",
- "alert_threshold_key": "string",
- "is_active": true
}, - "response_code": 0
}
Alert ID
Alert ID API.
Sample INPUT
{
"alert_id": "string"
}
Sample OUTPUT
{
"message": "Alert by ID",
"response": {
"alert_actions": [
{
"action_access_id": "string",
"action_access_token": "string",
"action_auth_header": "string",
"action_external_link": "string",
"action_header": "string",
"action_is_auto_payload": true,
"action_is_secure": true,
"action_message": "string",
"action_method": "string",
"action_payload": "string",
"action_process_delay": 0,
"action_query": "string",
"action_subject": "string",
"action_to": "string",
"action_type": "string",
"action_url": "string"
}
],
"alert_frequency": 0,
"alert_id": "string",
"alert_name": "string",
"alert_priority": "string",
"alert_threshold": "string",
"alert_threshold_condition": "string",
"alert_threshold_key": "string",
"is_active": true
},
"response_code": 200
}
Authorizations:
Request Body schema: application/json
Alert ID Payload
alert_id required | string |
Responses
Request samples
- Payload
{- "alert_id": "string"
}
Response samples
- 200
- 400
- 500
{- "message": "string",
- "response": {
- "alert_actions": [
- {
- "action_access_id": "string",
- "action_access_token": "string",
- "action_auth_header": "string",
- "action_external_link": "string",
- "action_header": "string",
- "action_is_auto_payload": true,
- "action_is_secure": true,
- "action_message": "string",
- "action_method": "string",
- "action_payload": "string",
- "action_process_delay": 0,
- "action_query": "string",
- "action_subject": "string",
- "action_to": "string",
- "action_type": "string",
- "action_url": "string"
}
], - "alert_frequency": 0,
- "alert_id": "string",
- "alert_name": "string",
- "alert_priority": "string",
- "alert_threshold": "string",
- "alert_threshold_condition": "string",
- "alert_threshold_key": "string",
- "is_active": true
}, - "response_code": 0
}
Alert List by Channel ID
Alert List API.
Sample INPUT
{
"channel_id": "string"
}
Sample OUTPUT
{
"message": "Alert list",
"response": [
{
"alert_actions": [
{
"action_access_id": "string",
"action_access_token": "string",
"action_auth_header": "string",
"action_external_link": "string",
"action_header": "string",
"action_is_auto_payload": true,
"action_is_secure": true,
"action_message": "string",
"action_method": "string",
"action_payload": "string",
"action_process_delay": 0,
"action_query": "string",
"action_subject": "string",
"action_to": "string",
"action_type": "string",
"action_url": "string"
}
],
"alert_frequency": 0,
"alert_id": "string",
"alert_name": "string",
"alert_priority": "string",
"alert_threshold": "string",
"alert_threshold_condition": "string",
"alert_threshold_key": "string",
"is_active": true
}
],
"response_code": 200
}
Authorizations:
Request Body schema: application/json
Alert List Payload
channel_id required | string |
Responses
Request samples
- Payload
{- "channel_id": "string"
}
Response samples
- 200
- 400
- 500
{- "message": "string",
- "response": [
- {
- "alert_actions": [
- {
- "action_access_id": "string",
- "action_access_token": "string",
- "action_auth_header": "string",
- "action_external_link": "string",
- "action_header": "string",
- "action_is_auto_payload": true,
- "action_is_secure": true,
- "action_message": "string",
- "action_method": "string",
- "action_payload": "string",
- "action_process_delay": 0,
- "action_query": "string",
- "action_subject": "string",
- "action_to": "string",
- "action_type": "string",
- "action_url": "string"
}
], - "alert_frequency": 0,
- "alert_id": "string",
- "alert_name": "string",
- "alert_priority": "string",
- "alert_threshold": "string",
- "alert_threshold_condition": "string",
- "alert_threshold_key": "string",
- "is_active": true
}
], - "response_code": 0
}
Notification Gallery
Notification Gallery API.
Sample INPUT
// Query params
{
"usecase_key": "string",
"channel_id": "string",
"notification_uuid": "string"
}
Sample Output
{
"message": "Notifications gallery by UUID",
"response": {
"channel_id": "string",
"gallery": [
{
"image": [
0
],
"time_stamp": "string",
"uuid": "string"
}
],
"usecase_key": "string"
},
"response_code": 200
}
Authorizations:
query Parameters
stream_key required | string Stream Key |
channel_id required | string Channel ID |
notification_offset | integer Notification Offset |
notification_limit | integer Notification Limit |
start required | string Start Time |
end required | string End Time |
Responses
Response samples
- 200
- 400
- 500
{- "message": "string",
- "response": {
- "channel_id": "string",
- "gallery": [
- {
- "image": [
- 0
], - "time_stamp": "string",
- "uuid": "string"
}
], - "usecase_key": "string"
}, - "response_code": 0
}
Notification Gallery Image by ID
Notification Gallery API.
Sample INPUT
// Query params
{
"usecase_key": "string",
"channel_id": "string",
"notification_uuid": "string"
}
Sample Output
{
"message": "Notifications gallery by UUID",
"response": {
"channel_id": "string",
"gallery": [
{
"image": [
0
],
"time_stamp": "string",
"uuid": "string"
}
],
"usecase_key": "string"
},
"response_code": 200
}
Authorizations:
query Parameters
channel_id required | string Channel ID |
notification_uuid | integer Notification UUID |
Responses
Response samples
- 200
- 400
- 500
{- "message": "string",
- "response": {
- "channel_id": "string",
- "gallery": [
- {
- "image": [
- 0
], - "time_stamp": "string",
- "uuid": "string"
}
], - "usecase_key": "string"
}, - "response_code": 0
}
Notifications By Range
Notification By Range API.
Sample INPUT
// Query params
{
"usecase_key": "string",
"channel_id": "string",
"notification_offset": 0,
"notification_limit": 0,
"start": "string",
"end": "string"
}
Sample OUTPUT
Hello
{
"message": "Notifications by range",
"response": {
"channel_id": "string",
"end": "string",
"notifications": [
{
"channel_id": "string",
"notification_data": {
"attachment": "string",
"from": "string",
"message": "string",
"subject": "string",
"to": "string"
},
"notification_extra": "string",
"notification_time": "string",
"notification_uuid": "string",
"usecase_key": "string"
}
],
"start": "string",
"usecase_key": "string"
},
"response_code": 200
}
Authorizations:
query Parameters
usecase required | string UseCase |
channel_id required | string Channel ID |
notification_offset | integer Notification Offset |
notification_limit | integer Notification Limit |
start required | string Start Time |
end required | string End Time |
Responses
Response samples
- 200
- 400
- 500
{- "message": "string",
- "response": {
- "channel_id": "string",
- "end": "string",
- "notifications": [
- {
- "channel_id": "string",
- "notification_data": {
- "attachment": "string",
- "from": "string",
- "message": "string",
- "subject": "string",
- "to": "string"
}, - "notification_extra": "string",
- "notification_time": "string",
- "notification_uuid": "string",
- "usecase_key": "string"
}
], - "start": "string",
- "usecase_key": "string"
}, - "response_code": 0
}
Notification By UUID
Notification By UUID API.
Sample INPUT
// Query params
{
"usecase_key": "string",
"channel_id": "string",
"notification_uuid": "string"
}
Sample OUTPUT
Hello
{
"message": "Notification by UUID",
"response": {
"channel_id": "string",
"notification_data": {
"attachment": "string",
"from": "string",
"message": "string",
"subject": "string",
"to": "string"
},
"notification_extra": "string",
"notification_time": "string",
"notification_uuid": "string",
"usecase_key": "string"
},
"response_code": 200
}
Authorizations:
query Parameters
usecase required | string UseCase Key |
channel_id required | string Channel ID |
notification_uuid required | string Notification UUID |
Responses
Response samples
- 200
- 400
- 500
{- "message": "string",
- "response": {
- "channel_id": "string",
- "notification_data": {
- "attachment": "string",
- "from": "string",
- "message": "string",
- "subject": "string",
- "to": "string"
}, - "notification_extra": "string",
- "notification_time": "string",
- "notification_uuid": "string",
- "usecase_key": "string"
}, - "response_code": 0
}
Alert Update
Alert Update API.
Sample INPUT
{
"alert_actions": [
{
"action_access_id": "string",
"action_access_token": "string",
"action_auth_header": "string",
"action_external_link": "string",
"action_header": "string",
"action_is_auto_payload": true,
"action_is_secure": true,
"action_message": "string",
"action_method": "string",
"action_payload": "string",
"action_process_delay": 0,
"action_query": "string",
"action_subject": "string",
"action_to": "string",
"action_type": "string",
"action_url": "string"
}
],
"alert_frequency": 0,
"alert_id": "string",
"alert_name": "string",
"alert_priority": "string",
"alert_threshold": "string",
"alert_threshold_condition": "string",
"alert_threshold_key": "string",
"is_active": true
}
Sample OUTPUT
{
"message": "Alert updated",
"response": {
"alert_actions": [
{
"action_access_id": "string",
"action_access_token": "string",
"action_auth_header": "string",
"action_external_link": "string",
"action_header": "string",
"action_is_auto_payload": true,
"action_is_secure": true,
"action_message": "string",
"action_method": "string",
"action_payload": "string",
"action_process_delay": 0,
"action_query": "string",
"action_subject": "string",
"action_to": "string",
"action_type": "string",
"action_url": "string"
}
],
"alert_frequency": 0,
"alert_id": "string",
"alert_name": "string",
"alert_priority": "string",
"alert_threshold": "string",
"alert_threshold_condition": "string",
"alert_threshold_key": "string",
"is_active": true
},
"response_code": 200
}
Authorizations:
Request Body schema: application/json
Alert Update Payload
required | Array of objects |
alert_frequency required | integer [ 0 .. 86400 ] |
alert_id required | string |
alert_name required | string |
alert_priority required | string |
alert_threshold required | string |
alert_threshold_condition required | string |
alert_threshold_key required | string |
channel_id required | string |
Responses
Request samples
- Payload
{- "alert_actions": [
- {
- "action_access_id": "string",
- "action_access_token": "string",
- "action_auth_header": "string",
- "action_external_link": "string",
- "action_header": "string",
- "action_is_auto_payload": true,
- "action_is_secure": true,
- "action_message": "string",
- "action_method": "string",
- "action_payload": "string",
- "action_process_delay": 0,
- "action_query": "string",
- "action_subject": "string",
- "action_to": "string",
- "action_type": "string",
- "action_url": "string"
}
], - "alert_frequency": 86400,
- "alert_id": "string",
- "alert_name": "string",
- "alert_priority": "string",
- "alert_threshold": "string",
- "alert_threshold_condition": "string",
- "alert_threshold_key": "string",
- "channel_id": "string"
}
Response samples
- 200
- 400
- 500
{- "message": "string",
- "response": {
- "alert_actions": [
- {
- "action_access_id": "string",
- "action_access_token": "string",
- "action_auth_header": "string",
- "action_external_link": "string",
- "action_header": "string",
- "action_is_auto_payload": true,
- "action_is_secure": true,
- "action_message": "string",
- "action_method": "string",
- "action_payload": "string",
- "action_process_delay": 0,
- "action_query": "string",
- "action_subject": "string",
- "action_to": "string",
- "action_type": "string",
- "action_url": "string"
}
], - "alert_frequency": 0,
- "alert_id": "string",
- "alert_name": "string",
- "alert_priority": "string",
- "alert_threshold": "string",
- "alert_threshold_condition": "string",
- "alert_threshold_key": "string",
- "is_active": true
}, - "response_code": 0
}
Events By Range
Event By Range API.
Sample INPUT
// Query params
{
"usecase_key": "string",
"usecase_meta_key": [
"string"
],
"channel_id": "string",
"event_offset": 0,
"event_limit": "string",
"start": "string",
"end": "string",
"agg_frequency": "string",
"details": false,
"type": 0
}
Sample OUTPUT
{
"message": "Alert activated",
"response": {
"agg_frequency": "string",
"channel_id": "string",
"end": "string",
"event_limit": 0,
"event_offset": 0,
"events": [
{
"alert": 0,
"down": 0,
"dwell_time": 0,
"fire": 0,
"frame_collision": 0,
"frame_near_miss": 0,
"high_smoke": 0,
"id": 0,
"ids": [
"string"
],
"intermediate_smoke": 0,
"low_smoke": 0,
"metadata": "string",
"moving_average_count": 0,
"non_violation": 0,
"occupancy": 0,
"threshold": "string",
"time": "string",
"total": 0,
"total_collision": 0,
"total_near_miss": 0,
"up": 0,
"violation": 0
}
],
"start": "string",
"usecase_key": "string"
},
"response_code": 200
}
Authorizations:
query Parameters
usecase required | string UseCase Key |
usecase_meta_key required | string UseCase Meta Key |
channel_id required | string Channel ID |
event_offset | integer Event Offset |
event_limit | integer Event Limit |
start required | string Start Time |
end required | string End Time |
agg_frequency required | string Default: "100ms" Aggregation Frequency |
details required | boolean Default: false details |
Responses
Response samples
- 200
- 400
- 500
{- "message": "string",
- "response": {
- "agg_frequency": "string",
- "channel_id": "string",
- "end": "string",
- "event_limit": 0,
- "event_offset": 0,
- "events": [
- {
- "alert": 0,
- "down": 0,
- "dwell_time": 0,
- "fire": 0,
- "frame_collision": 0,
- "frame_near_miss": 0,
- "high_smoke": 0,
- "id": 0,
- "ids": [
- "string"
], - "intermediate_smoke": 0,
- "low_smoke": 0,
- "metadata": "string",
- "moving_average": 0,
- "non_violation": 0,
- "occupancy": 0,
- "threshold": "string",
- "time": "string",
- "total": 0,
- "total_collision": 0,
- "total_near_miss": 0,
- "up": 0,
- "violation": 0
}
], - "start": "string",
- "usecase_key": "string"
}, - "response_code": 0
}
Channel Stats
Event Alert Stats API.
Sample INPUT
// Query params
{
"usecase_key": "string",
"usecase_meta_key": [
"string"
],
"channel_id": "string",
"frequency": "-string"
}
Sample OUTPUT
{
"message": "Alert activated",
"response": {
"channel_alert": {
"channel": "string",
"condition": "string",
"count": 0,
"key": "string",
"name": "string",
"time": "string"
},
"channel_id": "string",
"channel_key": "string",
"channel_name": "string",
"channel_stats": {
"alert": 0,
"down": 0,
"dwell_time": 0,
"fire": 0,
"frame_collision": 0,
"frame_near_miss": 0,
"high_smoke": 0,
"ids": [
"string"
],
"intermediate_smoke": 0,
"low_smoke": 0,
"moving_average_count": 0,
"non_violation": 0,
"occupancy": 0,
"total": 0,
"total_collision": 0,
"total_near_miss": 0,
"up": 0,
"violation": 0
},
"channel_total_alert": 0,
"channel_total_notification": 0,
"usecase_key": "string"
},
"response_code": 200
}
Authorizations:
query Parameters
usecase required | string UseCase Key |
usecase_meta_key required | string UseCase Meta Key |
channel_id required | string Channel ID |
frequency required | string Default: "-1h" Frequency |
Responses
Response samples
- 200
- 400
- 500
{- "message": "string",
- "response": {
- "channel_alert": {
- "channel": "string",
- "condition": "string",
- "count": 0,
- "key": "string",
- "name": "string",
- "time": "string"
}, - "channel_id": "string",
- "channel_key": "string",
- "channel_name": "string",
- "channel_stats": {
- "alert": 0,
- "down": 0,
- "dwell_time": 0,
- "fire": 0,
- "frame_collision": 0,
- "frame_near_miss": 0,
- "high_smoke": 0,
- "ids": [
- "string"
], - "intermediate_smoke": 0,
- "low_smoke": 0,
- "moving_average": 0,
- "non_violation": 0,
- "occupancy": 0,
- "total": 0,
- "total_collision": 0,
- "total_near_miss": 0,
- "up": 0,
- "violation": 0
}, - "channel_total_alert": 0,
- "channel_total_notification": 0,
- "usecase_key": "string"
}, - "response_code": 0
}
UseCase Stats
Notification Stats By Usecase API.
Sample INPUT
// Query params
{
"usecase_key": "string",
"usecase_meta_key": [
"string",
"string",
"string"
],
"channel_id": "string",
"frequency": "string",
"details": true
}
Sample OUTPUT
Hello
{
"message": "Notification stats",
"response": {
"usecase_channel": [
{
"channel_alert": {
"channel": "string",
"condition": "string",
"count": 0,
"key": "string",
"name": "string",
"time": "string"
},
"channel_id": "string",
"channel_key": "string",
"channel_name": "string",
"channel_stats": {
"alert": 0,
"down": 0,
"dwell_time": 0,
"fire": 0,
"frame_collision": 0,
"frame_near_miss": 0,
"high_smoke": 0,
"ids": [
"string"
],
"intermediate_smoke": 0,
"low_smoke": 0,
"moving_average_count": 0,
"non_violation": 0,
"occupancy": 0,
"total": 0,
"total_collision": 0,
"total_near_miss": 0,
"up": 0,
"violation": 0
},
"channel_total_alert": 0,
"channel_total_notification": 0,
"usecase_key": "string"
}
],
"usecase_key": "string",
"usecase_total_alert": 0,
"usecase_total_notification": 0,
"usecase_total_stats": {
"down": 0,
"dwelltime": 0,
"fire": 0,
"framecollision": 0,
"framenearmiss": 0,
"highsmoke": 0,
"intermediatesmoke": 0,
"lowsmoke": 0,
"movingaveragecount": 0,
"nonviolation": 0,
"occupancy": 0,
"total": 0,
"totalcollision": 0,
"totalnearmiss": 0,
"up": 0,
"violation": 0
}
},
"response_code": 200
}
Authorizations:
query Parameters
usecase required | string UseCase Key |
usecase_meta_key required | string UseCase Meta Key |
frequency required | string Default: "-1h" Frequency |
details required | boolean Default: false details |
Responses
Response samples
- 200
- 400
- 500
{- "message": "string",
- "response": {
- "usecase_channel": [
- {
- "channel_alert": {
- "channel": "string",
- "condition": "string",
- "count": 0,
- "key": "string",
- "name": "string",
- "time": "string"
}, - "channel_id": "string",
- "channel_key": "string",
- "channel_name": "string",
- "channel_stats": {
- "alert": 0,
- "down": 0,
- "dwell_time": 0,
- "fire": 0,
- "frame_collision": 0,
- "frame_near_miss": 0,
- "high_smoke": 0,
- "ids": [
- "string"
], - "intermediate_smoke": 0,
- "low_smoke": 0,
- "moving_average": 0,
- "non_violation": 0,
- "occupancy": 0,
- "total": 0,
- "total_collision": 0,
- "total_near_miss": 0,
- "up": 0,
- "violation": 0
}, - "channel_total_alert": 0,
- "channel_total_notification": 0,
- "usecase_key": "string"
}
], - "usecase_key": "string",
- "usecase_total_alert": 0,
- "usecase_total_notification": 0,
- "usecase_total_stats": {
- "down": 0,
- "dwelltime": 0,
- "fire": 0,
- "framecollision": 0,
- "framenearmiss": 0,
- "highsmoke": 0,
- "intermediatesmoke": 0,
- "lowsmoke": 0,
- "movingaveragecount": 0,
- "nonviolation": 0,
- "occupancy": 0,
- "total": 0,
- "totalcollision": 0,
- "totalnearmiss": 0,
- "up": 0,
- "violation": 0
}
}, - "response_code": 0
}
UseCase Stats
Usecase Stats API
Sample INPUT
{
"details": true,
"frequency": "string",
"usecase_key": "string",
"usecase_meta_key": [
"string"
]
}
Sample OUTPUT
{
"message": "Usecase deleted",
"response": {
"usecase_channel": [
{
"channel_alert": {
"channel": "string",
"condition": "string",
"count": 0,
"key": "string",
"name": "string",
"time": "string"
},
"channel_id": "string",
"channel_key": "string",
"channel_name": "string",
"channel_stats": {
"alert": 0,
"down": 0,
"dwell_time": 0,
"fire": 0,
"frame_collision": 0,
"frame_near_miss": 0,
"high_smoke": 0,
"ids": [
"string"
],
"intermediate_smoke": 0,
"low_smoke": 0,
"moving_average_count": 0,
"non_violation": 0,
"occupancy": 0,
"total": 0,
"total_collision": 0,
"total_near_miss": 0,
"up": 0,
"violation": 0
},
"channel_total_alert": 0,
"channel_total_notification": 0,
"usecase_key": "string"
}
],
"usecase_key": "string",
"usecase_total_alert": 0,
"usecase_total_notification": 0,
"usecase_total_stats": {
"alert": 0,
"down": 0,
"dwell_time": 0,
"fire": 0,
"frame_collision": 0,
"frame_near_miss": 0,
"high_smoke": 0,
"ids": [
"string"
],
"intermediate_smoke": 0,
"low_smoke": 0,
"moving_average_count": 0,
"non_violation": 0,
"occupancy": 0,
"total": 0,
"total_collision": 0,
"total_near_miss": 0,
"up": 0,
"violation": 0
}
},
"response_code": 200
}
Authorizations:
Request Body schema: application/json
UseCase Stats Payload
details required | boolean |
frequency required | string |
usecase_key required | string |
usecase_meta_key required | Array of strings |
Responses
Request samples
- Payload
{- "details": true,
- "frequency": "string",
- "usecase_key": "string",
- "usecase_meta_key": [
- "string"
]
}
Response samples
- 200
- 400
- 500
{- "message": "string",
- "response": {
- "usecase_channel": [
- {
- "channel_alert": {
- "channel": "string",
- "condition": "string",
- "count": 0,
- "key": "string",
- "name": "string",
- "time": "string"
}, - "channel_id": "string",
- "channel_key": "string",
- "channel_name": "string",
- "channel_stats": {
- "alert": 0,
- "down": 0,
- "dwell_time": 0,
- "fire": 0,
- "frame_collision": 0,
- "frame_near_miss": 0,
- "high_smoke": 0,
- "ids": [
- "string"
], - "intermediate_smoke": 0,
- "low_smoke": 0,
- "moving_average": 0,
- "non_violation": 0,
- "occupancy": 0,
- "total": 0,
- "total_collision": 0,
- "total_near_miss": 0,
- "up": 0,
- "violation": 0
}, - "channel_total_alert": 0,
- "channel_total_notification": 0,
- "usecase_key": "string"
}
], - "usecase_key": "string",
- "usecase_total_alert": 0,
- "usecase_total_notification": 0,
- "usecase_total_stats": {
- "alert": 0,
- "down": 0,
- "dwell_time": 0,
- "fire": 0,
- "frame_collision": 0,
- "frame_near_miss": 0,
- "high_smoke": 0,
- "ids": [
- "string"
], - "intermediate_smoke": 0,
- "low_smoke": 0,
- "moving_average": 0,
- "non_violation": 0,
- "occupancy": 0,
- "total": 0,
- "total_collision": 0,
- "total_near_miss": 0,
- "up": 0,
- "violation": 0
}
}, - "response_code": 0
}
UseCase Report
Usecase Report API
Sample INPUT
{
"details": true,
"frequency": "string",
"usecase_key": "string",
"usecase_meta_key": [
"string"
]
}
Sample OUTPUT
{
"message": "Usecase deleted",
"response": {
"channel_stats": {
"alert": 0,
"down": 0,
"dwell_time": 0,
"fire": 0,
"frame_collision": 0,
"frame_near_miss": 0,
"high_smoke": 0,
"ids": [
"string"
],
"intermediate_smoke": 0,
"low_smoke": 0,
"moving_average_count": 0,
"non_violation": 0,
"occupancy": 0,
"total": 0,
"total_collision": 0,
"total_near_miss": 0,
"up": 0,
"violation": 0
}
},
"response_code": 200
}
Authorizations:
Request Body schema: application/json
UseCase Stats Payload
channel_id required | string |
details required | boolean |
end_date required | string |
start_date required | string |
usecase_key required | string |
Responses
Request samples
- Payload
{- "channel_id": "string",
- "details": true,
- "end_date": "string",
- "start_date": "string",
- "usecase_key": "string"
}
Response samples
- 200
- 400
- 500
{- "message": "string",
- "response": {
- "channel_alert": {
- "channel": "string",
- "condition": "string",
- "count": 0,
- "key": "string",
- "name": "string",
- "time": "string"
}, - "channel_id": "string",
- "channel_key": "string",
- "channel_name": "string",
- "channel_stats": {
- "alert": 0,
- "down": 0,
- "dwell_time": 0,
- "fire": 0,
- "frame_collision": 0,
- "frame_near_miss": 0,
- "high_smoke": 0,
- "ids": [
- "string"
], - "intermediate_smoke": 0,
- "low_smoke": 0,
- "moving_average": 0,
- "non_violation": 0,
- "occupancy": 0,
- "total": 0,
- "total_collision": 0,
- "total_near_miss": 0,
- "up": 0,
- "violation": 0
}, - "channel_total_alert": 0,
- "channel_total_notification": 0,
- "usecase_key": "string"
}, - "response_code": 0
}
User Auth
User Auth with return Access token
Request Body schema: application/json
User Auth Payload
email required | string |
password required | string |
Responses
Request samples
- Payload
{- "email": "string",
- "password": "string"
}
Response samples
- 200
- 400
- 404
- 500
{- "message": "string",
- "response": null,
- "response_code": 0
}
User Config By ID
User Config Update By ID
Sample INPUT
{
"user_config": {
"channel_ids": [
"string"
],
"role_id": "string",
"ui_config": {
"additionalProp1": {}
},
"usecase_ids": [
"string"
],
"user_id": "string"
},
"user_id": "string"
}
Sample OUTPUT
{
"message": "User Config Updated",
"response": null,
"response_code": 200
}
Authorizations:
Request Body schema: application/json
User Config By ID Payload
object (user.userConfigResp) | |
user_id required | string |
Responses
Request samples
- Payload
{- "user_config": {
- "channel_ids": [
- "string"
], - "customer_ids": [
- "string"
], - "role_id": "string",
- "site_ids": [
- "string"
], - "ui_config": { },
- "usecase_ids": [
- "string"
], - "user_id": "string"
}, - "user_id": "string"
}
Response samples
- 200
- 400
- 500
{- "message": "string",
- "response": {
- "channel_ids": [
- "string"
], - "customer_ids": [
- "string"
], - "role_id": "string",
- "site_ids": [
- "string"
], - "ui_config": { },
- "usecase_ids": [
- "string"
], - "user_id": "string"
}, - "response_code": 0
}
User Config Update By ID
User Config Update By ID
Sample INPUT
{
"user_config": {
"channel_ids": [
"string"
],
"role_id": "string",
"ui_config": {
"additionalProp1": {}
},
"usecase_ids": [
"string"
],
"user_id": "string"
},
"user_id": "string"
}
Sample OUTPUT
{
"message": "User Config Updated",
"response": null,
"response_code": 200
}
Authorizations:
Request Body schema: application/json
User Config Update By ID Payload
object (user.userConfigResp) | |
user_id required | string |
Responses
Request samples
- Payload
{- "user_config": {
- "channel_ids": [
- "string"
], - "customer_ids": [
- "string"
], - "role_id": "string",
- "site_ids": [
- "string"
], - "ui_config": { },
- "usecase_ids": [
- "string"
], - "user_id": "string"
}, - "user_id": "string"
}
Response samples
- 200
- 400
- 500
{- "message": "string",
- "response": null,
- "response_code": 0
}
User Register
New User Register
Sample INPUT
{
"email": "string",
"first_name": "string",
"last_name": "string",
"password": "string",
"role_key": "string"
}
Sample OUTPUT
{
"message": "User Registered",
"response": {
"avatar": "string",
"channel_ids": [
"string"
],
"email": "string",
"first_name": "string",
"is_active": true,
"is_verified": true,
"last_logged_in_at": "string",
"last_name": "string",
"role_id": "string",
"role_key": "string",
"ui_config": {
"additionalProp1": {}
},
"usecase_ids": [
"string"
],
"user_id": "string",
"user_name": "string"
},
"response_code": 201
}
Request Body schema: application/json
User Register Payload
email required | string |
first_name required | string |
last_name required | string |
password required | string |
role_key required | string |
Responses
Request samples
- Payload
{- "email": "string",
- "first_name": "string",
- "last_name": "string",
- "password": "string",
- "role_key": "string"
}
Response samples
- 200
- 201
- 400
- 500
{- "message": "string",
- "response": {
- "avatar": "string",
- "channel_ids": [
- "string"
], - "customer_ids": [
- "string"
], - "email": "string",
- "first_name": "string",
- "is_active": true,
- "is_verified": true,
- "last_logged_in_at": "string",
- "last_name": "string",
- "role_id": "string",
- "role_key": "string",
- "site_ids": [
- "string"
], - "ui_config": { },
- "usecase_ids": [
- "string"
], - "user_id": "string",
- "user_name": "string"
}, - "response_code": 0
}
User Delete
User Delete by ID
Sample INPUT
{
"user_id": "string"
}
Sample OUTPUT
{
"message": "User Deleted",
"response": null,
"response_code": 200
}
Authorizations:
Request Body schema: application/json
User Update Payload
user_id required | string |
Responses
Request samples
- Payload
{- "user_id": "string"
}
Response samples
- 200
- 400
- 500
{- "message": "string",
- "response": null,
- "response_code": 0
}
User Get By ID
User Get by ID
Sample INPUT
{
"user_id": "string"
}
Sample OUTPUT
{
"message": "User By ID",
"response": {
"avatar": "string",
"channel_ids": [
"string"
],
"email": "string",
"first_name": "string",
"is_active": true,
"is_verified": true,
"last_logged_in_at": "string",
"last_name": "string",
"role_id": "string",
"role_key": "string",
"ui_config": {
"additionalProp1": {}
},
"usecase_ids": [
"string"
],
"user_id": "string",
"user_name": "string"
},
"response_code": 200
}
Authorizations:
Request Body schema: application/json
User Get By ID Payload
user_id required | string |
Responses
Request samples
- Payload
{- "user_id": "string"
}
Response samples
- 200
- 400
- 500
{- "message": "string",
- "response": {
- "avatar": "string",
- "channel_ids": [
- "string"
], - "customer_ids": [
- "string"
], - "email": "string",
- "first_name": "string",
- "is_active": true,
- "is_verified": true,
- "last_logged_in_at": "string",
- "last_name": "string",
- "role_id": "string",
- "role_key": "string",
- "site_ids": [
- "string"
], - "ui_config": { },
- "usecase_ids": [
- "string"
], - "user_id": "string",
- "user_name": "string"
}, - "response_code": 0
}
User Info
User Info by Access token
Sample OUTPUT
{
"message": "User By ID",
"response": {
"avatar": "string",
"channel_ids": [
"string"
],
"email": "string",
"first_name": "string",
"is_active": true,
"is_verified": true,
"last_logged_in_at": "string",
"last_name": "string",
"role_id": "string",
"role_key": "string",
"ui_config": {
"additionalProp1": {}
},
"usecase_ids": [
"string"
],
"user_id": "string",
"user_name": "string",
"user_config": {
"channel_ids": [
"string"
],
"role_id": "string",
"ui_config": {
"additionalProp1": {}
},
"usecase_ids": [
"string"
],
"user_id": "string"
}
},
"response_code": 200
}
Authorizations:
Responses
Response samples
- 200
- 400
- 500
{- "message": "string",
- "response": {
- "avatar": "string",
- "channel_ids": [
- "string"
], - "customer_ids": [
- "string"
], - "email": "string",
- "first_name": "string",
- "is_active": true,
- "is_verified": true,
- "last_logged_in_at": "string",
- "last_name": "string",
- "role_id": "string",
- "role_key": "string",
- "site_ids": [
- "string"
], - "ui_config": { },
- "usecase_ids": [
- "string"
], - "user_id": "string",
- "user_name": "string",
- "user_config": {
- "channel_ids": [
- "string"
], - "customer_ids": [
- "string"
], - "role_id": "string",
- "site_ids": [
- "string"
], - "ui_config": { },
- "usecase_ids": [
- "string"
], - "user_id": "string"
}
}, - "response_code": 0
}
User List
User List`
Sample OUTPUT
{
"message": "User List",
"response": [
{
"avatar": "string",
"channel_ids": [
"string"
],
"email": "string",
"first_name": "string",
"is_active": true,
"is_verified": true,
"last_logged_in_at": "string",
"last_name": "string",
"role_id": "string",
"role_key": "string",
"ui_config": {
"additionalProp1": {}
},
"usecase_ids": [
"string"
],
"user_id": "string",
"user_name": "string"
}
],
"response_code": 200
}
Authorizations:
Responses
Response samples
- 200
- 400
- 500
{- "message": "string",
- "response": [
- {
- "avatar": "string",
- "channel_ids": [
- "string"
], - "customer_ids": [
- "string"
], - "email": "string",
- "first_name": "string",
- "is_active": true,
- "is_verified": true,
- "last_logged_in_at": "string",
- "last_name": "string",
- "role_id": "string",
- "role_key": "string",
- "site_ids": [
- "string"
], - "ui_config": { },
- "usecase_ids": [
- "string"
], - "user_id": "string",
- "user_name": "string"
}
], - "response_code": 0
}
User Update
User Update by ID
Sample INPUT
{
"change_password": true,
"confirm_password": "string",
"email": "string",
"first_name": "string",
"last_name": "string",
"password": "string",
"role_id": "string",
"user_id": "string"
}
Sample OUTPUT
{
"message": "User Updated",
"response": null,
"response_code": 200
}
Authorizations:
Request Body schema: application/json
User Update Payload
change_password required | boolean |
confirm_password | string |
email required | string |
first_name | string |
last_name | string |
password | string |
role_id required | string |
user_id required | string |
Responses
Request samples
- Payload
{- "change_password": true,
- "confirm_password": "string",
- "email": "string",
- "first_name": "string",
- "last_name": "string",
- "password": "string",
- "role_id": "string",
- "user_id": "string"
}
Response samples
- 200
- 400
- 500
{- "message": "string",
- "response": {
- "avatar": "string",
- "channel_ids": [
- "string"
], - "customer_ids": [
- "string"
], - "email": "string",
- "first_name": "string",
- "is_active": true,
- "is_verified": true,
- "last_logged_in_at": "string",
- "last_name": "string",
- "role_id": "string",
- "role_key": "string",
- "site_ids": [
- "string"
], - "ui_config": { },
- "usecase_ids": [
- "string"
], - "user_id": "string",
- "user_name": "string"
}, - "response_code": 0
}
Get SMS Config
Get SMS Config API.
Sample OUTPUT
{
"message": "SMS Settings",
"response": {
"sms_auth_key": "string",
"sms_auth_token": "string",
"sms_provider": "string",
"sms_from": "string",
"sms_to": "string"
},
"response_code": 200
}
Authorizations:
query Parameters
is_secret required | boolean Reveal Secret |
Responses
Response samples
- 200
- 400
- 500
{- "message": "string",
- "response": {
- "sms_auth_key": "string",
- "sms_auth_token": "string",
- "sms_from": "string",
- "sms_provider": "string",
- "sms_to": "string"
}, - "response_code": 0
}
Update SMS Config
Update SMS Config API.
Sample INPUT
{
"sms_auth_key": "string",
"sms_auth_token": "string",
"sms_provider": "string",
"sms_from": "string",
"sms_to": "string"
}
Sample OUTPUT
{
"message": "SMS settings updated",
"response": null,
"response_code": 200
}
Authorizations:
Responses
Response samples
- 200
- 400
- 500
{- "message": "string",
- "response": null,
- "response_code": 0
}
Get SMTP Config
Get SMS Config API.
Sample OUTPUT
{
"message": "SMTP Settings",
"response": {
"smtp_attachment": true,
"smtp_auth": true,
"smtp_from": "string",
"smtp_host": "string",
"smtp_password": "string",
"smtp_port": 0,
"smtp_to": "string",
"smtp_username": "string"
},
"response_code": 200
}
Authorizations:
query Parameters
is_secret required | boolean Reveal Secret |
Responses
Response samples
- 200
- 400
- 500
{- "message": "string",
- "response": {
- "smtp_attachment": true,
- "smtp_auth": true,
- "smtp_from": "string",
- "smtp_host": "string",
- "smtp_password": "string",
- "smtp_port": 0,
- "smtp_to": "string",
- "smtp_username": "string"
}, - "response_code": 0
}
Update SMTP Config
Update SMTP Config API.
Sample INPUT
{
"smtp_attachment": true,
"smtp_auth": true,
"smtp_from": "string",
"smtp_host": "string",
"smtp_password": "string",
"smtp_port": 0,
"smtp_to": "string",
"smtp_username": "string"
}
Sample OUTPUT
{
"message": "SMTP settings updated",
"response": null,
"response_code": 200
}
Authorizations:
Responses
Response samples
- 200
- 400
- 500
{- "message": "string",
- "response": null,
- "response_code": 0
}
Customer Assign
Customer Site Assign API.
Sample INPUT
{
"customer_id": "string",
"site_ids": [
"string"
]
}
Sample OUTPUT
{
"message": "Assigned site(s) to customer",
"response": null,
"response_code": 200
}
Authorizations:
Request Body schema: application/json
Customer Assign Payload
customer_id required | Array of strings |
user_id required | string |
Responses
Request samples
- Payload
{- "customer_id": [
- "string"
], - "user_id": "string"
}
Response samples
- 200
- 400
- 500
{- "message": "string",
- "response": null,
- "response_code": 0
}
Customer Create
Customer Create API.
At create customer customer_sites
is an empty array, or it has to have a valid list of site_id
s
Sample INPUT
{
"customer_address": {
"customer_area": "string",
"customer_city": "string",
"customer_country": "string",
"customer_state": "string",
"customer_street": "string",
"customer_unit": "string",
"customer_zip": "string"
},
"customer_contact": [
"string"
],
"customer_description": "string",
"customer_icon": "string",
"customer_id": "string",
"customer_key": "string",
"customer_name": "string",
"customer_sites": [],
"customer_type": "string",
"organization_id": "string"
}
Sample OUTPUT
{
"message": "Customer Created",
"response": null,
"response_code": 201
}
Authorizations:
Request Body schema: application/json
Customer Create Payload
required | object (customer.customerAddress) |
customer_contact | Array of strings |
customer_description required | string |
customer_icon required | string |
customer_key required | string |
customer_name required | string |
customer_sites | Array of strings |
customer_type | string |
organization_id required | string |
Responses
Request samples
- Payload
{- "customer_address": {
- "customer_area": "string",
- "customer_city": "string",
- "customer_country": "string",
- "customer_state": "string",
- "customer_street": "string",
- "customer_unit": "string",
- "customer_zip": "string"
}, - "customer_contact": [
- "string"
], - "customer_description": "string",
- "customer_icon": "string",
- "customer_key": "string",
- "customer_name": "string",
- "customer_sites": [
- "string"
], - "customer_type": "string",
- "organization_id": "string"
}
Response samples
- 200
- 400
- 500
{- "message": "string",
- "response": null,
- "response_code": 0
}
Customer Delete
Customer Delete API.
Sample INPUT
{
"customer_id": "string"
}
Sample OUTPUT
{
"message": "Customer deleted",
"response": null,
"response_code": 200
}
Authorizations:
Request Body schema: application/json
Customer Delete Payload
customer_id required | string |
Responses
Request samples
- Payload
{- "customer_id": "string"
}
Response samples
- 200
- 400
- 500
{- "message": "string",
- "response": null,
- "response_code": 0
}
Customer ID
Customer ID API.
Sample INPUT
// Query params
{
"customer_id": "string"
}
Sample OUTPUT
{
"message": "Customer Id",
"response": {
"customer_address": {
"customer_area": "string",
"customer_city": "string",
"customer_country": "string",
"customer_state": "string",
"customer_street": "string",
"customer_unit": "string",
"customer_zip": "string"
},
"customer_contact": [
"string"
],
"customer_description": "string",
"customer_icon": "string",
"customer_id": "string",
"customer_key": "string",
"customer_name": "string",
"customer_sites": [
"string"
],
"customer_type": "string",
"organization_id": "string"
},
"response_code": 200
}
Authorizations:
query Parameters
customer_id required | string Customer ID |
Responses
Response samples
- 200
- 400
- 500
{- "message": "string",
- "response": {
- "customer_address": {
- "customer_area": "string",
- "customer_city": "string",
- "customer_country": "string",
- "customer_state": "string",
- "customer_street": "string",
- "customer_unit": "string",
- "customer_zip": "string"
}, - "customer_contact": [
- "string"
], - "customer_description": "string",
- "customer_icon": "string",
- "customer_id": "string",
- "customer_key": "string",
- "customer_name": "string",
- "customer_sites": [
- "string"
], - "customer_type": "string",
- "organization_id": "string"
}, - "response_code": 0
}
Customer List
Customer List API.
Sample INPUT
// Query params
{
"organization_id": "string",
"is_default": "string"
}
Sample OUTPUT
{
"message": "Customer List",
"response": [
{
"customer_address": {
"customer_area": "string",
"customer_city": "string",
"customer_country": "string",
"customer_state": "string",
"customer_street": "string",
"customer_unit": "string",
"customer_zip": "string"
},
"customer_contact": [
"string"
],
"customer_description": "string",
"customer_icon": "string",
"customer_id": "string",
"customer_key": "string",
"customer_name": "string",
"customer_sites": [
"string"
],
"customer_type": "string",
"organization_id": "string"
}
],
"response_code": 200
}
Authorizations:
query Parameters
organization_id required | string Organization ID |
is_default | string Includes Default Customer |
Responses
Response samples
- 200
- 400
- 500
{- "message": "string",
- "response": [
- {
- "customer_address": {
- "customer_area": "string",
- "customer_city": "string",
- "customer_country": "string",
- "customer_state": "string",
- "customer_street": "string",
- "customer_unit": "string",
- "customer_zip": "string"
}, - "customer_contact": [
- "string"
], - "customer_description": "string",
- "customer_icon": "string",
- "customer_id": "string",
- "customer_key": "string",
- "customer_name": "string",
- "customer_sites": [
- "string"
], - "customer_type": "string",
- "organization_id": "string"
}
], - "response_code": 0
}
Customer Site Assign
Customer Site Assign API.
Sample INPUT
{
"customer_id": "string",
"site_ids": [
"string"
]
}
Sample OUTPUT
{
"message": "Assigned site(s) to customer",
"response": null,
"response_code": 200
}
Authorizations:
Request Body schema: application/json
Customer Site Assign Payload
customer_id required | string |
site_ids required | Array of strings |
Responses
Request samples
- Payload
{- "customer_id": "string",
- "site_ids": [
- "string"
]
}
Response samples
- 200
- 400
- 500
{- "message": "string",
- "response": null,
- "response_code": 0
}
Customer Site Unassign
Customer Site Unassign API.
Sample INPUT
{
"customer_id": "string",
"site_ids": [
"string"
]
}
Sample OUTPUT
{
"message": "Unassigned site(s) to customer",
"response": null,
"response_code": 200
}
Authorizations:
Request Body schema: application/json
Customer Site Assign Payload
customer_id required | string |
site_ids required | Array of strings |
Responses
Request samples
- Payload
{- "customer_id": "string",
- "site_ids": [
- "string"
]
}
Response samples
- 200
- 400
- 500
{- "message": "string",
- "response": null,
- "response_code": 0
}
Customer Assign
Customer Site Unassign API.
Sample INPUT
{
"customer_id": "string",
"site_ids": [
"string"
]
}
Sample OUTPUT
{
"message": "Unassigned site(s) to customer",
"response": null,
"response_code": 200
}
Authorizations:
Request Body schema: application/json
Customer UnAssign Payload
customer_id required | Array of strings |
user_id required | string |
Responses
Request samples
- Payload
{- "customer_id": [
- "string"
], - "user_id": "string"
}
Response samples
- 200
- 400
- 500
{- "message": "string",
- "response": null,
- "response_code": 0
}
Customer Update
Customer Update API.
Sample INPUT
{
"customer_address": {
"customer_area": "string",
"customer_city": "string",
"customer_country": "string",
"customer_state": "string",
"customer_street": "string",
"customer_unit": "string",
"customer_zip": "string"
},
"customer_contact": [
"string"
],
"customer_description": "string",
"customer_icon": "string",
"customer_id": "string",
"customer_key": "string",
"customer_name": "string",
"customer_sites": [
"string"
],
"customer_type": "string",
"organization_id": "string"
}
Sample OUTPUT
{
"message": "Customer updated",
"response": null,
"response_code": 200
}
Authorizations:
Request Body schema: application/json
Customer Update Payload
required | object (customer.customerAddress) |
customer_contact | Array of strings |
customer_description required | string |
customer_icon required | string |
customer_id required | string |
customer_key required | string |
customer_name required | string |
customer_sites | Array of strings |
customer_type | string |
organization_id required | string |
Responses
Request samples
- Payload
{- "customer_address": {
- "customer_area": "string",
- "customer_city": "string",
- "customer_country": "string",
- "customer_state": "string",
- "customer_street": "string",
- "customer_unit": "string",
- "customer_zip": "string"
}, - "customer_contact": [
- "string"
], - "customer_description": "string",
- "customer_icon": "string",
- "customer_id": "string",
- "customer_key": "string",
- "customer_name": "string",
- "customer_sites": [
- "string"
], - "customer_type": "string",
- "organization_id": "string"
}
Response samples
- 200
- 400
- 500
{- "message": "string",
- "response": null,
- "response_code": 0
}
Customer View
Customer View API
Sample INPUT
// Query params
{
"customer_id": "string",
"type": 1
}
Sample OUTPUT Type 1
{
"message": "Customer site map",
"response": [
{
"site_address": {
"site_area": "string",
"site_city": "string",
"site_country": "string",
"site_geolocation": {
"lat": 0,
"long": 0
},
"site_state": "string",
"site_street": "string",
"site_unit": "string",
"site_zip": "string"
},
"site_description": "string",
"site_devices": [
{
"device_id": "string",
"device_identifier": "string",
"device_name": "string",
"device_source": [
{
"source_address": "string",
"source_fps": 0,
"source_id": "string",
"source_name": "string",
"source_sid": 0,
"source_type": "string"
}
],
"device_state": true,
"device_status": "string",
"device_tags": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"device_type": "string",
"device_uuid": "string",
"device_value": "string",
"source_channels": [
{
"channel_favorite": true,
"channel_id": "string",
"channel_key": "string",
"channel_name": "string",
"channel_sid": "string",
"channel_threshold_duration": 0,
"device_id": "string",
"is_active": true,
"is_storage": true,
"is_verified": true,
"nimble_id": "string",
"pipeline_id": "string",
"source_id": "string",
"usecase_icon": "string",
"usecase_id": "string",
"usecase_key": "string",
"usecase_meta_key": [
"string"
],
"usecase_name": "string"
}
]
}
],
"site_icon": "string",
"site_id": "string",
"site_image": "string",
"site_key": "string",
"site_name": "string",
"site_type": "string"
}
],
"response_code": 200
}
Sample OUTPUT Type 2
{
"message": "Customer site map",
"response": [
{
"usecase_background_color": "string",
"usecase_channels": [
{
"channel_favorite": true,
"channel_id": "string",
"channel_key": "string",
"channel_name": "string",
"channel_sid": "string",
"channel_threshold_duration": 0,
"device_id": "string",
"is_active": true,
"is_storage": true,
"is_verified": true,
"nimble_id": "string",
"pipeline_id": "string",
"site_id": "string",
"source_id": "string",
"usecase_icon": "string",
"usecase_id": "string",
"usecase_key": "string",
"usecase_meta_key": [
"string"
],
"usecase_name": "string"
}
],
"usecase_component_key": "string",
"usecase_desc": "string",
"usecase_icon": "string",
"usecase_id": "string",
"usecase_key": "string",
"usecase_meta_key": [
"string"
],
"usecase_name": "string"
}
],
"response_code": 200
}
Authorizations:
query Parameters
customer_id required | string Customer ID |
type required | integer type |
Responses
Response samples
- 200
- 202
- 400
- 500
{- "message": "string",
- "response": [
- {
- "site_address": {
- "site_area": "string",
- "site_city": "string",
- "site_country": "string",
- "site_geolocation": {
- "lat": 0,
- "long": 0
}, - "site_state": "string",
- "site_street": "string",
- "site_unit": "string",
- "site_zip": "string"
}, - "site_description": "string",
- "site_devices": [
- {
- "device_id": "string",
- "device_identifier": "string",
- "device_name": "string",
- "device_source": [
- {
- "source_address": "string",
- "source_fps": 0,
- "source_id": "string",
- "source_name": "string",
- "source_sid": 0,
- "source_type": "string"
}
], - "device_state": true,
- "device_status": "string",
- "device_tags": {
- "property1": "string",
- "property2": "string"
}, - "device_type": "string",
- "device_uuid": "string",
- "device_value": "string",
- "source_channels": [
- {
- "channel_favorite": true,
- "channel_id": "string",
- "channel_key": "string",
- "channel_name": "string",
- "channel_sid": "string",
- "channel_threshold_duration": 0,
- "device_id": "string",
- "is_active": true,
- "is_auto_recovery": true,
- "is_storage": true,
- "is_verified": true,
- "nimble_id": "string",
- "pipeline_id": "string",
- "site_id": "string",
- "source_id": "string",
- "usecase_icon": "string",
- "usecase_id": "string",
- "usecase_key": "string",
- "usecase_meta_key": [
- "string"
], - "usecase_name": "string"
}
]
}
], - "site_icon": "string",
- "site_id": "string",
- "site_image": "string",
- "site_key": "string",
- "site_name": "string",
- "site_type": "string"
}
], - "response_code": 0
}
Device Create
Device Create API
Sample INPUT
{
"device_identifier": "string",
"device_name": "string",
"device_streams": [
{
"address": "string",
"fps": {
"input": 0
},
"id": 0,
"password": "string",
"port": 0,
"protocol": "string",
"resolution": {
"height": 0,
"width": 0
},
"type": "string",
"username": "string",
"uuid": "string"
}
],
"device_tags": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"device_type": "string",
"device_uuid": "string",
"site_id": "string"
}
Sample OUTPUT
{
"message": "Device created",
"response": {
"device_id": "string"
},
"response_code": 201
}
Authorizations:
Request Body schema: application/json
Device Create Payload
device_identifier required | string |
device_name required | string |
Array of objects (device.deviceStream) | |
required | object |
device_type required | string |
device_uuid | string |
nimble_id required | string |
site_id required | string |
Responses
Request samples
- Payload
{- "device_identifier": "string",
- "device_name": "string",
- "device_streams": [
- {
- "address": "string",
- "fps": {
- "input": 0,
- "output": 0
}, - "id": 0,
- "password": "string",
- "port": 0,
- "protocol": "string",
- "resolution": {
- "height": 0,
- "width": 0
}, - "type": "string",
- "username": "string",
- "uuid": "string"
}
], - "device_tags": {
- "property1": "string",
- "property2": "string"
}, - "device_type": "string",
- "device_uuid": "string",
- "nimble_id": "string",
- "site_id": "string"
}
Response samples
- 200
- 400
- 500
{- "message": "string",
- "response": {
- "device_id": "string"
}, - "response_code": 0
}
Device Delete
Device Delete API
Sample INPUT
{
"device_id": "string"
}
Sample OUTPUT
{
"message": "Device deleted",
"response": null,
"response_code": 200
}
Authorizations:
Request Body schema: application/json
Device Delete Payload
device_id required | string |
Responses
Request samples
- Payload
{- "device_id": "string"
}
Response samples
- 200
- 400
- 500
{- "message": "string",
- "response": null,
- "response_code": 0
}
Device ID
Device ID API
Sample INPUT
// Query params
{
"device_id": "string"
}
Sample OUTPUT
{
"message": "Device ID",
"response": {
"device_id": "string",
"device_identifier": "string",
"device_name": "string",
"device_source": [
{
"source_address": "string",
"source_channels": [
{
"channel_favorite": true,
"channel_id": "string",
"channel_key": "string",
"channel_name": "string",
"channel_sid": "string",
"channel_threshold_duration": 0,
"is_active": true,
"is_storage": true,
"is_verified": true,
"nimble_id": "string",
"pipeline_id": "string",
"source_id": "string",
"usecase_icon": "string",
"usecase_id": "string",
"usecase_key": "string",
"usecase_meta_key": [
"string"
],
"usecase_name": "string"
}
],
"source_fps": 0,
"source_id": "string",
"source_name": "string",
"source_sid": 0,
"source_type": "string"
}
],
"device_state": true,
"device_status": "string",
"device_streams": [
{
"address": "string",
"fps": {
"input": 0
},
"id": 0,
"password": "string",
"port": 0,
"protocol": "string",
"resolution": {
"height": 0,
"width": 0
},
"type": "string",
"username": "string",
"uuid": "string"
}
],
"device_tags": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"device_type": "string",
"device_uuid": "string",
"device_value": "string",
"site_id": "string",
"source_channels": [
{
"channel_favorite": true,
"channel_id": "string",
"channel_key": "string",
"channel_name": "string",
"channel_sid": "string",
"channel_threshold_duration": 0,
"is_active": true,
"is_storage": true,
"is_verified": true,
"nimble_id": "string",
"pipeline_id": "string",
"source_id": "string",
"usecase_icon": "string",
"usecase_id": "string",
"usecase_key": "string",
"usecase_meta_key": [
"string"
],
"usecase_name": "string"
}
]
},
"response_code": 200
}
Authorizations:
query Parameters
device_id required | string Device ID |
Responses
Response samples
- 200
- 400
- 500
{- "message": "string",
- "response": {
- "device_id": "string",
- "device_identifier": "string",
- "device_name": "string",
- "device_source": [
- {
- "source_address": "string",
- "source_channels": [
- {
- "channel_favorite": true,
- "channel_id": "string",
- "channel_key": "string",
- "channel_name": "string",
- "channel_sid": "string",
- "channel_threshold_duration": 0,
- "device_id": "string",
- "is_active": true,
- "is_auto_recovery": true,
- "is_storage": true,
- "is_verified": true,
- "nimble_id": "string",
- "pipeline_id": "string",
- "source_id": "string",
- "usecase_icon": "string",
- "usecase_id": "string",
- "usecase_key": "string",
- "usecase_meta_key": [
- "string"
], - "usecase_name": "string"
}
], - "source_fps": 0,
- "source_id": "string",
- "source_name": "string",
- "source_sid": 0,
- "source_type": "string"
}
], - "device_state": true,
- "device_status": "string",
- "device_streams": [
- {
- "address": "string",
- "fps": {
- "input": 0,
- "output": 0
}, - "id": 0,
- "password": "string",
- "port": 0,
- "protocol": "string",
- "resolution": {
- "height": 0,
- "width": 0
}, - "type": "string",
- "username": "string",
- "uuid": "string"
}
], - "device_tags": {
- "property1": "string",
- "property2": "string"
}, - "device_type": "string",
- "device_uuid": "string",
- "device_value": "string",
- "nimble_id": "string",
- "site_id": "string",
- "source_channels": [
- {
- "channel_favorite": true,
- "channel_id": "string",
- "channel_key": "string",
- "channel_name": "string",
- "channel_sid": "string",
- "channel_threshold_duration": 0,
- "device_id": "string",
- "is_active": true,
- "is_auto_recovery": true,
- "is_storage": true,
- "is_verified": true,
- "nimble_id": "string",
- "pipeline_id": "string",
- "source_id": "string",
- "usecase_icon": "string",
- "usecase_id": "string",
- "usecase_key": "string",
- "usecase_meta_key": [
- "string"
], - "usecase_name": "string"
}
], - "transaction_id": "string"
}, - "response_code": 0
}
Device List
Device List API
Sample INPUT
// Query params
{
"site_id": "string"
}
Sample OUTPUT
{
"message": "Device List",
"response": [
{
"device_id": "string",
"device_identifier": "string",
"device_name": "string",
"device_source": [
{
"source_address": "string",
"source_channels": [
{
"channel_favorite": true,
"channel_id": "string",
"channel_key": "string",
"channel_name": "string",
"channel_sid": "string",
"channel_threshold_duration": 0,
"is_active": true,
"is_storage": true,
"is_verified": true,
"nimble_id": "string",
"pipeline_id": "string",
"source_id": "string",
"usecase_icon": "string",
"usecase_id": "string",
"usecase_key": "string",
"usecase_meta_key": [
"string"
],
"usecase_name": "string"
}
],
"source_fps": 0,
"source_id": "string",
"source_name": "string",
"source_sid": 0,
"source_type": "string"
}
],
"device_state": true,
"device_status": "string",
"device_streams": [
{
"address": "string",
"fps": {
"input": 0
},
"id": 0,
"password": "string",
"port": 0,
"protocol": "string",
"resolution": {
"height": 0,
"width": 0
},
"type": "string",
"username": "string",
"uuid": "string"
}
],
"device_tags": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"device_type": "string",
"device_uuid": "string",
"device_value": "string",
"site_id": "string",
"source_channels": [
{
"channel_favorite": true,
"channel_id": "string",
"channel_key": "string",
"channel_name": "string",
"channel_sid": "string",
"channel_threshold_duration": 0,
"is_active": true,
"is_storage": true,
"is_verified": true,
"nimble_id": "string",
"pipeline_id": "string",
"source_id": "string",
"usecase_icon": "string",
"usecase_id": "string",
"usecase_key": "string",
"usecase_meta_key": [
"string"
],
"usecase_name": "string"
}
]
}
],
"response_code": 200
}
Authorizations:
query Parameters
site_id required | string Site ID |
Responses
Response samples
- 200
- 400
- 500
{- "message": "string",
- "response": [
- {
- "device_id": "string",
- "device_identifier": "string",
- "device_name": "string",
- "device_source": [
- {
- "source_address": "string",
- "source_channels": [
- {
- "channel_favorite": true,
- "channel_id": "string",
- "channel_key": "string",
- "channel_name": "string",
- "channel_sid": "string",
- "channel_threshold_duration": 0,
- "device_id": "string",
- "is_active": true,
- "is_auto_recovery": true,
- "is_storage": true,
- "is_verified": true,
- "nimble_id": "string",
- "pipeline_id": "string",
- "source_id": "string",
- "usecase_icon": "string",
- "usecase_id": "string",
- "usecase_key": "string",
- "usecase_meta_key": [
- "string"
], - "usecase_name": "string"
}
], - "source_fps": 0,
- "source_id": "string",
- "source_name": "string",
- "source_sid": 0,
- "source_type": "string"
}
], - "device_state": true,
- "device_status": "string",
- "device_streams": [
- {
- "address": "string",
- "fps": {
- "input": 0,
- "output": 0
}, - "id": 0,
- "password": "string",
- "port": 0,
- "protocol": "string",
- "resolution": {
- "height": 0,
- "width": 0
}, - "type": "string",
- "username": "string",
- "uuid": "string"
}
], - "device_tags": {
- "property1": "string",
- "property2": "string"
}, - "device_type": "string",
- "device_uuid": "string",
- "device_value": "string",
- "nimble_id": "string",
- "site_id": "string",
- "source_channels": [
- {
- "channel_favorite": true,
- "channel_id": "string",
- "channel_key": "string",
- "channel_name": "string",
- "channel_sid": "string",
- "channel_threshold_duration": 0,
- "device_id": "string",
- "is_active": true,
- "is_auto_recovery": true,
- "is_storage": true,
- "is_verified": true,
- "nimble_id": "string",
- "pipeline_id": "string",
- "source_id": "string",
- "usecase_icon": "string",
- "usecase_id": "string",
- "usecase_key": "string",
- "usecase_meta_key": [
- "string"
], - "usecase_name": "string"
}
], - "transaction_id": "string"
}
], - "response_code": 0
}
Device Update
Device Update API
Sample INPUT
{
"device_id": "string",
"device_identifier": "string",
"device_name": "string",
"device_source": [
{
"source_address": "string",
"source_channels": [
{
"channel_favorite": true,
"channel_id": "string",
"channel_key": "string",
"channel_name": "string",
"channel_sid": "string",
"channel_threshold_duration": 0,
"is_active": true,
"is_storage": true,
"is_verified": true,
"nimble_id": "string",
"pipeline_id": "string",
"source_id": "string",
"usecase_icon": "string",
"usecase_id": "string",
"usecase_key": "string",
"usecase_meta_key": [
"string"
],
"usecase_name": "string"
}
],
"source_fps": 0,
"source_id": "string",
"source_name": "string",
"source_sid": 0,
"source_type": "string"
}
],
"device_state": true,
"device_status": "string",
"device_streams": [
{
"address": "string",
"fps": {
"input": 0
},
"id": 0,
"password": "string",
"port": 0,
"protocol": "string",
"resolution": {
"height": 0,
"width": 0
},
"type": "string",
"username": "string",
"uuid": "string"
}
],
"device_tags": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"device_type": "string",
"device_uuid": "string",
"device_value": "string",
"site_id": "string",
"source_channels": [
{
"channel_favorite": true,
"channel_id": "string",
"channel_key": "string",
"channel_name": "string",
"channel_sid": "string",
"channel_threshold_duration": 0,
"is_active": true,
"is_storage": true,
"is_verified": true,
"nimble_id": "string",
"pipeline_id": "string",
"source_id": "string",
"usecase_icon": "string",
"usecase_id": "string",
"usecase_key": "string",
"usecase_meta_key": [
"string"
],
"usecase_name": "string"
}
]
}
Sample OUTPUT
{
"message": "Device Updated",
"response": null,
"response_code": 200
}
Authorizations:
Request Body schema: application/json
Device Update Payload
device_id required | string |
device_identifier required | string |
device_name required | string |
Array of objects (device.deviceStream) | |
required | object |
device_type required | string |
device_uuid | string |
nimble_id required | string |
site_id required | string |
Responses
Request samples
- Payload
{- "device_id": "string",
- "device_identifier": "string",
- "device_name": "string",
- "device_streams": [
- {
- "address": "string",
- "fps": {
- "input": 0,
- "output": 0
}, - "id": 0,
- "password": "string",
- "port": 0,
- "protocol": "string",
- "resolution": {
- "height": 0,
- "width": 0
}, - "type": "string",
- "username": "string",
- "uuid": "string"
}
], - "device_tags": {
- "property1": "string",
- "property2": "string"
}, - "device_type": "string",
- "device_uuid": "string",
- "nimble_id": "string",
- "site_id": "string"
}
Response samples
- 200
- 400
- 500
{- "message": "string",
- "response": null,
- "response_code": 0
}
Device List
Device View API
Sample INPUT
// Query params
{
"device_id": "string"
}
Sample OUTPUT
{
"message": "Device view",
"response": {
"site_id": "string",
"device_uuid": "string",
"device_name": "string",
"device_type": "string",
"device_identifier": "string",
"device_tags": {
"tag": "string",
"device_streams": [
{
"id": "string",
"uuid": "string",
"fps": {
"input": "string"
},
"type": "string",
"protocol": "string",
"address": "string",
"port": "string",
"username": "string",
"password": "string",
"resolution": {
"width": 0,
"height": 0
}
}
]
}
},
"response_code": 200
}
Authorizations:
query Parameters
device_id required | string Device ID |
Responses
Response samples
- 200
- 400
- 500
{- "message": "string",
- "response": {
- "device_id": "string",
- "device_identifier": "string",
- "device_name": "string",
- "device_source": [
- {
- "source_address": "string",
- "source_channels": [
- {
- "channel_favorite": true,
- "channel_id": "string",
- "channel_key": "string",
- "channel_name": "string",
- "channel_sid": "string",
- "channel_threshold_duration": 0,
- "device_id": "string",
- "is_active": true,
- "is_auto_recovery": true,
- "is_storage": true,
- "is_verified": true,
- "nimble_id": "string",
- "pipeline_id": "string",
- "source_id": "string",
- "usecase_icon": "string",
- "usecase_id": "string",
- "usecase_key": "string",
- "usecase_meta_key": [
- "string"
], - "usecase_name": "string"
}
], - "source_fps": 0,
- "source_id": "string",
- "source_name": "string",
- "source_sid": 0,
- "source_type": "string"
}
], - "device_state": true,
- "device_status": "string",
- "device_streams": [
- {
- "address": "string",
- "fps": {
- "input": 0,
- "output": 0
}, - "id": 0,
- "password": "string",
- "port": 0,
- "protocol": "string",
- "resolution": {
- "height": 0,
- "width": 0
}, - "type": "string",
- "username": "string",
- "uuid": "string"
}
], - "device_tags": {
- "property1": "string",
- "property2": "string"
}, - "device_type": "string",
- "device_uuid": "string",
- "device_value": "string",
- "nimble_id": "string",
- "site_id": "string",
- "source_channels": [
- {
- "channel_favorite": true,
- "channel_id": "string",
- "channel_key": "string",
- "channel_name": "string",
- "channel_sid": "string",
- "channel_threshold_duration": 0,
- "device_id": "string",
- "is_active": true,
- "is_auto_recovery": true,
- "is_storage": true,
- "is_verified": true,
- "nimble_id": "string",
- "pipeline_id": "string",
- "source_id": "string",
- "usecase_icon": "string",
- "usecase_id": "string",
- "usecase_key": "string",
- "usecase_meta_key": [
- "string"
], - "usecase_name": "string"
}
], - "transaction_id": "string",
- "device_sources": [
- {
- "source_address": "string",
- "source_channels": [
- {
- "channel_favorite": true,
- "channel_id": "string",
- "channel_key": "string",
- "channel_name": "string",
- "channel_sid": "string",
- "channel_threshold_duration": 0,
- "device_id": "string",
- "is_active": true,
- "is_auto_recovery": true,
- "is_storage": true,
- "is_verified": true,
- "nimble_id": "string",
- "pipeline_id": "string",
- "source_id": "string",
- "usecase_icon": "string",
- "usecase_id": "string",
- "usecase_key": "string",
- "usecase_meta_key": [
- "string"
], - "usecase_name": "string"
}
], - "source_fps": 0,
- "source_id": "string",
- "source_name": "string",
- "source_sid": 0,
- "source_type": "string"
}
]
}, - "response_code": 0
}
Static Content Create
Static Create API
Sample INPUT
{
"device_id": "string",
"id": 0,
"static_content_data": {
"additionalProp1": {}
},
"static_content_name": "string",
"static_content_type": "string"
}
Sample OUTPUT
{
"message": "Zone created",
"response": null,
"response_code": 201
}
Authorizations:
Request Body schema: application/json
Static Content Payload
id required | integer |
source_id required | string |
required | object |
static_content_name required | string |
static_content_type required | string |
Responses
Request samples
- Payload
{- "id": 0,
- "source_id": "string",
- "static_content_data": { },
- "static_content_name": "string",
- "static_content_type": "string"
}
Response samples
- 200
- 400
- 500
{- "message": "string",
- "response": null,
- "response_code": 0
}