Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Failed to load latest commit information.
src bump to v34 (fix)
.gitignore ignore intelliJ files Update
pom.xml README about new release process. Removed release plugin. REST API Connector

Lightweight library for building apps with OAuth authentication and data access through the REST API.


Releases are published on Maven Central. Include in your project with:


Build and link locally

$ git clone
$ cd force-rest-api
$ mvn install -DskipTests

The version number is never updated in SCM. So builds will always produce a module with version 0-SNAPSHOT. Add it as a dependency to your local builds with:


To check out the source code for a particular version found in Maven Central, use the corresponding git tag, e.g:

 $ git clone
 $ cd force-rest-api
 $ git checkout force-rest-api-0.0.28

Authentication and Instantiation

Username / Password Authentication

Authenticate using just login and password:

ForceApi api = new ForceApi(new ApiConfig()

OAuth Username/Password Authentication Flow

As documented here

ForceApi api = new ForceApi(new ApiConfig()

OAuth Web Server Flow

As documented here

String url = Auth.startOAuthWebServerFlow(new AuthorizationRequest()
    .apiConfig(new ApiConfig()

// redirect browser to url
// Browser will get redirected back to your app after user authentication at
// with a code parameter. Now do:

ApiSession s = Auth.completeOAuthWebServerFlow(new AuthorizationResponse()
    .apiConfig(new ApiConfig()

ForceApi api = new ForceApi(s.getApiConfig(),s);

Instantiate with existing accessToken and endpoint

If you already have an access token and endpoint (e.g. from a cookie), you can pass an ApiSession instance to ForceApi:

ApiConfig c = new ApiConfig()

ApiSession s = new ApiSession()

ForceApi api = new ForceApi(c,s);

CRUD and Query Operations

Get an SObject

Account res = api.getSObject("Account", "001D000000INjVe").as(Account.class);

This assumes you have an Account class defined with proper Jackson deserialization annotations. For example:

import org.codehaus.jackson.annotate.JsonIgnoreProperties;
import org.codehaus.jackson.annotate.JsonProperty;

public class Account {

    String id;
    String name;
    private Double annualRevenue;
    String externalId;  

    public String getId() { return id; }
    public void setId(String id) { = id; }
    public String getName() { return name; }
    public void setName(String name) { = name; }
    public Double getAnnualRevenue() { return annualRevenue; }
    public void setAnnualRevenue(Double value) { annualRevenue = value; }
    public String getExternalId() { return externalId; }
    public void setExternalId(String externalId) { this.externalId = externalId; }

Create SObject

Account a = new Account();
a.setName("Test account");
String id = api.createSObject("account", a);

Update SObject

a.setName("Updated Test Account");
api.updateSObject("account", id, a);

Create or Update SObject

a = new Account();
a.setName("Perhaps existing account");
api.createOrUpdateSObject("account", "externalId__c", "1234", a);

Delete an SObject

api.deleteSObject("account", id);

Query SObjects

QueryResult<Account> res = api.query("SELECT id FROM Account WHERE name LIKE 'Test account%'", Account.class);

Run Tests

This project currently only has integration-y tests (they hit the actual API). To make them work copy src/test/resources/ to src/test/resources/ and replace the properties in the file with actual values.

Login and password

Add your developer org login and password. Needless to say, don't use credentials for a production org containing sensitive data. If you don't have a developer org, sign up for one. It's free.

Client ID and Secret

Once you have signed up for an org, navigate to the Remote Access Setup:

  • Click on "Admin User" drop-down in upper-right
  • Select Setup
  • In the left-side navigation pane, under "App Setup", click on "Develop"
  • Select "Remote Access"

Now create a new Remote Access Application:

  • Click on "New"
  • Choose any name for your application
  • Choose any callback URL (you'll need to set this properly when web server flow is supported)
  • Choose some contact email
  • Click "Save"
  • Copy "Consumer Key" to the property "clientId" in
  • Click on "Click to reveal" and copy "Consumer Secret" to "clientSecret" in

Add externalId__c to Account SObject

Use the Web UI to add a custom field called externalId__c and mark it as an external ID field:

  • (sorry, you have to figure out how to do this yourself. Will add instructions or automate it later)

Now run tests with

$ mvn test

Interactive end-to-end OAuth handshake Test

This test is not run as part of the test suite because it requires manual intervention. Run it like this:

mvn -Dtest=com.force.api.EndToEndOAuthFlowExample test

Cutting a Release

This project now uses Alex Fontaine's release process because the release plugin is a pretty insane piece of software that should never exist. The pom.xml version number checked into SCM is always 0-SNAPSHOT. Mapping releases back to source code now relies on git tags only.

The project is set up to release to Maven Central. If you have forked it and want to deploy your own version, you will need to update groupId and set up your own Sonatype credentials and GPG. Assuming this is all correctly set up. Here's how you cut a new release:

First ensure all your code is checked in (with git status or the like). Then find the latest version number with git tag (or in Maven central depending on what you trust most). Bump the version number to that plus one:

$ mvn versions:set -DnewVersion=<new-version> scm:tag

This will update pom.xml locally to the new version and tag the repo with the new version number. Now deploy:

$ mvn clean deploy -DperformRelease

When you're done, reset the local version change to pom.xml with:

$ mvn versions:revert

Remember to push your recent changes and tags to origin:

$ git push origin master

This project uses the Maven release plugin with Github pages as Maven repo to facilitate quick releases. Snapshots are never released. They are reserved for local builds. See Christian Kaltepoth's post for an excellent guide to setting up Github pages as a maven repo. To cut a release: (adjust repo references as necessary below if you're on a fork or doing this on your own repo)

Clone this repo

$ git clone

Clone the github pages branch of this repo into release-repo sub-dir

$ cd force-rest-api
$ git clone -b gh-pages release-repo

Prepare a new release

Set up your test properties as described above in the testing section. Tests must pass. Edit pom.xml and adjust the SCM information to match your repo and github info if different from this one. Run

$ mvn release:prepare

This will create a couple of commits and push to your github repo. A new release has now been created and snapshotted in github, but it has not yet actually been built and deployed.

Build and deploy the new release

You can't use mvn release:perform because it will be missing your test fixture. Instead just do it manually. Check out the commit that was tagged as the new release. Something like:

$ git checkout force-rest-api-0.0.21

Build and deploy

$ mvn clean deploy -DupdateReleaseInfo

Commit the new release and push to gh-pages

$ cd release-repo
$ git add .
$ git commit -m "Release 0.0.21"
$ git push origin gh-pages

Clean up

$ cd ..
$ mvn release:clean

(deletes temporary and backup files)

$ git checkout master

gets you back to master from detached HEAD.

Release History


  • Upgrade to Jackson 2. Thanks to emckissick for the pull request.


  • Include Javadoc in release jars


  • Made various fixes to get tests passing again after a long period of inactivity
  • end-to-end oauth test has been renamed to exlude it from test suite. Run it manually instead. It no longer uses HtmlUnit but instead requires manual intervention
  • ApiVersion is now up to date up to v33.0.
  • API version can now be set as a string. Setting it as an ApiVersion enum has been deprecated. There doesn't seem to be much value in strongly typing the api version.


  • thysmichels noticed that Spring 14 broke this library because was set to strictly map to the underlying JSON resource. This class now uses ignoreUnknown=true so it should be more robust to changes.



  • Some relationship queries work now. See QueryTest for an example.
  • Tested with Jackson 1.9.7


  • Modified deserialization of query results to better supper queries that return graphs of records.


  • Added more testing, including an end-to-end oauth flow test using HtmlUnit
  • Scope is now an enum


  • ApiSession now serializable, so it can be cached in Memcached and similar


  • Fixed bug in DescribeSObject. Had inlineHelpText as boolean instead of String


  • More complete DescribeSObject. Can now be used to generate Java classes. An example can be found in the tests based on PojoCodeGenerator


  • 0.0.11 broke describeSObject. Fixed now and added test


0.0.10 was botched. Missed a checkin


  • Basic exceptions
  • Some internal refactorings
  • First attempt at session renewal


  • Minimalistic Describe


  • Added revoke support (read more)
  • Refactored refreshToken out of ApiConfig


  • Added support for OAuth refresh_token flow
  • Added a bit more debug info to createSObject
  • Should work with Jackson 1.9.1 and 1.9.2. Both are accepted in the version range


  • Tested with Winter '12, API version 23
  • Requires (and explicitly declares dependency on) Jackson 1.9.1. Not tested with other Jackson versions.
  • Basic CRUD and query functionality for SObjects
  • OAuth functionality that covers all options
  • Only happy path tested, almost no error scenarios or edge cases covered except for some sporadic debug output
  • Focused on typed access. But you must build SObject classes manually for now (or use builders available elsewhere)

Project Goals:

  • Make it as thin as possible
    • Status: Both ForceApi and Auth classes are very thin wrappers on top of the APIs.
  • Few or no dependencies
    • Status: Currently only depends on Jackson. Could consider supporting gson as well for added flexibility
  • Other projects will handle generation of typed SObject classes and it should work here
  • Automatic session renewal
    • Status: Added in 0.0.10 and testable in 0.0.12. Waiting for feedback to see if it works.
  • Pluggable JSON kit
    • Status: Not yet. This is currently low priority
  • Make sure it's Spring friendly. This solution may be necessary.
    • Status: No Spring work has been done yet
  • Consider adding newrelic hooks.


BSD 2-clause license


Jesper Joergensen

Something went wrong with that request. Please try again.