Cisco Cisco Meeting Server 2000 开发者指南

Response elements

Type/Value

Description/Notes

numUsersImported

Number

The number of users imported so far for an in-progress
LDAP sync

numLdapSourcesComplete

Number

The number of LDAP sources for which the sync method
has been completed for an in-progress LDAP sync of
multiple LDAP sources. However if the first LDAP source
synchronization is still in progress so that
numLdapSourcesComplete=0, then the parameter is
omitted

11.4.2 Initiating a new LDAP sync

POST method on the "/ldapSyncs" node. If neither parameter in the following table is included,
the sync is equivalent to the Sync now button on the Web Admin Interface Configuration >
Active Directory page.

Parameters

Type/Value

Description/Notes

tenant

Text

If supplied the sync will be restricted to that tenant

ldapSource

ID

If supplied the sync will be restricted to that LDAP Source

removeWhenFinished

true|false

n

true - this LDAP sync will, when it has finished (either successfully or
with an error), be removed from the system's tracked list, and so can
no longer be queried

n

false - this LDAP sync will persist in the system's tracked list when it
has finished, at which point its success or failure status may then be
queried. To avoid it remaining permanently on the system's tracked
list, it needs to be deleted explicitly.

if this parameter is not supplied in a create (POST) operation, it defaults to
"true".

If a new LDAP synchronization happens successfully, the response will include a "Location" of
the form "/api/v1/ldapSyncs/<LDAPsync ID>".

11.4.3 Cancelling a scheduled LDAP sync

DELETE method on a "/ldapSyncs/<LDAP sync ID>" node. This method cancels a scheduled
LDAP sync. This method will fail if the sync method has already started (or started and
completed).

11.4.4 Retrieving information on a single LDAP sync method

GET method on an "/ldapSyncs/<LDAP sync ID>" node.