Java API

Java API

From LongJump Support Wiki

Java API (Redirected from Category:Java API)
Jump to: navigation, search

__NUMBEREDHEADINGS__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):

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:
Learn more about web services and programming:

3. Classes, Objects, and APIs

This table lists the APIs and links to detail pages. For a quick synopsis of syntax, see the Java API Cheatsheet.

Classes, Objects and APIs Detail
Record Handling

To handle records in Objects

Record Handling for Composite Objects

To operate on records in composite Object Relationships

Workflow Record Handling

To manage Workflows


To do social networking.

Record Handling for Tenant Data Sharing

To handle records in Objects shared using Tenant Data Sharing Policies

Data Import

Import CSV data into Objects

Email and Document Management

Provides APIs to manage Email and Documents

Event and Task Management

Provides APIs to create Appointments, Tasks and to Log Activities

Transaction Management

Provides the ability to Rollback transactions to a SavePoint

Support Classes and Objects

Use these support classes and objects when you work with the Java API


Provides APIs to perform general-purpose operations


These Provisional APIs give you the ability to manage metadata for program entities.


API for checking status of scheduled jobs.

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 Built-in or CRM objects and Custom Objects.
  • objectID: This identifier is a human-readable name for Built-in or CRM objects (e.g. CASE), but for Custom Objects, it is a computer-generated string with no humanly-interpretable semantic value (e.g. 123qwe456rty).
See also:

4.1 Find the Object Type Identifier

To find the object type identifier for an object:

  1. Click Designer > Objects > {object}
  2. The Object Name is displayed at the top of the page.
    (To see the object ID, click the section-expansion (triangle) icon next to it. File:Sections-expand.gif)


Note: The Object Name is typically used as the identifier, because it is human-readable for both Built-in or CRM objects and Custom Objects. Object ID can be used, as well, but it is only human-readable for Built-in or CRM objects.

5. Java API Library Reference

This section has moved to the Java API Cheatsheet.
(Please adjust your bookmarks!)
Personal tools