zOGI

[RoadMap] Clients OIE [QuickStart] [Development] [Administration]

• The zOGI API
  • Methods
• Related Pages

The zOGI API

The zOGI API is implemented in the coils.net.zogi.ZOGIAPI class. And instance of this class is created and calls to zOGI API calls mapped to its methods. This API is exposed via [RPC2] and [jsonrpc] protocol bundles. [RPC2] provides the zOGI API via XML-RPC and [jsonrpc] provides the same API via JSON-RPC 1.1. zOGI API calls in either XML-RPC or JSON-RPC use the Omphalos form for entity representation and serialization.

Methods

• [zogi.deleteObject](payload, flags={}) - delete an object
• [zogi.flagFavorites](ids) - mark objects as favorites
• [zogi.getAnchor](anchor) - retrieve a synchronization anchor
• [zogi.getAuditEntries](floor) - retrieve audit entries
• [zogi.getFavoritesByType](kind, detail) - retrieve objects of a type which are flagged as favorites
• [zogi.getLoginAccount](detail=65535) - retrieve the currently authenticated account
• [zogi.getNotifications](start, end) - retrieve notifications pending between two datetimes
• [zogi.getObjectById](object_id, detail_level, flags = {}) - retrieve an object by objectId
• [zogi.getObjectsById](object_ids, detail_level, flags={}) - retrieve an array of objects by objectids
• [zogi.getObjectVersionsById](ids) - retrieve the revision count of a specified array of objects
• [zogi.getSchedule]() - retrieve the current workflow schedule
• [zogi.getTombstone](object_id) - retrieve the tombstone of a specified object
• [zogi.getTypeOfObject](object_id) - lookup the type of an object
• [zogi.listObjectsByType](kind, list_name) - retrieve a named list of objects
• [zogi.listPrincipals]() - retrieve the current list of security principals
• [zogi.putObject](payload) - store an object, either create or update.
• [zogi.searchForObjects](kind, criteria, detail, flags=None) - search for objects based upon criteria.
• [zogi.unflagFavorites](ids) - remove favorite status from a specified set of objects.

Related Pages

• Make ToDo List Operations Faster