Event

analyze.event.activate(event_id)

Runs the event

Parameters

event_id (str) – Unique event identifier

Returns

None

analyze.event.add_calendar(event_id, calendar_id)

Adds a calendar to the event for use in determining holidays

Parameters
  • event_id (str) – Unique event identifier

  • calendar_id (str) – Unique calendar identifier

Returns

None

analyze.event.copy(event_id, rollup_id, after_position)

Copies an event

Parameters
  • event_id (str) – Unique event identifier

  • rollup_id (str) – Unique rollup identifier

  • after_position (int) – Position within the object rollup the object should be placed after

Returns

None

analyze.event.create(name, memo, project_id, workflow_id, enabled, schedule_type, schedule_params, time_zone, start_date, end_date, max_runs)

Creates an event

Parameters
  • name (str) – The object name

  • memo (str) – The object description

  • project_id (str) – Unique project identifier

  • workflow_id (str) – Unique workflow identifier

  • enabled (boo) – True if event is enabled for running

  • schedule_type (str) – workday or classic

  • schedule_params (dict) – Schedule parameters

  • time_zone (int) – Timezone offset

  • start_date (str) – Start date for event to begin running

  • end_date (str) – End date for event to run

  • max_runs (int) – Maximum number of times to run the event, 0 is unlimited

Returns

None

analyze.event.create_rollup(rollup_id, position, name)

Creates a folder in the event hierarchy

Parameters
  • rollup_id (str) – Unique rollup identifier

  • position (int) – The position order of the object within the rollup

  • name (str) – The object name

Returns

None

analyze.event.delete(event_id)

Deletes an event

Parameters

event_id (str) – Unique event identifier

Returns

None

analyze.event.delete_rollup(rollup_id)

Deletes a folder and its contents in the event hierarchy

Parameters

rollup_id (str) – Unique rollup identifier

Returns

None

analyze.event.disable(event_id)

Sets an event to disabled so it will not run on schedule

Parameters

event_id (str) – Unique event identifier

Returns

None

analyze.event.enable(event_id)

Sets the event to enabled for running

Parameters

event_id (str) – Unique event identifier

Returns

None

analyze.event.event(event_id)

Provides detailed event information

Parameters

event_id (str) – Unique event identifier

Returns

None

analyze.event.events(id_filter=None)

Provides list of events in the workspace

Parameters

id_filter (list) – List or tuple of object unique identifiers to which to limit the results

Returns

None

analyze.event.events_from_path(path)

Provides list of events based on a path fragment. Path fragment can be to parent level.

Parameters

path (str) – Object rollup path using unix style forward slashes

Returns

None

analyze.event.id_from_path(path)

Provides the cannonical id for the from a provided path

Parameters

path (str) – Object rollup path using unix style forward slashes

Returns

None

analyze.event.make_rollups(path)

Creates the path and all intermediate rollup points

Parameters

path (str) – Object rollup path using unix style forward slashes

Returns

None

analyze.event.move(event_id, rollup_id, after_position)

Moves an event in the hierarchy

Parameters
  • event_id (str) – Unique event identifier

  • rollup_id (str) – Unique rollup identifier

  • after_position (int) – Position within the object rollup the object should be placed after

Returns

None

analyze.event.paths_from_id(event_id)

Provides a list of paths associated with the cannonical id

Parameters

event_id (str) – Unique event identifier

Returns

None

analyze.event.remove_calendar(event_id, calendar_id)

Removes a calendar from the event for holidays

Parameters
  • event_id (str) – Unique event identifier

  • calendar_id (str) – Unique calendar identifier

Returns

None

analyze.event.search_by_name(text, criteria='contains')

Returns list of events that match the search criteria

Parameters
  • text (str) – The search text to locate

  • criteria (str) – The search criteria (contains, exact, startswith, or endswith)

Returns

None

analyze.event.update(event_id, name, memo)

Updates an event name and memo

Parameters
  • event_id (str) – Unique event identifier

  • name (str) – The object name

  • memo (str) – The object description

Returns

None

analyze.event.update_rollup(rollup_id, position, name)

Updates a folder name in the event hierarchy

Parameters
  • rollup_id (str) – Unique rollup identifier

  • position (int) – The position order of the object within the rollup

  • name (str) – The object name

Returns

None