Notification

Manage the system notifications

Method & Permission

Notification List

GET /notifications/notification/list/{level}/{sid}/{serializer}/

Get a list of notifications. You only get the notifications that sent to you.

Path Parameters

Headers

200

# serializer = name
{
    "page_size": 10,
    "page_number": 1,
    "page_count": 2,
    "count": 12,
    "next": null,
    "previous": null,
    "add_permission": true,
    "results": [
        {
            "sid": "adgj0a40xb7chmrwBGL",
            "name": "New version v5.0 released",
        },
        ...
    [
{
# serializer = list
{
    "page_size": 10,
    "page_number": 1,
    "page_count": 2,
    "count": 12,
    "next": null,
    "previous": null,
    "add_permission": true,
    "results": [
        {
            "sid": "adgj0a40xb7chmrwBGL",
            "name": "New version v5.0 released",
            "From": {
                "sid": "Labii",
                "name": "Labii"
            },
            "is_read": false,
            "change_permission": true
        },
        ...
    [
{
# serializer = detail
{
    "page_size": 10,
    "page_number": 1,
    "page_count": 2,
    "count": 12,
    "next": null,
    "previous": null,
    "add_permission": true,
    "results": [
        {
            "sid": "ILOR0a40x5dKPUZ50ej",
            "parent": null,
            "From": {
                "sid": "Labii",
                "name": "Labii"
            },
            "name": "Filter digest for My experiments on 2021-03-14",
            "body": "",
            "rows": [
                
            ],
            "is_read": true,
            "updated_by": null,
            "date_updated": "2021-03-14T20:57:37.077810Z",
            "date_created": "2021-03-14T20:57:37.073960Z",
            "change_permission": true
        },
        ...
    [
{

Notification List

POST /notifications/notification/list/{level}/{sid}/{serializer}/

Create a new notification

Path Parameters

Headers

Request Body

201

{
    "sid": "ILOR0a40x5dKPUZ50ej",
    "parent": null,
    "From": {
        "sid": "Labii",
        "name": "Labii"
    },
    "name": "Filter digest for My experiments on 2021-03-14",
    "body": "",
    "rows": [
        
    ],
    "is_read": true,
    "updated_by": null,
    "date_updated": "2021-03-14T20:57:37.077810Z",
    "date_created": "2021-03-14T20:57:37.073960Z",
    "change_permission": true
}

406

Please select at least one person or team to receive this notification

Notification Detail

GET /notifications/notification/detail/{sid}/

The view of notification will make this notification is_read=True.

Path Parameters

Headers

200

{
    "sid": "ILOR0a40x5dKPUZ50ej",
    "parent": null,
    "From": {
        "sid": "Labii",
        "name": "Labii"
    },
    "name": "Filter digest for My experiments on 2021-03-14",
    "body": "",
    "rows": [
        
    ],
    "is_read": true,
    "updated_by": null,
    "date_updated": "2021-03-14T20:57:37.077810Z",
    "date_created": "2021-03-14T20:57:37.073960Z",
    "change_permission": true
}

Notification Detail

PATCH /notifications/notification/detail/{sid}/

Path Parameters

Headers

200

{
    "sid": "ILOR0a40x5dKPUZ50ej",
    "parent": null,
    "From": {
        "sid": "Labii",
        "name": "Labii"
    },
    "name": "Filter digest for My experiments on 2021-03-14",
    "body": "",
    "rows": [
        
    ],
    "is_read": true,
    "updated_by": null,
    "date_updated": "2021-03-14T20:57:37.077810Z",
    "date_created": "2021-03-14T20:57:37.073960Z",
    "change_permission": true
}

Notification Detail

DELETE /notifications/notification/detail/{sid}/

Path Parameters

Headers

200 If there are other receivers.

{}

204 If you are the only receiver.

{}