objectAPI Reference

The objectAPI services are divided into categories that describe the functions in the service.

The available objectAPI services are:

AuditService
Functions to to manage purges of audit entries, submit events for audit by Event Collector, and get audit information from the Event Collector database tables.
BusinessDeadlineService
A function to calculate the deadline for completing a specified task, based on a given calendar.
BusinessServiceService
Functions to get information about and interact with deployed business services.
CaseActionService
A function that lists the case actions for the specified case reference.
DirectoryService
Functions to manage LDAP containers and to get information about LDAP connections.
DocumentService
Use this service to perform functions with case folders, which are used to store documents associated with a case.
DynamicResourceQueryService
Functions to reset dynamic resource queries.
EntityResolverService
A function to locate a resource by LDAP DN.
ExporterService
Functions to export and import defined LDAP containers, resource mappings, and push destinations.
GlobaldataAdminService
Functions to get information about and administer case models.
GlobaldataService
Functions to create, read, update and delete case data. You can also perform searches on case data based on specific criteria.
OrgEntityConfigService
Functions to manage resource configuration attributes and to get or set them for individual resources.
OrgModelService
Functions to get information about organization models, as well as get or set information for calendars, push destinations, extension points, and candidate queries that are tied to a particular organization model.
OrgResourceService
Functions to manage resources, such as creating, deleting, finding, and updating resources.
PageFlowService
Functions to get information about and interact with deployed PageFlows.
ProcessManagementService
Functions to manage process templates and process instances.
ResourceQueryService
Functions to execute a Resource Query Language (RQL) query to find a set of resources that match specific criteria.
RoleService
Functions related to roles, which are used to control access to applications, as well as access to specific functionality within an application.
SecurityService
Functions to manage user authorization.
StatisticsService
Function to request a process template measure from the Event Collector database tables.
UserSettingsService
Functions to manage user settings.
WorkCalService
Functions to create, delete, edit, and get information about base and overlay calendars and the time zones and calendar entries that they use.
WorkItemManagementService
Functions to perform actions on work items.
WorkListService
Functions to get work item lists for organization model entities, and to get or to set sort/filter criteria for work item lists.
WorkPresentationService
Functions to perform various operations on work items.