openapi: 3.2.0 info: title: Avnet Event API version: '1.0' description: 'Operations tagged Event across 2 of this provider''s published API definitions: avnet-iotconnect-event-aws-prod-swagger.json, avnet-iotconnect-event-azure-prod-swagger.json. Each path carries the servers of the definition it was published in.' security: - Bearer: [] tags: - name: Event description: Event Api List 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. Subscribe for events using this API endpoint. 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. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the event subscribed successfully. content: application/json: schema: $ref: '#/components/schemas/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." requestBody: content: application/json: schema: $ref: '#/components/schemas/EventSubscriptionCreateRequest' description: Json object. eventGuid is required operationId: postApiV21EventSubscriptionSubscribe x-operation-id-source: derived /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 schema: 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. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the event subscription updated successfully. content: application/json: schema: $ref: '#/components/schemas/EventSubscriptionUpdateResponse' '204': description: Indicates that RefData is null or RoleGuids or UserGuids not found in RefData. content: application/json: schema: $ref: '#/components/schemas/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." requestBody: content: application/json: schema: $ref: '#/components/schemas/EventSubscriptionUpdateRequest' description: Json object operationId: putApiV21EventSubscriptionBySubscriptionGuid x-operation-id-source: derived 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 schema: 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. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the event subscription received successfully. content: application/json: schema: $ref: '#/components/schemas/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. Event subscription not found and invalid logged user or company.' operationId: getApiV21EventSubscriptionBySubscriptionGuid x-operation-id-source: derived /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 schema: 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. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the event unsubscribed successfully. content: application/json: schema: $ref: '#/components/schemas/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." operationId: deleteApiV21EventSubscriptionBySubscriptionGuidUnSubscribe x-operation-id-source: derived /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. 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. schema: type: string - name: sortBy in: query description: Sort By, Eg. name asc, name desc, name etc. schema: type: string - name: eventguid in: query description: Get by eventGuid schema: type: string - name: pageNumber in: query description: 'To fetch specific page data. Eg: 2' schema: type: integer format: int32 - name: pageSize in: query description: 'To define number of records in single page. Eg: 25' schema: 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. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the event subscription list received successfully. content: application/json: schema: $ref: '#/components/schemas/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. invalid logged user or company.' operationId: getApiV21EventSubscription x-operation-id-source: derived /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. 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. schema: type: string - name: sortBy in: query description: Sort By, Eg. name asc, name desc, name etc. schema: type: string - name: pageNumber in: query description: 'To fetch specific page data. Eg: 2' schema: type: integer format: int32 - name: pageSize in: query description: 'To define number of records in single page. Eg: 25' schema: 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. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the event topic list received successfully. content: application/json: schema: $ref: '#/components/schemas/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. invalid logged user or company.' operationId: getApiV21EventTopics x-operation-id-source: derived /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. 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 schema: 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. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the predefined event topic list received successfully. content: application/json: schema: $ref: '#/components/schemas/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. Event topic guid not exists and invalid logged user or company.' operationId: getApiV21Event x-operation-id-source: derived /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 schema: 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. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the predefined event detail received successfully. content: application/json: schema: $ref: '#/components/schemas/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. Event not found and invalid logged user or company.' operationId: getApiV21EventByEventid x-operation-id-source: derived /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. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the severity level lookup list received successfully. content: application/json: schema: $ref: '#/components/schemas/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. Event not found and invalid logged user or company.' operationId: getApiV21SeverityLevelLookup x-operation-id-source: derived /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 schema: 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. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the event's delivery method detail received successfully. content: application/json: schema: $ref: '#/components/schemas/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. Event not found and invalid logged user or company.' operationId: getApiV21EventByEventIdDeliveryMethod x-operation-id-source: derived /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. 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 schema: type: string - name: pageNumber in: query description: 'To fetch specific page data. Eg: 2' schema: type: integer format: int32 - name: pageSize in: query description: 'To define number of records in single page. Eg: 25' schema: type: integer format: int32 - name: sortBy in: query description: Sort By, Eg. eventName asc, eventName desc, eventName etc. schema: type: string - name: searchText in: query description: To search for specific texts in the list. schema: type: string - name: startDate in: query description: Start Date to filter schema: type: string format: date-time - name: endDate in: query description: End Date to filter schema: type: string format: date-time - name: continuationToken in: header description: To get next data from cosmos schema: type: string - name: viewArchive in: query description: to view archive data from cosmos schema: 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. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the event notification list received successfully. content: application/json: schema: $ref: '#/components/schemas/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. Invalid user guid and invalid logged user or company.' operationId: getApiV21EventNotification x-operation-id-source: derived /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. This API endpoint allows you to create event notification templates. 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. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the event template created successfully. content: application/json: schema: $ref: '#/components/schemas/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." requestBody: content: application/json: schema: $ref: '#/components/schemas/EventTemplateCreateRequest' description: Json object operationId: postApiV21EventTemplate x-operation-id-source: derived /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 schema: 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. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the event template updated successfully. content: application/json: schema: $ref: '#/components/schemas/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. Event template not exists and invalid logged user or company.' requestBody: content: application/json: schema: $ref: '#/components/schemas/EventTemplateUpdateRequest' description: Json object operationId: putApiV21EventTemplateByEventTemplateGuid x-operation-id-source: derived 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 schema: 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. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the event template deleted successfully. content: application/json: schema: $ref: '#/components/schemas/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. Event template not exists, default event template can not be deleted and invalid logged user or company.' operationId: deleteApiV21EventTemplateByEventTemplateGuid x-operation-id-source: derived /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 schema: type: integer format: int32 - name: deliveryMethod in: path description: 'Delivery Method. Eg: sms, Email etc' required: true schema: 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. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the event template detail received successfully. content: application/json: schema: $ref: '#/components/schemas/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. delivery method not active and invalid logged user or company.' operationId: getApiV21EventTemplateByEventIdByDeliveryMethod x-operation-id-source: derived /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 schema: 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. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the delivery method list received successfully. content: application/json: schema: $ref: '#/components/schemas/DeliveryMethodResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. operationId: getApiV21Deliverymethod x-operation-id-source: derived /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 schema: 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. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the user device registered successfully. content: application/json: schema: $ref: '#/components/schemas/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. user not found and invalid logged user or company.' requestBody: content: application/json: schema: $ref: '#/components/schemas/RegisteredDevicesRequest' description: Json object operationId: postApiV21EventUserByUserGuidRegisterDevice x-operation-id-source: derived 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 schema: 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. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the user device registered updated successfully. content: application/json: schema: $ref: '#/components/schemas/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. user not found and invalid logged user or company.' requestBody: content: application/json: schema: $ref: '#/components/schemas/RegisteredDevicesUpdateRequest' description: Json object operationId: putApiV21EventUserByUserGuidRegisterDevice x-operation-id-source: derived /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. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the user device registered list received successfully. content: application/json: schema: $ref: '#/components/schemas/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. invalid logged user or company.' requestBody: content: application/json: schema: $ref: '#/components/schemas/RegisteredDevicesListRequest' description: Json object operationId: postApiV21EventRegisteredDevices x-operation-id-source: derived /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. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the event email sent successfully. content: application/json: schema: $ref: '#/components/schemas/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. user not found and invalid logged user or company.' requestBody: content: application/json: schema: $ref: '#/components/schemas/EventSendEmailRequest' description: Json object operationId: postApiV21EventSendEmail x-operation-id-source: derived /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. This API endpoint allows you to create event notification templates. 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 schema: 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. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the event template created successfully. content: application/json: schema: $ref: '#/components/schemas/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." requestBody: content: application/json: schema: $ref: '#/components/schemas/EventTemplateCreateRequest' description: Json object operationId: postApiV21EventSubscriptionsByEventSubscriptionGuidTemplate x-operation-id-source: derived /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 schema: type: string format: uuid - name: eventId in: path description: eventId required: true schema: type: integer format: int32 - name: deliveryMethod in: path description: 'Delivery Method. Eg: sms, Email etc' required: true schema: 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. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the event template detail received successfully. content: application/json: schema: $ref: '#/components/schemas/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. delivery method not active and invalid logged user or company.' operationId: getApiV21EventSubscriptionsByEventSubscriptionGuidTemplateEventIdByEventIdDeliveryMethodByDeliveryMethod x-operation-id-source: derived /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 schema: type: string format: date-time - name: endDate in: query schema: type: string format: date-time - name: pageSize in: query schema: type: integer format: int32 - name: pageNumber in: query schema: type: integer format: int32 - name: continuationToken in: query schema: 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. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the event ui-notification list received successfully. content: application/json: schema: $ref: '#/components/schemas/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. Invalid user guid and invalid logged user or company.' operationId: getApiV21EventEventNotification x-operation-id-source: derived /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 schema: 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. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the event ui-notification list received successfully. content: application/json: schema: $ref: '#/components/schemas/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. Invalid user guid and invalid logged user or company.' operationId: getApiV21EventWidgetNotification x-operation-id-source: derived /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 schema: 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. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the event ui-notification list received successfully. content: application/json: schema: $ref: '#/components/schemas/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. Invalid user guid and invalid logged user or company.' operationId: getApiV21EventUiNotification x-operation-id-source: derived /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 schema: 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. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the event ui-notification list received successfully. content: application/json: schema: $ref: '#/components/schemas/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. Invalid user guid and invalid logged user or company.' operationId: getApiV21EventAudienceDetailsByEventTriggredGuid x-operation-id-source: derived /api/v1.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. Subscribe for events using this API endpoint. 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. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the event subscribed successfully. content: application/json: schema: $ref: '#/components/schemas/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." requestBody: content: application/json: schema: $ref: '#/components/schemas/EventSubscriptionCreateRequest_2' description: Json object. eventGuid or eventName is required operationId: postApiV11EventSubscriptionSubscribe x-operation-id-source: derived /api/v1.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 schema: 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. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the event subscription updated successfully. content: application/json: schema: $ref: '#/components/schemas/EventSubscriptionUpdateResponse' '204': description: Indicates that RefData is null or RoleGuids or UserGuids not found in RefData. content: application/json: schema: $ref: '#/components/schemas/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." requestBody: content: application/json: schema: $ref: '#/components/schemas/EventSubscriptionUpdateRequest' description: Json object operationId: putApiV11EventSubscriptionBySubscriptionGuid x-operation-id-source: derived 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 schema: 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. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the event subscription received successfully. content: application/json: schema: $ref: '#/components/schemas/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. Event subscription not found and invalid logged user or company.' operationId: getApiV11EventSubscriptionBySubscriptionGuid x-operation-id-source: derived /api/v1.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 schema: 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. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the event unsubscribed successfully. content: application/json: schema: $ref: '#/components/schemas/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." operationId: deleteApiV11EventSubscriptionBySubscriptionGuidUnSubscribe x-operation-id-source: derived /api/v1.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. 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. schema: type: string - name: sortBy in: query description: Sort By, Eg. name asc, name desc, name etc. schema: type: string - name: eventguid in: query description: Get by eventGuid schema: type: string - name: pageNumber in: query description: 'To fetch specific page data. Eg: 2' schema: type: integer format: int32 - name: pageSize in: query description: 'To define number of records in single page. Eg: 25' schema: 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. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the event subscription list received successfully. content: application/json: schema: $ref: '#/components/schemas/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. invalid logged user or company.' operationId: getApiV11EventSubscription x-operation-id-source: derived /api/v1.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. 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. schema: type: string - name: sortBy in: query description: Sort By, Eg. name asc, name desc, name etc. schema: type: string - name: pageNumber in: query description: 'To fetch specific page data. Eg: 2' schema: type: integer format: int32 - name: pageSize in: query description: 'To define number of records in single page. Eg: 25' schema: 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. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the event topic list received successfully. content: application/json: schema: $ref: '#/components/schemas/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. invalid logged user or company.' operationId: getApiV11EventTopics x-operation-id-source: derived /api/v1.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. 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: searchText in: query description: To search for specific texts in the list. schema: type: string - name: sortBy in: query description: Sort By, Eg. name asc, name desc, name etc. schema: type: string - name: eventTopicGuid in: query description: Get by event topic guid schema: type: string - name: pageNumber in: query description: 'To fetch specific page data. Eg: 2' schema: type: integer format: int32 - name: pageSize in: query description: 'To define number of records in single page. Eg: 25' schema: 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. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the predefined event topic list received successfully. content: application/json: schema: $ref: '#/components/schemas/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. Event topic guid not exists and invalid logged user or company.' operationId: getApiV11Event x-operation-id-source: derived /api/v1.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 schema: 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. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the predefined event detail received successfully. content: application/json: schema: $ref: '#/components/schemas/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. Event not found and invalid logged user or company.' operationId: getApiV11EventByEventid x-operation-id-source: derived /api/v1.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. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the severity level lookup list received successfully. content: application/json: schema: $ref: '#/components/schemas/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. Event not found and invalid logged user or company.' operationId: getApiV11SeverityLevelLookup x-operation-id-source: derived /api/v1.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 schema: 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. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the event's delivery method detail received successfully. content: application/json: schema: $ref: '#/components/schemas/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. Event not found and invalid logged user or company.' operationId: getApiV11EventByEventIdDeliveryMethod x-operation-id-source: derived /api/v1.1/event-template: post: tags: - Event summary: Add event template description: 'To notify users, one needs predefined notification templates for email, SMS, or push. This API endpoint allows you to create event notification templates. 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. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the event template created successfully. content: application/json: schema: $ref: '#/components/schemas/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." requestBody: content: application/json: schema: $ref: '#/components/schemas/EventTemplateCreateRequest' description: Json object operationId: postApiV11EventTemplate x-operation-id-source: derived /api/v1.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 schema: 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. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the event template updated successfully. content: application/json: schema: $ref: '#/components/schemas/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. Event template not exists and invalid logged user or company.' requestBody: content: application/json: schema: $ref: '#/components/schemas/EventTemplateUpdateRequest' description: Json object operationId: putApiV11EventTemplateByEventTemplateGuid x-operation-id-source: derived 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 schema: 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. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the event template deleted successfully. content: application/json: schema: $ref: '#/components/schemas/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. Event template not exists, default event template can not be deleted and invalid logged user or company.' operationId: deleteApiV11EventTemplateByEventTemplateGuid x-operation-id-source: derived /api/v1.1/event-template/{eventId}/{deliveryMethod}: get: tags: - Event summary: Get event template by eventId and deliveryMethod 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 schema: type: integer format: int32 - name: deliveryMethod in: path description: 'Delivery Method. Eg: sms, Email etc' required: true schema: 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. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the event template detail received successfully. content: application/json: schema: $ref: '#/components/schemas/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. delivery method not active and invalid logged user or company.' operationId: getApiV11EventTemplateByEventIdByDeliveryMethod x-operation-id-source: derived /api/v1.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 schema: 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. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the delivery method list received successfully. content: application/json: schema: $ref: '#/components/schemas/DeliveryMethodResponse' '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. operationId: getApiV11Deliverymethod x-operation-id-source: derived /api/v1.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 schema: 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. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the user device registered successfully. content: application/json: schema: $ref: '#/components/schemas/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. user not found and invalid logged user or company.' requestBody: content: application/json: schema: $ref: '#/components/schemas/RegisteredDevicesRequest_2' description: Json object operationId: postApiV11EventUserByUserGuidRegisterDevice x-operation-id-source: derived 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 schema: 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. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the user device registered updated successfully. content: application/json: schema: $ref: '#/components/schemas/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. user not found and invalid logged user or company.' requestBody: content: application/json: schema: $ref: '#/components/schemas/RegisteredDevicesUpdateRequest' description: Json object operationId: putApiV11EventUserByUserGuidRegisterDevice x-operation-id-source: derived /api/v1.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. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the user device registered list received successfully. content: application/json: schema: $ref: '#/components/schemas/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. invalid logged user or company.' requestBody: content: application/json: schema: $ref: '#/components/schemas/RegisteredDevicesListRequest' description: Json object operationId: postApiV11EventRegisteredDevices x-operation-id-source: derived /api/v1.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. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the event email sent successfully. content: application/json: schema: $ref: '#/components/schemas/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. user not found and invalid logged user or company.' requestBody: content: application/json: schema: $ref: '#/components/schemas/EventSendEmailRequest' description: Json object operationId: postApiV11EventSendEmail x-operation-id-source: derived /api/v1.1/Event/notification-hub: get: tags: - Event summary: Get notification hub configuration description: This API endpoint provide you the notification hub configuration. 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. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the notification hub configuration received successfully. content: application/json: schema: $ref: '#/components/schemas/EventNotificationHubDetailResponse' '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. invalid logged user or company.' operationId: getApiV11EventNotificationHub x-operation-id-source: derived /api/v1.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. This API endpoint allows you to create event notification templates. 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 schema: 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. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the event template created successfully. content: application/json: schema: $ref: '#/components/schemas/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." requestBody: content: application/json: schema: $ref: '#/components/schemas/EventTemplateCreateRequest' description: Json object operationId: postApiV11EventSubscriptionsByEventSubscriptionGuidTemplate x-operation-id-source: derived /api/v1.1/Event/subscriptions/{eventSubscriptionGuid}/template/eventId/{eventId}/delivery-method/{deliveryMethod}: get: tags: - Event summary: Get event template by eventId and deliveryMethod 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 schema: type: string format: uuid - name: eventId in: path description: eventId required: true schema: type: integer format: int32 - name: deliveryMethod in: path description: 'Delivery Method. Eg: sms, Email etc' required: true schema: 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. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: Indicates that the event template detail received successfully. content: application/json: schema: $ref: '#/components/schemas/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. delivery method not active and invalid logged user or company.' operationId: getApiV11EventSubscriptionsByEventSubscriptionGuidTemplateEventIdByEventIdDeliveryMethodByDeliveryMethod x-operation-id-source: derived /api/v1.1/Event/webhook/test: post: tags: - Event 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. content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' '200': description: OK content: application/json: schema: $ref: '#/components/schemas/EventSubscriptionCreateResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/WebHookConfigWithData' summary: Create api event webhook test x-summary-source: derived operationId: postApiV11EventWebhookTest x-operation-id-source: derived components: schemas: RegisteredDevicesListResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/RegisteredDevicesList' 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 - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false EventLookup: type: object properties: guid: type: - string - 'null' readOnly: true SeverityLevel: type: - string - 'null' additionalProperties: false EventSubscribedList: type: object properties: eventGuid: type: - string - 'null' readOnly: true name: type: - string - 'null' eventSubscriptionGuid: type: - string - 'null' readOnly: true autoSubscribed: type: boolean deliveryMethod: type: integer format: int32 eventSubscriptionDeliveryMethod: type: integer format: int32 eventSubscriptionDeliveryMethodData: type: - array - 'null' items: $ref: '#/components/schemas/DeliveryMethod' eventTopicGuid: type: - string - 'null' readOnly: true severityLevelGuid: type: - string - 'null' readOnly: true eventTopicName: type: - string - 'null' dataRef: type: - object - 'null' row_num: type: integer format: int32 additionalProperties: false WidgetEventNotificationListModel: type: object properties: eventName: type: - string - 'null' severityLevel: type: - string - 'null' readOnly: true createdDate: type: - string - 'null' format: date-time uniqueId: type: - string - 'null' condition: type: - string - 'null' additionalProperties: false Templatedata: type: object properties: subject: type: - string - 'null' message: type: - string - 'null' additionalProperties: false WidgetEventNotificationResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/WidgetEventNotificationListModel' 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 - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false EventNotificationListModel: type: object properties: entityName: type: - string - 'null' createdDate: type: - string - 'null' format: date-time uniqueId: type: - string - 'null' condition: type: - string - 'null' eventName: type: - string - 'null' SeverityLevel: type: - string - 'null' row_num: type: integer format: int32 audienceData: type: - object - 'null' markedAsRead: type: boolean eventNotificationGuid: type: string format: uuid entityGuid: type: string format: uuid notificationText: type: - string - 'null' eventTriggredGuid: type: - string - 'null' format: uuid additionalProperties: false RegisteredDevicesResponse: type: object properties: data: type: - array - 'null' items: type: - object - 'null' 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 - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false EventTemplateResetResponse: type: object properties: data: type: - array - 'null' items: type: - object - 'null' 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 - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false EventSubscriptionUpdateResponse: type: object properties: data: type: - array - 'null' items: type: - object - 'null' 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 - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false EventTemplateUpdateRequest: required: - template type: object properties: template: $ref: '#/components/schemas/Templatedata' additionalProperties: false EventDeliveryMethodDetail: type: object properties: guid: type: - string - 'null' readOnly: true name: type: - string - 'null' bitValue: type: integer format: int32 isPrivate: type: boolean enableHtml: type: boolean templateLen: type: integer format: int32 audienceRequired: type: boolean additionalProperties: false RegisteredDevicesUpdateResponse: type: object properties: data: type: - array - 'null' items: type: - object - 'null' 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 - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false EventSubscriptionCreateRequest: required: - deliveryMethod - severityLevelGuid type: object properties: eventGuid: type: - string - 'null' description: "Event Guid, \nNote : EventGuid or EventName is required" eventName: maxLength: 100 type: - string - 'null' description: 'Event Name, Note : EventGuid or EventName is required' deliveryMethod: type: array items: type: string description: 'Delivery Method Eg: MQTT, UI Alert, Push, SignalR, DeviceCommand, WebHook, Email etc.' refData: $ref: '#/components/schemas/RefData' severityLevelGuid: minLength: 1 type: string description: Severity Level Guid refGuid: type: - string - 'null' description: 'Ref guid, Eg: RuleGuid' additionalProperties: false EventTemplateUpdateResponse: type: object properties: data: type: - array - 'null' items: type: - object - 'null' 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 - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false ErrorModel: type: object properties: param: type: - string - 'null' message: type: - string - 'null' additionalProperties: false EventTemplateCreateRequest: required: - deliveryMethod - eventId - template type: object properties: eventId: type: integer description: Event Id format: int32 eventSubscriptionGuid: type: - string - 'null' format: uuid deliveryMethod: minLength: 1 type: string description: 'Delivery Method Eg: MQTT, UI Alert, Push, SignalR, DeviceCommand, WebHook, Email etc.' template: $ref: '#/components/schemas/Templatedata' additionalProperties: false NoContentResult: type: object properties: statusCode: type: integer format: int32 additionalProperties: false EventUnsubscribeResponse: type: object properties: data: type: - array - 'null' items: type: - object - 'null' 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 - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false EventUINotificationResponse: type: object properties: continuationToken: type: - string - 'null' data: type: - array - 'null' items: $ref: '#/components/schemas/EventNotificationListModel' 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 - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false EventDeliveryMethodDetailResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/EventDeliveryMethodDetail' 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 - 'null' count: type: - integer - 'null' format: int64 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 EventByIdResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/EventById' 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 - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false EventSubscribedListResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/EventSubscribedList' 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 - 'null' count: type: - integer - 'null' format: int64 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 - 'null' registrationId: maxLength: 200 type: - string - 'null' additionalProperties: false EventSubscriptionDetail: type: object properties: guid: type: - string - 'null' readOnly: true eventGuid: type: - string - 'null' readOnly: true deliveryMethod: type: integer format: int32 deliveryMethodData: type: - object - 'null' companyGuid: type: - string - 'null' readOnly: true solutionGuid: type: - string - 'null' readOnly: true refGuid: type: - string - 'null' readOnly: true dataXml: type: - object - 'null' severityLevelGuid: type: - string - 'null' readOnly: true additionalProperties: false NotificationModel: type: object properties: entityName: type: - string - 'null' markedAsRead: type: integer format: int32 notificationText: type: - string - 'null' createdDate: type: string format: date-time audienceData: $ref: '#/components/schemas/AudienceData' eventGuid: type: - string - 'null' eventName: type: - string - 'null' cpId: type: - string - 'null' eventNotificationGuid: type: - string - 'null' severityLevelGuid: type: - string - 'null' severityName: type: - string - 'null' uniqueId: type: - string - 'null' condition: type: - string - 'null' additionalProperties: false EventLookupResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/EventLookup' 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 - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false EventAudienceDetail: type: object properties: deliveryMethodName: type: - string - 'null' firstName: type: - string - 'null' lastName: type: - string - 'null' userId: type: - string - 'null' deliveryMethod: type: integer format: int32 eventTriggredGuid: type: string format: uuid additionalProperties: false EventAudienceDetailsResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/EventAudienceDetail' 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 - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false DeliveryMethodResponse: type: object properties: data: type: - object - 'null' 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 - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false RegisteredDevicesListRequest: required: - userguids type: object properties: userguids: type: array items: $ref: '#/components/schemas/Userguid' description: User Guid List 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: '#/components/schemas/RefData' severityLevelGuid: minLength: 1 type: string description: Severity Level Guid refGuid: type: - string - 'null' description: 'Ref guid, Eg: RuleGuid' additionalProperties: false UiNotificationResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/NotificationModel' 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 - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false AudienceData: type: object properties: audienceDetails: type: - array - 'null' items: $ref: '#/components/schemas/AudienceDetail' additionalProperties: false EventSendEmailResponse: type: object properties: data: type: - object - 'null' 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 - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false EventSubscriptionDetailResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/EventSubscriptionDetail' 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 - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false Userguid: type: object properties: userguid: type: - string - 'null' additionalProperties: false AudienceDetail: type: object properties: deliveryMethodName: type: - string - 'null' readOnly: true deliveryMethod: type: integer format: int64 displayName: type: - string - 'null' userId: type: - string - 'null' additionalProperties: false EventListResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/EventList' 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 - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false EventTemplateDetailResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/EventTemplateDetail' 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 - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false ErrorsResponse: type: object properties: status: type: integer format: int32 message: type: - string - 'null' error: type: - array - 'null' items: $ref: '#/components/schemas/ErrorModel' additionalProperties: false EventTemplateDetail: type: object properties: guid: type: - string - 'null' readOnly: true companyGuid: type: - string - 'null' readOnly: true template: type: - string - 'null' deliveryMethod: type: integer format: int32 eventId: type: integer format: int32 createdDate: type: - string - 'null' format: date-time createdBy: type: - string - 'null' readOnly: true updatedDate: type: - string - 'null' format: date-time updatedBy: type: - string - 'null' readOnly: true additionalProperties: false CommandData: type: object properties: guid: type: - string - 'null' description: Command Guid text: type: - string - 'null' description: Command Text additionalProperties: false DeliveryMethod: type: object properties: guid: type: - string - 'null' name: type: - string - 'null' bitValue: type: integer format: int32 additionalProperties: false EventNotificationListResponse: type: object properties: continuationToken: type: - string - 'null' data: type: - array - 'null' items: $ref: '#/components/schemas/NotificationModel' 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 - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false WebHookConfig: type: object properties: url: type: - string - 'null' description: Webhook url. headers: type: - array - 'null' items: $ref: '#/components/schemas/WebHookHeader' description: Webhook headers. additionalProperties: false RegisteredDevicesList: type: object properties: companyGuid: type: - string - 'null' readOnly: true deviceToken: type: - string - 'null' guid: type: - string - 'null' readOnly: true osName: type: - string - 'null' osVersion: type: - string - 'null' registrationId: type: - string - 'null' userGuid: type: - string - 'null' readOnly: true uuid: type: - string - 'null' additionalProperties: false EventById: type: object properties: autoSubscribed: type: boolean deliveryMethod: type: integer format: int32 eventId: type: integer format: int32 eventTopicGuid: type: - string - 'null' readOnly: true guid: type: - string - 'null' readOnly: true name: type: - string - 'null' placeHolder: type: - string - 'null' additionalProperties: false TopicListResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/TopicList' 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 - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false EventSubscriptionCreateResponse: type: object properties: data: type: - array - 'null' items: type: - object - 'null' 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 - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false TopicList: type: object properties: guid: type: - string - 'null' readOnly: true topicId: type: integer format: int32 name: type: - string - 'null' 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 WebHookHeader: type: object properties: key: type: - string - 'null' description: Webhook header key. value: type: - string - 'null' description: Webhook header value. additionalProperties: false EventTemplateCreateResponse: type: object properties: data: type: - array - 'null' items: type: - object - 'null' 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 - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false RefData: type: object properties: userguids: type: - array - 'null' items: type: string description: User guid list for event audience roleguids: type: - array - 'null' items: type: string description: Role guid list for event audience command: $ref: '#/components/schemas/CommandData' webhook: $ref: '#/components/schemas/WebHookConfig' templateGuids: type: - array - 'null' items: type: string additionalProperties: false EventList: type: object properties: autoSubscribed: type: boolean deliveryMethod: type: integer format: int32 eventId: type: integer format: int32 eventTopicGuid: type: - string - 'null' readOnly: true guid: type: - string - 'null' readOnly: true name: type: - string - 'null' placeHolder: type: - string - 'null' severityLevel: type: - string - 'null' subscriptionCount: type: integer format: int32 additionalProperties: false EventNotificationHubDetail: type: object properties: connectionString: type: - string - 'null' hubName: type: - string - 'null' cpId: type: - string - 'null' additionalProperties: false EventSubscriptionCreateRequest_2: required: - deliveryMethod - severityLevelGuid type: object properties: eventGuid: type: - string - 'null' description: "Event Guid, \nNote : EventGuid or EventName is required" eventName: maxLength: 100 type: - string - 'null' description: 'Event Name, Note : EventGuid or EventName is required' deliveryMethod: type: array items: type: string description: 'Delivery Method Eg: MQTT, UI Alert, Push, SignalR, DeviceCommand, WebHook, Email etc.' refData: $ref: '#/components/schemas/RefData' severityLevelGuid: minLength: 1 type: string description: Severity Level Guid refGuid: type: - string - 'null' description: 'Ref guid, Eg: RuleGuid' additionalProperties: false WebHookConfigWithData: type: object properties: data: type: - string - 'null' description: Webhook test data. url: type: - string - 'null' description: Webhook url. headers: type: - array - 'null' items: $ref: '#/components/schemas/WebHookHeader' description: Webhook headers. additionalProperties: false RegisteredDevicesRequest_2: 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: 100 type: - string - 'null' additionalProperties: false EventNotificationHubDetailResponse: type: object properties: data: $ref: '#/components/schemas/EventNotificationHubDetail' 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 - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false securitySchemes: Bearer: type: apiKey description: Please enter JWT with Bearer into field name: Authorization in: header x-refined-from: - avnet-iotconnect-event-aws-prod-swagger.json - avnet-iotconnect-event-azure-prod-swagger.json