notification#

Autogenerated API

argus_api.lib.notifications.v2.notification.get_notifications(limit: int = 25, offset: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Returns a list of current user’s notifications (DEV)

Parameters

  • limit (int) – Limit number of results

  • offset (int) – Offset results

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.notifications.v2.notification.notification_bulk_seen(notificationIDs: str = None, endTimestamp: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Marks notifications as seen, either by timestamp or specified ids (DEV)

Parameters

  • notificationIDs (list) – UUID of notifications to mark as seen. If empty or null, all are set to seen.

  • endTimestamp (int) – Timestamp on the day until which to mark notifications as seen. Defaults to time of request.

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.notifications.v2.notification.notification_seen(notificationID: str, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Marks a single notification as seen (DEV)

Parameters

  • notificationID (str) – Notification ID

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.notifications.v2.notification.search_notifications(user: str = None, startTimestamp: int = None, endTimestamp: int = None, includeFlags: str = None, excludeFlags: str = None, channels: str = None, service: str = None, operation: str = None, objectID: str = None, objectCustomer: str = None, limit: int = 25, offset: int = None, includeContext: bool = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Returns a list of current user’s notifications matching the search criteria (DEV)

Parameters

  • user (list) – Restrict search to return notifications generated by specified users. Can be shortnames or userIds.

  • startTimestamp (int) – Restrict search to return notifications created after the timestamp. Defaults to no restrictions.

  • endTimestamp (int) – Restrict search to return notifications created before the timestamp. Defaults to now.

  • includeFlags (list) – Restrict search to return notifications which have the specified flags set.

  • excludeFlags (list) – Restrict search to return notifications which have the specified flags unset.

  • channels (list) – Restrict search to return notifications which was attempted to send in at least one off the specified channels. Defaults to no channel restrictions.

  • service (list) – Limit to notifications generated by the specified Argus services.

  • operation (list) – Limit to notifications generated by the specified Argus operations

  • objectID (list) – Limit to notification generated by the specified set of Argus objects by their IDs

  • objectCustomer (list) – Limit to notifications generated by the specified customers. Can be a list of shortnames and/or customerIDs

  • limit (int) – Limit number of returning notifications. (default 25)

  • offset (int) – Offset notifications (default 0)

  • includeContext (bool) – Specify if service specific notification context should be included (default false)

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON