{"info":{"title":"/IOTCONNECT™ Event API","description":"Event REST API contains information of Event modules.","version":"2.1"},"paths":{"/api/v2.1/Event/subscription/subscribe":{"post":{"tags":["Event"],"summary":"Subscribe to an event","description":"

Events play a crucial role in supervising users and devices (onshore or offshore) 24X7. These events can range from technical occurrences like creating a device, acquiring a device to changing an attribute by a user in a specific template. To notify users about any such events, a user needs to subscribe.

\n

Subscribe for events using this API endpoint.

\n

1.eventGuid 2.eventName 3.using both Let’s suppose, when the user employs both request parameters and out of it eventGuid is not correct.Even in that scene, eventGuid will be given priority and get validation. Here, deliveryMethod defines how you would like to notify a user, either by email, SMS, or push. If you provide role guid in roleGuid parameter, it will notify the users of that role. You can also give a list of user’s guid to notify users contained in a list.

","responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that the event subscribed successfully.","schema":{"$ref":"#/definitions/EventSubscriptionCreateResponse"}},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\nEvent not found, delivery method not found, delivery method not active, event subscription already exists, severity level not exists \nand invalid logged user or company."}},"parameters":[{"name":"request","in":"body","description":"Json object. eventGuid is required","schema":{"$ref":"#/definitions/EventSubscriptionCreateRequest"}}]}},"/api/v2.1/Event/subscription/{subscriptionGuid}":{"put":{"tags":["Event"],"summary":"Update event subscription details","description":"

This API endpoint allows you to update event subscription details. For that, you need to send subscriptionGuid in request url and updated event subscription details in the request body.

","parameters":[{"name":"subscriptionGuid","in":"path","description":"Event Subscription Guid","required":true,"type":"string","format":"uuid"},{"name":"request","in":"body","description":"Json object","schema":{"$ref":"#/definitions/EventSubscriptionUpdateRequest"}}],"responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that the event subscription updated successfully.","schema":{"$ref":"#/definitions/EventSubscriptionUpdateResponse"}},"204":{"description":"Indicates that RefData is null or RoleGuids or UserGuids not found in RefData.","schema":{"$ref":"#/definitions/NoContentResult"}},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\nDelivery method not found, delivery method not active, event subscription not exists, severity level not exists \nand invalid logged user or company."}}},"get":{"tags":["Event"],"summary":"Get details of single subscription","description":"

This API endpoint gives you a detailed description of the subscribed event subscription. For that, you need to send subscriptionGuid in request url.

","parameters":[{"name":"subscriptionGuid","in":"path","description":"Event Subscription Guid","required":true,"type":"string","format":"uuid"}],"responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that the event subscription received successfully.","schema":{"$ref":"#/definitions/EventSubscriptionDetailResponse"}},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\nEvent subscription not found and invalid logged user or company."}}}},"/api/v2.1/Event/subscription/{subscriptionGuid}/un-subscribe":{"delete":{"tags":["Event"],"summary":"Delete event subscription","description":"

This API endpoint allows you to unsubscribe an event subscription. For that, you need to send event subscriptionGuid in request url.

","parameters":[{"name":"subscriptionGuid","in":"path","description":"Event Subscription Guid","required":true,"type":"string","format":"uuid"}],"responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that the event unsubscribed successfully.","schema":{"$ref":"#/definitions/EventUnsubscribeResponse"}},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\nEvent subscription not found, Event subscription can not be Unsubscribed for auto subscribed event \nand invalid logged user or company."}}}},"/api/v2.1/Event/subscription":{"get":{"tags":["Event"],"summary":"Get subscribed event list","description":"

This API endpoint provides you the list of subscribed events for your company.

\n

You can also add the filters as given in the parameters. Though the filters are optional, to apply them, you need to send these filter parameters in a query string. The eventGuid parameter is used to get the list of subscriptions for the given event guid.

","parameters":[{"name":"searchText","in":"query","description":"To search for specific texts in the list.","type":"string"},{"name":"sortBy","in":"query","description":"Sort By, Eg. name asc, name desc, name etc.","type":"string"},{"name":"eventguid","in":"query","description":"Get by eventGuid","type":"string"},{"name":"pageNumber","in":"query","description":"To fetch specific page data. Eg: 2","type":"integer","format":"int32"},{"name":"pageSize","in":"query","description":"To define number of records in single page. Eg: 25","type":"integer","format":"int32"}],"responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that the event subscription list received successfully.","schema":{"$ref":"#/definitions/EventSubscribedListResponse"}},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\ninvalid logged user or company."}}}},"/api/v2.1/event-topics":{"get":{"tags":["Event"],"summary":"Get event topic list","description":"

This API endpoint gives you the list of available event topics. These event topics bifurcate the event subscriptions in different groups like Device, User, Firmware, Telemetry.

\n

You can also add the filters as given in the parameters. Though the filters are optional, to apply them, you need to send these filter parameters in a query string.

","parameters":[{"name":"searchText","in":"query","description":"To search for specific texts in the list.","type":"string"},{"name":"sortBy","in":"query","description":"Sort By, Eg. name asc, name desc, name etc.","type":"string"},{"name":"pageNumber","in":"query","description":"To fetch specific page data. Eg: 2","type":"integer","format":"int32"},{"name":"pageSize","in":"query","description":"To define number of records in single page. Eg: 25","type":"integer","format":"int32"}],"responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that the event topic list received successfully.","schema":{"$ref":"#/definitions/TopicListResponse"}},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\ninvalid logged user or company."}}}},"/api/v2.1/Event":{"get":{"tags":["Event"],"summary":"Get predefined event list","description":"

This API endpoint provides you the list of predefined event subscriptions. Using these details, company users can subscribe to these events later.

\n

You can also add the filters as given in the parameters. Though the filters are optional, to apply them, you need to send these filter parameters in a query string. eventTopicGuid parameter is used to get the list of event subscriptions for a given event topic group.

","parameters":[{"name":"eventTopicGuid","in":"query","description":"Get by event topic guid","type":"string"}],"responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that the predefined event topic list received successfully.","schema":{"$ref":"#/definitions/EventListResponse"}},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\nEvent topic guid not exists and invalid logged user or company."}}}},"/api/v2.1/Event/{eventid}":{"get":{"tags":["Event"],"summary":"Get single predefined event detail","description":"

This API endpoint gives you a detailed description of the predefined event subscription. For that, you need to send eventId in request url.

","parameters":[{"name":"eventid","in":"path","description":"Event Id","required":true,"type":"integer","format":"int32"}],"responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that the predefined event detail received successfully.","schema":{"$ref":"#/definitions/EventByIdResponse"}},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\nEvent not found and invalid logged user or company."}}}},"/api/v2.1/severity-level/lookup":{"get":{"tags":["Event"],"summary":"Get severity level lookup list","description":"

Users can define severity levels from critical, major, minor, information, or warning based on the need for their use case. This API endpoint helps you to get the lookup list of severity levels.

","responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that the severity level lookup list received successfully.","schema":{"$ref":"#/definitions/EventLookupResponse"}},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\nEvent not found and invalid logged user or company."}}}},"/api/v2.1/Event/{eventId}/delivery-method":{"get":{"tags":["Event"],"summary":"Get delivery method list","description":"

This API endpoint gives you the list of delivery methods for the event. For that, you need to send the event’s eventId in request url.

","parameters":[{"name":"eventId","in":"path","description":"Event Id","required":true,"type":"string"}],"responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that the event's delivery method detail received successfully.","schema":{"$ref":"#/definitions/EventDeliveryMethodDetailResponse"}},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\nEvent not found and invalid logged user or company."}}}},"/api/v2.1/Event/notification":{"get":{"tags":["Event"],"summary":"Get notification list","description":"

This API endpoint provides you the notification sent list for subscribed events.

\n

You can also add the filters as given in the parameters. Though the filters are optional, to apply them, you need to send these filter parameters in a query string.

","parameters":[{"name":"userGuid","in":"query","description":"User Guid to filter","type":"string"},{"name":"pageNumber","in":"query","description":"To fetch specific page data. Eg: 2","type":"integer","format":"int32"},{"name":"pageSize","in":"query","description":"To define number of records in single page. Eg: 25","type":"integer","format":"int32"},{"name":"sortBy","in":"query","description":"Sort By, Eg. eventName asc, eventName desc, eventName etc.","type":"string"},{"name":"searchText","in":"query","description":"To search for specific texts in the list.","type":"string"},{"name":"startDate","in":"query","description":"Start Date to filter","type":"string","format":"date-time"},{"name":"endDate","in":"query","description":"End Date to filter","type":"string","format":"date-time"},{"name":"continuationToken","in":"header","description":"To get next data from cosmos","type":"string"},{"name":"viewArchive","in":"query","description":"to view archive data from cosmos","type":"boolean"}],"responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that the event notification list received successfully.","schema":{"$ref":"#/definitions/EventNotificationListResponse"}},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\nInvalid user guid and invalid logged user or company."}}}},"/api/v2.1/event-template":{"post":{"tags":["Event"],"summary":"Add event template","description":"

To notify users, one needs predefined notification templates for email, SMS, or push.

\n

This API endpoint allows you to create event notification templates.

\n

Here, eventID is a unique event id. The deliveryMethod defines how you would like to notify a user, either by email, SMS, or push.

","responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that the event template created successfully.","schema":{"$ref":"#/definitions/EventTemplateCreateResponse"}},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\nEvent not found, event is not subscribed, delivery method not active, delivery method not found, event template already exists \ndelivery method not subscribed and invalid logged user or company."}},"parameters":[{"name":"request","in":"body","description":"Json object","schema":{"$ref":"#/definitions/EventTemplateCreateRequest"}}]}},"/api/v2.1/event-template/{eventTemplateGuid}":{"put":{"tags":["Event"],"summary":"Update event template","description":"

This API endpoint allows you to update event notification template details. For that, you need to send eventTemplateGuid in request url and updated event template details in the request body.

","parameters":[{"name":"eventTemplateGuid","in":"path","description":"Update Event Template","required":true,"type":"string","format":"uuid"},{"name":"request","in":"body","description":"Json object","schema":{"$ref":"#/definitions/EventTemplateUpdateRequest"}}],"responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that the event template updated successfully.","schema":{"$ref":"#/definitions/EventTemplateUpdateResponse"}},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\nEvent template not exists and invalid logged user or company."}}},"delete":{"tags":["Event"],"summary":"Delete event template","description":"

This API endpoint allows you to delete the event notification template. For that, you need to send eventTemplateGuid in request url.

","parameters":[{"name":"eventTemplateGuid","in":"path","description":"Event Template Guid","required":true,"type":"string","format":"uuid"}],"responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that the event template deleted successfully.","schema":{"$ref":"#/definitions/EventTemplateResetResponse"}},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\nEvent template not exists, default event template can not be deleted and invalid logged user or company."}}}},"/api/v2.1/event-template/{eventId}/{deliveryMethod}":{"get":{"tags":["Event"],"summary":"Get event template by eventId and delivery Method","description":"

This API endpoint gives you the event notification template details. For that, you need to send the eventId and delivery method in request url.

","parameters":[{"name":"eventId","in":"path","description":"Event Id","required":true,"type":"integer","format":"int32"},{"name":"deliveryMethod","in":"path","description":"Delivery Method. Eg: sms, Email etc","required":true,"type":"string"}],"responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that the event template detail received successfully.","schema":{"$ref":"#/definitions/EventTemplateDetailResponse"}},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\ndelivery method not active and invalid logged user or company."}}}},"/api/v2.1/deliverymethod":{"get":{"tags":["Event"],"summary":"Get delivery methods","description":"

This API endpoint provides you the delivery methods for the given delivery method bytes value in deliveryMethod parameter in request url.

","parameters":[{"name":"deliveryMethod","in":"query","description":"Bytes","type":"integer","format":"int32"}],"responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that the delivery method list received successfully.","schema":{"$ref":"#/definitions/DeliveryMethodResponse"}},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."}}}},"/api/v2.1/Event/user/{userGuid}/register-device":{"post":{"tags":["Event"],"summary":"Register user devices","description":"

This API endpoint allows you to register user login devices into a system through which users are logging into the system. For that, you need to send userGuid in request url and user device details in the request body. Here, devices will be registered for a given user.

","parameters":[{"name":"userGuid","in":"path","description":"User Guid","required":true,"type":"string","format":"uuid"},{"name":"request","in":"body","description":"Json object","schema":{"$ref":"#/definitions/RegisteredDevicesRequest"}}],"responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that the user device registered successfully.","schema":{"$ref":"#/definitions/RegisteredDevicesResponse"}},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\nuser not found and invalid logged user or company."}}},"put":{"tags":["Event"],"summary":"Update registered user device","description":"

This API endpoint allows you to update registered user login devices. For that, you need to send userGuid in request url and updated user device details in the request body.

","parameters":[{"name":"userGuid","in":"path","description":"User Guid","required":true,"type":"string","format":"uuid"},{"name":"request","in":"body","description":"Json object","schema":{"$ref":"#/definitions/RegisteredDevicesUpdateRequest"}}],"responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that the user device registered updated successfully.","schema":{"$ref":"#/definitions/RegisteredDevicesUpdateResponse"}},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\nuser not found and invalid logged user or company."}}}},"/api/v2.1/Event/registered-devices":{"post":{"tags":["Event"],"summary":"Get registered user devices list","description":"

This API endpoint provides you the list of registered devices under given users.

","responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that the user device registered list received successfully.","schema":{"$ref":"#/definitions/RegisteredDevicesListResponse"}},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\ninvalid logged user or company."}},"parameters":[{"name":"request","in":"body","description":"Json object","schema":{"$ref":"#/definitions/RegisteredDevicesListRequest"}}]}},"/api/v2.1/Event/send-email":{"post":{"tags":["Event"],"summary":"Send Email","description":"

This API endpoint allows you to send an email to the provided list of emails. For that, you need to post email subject, email body and list of recipient email ids in the request body.

","responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that the event email sent successfully.","schema":{"$ref":"#/definitions/EventSendEmailResponse"}},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\nuser not found and invalid logged user or company."}},"parameters":[{"name":"request","in":"body","description":"Json object","schema":{"$ref":"#/definitions/EventSendEmailRequest"}}]}},"/api/v2.1/Event/subscriptions/{eventSubscriptionGuid}/template":{"post":{"tags":["Event"],"summary":"Add event template","description":"

To notify users, one needs predefined notification templates for email, SMS, or push.

\n

This API endpoint allows you to create event notification templates.

\n

Here, eventID is a unique event id. The deliveryMethod defines how you would like to notify a user, either by email, SMS, or push.

","parameters":[{"name":"eventSubscriptionGuid","in":"path","description":"eventSubscriptionGuid object","required":true,"type":"string","format":"uuid"},{"name":"request","in":"body","description":"Json object","schema":{"$ref":"#/definitions/EventTemplateCreateRequest"}}],"responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that the event template created successfully.","schema":{"$ref":"#/definitions/EventTemplateCreateResponse"}},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\nEvent not found, event is not subscribed, delivery method not active, delivery method not found, event template already exists \ndelivery method not subscribed and invalid logged user or company."}}}},"/api/v2.1/Event/subscriptions/{eventSubscriptionGuid}/template/eventId/{eventId}/delivery-method/{deliveryMethod}":{"get":{"tags":["Event"],"summary":"Get event template by eventId and delivery Method","description":"

This API endpoint gives you the event notification template details. For that, you need to send the eventId and delivery method in request url.

","parameters":[{"name":"eventSubscriptionGuid","in":"path","description":"eventSubscriptionGuid guid","required":true,"type":"string","format":"uuid"},{"name":"eventId","in":"path","description":"eventId","required":true,"type":"integer","format":"int32"},{"name":"deliveryMethod","in":"path","description":"Delivery Method. Eg: sms, Email etc","required":true,"type":"string"}],"responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that the event template detail received successfully.","schema":{"$ref":"#/definitions/EventTemplateDetailResponse"}},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\ndelivery method not active and invalid logged user or company."}}}},"/api/v2.1/Event/event-notification":{"get":{"tags":["Event"],"summary":"Get Top 50 UI-Notification list","description":"

This API endpoint provides you the ui notification sent list for subscribed events.

","parameters":[{"name":"startDate","in":"query","type":"string","format":"date-time"},{"name":"endDate","in":"query","type":"string","format":"date-time"},{"name":"pageSize","in":"query","type":"integer","format":"int32"},{"name":"pageNumber","in":"query","type":"integer","format":"int32"},{"name":"continuationToken","in":"query","type":"string"}],"responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that the event ui-notification list received successfully.","schema":{"$ref":"#/definitions/EventUINotificationResponse"}},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\nInvalid user guid and invalid logged user or company."}}}},"/api/v2.1/Event/widget-notification":{"get":{"tags":["Event"],"summary":"Get Top 50 WidgetEvent-Notification list","description":"

This API endpoint provides you the ui notification sent list for subscribed events.

","parameters":[{"name":"size","in":"query","type":"integer","format":"int32"}],"responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that the event ui-notification list received successfully.","schema":{"$ref":"#/definitions/WidgetEventNotificationResponse"}},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\nInvalid user guid and invalid logged user or company."}}}},"/api/v2.1/Event/ui-notification":{"get":{"tags":["Event"],"summary":"Get Top 50 UI-Notification list","description":"

This API endpoint provides you the ui notification sent list for subscribed events.

","parameters":[{"name":"size","in":"query","type":"integer","format":"int32"}],"responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that the event ui-notification list received successfully.","schema":{"$ref":"#/definitions/UiNotificationResponse"}},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\nInvalid user guid and invalid logged user or company."}}}},"/api/v2.1/Event/audience-details/{eventTriggredGuid}":{"get":{"tags":["Event"],"summary":"Get Audience Details List","description":"

This API endpoint provides you the audience list for events.

","parameters":[{"name":"eventTriggredGuid","in":"path","required":true,"type":"string","format":"uuid"}],"responses":{"412":{"description":"Indicates that a condition set for this request is failed, and the request cannot be carried out."},"500":{"description":"Indicates that the request could not be carried out because of some technical error on the server.","schema":{"$ref":"#/definitions/ErrorsResponse"}},"200":{"description":"Indicates that the event ui-notification list received successfully.","schema":{"$ref":"#/definitions/EventAudienceDetailsResponse"}},"401":{"description":"Indicates that authentication is failed because of the token is invalid or expired or missing."},"409":{"description":"Indicates that the request could not be carried out because of one of the below or other conflicts on the server.\nInvalid user guid and invalid logged user or company."}}}}},"security":[{"Bearer":[]}],"tags":[{"name":"Event","description":"Event Api List"}],"swagger":"2.0","definitions":{"AudienceData":{"type":"object","properties":{"audienceDetails":{"type":"array","items":{"$ref":"#/definitions/AudienceDetail"},"nullable":true}},"additionalProperties":false},"AudienceDetail":{"type":"object","properties":{"deliveryMethodName":{"type":"string","nullable":true,"readOnly":true},"deliveryMethod":{"type":"integer","format":"int64"},"displayName":{"type":"string","nullable":true},"userId":{"type":"string","nullable":true}},"additionalProperties":false},"CommandData":{"type":"object","properties":{"guid":{"type":"string","description":"Command Guid","nullable":true},"text":{"type":"string","description":"Command Text","nullable":true}},"additionalProperties":false},"DeliveryMethod":{"type":"object","properties":{"guid":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"bitValue":{"type":"integer","format":"int32"}},"additionalProperties":false},"DeliveryMethodResponse":{"type":"object","properties":{"data":{"type":"object","nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"ErrorModel":{"type":"object","properties":{"param":{"type":"string","nullable":true},"message":{"type":"string","nullable":true}},"additionalProperties":false},"ErrorsResponse":{"type":"object","properties":{"status":{"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"error":{"type":"array","items":{"$ref":"#/definitions/ErrorModel"},"nullable":true}},"additionalProperties":false},"EventAudienceDetail":{"type":"object","properties":{"deliveryMethodName":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"userId":{"type":"string","nullable":true},"deliveryMethod":{"type":"integer","format":"int32"},"eventTriggredGuid":{"type":"string","format":"uuid"}},"additionalProperties":false},"EventAudienceDetailsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/EventAudienceDetail"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"EventById":{"type":"object","properties":{"autoSubscribed":{"type":"boolean"},"deliveryMethod":{"type":"integer","format":"int32"},"eventId":{"type":"integer","format":"int32"},"eventTopicGuid":{"type":"string","nullable":true,"readOnly":true},"guid":{"type":"string","nullable":true,"readOnly":true},"name":{"type":"string","nullable":true},"placeHolder":{"type":"string","nullable":true}},"additionalProperties":false},"EventByIdResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/EventById"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"EventDeliveryMethodDetail":{"type":"object","properties":{"guid":{"type":"string","nullable":true,"readOnly":true},"name":{"type":"string","nullable":true},"bitValue":{"type":"integer","format":"int32"},"isPrivate":{"type":"boolean"},"enableHtml":{"type":"boolean"},"templateLen":{"type":"integer","format":"int32"},"audienceRequired":{"type":"boolean"}},"additionalProperties":false},"EventDeliveryMethodDetailResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/EventDeliveryMethodDetail"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"EventList":{"type":"object","properties":{"autoSubscribed":{"type":"boolean"},"deliveryMethod":{"type":"integer","format":"int32"},"eventId":{"type":"integer","format":"int32"},"eventTopicGuid":{"type":"string","nullable":true,"readOnly":true},"guid":{"type":"string","nullable":true,"readOnly":true},"name":{"type":"string","nullable":true},"placeHolder":{"type":"string","nullable":true},"severityLevel":{"type":"string","nullable":true},"subscriptionCount":{"type":"integer","format":"int32"}},"additionalProperties":false},"EventListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/EventList"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"EventLookup":{"type":"object","properties":{"guid":{"type":"string","nullable":true,"readOnly":true},"SeverityLevel":{"type":"string","nullable":true}},"additionalProperties":false},"EventLookupResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/EventLookup"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"EventNotificationListModel":{"type":"object","properties":{"entityName":{"type":"string","nullable":true},"createdDate":{"type":"string","format":"date-time","nullable":true},"uniqueId":{"type":"string","nullable":true},"condition":{"type":"string","nullable":true},"eventName":{"type":"string","nullable":true},"SeverityLevel":{"type":"string","nullable":true},"row_num":{"type":"integer","format":"int32"},"audienceData":{"type":"object","nullable":true},"markedAsRead":{"type":"boolean"},"eventNotificationGuid":{"type":"string","format":"uuid"},"entityGuid":{"type":"string","format":"uuid"},"notificationText":{"type":"string","nullable":true},"eventTriggredGuid":{"type":"string","format":"uuid","nullable":true}},"additionalProperties":false},"EventNotificationListResponse":{"type":"object","properties":{"continuationToken":{"type":"string","nullable":true},"data":{"type":"array","items":{"$ref":"#/definitions/NotificationModel"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"EventSendEmailRequest":{"required":["emailMessage","subject","to"],"type":"object","properties":{"to":{"minLength":1,"type":"string","description":"Recipient email id. For multiple recipients send comma(,) separated list."},"emailMessage":{"minLength":1,"type":"string","description":"Email Body"},"subject":{"minLength":1,"type":"string","description":"Email Subject"}},"additionalProperties":false},"EventSendEmailResponse":{"type":"object","properties":{"data":{"type":"object","nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"EventSubscribedList":{"type":"object","properties":{"eventGuid":{"type":"string","nullable":true,"readOnly":true},"name":{"type":"string","nullable":true},"eventSubscriptionGuid":{"type":"string","nullable":true,"readOnly":true},"autoSubscribed":{"type":"boolean"},"deliveryMethod":{"type":"integer","format":"int32"},"eventSubscriptionDeliveryMethod":{"type":"integer","format":"int32"},"eventSubscriptionDeliveryMethodData":{"type":"array","items":{"$ref":"#/definitions/DeliveryMethod"},"nullable":true},"eventTopicGuid":{"type":"string","nullable":true,"readOnly":true},"severityLevelGuid":{"type":"string","nullable":true,"readOnly":true},"eventTopicName":{"type":"string","nullable":true},"dataRef":{"type":"object","nullable":true},"row_num":{"type":"integer","format":"int32"}},"additionalProperties":false},"EventSubscribedListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/EventSubscribedList"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"EventSubscriptionCreateRequest":{"required":["deliveryMethod","severityLevelGuid"],"type":"object","properties":{"eventGuid":{"type":"string","description":"Event Guid, \nNote : EventGuid or EventName is required","nullable":true},"eventName":{"maxLength":100,"type":"string","description":"Event Name,\nNote : EventGuid or EventName is required","nullable":true},"deliveryMethod":{"type":"array","items":{"type":"string"},"description":"Delivery Method Eg: MQTT, UI Alert, Push, SignalR, DeviceCommand, WebHook, Email etc."},"refData":{"$ref":"#/definitions/RefData"},"severityLevelGuid":{"minLength":1,"type":"string","description":"Severity Level Guid"},"refGuid":{"type":"string","description":"Ref guid, Eg: RuleGuid","nullable":true}},"additionalProperties":false},"EventSubscriptionCreateResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","nullable":true},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"EventSubscriptionDetail":{"type":"object","properties":{"guid":{"type":"string","nullable":true,"readOnly":true},"eventGuid":{"type":"string","nullable":true,"readOnly":true},"deliveryMethod":{"type":"integer","format":"int32"},"deliveryMethodData":{"type":"object","nullable":true},"companyGuid":{"type":"string","nullable":true,"readOnly":true},"solutionGuid":{"type":"string","nullable":true,"readOnly":true},"refGuid":{"type":"string","nullable":true,"readOnly":true},"dataXml":{"type":"object","nullable":true},"severityLevelGuid":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"EventSubscriptionDetailResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/EventSubscriptionDetail"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"EventSubscriptionUpdateRequest":{"required":["deliveryMethod","severityLevelGuid"],"type":"object","properties":{"deliveryMethod":{"type":"array","items":{"type":"string"},"description":"Delivery Method Eg: MQTT, UI Alert, Push, SignalR, DeviceCommand, WebHook, Email etc."},"refData":{"$ref":"#/definitions/RefData"},"severityLevelGuid":{"minLength":1,"type":"string","description":"Severity Level Guid"},"refGuid":{"type":"string","description":"Ref guid, Eg: RuleGuid","nullable":true}},"additionalProperties":false},"EventSubscriptionUpdateResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","nullable":true},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"EventTemplateCreateRequest":{"required":["deliveryMethod","eventId","template"],"type":"object","properties":{"eventId":{"type":"integer","description":"Event Id","format":"int32"},"eventSubscriptionGuid":{"type":"string","format":"uuid","nullable":true},"deliveryMethod":{"minLength":1,"type":"string","description":"Delivery Method Eg: MQTT, UI Alert, Push, SignalR, DeviceCommand, WebHook, Email etc."},"template":{"$ref":"#/definitions/Templatedata"}},"additionalProperties":false},"EventTemplateCreateResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","nullable":true},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"EventTemplateDetail":{"type":"object","properties":{"guid":{"type":"string","nullable":true,"readOnly":true},"companyGuid":{"type":"string","nullable":true,"readOnly":true},"template":{"type":"string","nullable":true},"deliveryMethod":{"type":"integer","format":"int32"},"eventId":{"type":"integer","format":"int32"},"createdDate":{"type":"string","format":"date-time","nullable":true},"createdBy":{"type":"string","nullable":true,"readOnly":true},"updatedDate":{"type":"string","format":"date-time","nullable":true},"updatedBy":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"EventTemplateDetailResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/EventTemplateDetail"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"EventTemplateResetResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","nullable":true},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"EventTemplateUpdateRequest":{"required":["template"],"type":"object","properties":{"template":{"$ref":"#/definitions/Templatedata"}},"additionalProperties":false},"EventTemplateUpdateResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","nullable":true},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"EventUINotificationResponse":{"type":"object","properties":{"continuationToken":{"type":"string","nullable":true},"data":{"type":"array","items":{"$ref":"#/definitions/EventNotificationListModel"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"EventUnsubscribeResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","nullable":true},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"NoContentResult":{"type":"object","properties":{"statusCode":{"type":"integer","format":"int32"}},"additionalProperties":false},"NotificationModel":{"type":"object","properties":{"entityName":{"type":"string","nullable":true},"markedAsRead":{"type":"integer","format":"int32"},"notificationText":{"type":"string","nullable":true},"createdDate":{"type":"string","format":"date-time"},"audienceData":{"$ref":"#/definitions/AudienceData"},"eventGuid":{"type":"string","nullable":true},"eventName":{"type":"string","nullable":true},"cpId":{"type":"string","nullable":true},"eventNotificationGuid":{"type":"string","nullable":true},"severityLevelGuid":{"type":"string","nullable":true},"severityName":{"type":"string","nullable":true},"uniqueId":{"type":"string","nullable":true},"condition":{"type":"string","nullable":true}},"additionalProperties":false},"RefData":{"type":"object","properties":{"userguids":{"type":"array","items":{"type":"string"},"description":"User guid list for event audience","nullable":true},"roleguids":{"type":"array","items":{"type":"string"},"description":"Role guid list for event audience","nullable":true},"command":{"$ref":"#/definitions/CommandData"},"webhook":{"$ref":"#/definitions/WebHookConfig"},"templateGuids":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false},"RegisteredDevicesList":{"type":"object","properties":{"companyGuid":{"type":"string","nullable":true,"readOnly":true},"deviceToken":{"type":"string","nullable":true},"guid":{"type":"string","nullable":true,"readOnly":true},"osName":{"type":"string","nullable":true},"osVersion":{"type":"string","nullable":true},"registrationId":{"type":"string","nullable":true},"userGuid":{"type":"string","nullable":true,"readOnly":true},"uuid":{"type":"string","nullable":true}},"additionalProperties":false},"RegisteredDevicesListRequest":{"required":["userguids"],"type":"object","properties":{"userguids":{"type":"array","items":{"$ref":"#/definitions/Userguid"},"description":"User Guid List"}},"additionalProperties":false},"RegisteredDevicesListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/RegisteredDevicesList"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"RegisteredDevicesRequest":{"required":["osName","osVersion","uuid"],"type":"object","properties":{"osName":{"maxLength":50,"minLength":1,"type":"string"},"osVersion":{"maxLength":100,"minLength":1,"type":"string"},"uuid":{"minLength":1,"type":"string"},"deviceToken":{"maxLength":255,"type":"string","nullable":true},"registrationId":{"maxLength":200,"type":"string","nullable":true}},"additionalProperties":false},"RegisteredDevicesResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","nullable":true},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"RegisteredDevicesUpdateRequest":{"required":["deviceToken","osName","osVersion","uuid"],"type":"object","properties":{"osName":{"maxLength":50,"minLength":1,"type":"string"},"osVersion":{"maxLength":100,"minLength":1,"type":"string"},"uuid":{"minLength":1,"type":"string"},"deviceToken":{"maxLength":100,"minLength":1,"type":"string"}},"additionalProperties":false},"RegisteredDevicesUpdateResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","nullable":true},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"Templatedata":{"type":"object","properties":{"subject":{"type":"string","nullable":true},"message":{"type":"string","nullable":true}},"additionalProperties":false},"TopicList":{"type":"object","properties":{"guid":{"type":"string","nullable":true,"readOnly":true},"topicId":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true}},"additionalProperties":false},"TopicListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/TopicList"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"UiNotificationResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/NotificationModel"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false},"Userguid":{"type":"object","properties":{"userguid":{"type":"string","nullable":true}},"additionalProperties":false},"WebHookConfig":{"type":"object","properties":{"url":{"type":"string","description":"Webhook url.","nullable":true},"headers":{"type":"array","items":{"$ref":"#/definitions/WebHookHeader"},"description":"Webhook headers.","nullable":true}},"additionalProperties":false},"WebHookHeader":{"type":"object","properties":{"key":{"type":"string","description":"Webhook header key.","nullable":true},"value":{"type":"string","description":"Webhook header value.","nullable":true}},"additionalProperties":false},"WidgetEventNotificationListModel":{"type":"object","properties":{"eventName":{"type":"string","nullable":true},"severityLevel":{"type":"string","nullable":true,"readOnly":true},"createdDate":{"type":"string","format":"date-time","nullable":true},"uniqueId":{"type":"string","nullable":true},"condition":{"type":"string","nullable":true}},"additionalProperties":false},"WidgetEventNotificationResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/WidgetEventNotificationListModel"},"nullable":true},"status":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32"},"message":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64","nullable":true}},"additionalProperties":false}},"securityDefinitions":{"Bearer":{"type":"apiKey","description":"Please enter JWT with Bearer into field","name":"Authorization","in":"header"}}}