Event Calendar

analyze.eventcalendar.calendar(calendar_id)

Provides detaild calendar information

Parameters

calendar_id (str) – Unique calendar identifier

Returns

None

analyze.eventcalendar.calendars(id_filter)

Provides a list of calendars in the workspace

Parameters

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

Returns

None

analyze.eventcalendar.copy(calendar_id, rollup_id, after_position)

Deletes an event calendar

Parameters
  • calendar_id (str) – Unique calendar identifier

  • rollup_id (str) – Unique rollup identifier

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

Returns

None

analyze.eventcalendar.create(path, name, memo)

Creates an event calendar

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

  • name (str) – The object name

  • memo (str) – The object description

Returns

None

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

Creates a folder in the event calendar 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.eventcalendar.delete(calendar_id)

Deletes an event calendar

Parameters

calendar_id (str) – Unique calendar identifier

Returns

None

analyze.eventcalendar.delete_rollup(rollup_id)

Deletes a folder and its contents in the event calendar hierarchy

Parameters

rollup_id (str) – Unique rollup identifier

Returns

None

analyze.eventcalendar.id_from_path(path)

Provides the canonical id for the from a provided path

Parameters

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

Returns

None

analyze.eventcalendar.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.eventcalendar.move(calendar_id, rollup_id, after_position)

Deletes an event calendar

Parameters
  • calendar_id (str) – Unique calendar identifier

  • rollup_id (str) – Unique rollup identifier

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

Returns

None

analyze.eventcalendar.paths_from_id(calendar_id)

Provides a list of paths associated with the cannonical id

Parameters

calendar_id (str) – Unique calendar identifier

Returns

None

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

Returns list of event calendars 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.eventcalendar.steps_from_path(path)

Provides list of event calendars 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.eventcalendar.update(calendar_id, name, memo)

Updates and event calendar name and memo

Parameters
  • calendar_id (str) – Unique calendar identifier

  • name (str) – The object name

  • memo (str) – The object description

Returns

None

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

Updates a folder name in the event calendar 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