HoxtonAi
Powered by Redocly

Notification Group Mappings

APIs to manage an organisation's notification group links.

Create/Update notification group notification group

Update existing notification group link, create a new one otherwise.

Securityo_auth
Request
Request Body schema: application/json
required

A link between two notification groups.

childId
required
string <uuid>
id
string or null <uuid>
organisationId
required
string <uuid>
parentId
required
string <uuid>
state
string
Enum: "active" "deleted"
Responses
201

OK.

204

OK.

400

Bad request.

401

Authentication failed.

403

Not allowed.

410

Gone.

422

Unprocessable entity.

500

Failed.

501

Not implemented.

put/notification-group-notification-groups
Request samples
application/json
{
  • "childId": "da54978f-5a21-4efd-948e-3959f61b037a",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
  • "state": "active"
}
Response samples
application/json
{
  • "childId": "da54978f-5a21-4efd-948e-3959f61b037a",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
  • "state": "active"
}

Delete notification group notification group

Set the state of a notification group link to deleted.

Securityo_auth
Request
path Parameters
notificationGroupNotificationGroupId
required
string <uuid>

the ID of the notification group link to delete.

Responses
204

OK.

400

Bad request.

401

Authentication failed.

403

Not allowed.

404

Not found.

410

Gone.

422

Unprocessable entity.

500

Failed.

501

Not implemented.

delete/notification-group-notification-groups/{notificationGroupNotificationGroupId}
Request samples 
Response samples 
application/json
{
  • "code": 0,
  • "message": "string"
}
Get notification group notification group
Get a notification group link identified by the provided ID.


Securityo_auth 
Request 
path Parameters
notificationGroupNotificationGroupId
required
string <uuid> 
The ID of the notification group link to get.


 
Responses 
200
OK.


401
Authentication failed.


403
Not allowed.


404
Not found.


422
Unprocessable entity.


500
Failed.


501
Not implemented.


get/notification-group-notification-groups/{notificationGroupNotificationGroupId}
Request samples 
Response samples 
application/json
{
  • "childId": "da54978f-5a21-4efd-948e-3959f61b037a",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
  • "state": "active"
}
List notification group notification groups
Get all notification groups link subject to filters.


Securityo_auth 
Request 
query Parameters
notificationGroupNotificationGroupId
string <uuid> 
The ID of the notification group link to get.


 
parentNotificationGroupId
string <uuid> 
The ID of the parent notification group to get all nested child IDs.


 
childNotificationGroupId
string <uuid> 
The ID of the child notification group to get all ancestral IDs.


 
organisationId
string <uuid> 
The ID of the organisation the notification group links are linked to.


 
state
string
The state of the notification group notification group link.


 Enum: "active" "deleted"  
Responses 
200
OK.


401
Authentication failed.


403
Not allowed.


422
Unprocessable entity.


500
Failed.


501
Not implemented.


get/notification-group-notification-groups
Request samples 
Response samples 
application/json
[
  • {
    }
]