Home       Trees       Indices       Help   
Package cm_api :: Package endpoints :: Module events
[hide private]
[frames] | no frames]

Module events

source code

Classes [hide private]
  ApiEvent
  ApiEventQueryResult
Functions [hide private]
 
query_events(resource_root, query_str=None)
Search for events.		 source code
 
get_event(resource_root, event_id)
Retrieve a particular event by ID.		 source code
Variables [hide private]
  EVENTS_PATH = '/events'
  __package__ = 'cm_api.endpoints'
Function Details [hide private]

query_events(resource_root, query_str=None)

source code 

Search for events.

Parameters:
  • query_str - Query string.
Returns:
A list of ApiEvent.

get_event(resource_root, event_id)

source code 

Retrieve a particular event by ID.

Parameters:
  • event_id - The event ID.
Returns:
An ApiEvent.

   Home       Trees       Indices       Help   
Generated by Epydoc 3.0.1 on Mon Apr 17 11:15:59 2017 http://epydoc.sourceforge.net