case#

Autogenerated API

argus_api.lib.events.v2.case.case.list_events_by_case(caseID: int, includeProperties: str = None, sortBy: str = None, limit: int = 25, includeAllProperties: bool = None, includeComments: bool = None, includeSubEvents: bool = None, 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#

Lists events associated with the case (DEV)

Parameters

  • caseID (int) – Case ID

  • includeProperties (list) – Which event properties to include (if includeAllProperties=false).

  • sortBy (list) – Fields to sort events by (without sign is ascending, with ‘-’ sign is descending).

  • limit (int) – The max amount of events to return (0 means no limit)

  • includeAllProperties (bool) – Whether to include all properties of events (overrides the selection of ‘includeProperties’ if set to true).

  • includeComments (bool) – Whether to include comments of events.

  • includeSubEvents (bool) – Whether to include sub-events’ IDs.

  • offset (int) – The amount of events to skip from the beginning

  • 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

requests.Response object or dictionary translated from JSON