Notification

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

NameInTypeRequiredDescription
notificationIdquerystringtrueThe notification identifier
groupIdquerystringfalseThe group identifier

Responses

StatusMeaningDescriptionSchema
200OKSuccess responseNotification
400Bad RequestBad requestNone

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

NameInTypeRequiredDescription
bodybodyNotificationInputtruenone

Responses

StatusMeaningDescriptionSchema
200OKSuccess responseNotification
400Bad RequestBad requestNone

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

NameInTypeRequiredDescription
bodybodyUpdateNotificationInputtruenone

Responses

StatusMeaningDescriptionSchema
200OKSuccess responseNotification
400Bad RequestBad requestNone

DELETE /notification
Delete a Notification
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.

Parameters

NameInTypeRequiredDescription
namequerystringtrueUnaConnect Group Id
notificationIdquerystringtrueThe id of the notification

Responses

StatusMeaningDescriptionSchema
200OKSuccess responseNotification
400Bad RequestBad requestNone

GET /notification/notificationType
Get a notification Type
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.

Parameters

NameInTypeRequiredDescription
typequerystringtruenone

Responses

StatusMeaningDescriptionSchema
200OKreturning notificationType successfullyNotificationType
400Bad RequestBad requestNone

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

NameInTypeRequiredDescription
limitqueryintegerfalseThe maximum number of items to retrieve
nextTokenquerystringfalseThe 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

StatusMeaningDescriptionSchema
200OKThe list of notification typesInline
400Bad RequestBad requestNone

Response Schema

Status Code 200
NameTypeRequiredRestrictionsDescription
anonymous[NotificationTypeConnection]falsenonenone

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

NameInTypeRequiredDescription
groupIdquerystringfalseThe group identifier
limitqueryintegerfalseThe maximum number of items to retrieve
nextTokenquerystringfalseThe 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

StatusMeaningDescriptionSchema
200OKSuccess responseNotificationConnection
400Bad RequestBad requestNone

Schemas

GenericReturn

{
  "message": "string"
}

NameTypeRequiredRestrictionsDescription
messagestringfalsenonenone

GenericReturnBoolean

{
  "message": "string",
  "value": true
}

NameTypeRequiredRestrictionsDescription
messagestringfalsenonenone
valuebooleanfalsenonenone

RetryPolicy

{
  "retryDelay": 0,
  "maxRetry": 0
}

NameTypeRequiredRestrictionsDescription
retryDelayintegerfalsenonenone
maxRetryintegerfalsenonenone

DataFailurePolicy

{
  "strongDuration": 0,
  "hasData": true,
  "startTime": "2019-08-24",
  "resending": true
}

NameTypeRequiredRestrictionsDescription
strongDurationintegerfalsenonenone
hasDatabooleanfalsenonenone
startTimestring(date)falsenonenone
resendingbooleanfalsenonenone

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"
  ]
}

NameTypeRequiredRestrictionsDescription
groupIdstringtruenonenone
idstringtruenonenone
namestringfalsenonenone
descriptionstringfalsenonenone
paramsstringtruenonenone
typestringtruenonenone
createdAtstring(date)truenonenone
updatedAtstring(date)truenonenone
updatedBystringtruenonenone
createdBystringtruenonenone
deviceIdstringfalsenonenone
deviceTypes[string]falsenonenone
reasonstringfalsenonenone
schedulestringfalsenonenone
enabledbooleanfalsenonenone
tags[string]falsenonenone

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"
}

NameTypeRequiredRestrictionsDescription
items[Notification]falsenonenone

NotificationType

{
  "expectedParameters": "string",
  "type": "string",
  "name": "string"
}

NameTypeRequiredRestrictionsDescription
expectedParametersstringtruenonenone
typestringtruenonenone
namestringfalsenonenone

NotificationTypeConnection

{
  "items": [
    {
      "expectedParameters": "string",
      "type": "string",
      "name": "string"
    }
  ],
  "nextToken": "string"
}

NameTypeRequiredRestrictionsDescription
items[NotificationType]falsenonenone

Time

{
  "Hours": 0,
  "Minutes": 0,
  "Secondes": 0
}

NameTypeRequiredRestrictionsDescription
Hoursintegertruenonenone
Minutesintegertruenonenone
Secondesintegerfalsenonenone

Schedule

{
  "Day": 0,
  "From": {
    "Hours": 0,
    "Minutes": 0,
    "Secondes": 0
  },
  "To": {
    "Hours": 0,
    "Minutes": 0,
    "Secondes": 0
  }
}

NameTypeRequiredRestrictionsDescription
Dayintegertruenonenone

NotificationInput

{
  "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"
  ]
}

NameTypeRequiredRestrictionsDescription
groupIdstringtruenonenone
paramsstringtruenonenone
typestringtruenonenone
namestringtruenonenone
descriptionstringfalsenonenone
deviceIdstringfalsenonenone
reasonstringfalsenonenone

UpdateNotificationInput

{
  "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"
  ]
}

NameTypeRequiredRestrictionsDescription
notificationIdstringtruenonenone
groupIdstringtruenonenone
paramsstringfalsenonenone
namestringfalsenonenone
descriptionstringfalsenonenone
typestringfalsenonenone
deviceIdstringfalsenonenone
reasonstringfalsenonenone

NotificationTypeInput

{
  "expectedParameters": "string",
  "type": "string"
}

NameTypeRequiredRestrictionsDescription
expectedParametersstringtruenonenone
typestringtruenonenone

DeleteNotificationInput

{
  "groupId": "string",
  "notificationId": "string"
}

NameTypeRequiredRestrictionsDescription
groupIdstringtruenonenone
notificationIdstringtruenonenone

DeleteNotificationTypeInput

{
  "type": "string"
}

NameTypeRequiredRestrictionsDescription
typestringtruenonenone