transaction#

Autogenerated API

argus_api.lib.notifications.v2.transaction.prepare_notification_transaction(recipients: dict = None, objectCustomer: str = None, objectID: str = None, service: str = None, operation: str = None, requestContext: dict = 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#

Prepare a new notification transaction. This endpoint is NOT meant for users, only for applications on behalf of a user. (DEV)

Parameters
  • recipients (list) – List of user and email recipients to notify.

  • objectCustomer (str) – Id or shortname for customer of the object this notification is related to.If notification is not customer relevant, this may not be set.

  • objectID (str) – Which Argus object (case, document, sensor, asset, etc.) generated the notification. Is not required, as some operations will not have a corresponding Argus object.

  • service (str) – What service generated the notification.

  • operation (str) – What operation generated the notification.

  • requestContext (dict) –

  • 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