Cisco Cisco TelePresence MCU 4510 Developer's Guide

Page of 223
API reference
Cisco TelePresence MCU API 2.9
Page 25 of 223
The call deletes all whole log files whose highest log indexes are lower than the supplied
deleteIndex.
Input parameters
Parameter name
Type
Short description
deleteIndex (CDR log)
integer
An event identifier that selects which whole CDR files will
be deleted. Any whole files whose highest index is below
the supplied value will be deleted from CDR log storage. If
you supply the value returned in
cdrlog.query.deleteableIndex, you will delete all the
files stored at the time of that query.
cdrlog.enumerate
This call allows the calling application to download CDR log data without having to return the entire CDR log.
The call returns a subset of the CDR log based on the optional
filterindex and numEvents parameters.
Note: The
describes the CDR log in its XML form, as downloaded in cdr_log.xml
via the web interface. When the same events are enumerated with this call, the event type names use
camelCase for multiple words rather than using underscores. For example,
conference_finished in cdr_
log.xml is the same event type as
conferenceFinished in this response.
Input parameters
Optional or conditional inputs
Parameter name
Type
Short description
filter
array
An array of strings, which contain the names of event types
by which to filter the response. Omit filter to return all
event types or include a subset of the following:
scheduledConferenceStartedad-
hocConferenceStarted
conferenceFinished,
participantJoinedparticipantLeft
index (CDR log enumerate call)
integer
Index from which to get events. The device returns the
nextIndex so the application can use it to retrieve the
next enumeration of CDR data.
If
index is omitted, negative, or greater (by 2 or more) than
the highest index, then the device will enumerate events
from the beginning of the CDR log.
numEvents (per enumeration)
integer
Specifies maximum number of events to be returned per
enumeration. If omitted (or not between 1 - 20 inclusive), a
maximum of 20 events will be returned per enumeration.
Returned data
The response provides reference information such as time and log position, and an array of events that meet
the parameters provided in the call. If there are no events to enumerate, the
events array is returned empty.