Java API

The Java API is a set of built-in calls that are made to programmatically customize and extend the platform.

1 About the Java API

The following platform elements provide the ability to make Java API calls from the user interface (UI):

• Standard Java classes, to create custom business logic that models your organization's environment
• Data policies, by Invoking a Java Method

2 Prerequisites

You must know the Java programming language to make the Java API calls. This includes knowing the basic elements of Java such as conditional structures (if statement), looping structures (while and for loop statements), variable declaration and assignment, use of operators, variable naming conventions, debugging techniques, and so on.

Learn more about the platform:

• Getting Started with the Java API
• Java API Cheatsheet
• Java Code in the Developer Suite

Learn more about web services and programming:

• Java Programming Language
• Java Tutorial

3 Classes, Objects and APIs

Classes, Objects and APIs	Detail
Record Handling To handle records in Objects	addRecord updateRecord changeOwnerShipInfo deleteRecord searchRecords getRecord replaceTemplateVariables
Record Handling for Composite Objects To operate on records in composite Object Relationships	getRecordCount getRecord searchRecords
Workflow Record Handling To manage Workflows	processWorkflowAction getWorkflowActionList getWFOwners
Record Handling for Tenant Data Sharing To handle records in Objects shared using Tenant Data Sharing Policies	addRecord updateRecord deleteRecord searchRecords getRecord
Data Import Import CSV data into Objects	getMappingProfiles importData
Email and Document Management Provides APIs to manage Email and Documents	sendEmail sendEmailUsingTemplate generateDocument
Event and Task Management Provides APIs to create Appointments, Tasks and to Log Activities	addTask updateTask deleteTask addEvent updateEvent deleteEvent logActivity
Transaction Management Provides the ability to Rollback transactions to a SavePoint	addSavePoint rollbackToSavePoint doesSavePointExist rollback removeSavePoint getAllSavePoints
Support Classes and Objects Use these support classes and objects when you work with the Java API	HttpConnection class Parameters class ParametersIterator class Result class SearchContext class functionParams object request object - Page requestParams object - Data Policy TenantContext Object
Utility Provides APIs to perform general-purpose operations	debug exec getEnv getParametersInstance getTimezonesUtility getTimezoneUtility getLoggedInUserInfo setTargetPage showMessage throwError translateToken
GUI APIs for GUI components	Enumerated Fields Retrieving Field Metadata Adding a Picklist Updating a Picklist Define Mapping for a Dependent Picklist Global Picklists Adding a Global Picklist Searching for Global Picklists Getting a Global Picklist Updating a Global Picklist Deleting a Global Picklist
Customize These Provisional APIs give you the ability to manage metadata for program entities.	Object Metadata Field Metadata Form Metadata Package Metadata
Status API for checking status of scheduled jobs.	getStatus

4 Identifying Objects and Records

Many of the API record handling calls require an {object} element identifier. To find the Object Type Identifier:

An object type identifier uniquely identifies an object type. It is used to specify object types in APIs.

There are two kinds of type identifiers:

• objectName: This identifier is a human-readable name for both System Objects and Custom Objects.
• objectID: This identifier is a human-readable name for System Objects (e.g. "cases"), but for Custom Objects, it is a computer-generated string with no humanly-interpretable semantic value (e.g. 123qwe456rty).

See also:

• Session Identifier - session identifier
• Record Id - record id

To find an object type identifier:

1. Click > Customization > Objects
2. In the Display Title column, find the object you're looking for.
3. The Object Name column has the identifier you need.

Alternatively:

1. Go to > Customization > Objects > {object}
2. Click Properties
3. The object name appears at the top of the page

Note: For objects that are not listed, see the System Objects page. The Object Name is typically used as the identifier, because it is human-readable for both System Objects and Custom Objects. Object ID can be used, as well, but it is human-readable only for System Objects.

5 Java API Library Reference

This section has moved to the Java API Cheatsheet.

(Please adjust your bookmarks!)