GET /notification
Get the notification using notificationId and (optionally) groupId
You must authenticate using an access token with the Authorization:accessToken
header to use this endpoint.
Parameters Name In Type Required Description notificationId query string true The notification identifier groupId query string false The group identifier
Responses POST /notification
Create a Notification
You must authenticate using an access token with the Authorization:accessToken
header to use this endpoint.
Body parameter
{
"groupId" : "string" ,
"params" : "string" ,
"type" : "string" ,
"name" : "string" ,
"description" : "string" ,
"deviceId" : "string" ,
"reason" : "string" ,
"schedule" : {
"Day" : 0 ,
"From" : {
"Hours" : 0 ,
"Minutes" : 0 ,
"Secondes" : 0
} ,
"To" : {
"Hours" : 0 ,
"Minutes" : 0 ,
"Secondes" : 0
}
} ,
"deviceTypes" : [
"string"
] ,
"tags" : [
"string"
]
}
Parameters
Responses PUT /notification
Update a Notification
You must authenticate using an access token with the Authorization:accessToken
header to use this endpoint.
Body parameter
{
"notificationId" : "string" ,
"groupId" : "string" ,
"params" : "string" ,
"name" : "string" ,
"description" : "string" ,
"type" : "string" ,
"deviceId" : "string" ,
"reason" : "string" ,
"schedule" : {
"Day" : 0 ,
"From" : {
"Hours" : 0 ,
"Minutes" : 0 ,
"Secondes" : 0
} ,
"To" : {
"Hours" : 0 ,
"Minutes" : 0 ,
"Secondes" : 0
}
} ,
"enabled" : true ,
"deviceTypes" : [
"string"
] ,
"tags" : [
"string"
]
}
Parameters
Responses DELETE /notification
Delete a Notification
You must authenticate using an access token with the Authorization:accessToken
header to use this endpoint.
Parameters Name In Type Required Description name query string true UnaConnect Group Id notificationId query string true The id of the notification
Responses GET /notification/notificationType
Get a notification Type
You must authenticate using an access token with the Authorization:accessToken
header to use this endpoint.
Parameters Name In Type Required Description type query string true none
Responses Get the list of notification types
GET /notification/notificationTypes
Get the list of all UnaConnect notification types
You must authenticate using an access token with the Authorization:accessToken
header to use this endpoint.
Parameters Name In Type Required Description limit query integer false The maximum number of items to retrieve nextToken query string false The key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.
Responses Status Meaning Description Schema 200 OK The list of notification types Inline 400 Bad Request Bad request None
Response Schema Status Code 200
Get the list of notification of the user per groupId
GET /notification/notifications
Get the list of notification of the user per groupId
You must authenticate using an access token with the Authorization:accessToken
header to use this endpoint.
Parameters Name In Type Required Description groupId query string false The group identifier limit query integer false The maximum number of items to retrieve nextToken query string false The key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.
Responses Schemas
GenericReturn {
"message" : "string"
}
Name Type Required Restrictions Description message string false none none
GenericReturnBoolean {
"message" : "string" ,
"value" : true
}
Name Type Required Restrictions Description message string false none none value boolean false none none
RetryPolicy {
"retryDelay" : 0 ,
"maxRetry" : 0
}
Name Type Required Restrictions Description retryDelay integer false none none maxRetry integer false none none
DataFailurePolicy {
"strongDuration" : 0 ,
"hasData" : true ,
"startTime" : "2019-08-24" ,
"resending" : true
}
Name Type Required Restrictions Description strongDuration integer false none none hasData boolean false none none startTime string(date) false none none resending boolean false none none
Notification {
"groupId" : "string" ,
"id" : "string" ,
"name" : "string" ,
"description" : "string" ,
"params" : "string" ,
"type" : "string" ,
"createdAt" : "2019-08-24" ,
"updatedAt" : "2019-08-24" ,
"updatedBy" : "string" ,
"createdBy" : "string" ,
"deviceId" : "string" ,
"deviceTypes" : [
"string"
] ,
"reason" : "string" ,
"schedule" : "string" ,
"enabled" : true ,
"tags" : [
"string"
]
}
Name Type Required Restrictions Description groupId string true none none id string true none none name string false none none description string false none none params string true none none type string true none none createdAt string(date) true none none updatedAt string(date) true none none updatedBy string true none none createdBy string true none none deviceId string false none none deviceTypes [string] false none none reason string false none none schedule string false none none enabled boolean false none none tags [string] false none none
NotificationConnection {
"items" : [
{
"groupId" : "string" ,
"id" : "string" ,
"name" : "string" ,
"description" : "string" ,
"params" : "string" ,
"type" : "string" ,
"createdAt" : "2019-08-24" ,
"updatedAt" : "2019-08-24" ,
"updatedBy" : "string" ,
"createdBy" : "string" ,
"deviceId" : "string" ,
"deviceTypes" : [
"string"
] ,
"reason" : "string" ,
"schedule" : "string" ,
"enabled" : true ,
"tags" : [
"string"
]
}
] ,
"nextToken" : "string"
}
Name Type Required Restrictions Description items [Notification ] false none none
NotificationType {
"expectedParameters" : "string" ,
"type" : "string" ,
"name" : "string"
}
Name Type Required Restrictions Description expectedParameters string true none none type string true none none name string false none none
NotificationTypeConnection {
"items" : [
{
"expectedParameters" : "string" ,
"type" : "string" ,
"name" : "string"
}
] ,
"nextToken" : "string"
}
Time {
"Hours" : 0 ,
"Minutes" : 0 ,
"Secondes" : 0
}
Name Type Required Restrictions Description Hours integer true none none Minutes integer true none none Secondes integer false none none
Schedule {
"Day" : 0 ,
"From" : {
"Hours" : 0 ,
"Minutes" : 0 ,
"Secondes" : 0
} ,
"To" : {
"Hours" : 0 ,
"Minutes" : 0 ,
"Secondes" : 0
}
}
Name Type Required Restrictions Description Day integer true none none
{
"groupId" : "string" ,
"params" : "string" ,
"type" : "string" ,
"name" : "string" ,
"description" : "string" ,
"deviceId" : "string" ,
"reason" : "string" ,
"schedule" : {
"Day" : 0 ,
"From" : {
"Hours" : 0 ,
"Minutes" : 0 ,
"Secondes" : 0
} ,
"To" : {
"Hours" : 0 ,
"Minutes" : 0 ,
"Secondes" : 0
}
} ,
"deviceTypes" : [
"string"
] ,
"tags" : [
"string"
]
}
Name Type Required Restrictions Description groupId string true none none params string true none none type string true none none name string true none none description string false none none deviceId string false none none reason string false none none
{
"notificationId" : "string" ,
"groupId" : "string" ,
"params" : "string" ,
"name" : "string" ,
"description" : "string" ,
"type" : "string" ,
"deviceId" : "string" ,
"reason" : "string" ,
"schedule" : {
"Day" : 0 ,
"From" : {
"Hours" : 0 ,
"Minutes" : 0 ,
"Secondes" : 0
} ,
"To" : {
"Hours" : 0 ,
"Minutes" : 0 ,
"Secondes" : 0
}
} ,
"enabled" : true ,
"deviceTypes" : [
"string"
] ,
"tags" : [
"string"
]
}
Name Type Required Restrictions Description notificationId string true none none groupId string true none none params string false none none name string false none none description string false none none type string false none none deviceId string false none none reason string false none none
{
"expectedParameters" : "string" ,
"type" : "string"
}
Name Type Required Restrictions Description expectedParameters string true none none type string true none none
{
"groupId" : "string" ,
"notificationId" : "string"
}
Name Type Required Restrictions Description groupId string true none none notificationId string true none none
{
"type" : "string"
}
Name Type Required Restrictions Description type string true none none