Organization User Notification Resource

gsn_notification resources are messages sent to organization users. Examples of org_user notification errors are:

• Trigger start and stop notifications
  

Notification category types:

• INFO
• WARNING
• CRITICAL
  

GET gs_notification/org_user/{gsnUid}

---

Get the GroveStreams notification with the specified uid.	Resource Information
	Rate Limited?	No
	session, oauth and org tokens compatible?	Yes
	api_key compatible?	Yes

Parameters

datetime

required

The datetime (UTC epoch millis) of the notification

Example Requests

/gs_notification/org_user/8af0bfc0-2ce8-47a9-be96-5754ea734c1a

Response Body

{
  "message": "",
  "gs_notification": {
    "uid": "8af0bfc0-2ce8-47a9-be96-5754ea734c1a",
    "to": "a@a.com,b@b.com",
    "body": "notification body",
    "eventUid": "26fb0502-ff10-36fb-afc6-c423a0d5b2d6",
    "subject": "notification subject",
    "item": {
      "itemName": "",
      "cycleName": "",
      "cycleUid": "",
      "componentName": "",
      "stats": "",
      "itemType": "stream",
      "componentUid": "389e2770-affe-3d15-859e-0857d206e805",
      "extraData": "",
      "itemUid": "0fffe14b-dc0a-39cd-b2a6-3d7b222b1781"
    },
    "acknowledged": false,
    "categoryType": "WARN",
    "actionUid": "e3a772e8-fdd6-3172-a98a-7774455007b6",
    "date": 1335922280325
  },
  "success": true
}

GET gs_notification/org_user

---

Returns a list of gs_notification/org_user resources.	Resource Information
	Rate Limited?	No
	session, oauth and org tokens compatible?	Yes
	api_key compatible	Yes

Parameters

filter

optional

Applies enabled filters. Defaults to false if missing.

Example Requests

/gs_notification/org_user

Response Body

{
  "message": "",
  "totalCount": 2,
  "gs_notification": [
    {
      "uid": "4bc58a68-1934-3a1d-bf13-fdce88368009",
      "subject": "notification subject",
      "acknowledged": false,
      "categoryType": "WARN",
      "date": 1335923526568
    },
    {
      "uid": "f1eea163-30d4-3b73-8c7b-50eb437dce4b",
      "subject": "notification subject",
      "acknowledged": false,
      "categoryType": "WARN",
      "date": 1335923526568
    }
  ],
  "success": true
}

POST gs_notification/org_user

---

Bulk deletes a collection of notifications	Resource Information
	Rate Limited?	Yes
	session, oauth and org tokens compatible?	Yes
	api_key compatible	Yes

Parameters

Example Requests

/gs_notification/system

  Request Body
{
  "gs_notification": [
    {
      "uid": "a682cf8c-cb52-3aa4-b3ca-7a55a5b2b6c2",
      "date": 1337675714029
    },
    {
      "uid": "fae69063-c371-342d-91a6-30f90adf0b5f",
      "date": 1337672114029
    },
    {
      "uid": "a06b16d9-d690-3f68-b426-8417f904826e",
      "date": 1337679314029
    }
  ]
}

GET gs_notification/new_count

---

Returns a count of unacknowledged user, system, and job notifications. This call respects security role of the user. No counts will be returned for Guest users. No system or job counts will be returned for users who do not have observation studio rights.	Resource Information
	Rate Limited?	No
	session, oauth and org tokens compatible?	Yes
	api_key compatible	Yes

Parameters

none

Example Requests

/gs_notification/org_user

Response Body

{
  "message": "",
  "totalCount": 2,
  "gs_notification": [
    {
      "uid": "4bc58a68-1934-3a1d-bf13-fdce88368009",
      "subject": "notification subject",
      "acknowledged": false,
      "categoryType": "WARN",
      "date": 1335923526568
    },
    {
      "uid": "f1eea163-30d4-3b73-8c7b-50eb437dce4b",
      "subject": "notification subject",
      "acknowledged": false,
      "categoryType": "WARN",
      "date": 1335923526568
    }
  ],
  "success": true
}

POST gs_notification/org_user/{gsnUid}/acknowledge

---

Marks a notification as acknowledged. The acknowledged flag is only used by the user interface.	Resource Information
	Rate Limited?	Yes
	session, oauth and org tokens compatible?	Yes
	api_key compatible	Yes

Parameters

datetime

required

The datetime (UTC epoch millis) of the notification

Example Requests

/gs_notification/org_user/2f22b3d2-7d26-3d81-9653-aa9d6a265670/acknowledge

Response Body
{
  "message": "Acknowledged gs_notification with uid '2f22b3d2-7d26-3d81-9653-aa9d6a265670'",
  "success": true
}

DELETE gs_notification/org_user/{gsnUid}

---

Deletes a notification.	Resource Information
	Rate Limited?	Yes
	session, oauth and org tokens compatible?	Yes
	api_key compatible	Yes

Parameters

datetime

required

The datetime (UTC epoch millis) of the notification

Example Requests

/gs_notification/org_user/8af0bfc0-2ce8-47a9-be96-5754ea734c1a

Response Body

{
  "message": "Deleted gs_notification with uid '8af0bfc0-2ce8-47a9-be96-5754ea734c1a'",
  "success": true
}