com.salesforce.androidsdk.rest

Class RestRequest

java.lang.Object

com.salesforce.androidsdk.rest.RestRequest

Direct Known Subclasses:

BatchRequest, CompositeRequest

public class RestRequest
extends java.lang.Object

RestRequest: Class to represent any REST request. The class offers factory methods to build RestRequest objects for all REST API actions:

• userinfo
• tokeninfo
• singleaccess
• versions
• resources
• describeGlobal
• metadata
• describe
• create
• retrieve
• upsert
• update
• delete
• query
• search
• searchScopeAndOrder
• searchResultLayout
• objectLayout
• composite
• batch
• tree
• notifications
• priming records
• sobject collection create
• sobject collection retrieve
• sobject collection update
• sobject collection upsert
• sobject collection delete

It also has constructors to build any arbitrary request.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RestRequest.RestEndpoint Enumeration for all REST API endpoints.
static class	RestRequest.RestMethod Enumeration for all HTTP methods.
static class	RestRequest.SObjectTree Helper class for getRequestForSObjectTree.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ALL_OR_NONE
static java.lang.String	ATTRIBUTES
static java.lang.String	BATCH_REQUESTS
static java.lang.String	BATCH_SIZE_OPTION
static java.lang.String	BODY
static java.lang.String	COMPOSITE_REQUEST
static int	DEFAULT_BATCH_SIZE
static java.lang.String	HALT_ON_ERROR
static java.text.DateFormat	HTTP_DATE_FORMAT HTTP date format
static java.lang.String	HTTP_HEADERS
static java.lang.String	IF_UNMODIFIED_SINCE
static java.text.DateFormat	ISO8601_DATE_FORMAT Salesforce timestamp format.
static int	MAX_BATCH_SIZE
static int	MAX_COLLECTION_RETRIEVE_SIZE
static MediaType	MEDIA_TYPE_JSON application/json media type
static java.lang.String	METHOD
static int	MIN_BATCH_SIZE
static java.lang.String	RECORDS Misc keys appearing in requests
static java.lang.String	REFERENCE_ID
static java.lang.String	RICH_INPUT
static java.lang.String	SERVICES_DATA
static java.lang.String	SERVICES_OAUTH2
static java.lang.String	SFORCE_QUERY_OPTIONS
static java.lang.String	TYPE
static java.lang.String	URL
static java.lang.String	UTF_8 utf_8 charset

Constructor Summary

Constructors

Constructor and Description
RestRequest(RestRequest.RestMethod method, RestRequest.RestEndpoint endpoint, java.lang.String path, JSONObject requestBodyAsJson, java.util.Map<java.lang.String,java.lang.String> additionalHttpHeaders) Generic constructor for arbitrary requests.
RestRequest(RestRequest.RestMethod method, RestRequest.RestEndpoint endpoint, java.lang.String path, RequestBody requestBody, java.util.Map<java.lang.String,java.lang.String> additionalHttpHeaders) Generic constructor for arbitrary requests.
RestRequest(RestRequest.RestMethod method, java.lang.String path) Generic constructor for arbitrary requests without a body.
RestRequest(RestRequest.RestMethod method, java.lang.String path, JSONObject requestBodyAsJson) Generic constructor for arbitrary requests.
RestRequest(RestRequest.RestMethod method, java.lang.String path, JSONObject requestBodyAsJson, java.util.Map<java.lang.String,java.lang.String> additionalHttpHeaders) Generic constructor for arbitrary requests.
RestRequest(RestRequest.RestMethod method, java.lang.String path, java.util.Map<java.lang.String,java.lang.String> additionalHttpHeaders) Generic constructor for arbitrary requests without a body.
RestRequest(RestRequest.RestMethod method, java.lang.String path, RequestBody requestBody) Generic constructor for arbitrary requests.
RestRequest(RestRequest.RestMethod method, java.lang.String path, RequestBody requestBody, java.util.Map<java.lang.String,java.lang.String> additionalHttpHeaders) Generic constructor for arbitrary requests.

Method Summary

Modifier and Type	Method and Description
protected JSONObject	asJSON()
java.util.Map<java.lang.String,java.lang.String>	getAdditionalHttpHeaders()
static BatchRequest	getBatchRequest(java.lang.String apiVersion, boolean haltOnError, java.util.List<RestRequest> requests) Batch request
static RestRequest	getCheapRequest(java.lang.String apiVersion) Cheap request to re-hydrate access token
static CompositeRequest	getCompositeRequest(java.lang.String apiVersion, boolean allOrNone, java.util.LinkedHashMap<java.lang.String,RestRequest> refIdToRequests) Composite request
RestRequest.RestEndpoint	getEndpoint()
RestRequest.RestMethod	getMethod()
java.lang.String	getPath()
RequestBody	getRequestBody()
JSONObject	getRequestBodyAsJson()
static RestRequest	getRequestForCollectionCreate(java.lang.String apiVersion, boolean allOrNone, JSONArray records) Request for creating multiple records with fewer round trips
static RestRequest	getRequestForCollectionDelete(java.lang.String apiVersion, boolean allOrNone, java.util.List<java.lang.String> objectIds) Request for deleting multiple records with fewer round trips
static RestRequest	getRequestForCollectionRetrieve(java.lang.String apiVersion, java.lang.String objectType, java.util.List<java.lang.String> objectIds, java.util.List<java.lang.String> fieldList) Request for retrieving multiple records with fewer round trips
static RestRequest	getRequestForCollectionUpdate(java.lang.String apiVersion, boolean allOrNone, JSONArray records) Request for updating multiple records with fewer round trips
static RestRequest	getRequestForCollectionUpsert(java.lang.String apiVersion, boolean allOrNone, java.lang.String objectType, java.lang.String externalIdField, JSONArray records) Request for upserting multiple records with fewer round trips
static RestRequest	getRequestForCreate(java.lang.String apiVersion, java.lang.String objectType, java.util.Map<java.lang.String,java.lang.Object> fields) Request to create a record.
static RestRequest	getRequestForDelete(java.lang.String apiVersion, java.lang.String objectType, java.lang.String objectId) Request to delete a record.
static RestRequest	getRequestForDescribe(java.lang.String apiVersion, java.lang.String objectType) Request to completely describe the individual metadata at all levels for the specified object.
static RestRequest	getRequestForDescribeGlobal(java.lang.String apiVersion) Request to list the available objects and their metadata for your organization's data.
static RestRequest	getRequestForLimits(java.lang.String apiVersion) Request for getting information about limits in your org
static RestRequest	getRequestForMetadata(java.lang.String apiVersion, java.lang.String objectType) Request to describe the individual metadata for the specified object.
static RestRequest	getRequestForNotification(java.lang.String apiVersion, java.lang.String notificationId) Request to get a notification.
static RestRequest	getRequestForNotifications(java.lang.String apiVersion, java.lang.Integer size, java.util.Date before, java.util.Date after) Request for getting notifications.
static RestRequest	getRequestForNotificationsStatus(java.lang.String apiVersion) Request to get status of notifications for the user.
static RestRequest	getRequestForNotificationsUpdate(java.lang.String apiVersion, java.util.List<java.lang.String> notificationIds, java.util.Date before, java.lang.Boolean read, java.lang.Boolean seen) Request for updating notifications.
static RestRequest	getRequestForNotificationUpdate(java.lang.String apiVersion, java.lang.String notificationId, java.lang.Boolean read, java.lang.Boolean seen) Request for updating a notification.
static RestRequest	getRequestForObjectLayout(java.lang.String apiVersion, java.lang.String objectAPIName, java.lang.String formFactor, java.lang.String layoutType, java.lang.String mode, java.lang.String recordTypeId) Request to get object layout data.
static RestRequest	getRequestForPrimingRecords(java.lang.String apiVersion, java.lang.String relayToken, java.lang.Long changedAfterTime) Request for getting list of record related to offline briefcase
static RestRequest	getRequestForQuery(java.lang.String apiVersion, java.lang.String q) Request to execute the specified SOQL query.
static RestRequest	getRequestForQuery(java.lang.String apiVersion, java.lang.String q, int batchSize) Request to execute the specified SOQL query.
static RestRequest	getRequestForQueryAll(java.lang.String apiVersion, java.lang.String q) Request to execute the specified SOQL query which includes deleted records because of a merge or delete in the result set.
static RestRequest	getRequestForResources(java.lang.String apiVersion) Request to list available resources for the specified API version, including resource name and URI.
static RestRequest	getRequestForRetrieve(java.lang.String apiVersion, java.lang.String objectType, java.lang.String objectId, java.util.List<java.lang.String> fieldList) Request to retrieve a record by object ID.
static RestRequest	getRequestForSearch(java.lang.String apiVersion, java.lang.String q) Request to execute the specified SOSL search.
static RestRequest	getRequestForSearchResultLayout(java.lang.String apiVersion, java.util.List<java.lang.String> objectList) Request to get search result layouts
static RestRequest	getRequestForSearchScopeAndOrder(java.lang.String apiVersion) Request to get search scope and order.
static RestRequest	getRequestForSingleAccess(java.lang.String redirectUri) Request to generate URL to bridge into UI sessions (a front door URL) Applications should use that API instead of building front door URLs directly
static RestRequest	getRequestForSObjectTree(java.lang.String apiVersion, java.lang.String objectType, java.util.List<RestRequest.SObjectTree> objectTrees) Request to create one or more sObject trees with root records of the specified type.
static RestRequest	getRequestForUpdate(java.lang.String apiVersion, java.lang.String objectType, java.lang.String objectId, java.util.Map<java.lang.String,java.lang.Object> fields) Request to update a record.
static RestRequest	getRequestForUpdate(java.lang.String apiVersion, java.lang.String objectType, java.lang.String objectId, java.util.Map<java.lang.String,java.lang.Object> fields, java.util.Date ifUnmodifiedSinceDate) Request to update a record.
static RestRequest	getRequestForUpsert(java.lang.String apiVersion, java.lang.String objectType, java.lang.String externalIdField, java.lang.String externalId, java.util.Map<java.lang.String,java.lang.Object> fields) Request to upsert (update or insert) a record.
static RestRequest	getRequestForUserInfo() Request to get information about the user making the request.
static RestRequest	getRequestForVersions() Request to get summary information about each Salesforce.com version currently available.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

MEDIA_TYPE_JSON

public static final MediaType MEDIA_TYPE_JSON

application/json media type

UTF_8

public static final java.lang.String UTF_8

utf_8 charset

RECORDS

public static final java.lang.String RECORDS

Misc keys appearing in requests

See Also:

Constant Field Values

METHOD

public static final java.lang.String METHOD

See Also:

Constant Field Values

URL

public static final java.lang.String URL

See Also:

Constant Field Values

BODY

public static final java.lang.String BODY

See Also:

Constant Field Values

HTTP_HEADERS

public static final java.lang.String HTTP_HEADERS

See Also:

Constant Field Values

COMPOSITE_REQUEST

public static final java.lang.String COMPOSITE_REQUEST

See Also:

Constant Field Values

BATCH_REQUESTS

public static final java.lang.String BATCH_REQUESTS

See Also:

Constant Field Values

ALL_OR_NONE

public static final java.lang.String ALL_OR_NONE

See Also:

Constant Field Values

HALT_ON_ERROR

public static final java.lang.String HALT_ON_ERROR

See Also:

Constant Field Values

RICH_INPUT

public static final java.lang.String RICH_INPUT

See Also:

Constant Field Values

SERVICES_DATA

public static final java.lang.String SERVICES_DATA

See Also:

Constant Field Values

SERVICES_OAUTH2

public static final java.lang.String SERVICES_OAUTH2

See Also:

Constant Field Values

REFERENCE_ID

public static final java.lang.String REFERENCE_ID

See Also:

Constant Field Values

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

ATTRIBUTES

public static final java.lang.String ATTRIBUTES

See Also:

Constant Field Values

IF_UNMODIFIED_SINCE

public static final java.lang.String IF_UNMODIFIED_SINCE

See Also:

Constant Field Values

SFORCE_QUERY_OPTIONS

public static final java.lang.String SFORCE_QUERY_OPTIONS

See Also:

Constant Field Values

BATCH_SIZE_OPTION

public static final java.lang.String BATCH_SIZE_OPTION

See Also:

Constant Field Values

MIN_BATCH_SIZE

public static final int MIN_BATCH_SIZE

See Also:

Constant Field Values

MAX_BATCH_SIZE

public static final int MAX_BATCH_SIZE

See Also:

Constant Field Values

DEFAULT_BATCH_SIZE

public static final int DEFAULT_BATCH_SIZE

See Also:

Constant Field Values

MAX_COLLECTION_RETRIEVE_SIZE

public static final int MAX_COLLECTION_RETRIEVE_SIZE

See Also:

Constant Field Values

HTTP_DATE_FORMAT

public static final java.text.DateFormat HTTP_DATE_FORMAT

HTTP date format

ISO8601_DATE_FORMAT

public static final java.text.DateFormat ISO8601_DATE_FORMAT

Salesforce timestamp format.

Constructor Detail

RestRequest

public RestRequest(RestRequest.RestMethod method,
                   java.lang.String path)

Generic constructor for arbitrary requests without a body.

Parameters:

method - HTTP method used in the request (GET/POST/DELETE etc).

path - URI path. This is automatically resolved against the user's current instance host.

RestRequest

public RestRequest(RestRequest.RestMethod method,
                   java.lang.String path,
                   java.util.Map<java.lang.String,java.lang.String> additionalHttpHeaders)

Generic constructor for arbitrary requests without a body.

Parameters:

method - HTTP method used for the request (GET/POST/DELETE etc).

path - URI path. This will automatically be resolved against the user's current instance host.

additionalHttpHeaders - Additional headers.

RestRequest

public RestRequest(RestRequest.RestMethod method,
                   java.lang.String path,
                   RequestBody requestBody)

Generic constructor for arbitrary requests.

Parameters:

method - HTTP method used for the request (GET/POST/DELETE etc).

path - URI path. This will automatically be resolved against the user's current instance host.

requestBody - Request body, if one exists. Can be null. Note: Do not use this constructor if requestBody is not null and you want to build a batch or composite request.

RestRequest

public RestRequest(RestRequest.RestMethod method,
                   java.lang.String path,
                   JSONObject requestBodyAsJson)

Generic constructor for arbitrary requests.

Parameters:

method - HTTP method used for the request (GET/POST/DELETE etc).

path - URI path. This will automatically be resolved against the user's current instance host.

requestBodyAsJson - Request body as JSON, if one exists. Can be null. Note: Use this constructor if requestBody is not null and you want to build a batch or composite request.

RestRequest

public RestRequest(RestRequest.RestMethod method,
                   java.lang.String path,
                   RequestBody requestBody,
                   java.util.Map<java.lang.String,java.lang.String> additionalHttpHeaders)

Generic constructor for arbitrary requests.

Parameters:

method - HTTP method used for the request (GET/POST/DELETE etc).

path - URI path. This will automatically be resolved against the user's current instance host.

requestBody - Request body, if one exists. Can be null.

additionalHttpHeaders - Additional headers. Note: Do not use this constructor if requestBody is not null and you want to build a batch or composite request.

RestRequest

public RestRequest(RestRequest.RestMethod method,
                   java.lang.String path,
                   JSONObject requestBodyAsJson,
                   java.util.Map<java.lang.String,java.lang.String> additionalHttpHeaders)

Generic constructor for arbitrary requests.

Parameters:

method - HTTP method used for the request (GET/POST/DELETE etc).

path - URI path. This will automatically be resolved against the user's current instance host.

requestBodyAsJson - Request body as JSON, if one exists. Can be null.

additionalHttpHeaders - Additional headers. Note: Use this constructor if requestBody is not null and you want to build a batch or composite request.

RestRequest

public RestRequest(RestRequest.RestMethod method,
                   RestRequest.RestEndpoint endpoint,
                   java.lang.String path,
                   RequestBody requestBody,
                   java.util.Map<java.lang.String,java.lang.String> additionalHttpHeaders)

Generic constructor for arbitrary requests.

Parameters:

method - HTTP method used for the request (GET/POST/DELETE etc).

endpoint - The endpoint associated with the request.

path - URI path. This will be resolved against the user's current Rest endpoint, as specified by the endpoint parameter.

requestBody - Request body, if one exists. Can be null.

additionalHttpHeaders - Additional headers.

RestRequest

public RestRequest(RestRequest.RestMethod method,
                   RestRequest.RestEndpoint endpoint,
                   java.lang.String path,
                   JSONObject requestBodyAsJson,
                   java.util.Map<java.lang.String,java.lang.String> additionalHttpHeaders)

Generic constructor for arbitrary requests.

Parameters:

method - HTTP method used for the request (GET/POST/DELETE etc).

endpoint - The endpoint associated with the request.

path - URI path. This will be resolved against the user's current Rest endpoint, as specified by the endpoint parameter.

requestBodyAsJson - Request body as JSON, if one exists. Can be null.

additionalHttpHeaders - Additional headers.

Method Detail

getMethod

public RestRequest.RestMethod getMethod()

Returns:

HTTP method of the request.

getEndpoint

public RestRequest.RestEndpoint getEndpoint()

Returns:

The endpoint of the request.

getPath

public java.lang.String getPath()

Returns:

Path of the request.

getRequestBody

public RequestBody getRequestBody()

Returns:

Request body.

getRequestBodyAsJson

public JSONObject getRequestBodyAsJson()

Returns:

Request body as JSON.

getAdditionalHttpHeaders

public java.util.Map<java.lang.String,java.lang.String> getAdditionalHttpHeaders()

Returns:

Additional HTTP headers.

getRequestForUserInfo

public static RestRequest getRequestForUserInfo()

Request to get information about the user making the request.

Returns:

RestRequest object that requests user info.

See Also:

https://help.salesforce.com/articleView?id=remoteaccess_using_userinfo_endpoint.htm

getRequestForSingleAccess

public static RestRequest getRequestForSingleAccess(java.lang.String redirectUri)
                                             throws java.io.UnsupportedEncodingException

Request to generate URL to bridge into UI sessions (a front door URL) Applications should use that API instead of building front door URLs directly

Parameters:

redirectUri - A relative path that points to where the user is redirected when their new session begins.

Returns:

RestRequest object that requests single access URL.

Throws:

java.io.UnsupportedEncodingException

See Also:

https://help.salesforce.com/s/articleView?id=sf.frontdoor_singleaccess.htm

getRequestForVersions

public static RestRequest getRequestForVersions()

Request to get summary information about each Salesforce.com version currently available.

Returns:

RestRequest object that requests the list of versions.

See Also:

http://www.salesforce.com/us/developer/docs/api_rest/Content/resources_versions.htm

getRequestForResources

public static RestRequest getRequestForResources(java.lang.String apiVersion)

Request to list available resources for the specified API version, including resource name and URI.

Parameters:

apiVersion - Salesforce API version.

Returns:

RestRequest object that requests resources for the given API version.

See Also:

http://www.salesforce.com/us/developer/docs/api_rest/Content/resources_discoveryresource.htm

getRequestForDescribeGlobal

public static RestRequest getRequestForDescribeGlobal(java.lang.String apiVersion)

Request to list the available objects and their metadata for your organization's data.

Parameters:

apiVersion - Salesforce API version.

Returns:

RestRequest object that requests objects and metadata for the given API version.

See Also:

http://www.salesforce.com/us/developer/docs/api_rest/Content/resources_describeGlobal.htm

getRequestForMetadata

public static RestRequest getRequestForMetadata(java.lang.String apiVersion,
                                                java.lang.String objectType)

Request to describe the individual metadata for the specified object.

Parameters:

apiVersion - Salesforce API version.

objectType - Type of object for which the caller is requesting object metadata.

Returns:

RestRequest object that requests an object's metadata for the given API version.

See Also:

http://www.salesforce.com/us/developer/docs/api_rest/Content/resources_sobject_basic_info.htm

getRequestForDescribe

public static RestRequest getRequestForDescribe(java.lang.String apiVersion,
                                                java.lang.String objectType)

Request to completely describe the individual metadata at all levels for the specified object.

Parameters:

apiVersion - Salesforce API version.

objectType - Type of object for which the caller is requesting the metadata description.

Returns:

RestRequest object that requests an object's metadata description for the given API version.

See Also:

http://www.salesforce.com/us/developer/docs/api_rest/Content/resources_sobject_describe.htm

getRequestForCreate

public static RestRequest getRequestForCreate(java.lang.String apiVersion,
                                              java.lang.String objectType,
                                              java.util.Map<java.lang.String,java.lang.Object> fields)

Request to create a record.

Parameters:

apiVersion - Salesforce API version.

objectType - Type of record to be created.

fields - Map of the new record's fields and their values. Can be null.

Returns:

RestRequest object that requests creation of a record.

See Also:

http://www.salesforce.com/us/developer/docs/api_rest/Content/resources_sobject_retrieve.htm

getRequestForRetrieve

public static RestRequest getRequestForRetrieve(java.lang.String apiVersion,
                                                java.lang.String objectType,
                                                java.lang.String objectId,
                                                java.util.List<java.lang.String> fieldList)
                                         throws java.io.UnsupportedEncodingException

Request to retrieve a record by object ID.

Parameters:

apiVersion - Salesforce API version.

objectType - Type of the requested record.

objectId - Salesforce ID of the requested record.

fieldList - List of requested field names.

Returns:

RestRequest object that requests a record.

Throws:

java.io.UnsupportedEncodingException

See Also:

http://www.salesforce.com/us/developer/docs/api_rest/Content/resources_sobject_retrieve.htm

getRequestForUpdate

public static RestRequest getRequestForUpdate(java.lang.String apiVersion,
                                              java.lang.String objectType,
                                              java.lang.String objectId,
                                              java.util.Map<java.lang.String,java.lang.Object> fields)

Request to update a record.

Parameters:

apiVersion - Salesforce API version.

objectType - Type of the record.

objectId - Salesforce ID of the record.

fields - Map of the fields to be updated and their new values.

Returns:

RestRequest object that requests a record update.

See Also:

http://www.salesforce.com/us/developer/docs/api_rest/Content/resources_sobject_retrieve.htm

getRequestForUpdate

public static RestRequest getRequestForUpdate(java.lang.String apiVersion,
                                              java.lang.String objectType,
                                              java.lang.String objectId,
                                              java.util.Map<java.lang.String,java.lang.Object> fields,
                                              java.util.Date ifUnmodifiedSinceDate)

Request to update a record.

Parameters:

apiVersion - Salesforce API version.

objectType - Type of the record.

objectId - Salesforce ID of the record.

fields - Map of the fields to be updated and their new values. Can be null.

ifUnmodifiedSinceDate - Fulfill the request only if the record has not been modified since the given date.

Returns:

RestRequest object that requests a record update.

See Also:

http://www.salesforce.com/us/developer/docs/api_rest/Content/resources_sobject_retrieve.htm

getRequestForUpsert

public static RestRequest getRequestForUpsert(java.lang.String apiVersion,
                                              java.lang.String objectType,
                                              java.lang.String externalIdField,
                                              java.lang.String externalId,
                                              java.util.Map<java.lang.String,java.lang.Object> fields)

Request to upsert (update or insert) a record.

Parameters:

apiVersion - Salesforce API version.

objectType - Type of the record.

externalIdField - Name of ID field in source data.

externalId - ID of source data record. Can be an empty string.

fields - Map of the fields to be upserted and their new values. Can be null.

Returns:

RestRequest object that requests a record upsert.

See Also:

http://www.salesforce.com/us/developer/docs/api_rest/Content/resources_sobject_upsert.htm

getRequestForDelete

public static RestRequest getRequestForDelete(java.lang.String apiVersion,
                                              java.lang.String objectType,
                                              java.lang.String objectId)

Request to delete a record.

Parameters:

apiVersion - Salesforce API version.

objectType - Type of the record.

objectId - Salesforce ID of the record.

Returns:

RestRequest object that requests a record deletion.

See Also:

http://www.salesforce.com/us/developer/docs/api_rest/Content/resources_sobject_retrieve.htm

getRequestForSearch

public static RestRequest getRequestForSearch(java.lang.String apiVersion,
                                              java.lang.String q)
                                       throws java.io.UnsupportedEncodingException

Request to execute the specified SOSL search.

Parameters:

apiVersion - Salesforce API version.

q - SOSL search string.

Returns:

RestRequest object that requests a SOSL search.

Throws:

java.io.UnsupportedEncodingException

See Also:

http://www.salesforce.com/us/developer/docs/api_rest/Content/resources_search.htm

getRequestForQuery

public static RestRequest getRequestForQuery(java.lang.String apiVersion,
                                             java.lang.String q)
                                      throws java.io.UnsupportedEncodingException

Request to execute the specified SOQL query.

Parameters:

apiVersion - Salesforce API version.

q - SOQL query string.

Returns:

RestRequest object that requests a SOQL query.

Throws:

java.io.UnsupportedEncodingException

See Also:

http://www.salesforce.com/us/developer/docs/api_rest/Content/resources_query.htm

getRequestForQuery

public static RestRequest getRequestForQuery(java.lang.String apiVersion,
                                             java.lang.String q,
                                             int batchSize)
                                      throws java.io.UnsupportedEncodingException

Request to execute the specified SOQL query.

Parameters:

apiVersion - Salesforce API version.

q - SOQL query string.

batchSize - Batch size: number between 200 and 2000 (default).

Returns:

RestRequest object that requests a SOQL query.

Throws:

java.io.UnsupportedEncodingException

See Also:

http://www.salesforce.com/us/developer/docs/api_rest/Content/resources_query.htm

getRequestForQueryAll

public static RestRequest getRequestForQueryAll(java.lang.String apiVersion,
                                                java.lang.String q)
                                         throws java.io.UnsupportedEncodingException

Request to execute the specified SOQL query which includes deleted records because of a merge or delete in the result set.

Parameters:

apiVersion - Salesforce API version.

q - SOQL query string.

Returns:

RestRequest object that requests a SOQL query that includes deleted records.

Throws:

java.io.UnsupportedEncodingException

See Also:

https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_queryall.htm

getRequestForSearchScopeAndOrder

public static RestRequest getRequestForSearchScopeAndOrder(java.lang.String apiVersion)

Request to get search scope and order.

Parameters:

apiVersion - Salesforce API version.

Returns:

RestRequest object that requests the search scope and order for the given API version.

See Also:

http://www.salesforce.com/us/developer/docs/api_rest/Content/resources_search_scope_order.htm

getRequestForSearchResultLayout

public static RestRequest getRequestForSearchResultLayout(java.lang.String apiVersion,
                                                          java.util.List<java.lang.String> objectList)
                                                   throws java.io.UnsupportedEncodingException

Request to get search result layouts

Parameters:

apiVersion - Salesforce API version.

objectList - List of objects whose search result layouts are being requested.

Returns:

RestRequest object that requests the search result layout for the given list of objects.

Throws:

java.io.UnsupportedEncodingException

See Also:

http://www.salesforce.com/us/developer/docs/api_rest/Content/resources_search_layouts.htm

getRequestForObjectLayout

public static RestRequest getRequestForObjectLayout(java.lang.String apiVersion,
                                                    java.lang.String objectAPIName,
                                                    java.lang.String formFactor,
                                                    java.lang.String layoutType,
                                                    java.lang.String mode,
                                                    java.lang.String recordTypeId)

Request to get object layout data.

Parameters:

apiVersion - Salesforce API version.

objectAPIName - Object API name.

formFactor - Form factor. Could be "Large", "Medium" or "Small". Default value is "Large".

layoutType - Layout type. Could be "Compact" or "Full". Default value is "Full".

mode - Mode. Could be "Create", "Edit" or "View". Default value is "View".

recordTypeId - Record type ID. Default will be used if not supplied.

Returns:

RestRequest object that requests the object layout for the given parameters.

See Also:

https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_record_layout.htm

getCompositeRequest

public static CompositeRequest getCompositeRequest(java.lang.String apiVersion,
                                                   boolean allOrNone,
                                                   java.util.LinkedHashMap<java.lang.String,RestRequest> refIdToRequests)
                                            throws JSONException

Composite request

Parameters:

apiVersion - Salesforce API version.

allOrNone - Indicates whether the request will accept partially complete results.

refIdToRequests - Linked map of reference IDs to RestRequest objects. The requests will be played in order in which they were added.

Returns:

RestRequest object that requests execution of the given composite request.

Throws:

JSONException

See Also:

https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_composite.htm

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

asJSON

protected JSONObject asJSON()
                     throws JSONException

Throws:

JSONException

getBatchRequest

public static BatchRequest getBatchRequest(java.lang.String apiVersion,
                                           boolean haltOnError,
                                           java.util.List<RestRequest> requests)
                                    throws JSONException

Batch request

Parameters:

apiVersion - Salesforce API version.

haltOnError - Indicates whether to stop processing the batch if an error occurs.

requests - List of RestRequest objects.

Returns:

RestRequest object that requests execution of the given batch of requests.

Throws:

JSONException

See Also:

https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_batch.htm

getRequestForSObjectTree

public static RestRequest getRequestForSObjectTree(java.lang.String apiVersion,
                                                   java.lang.String objectType,
                                                   java.util.List<RestRequest.SObjectTree> objectTrees)
                                            throws JSONException

Request to create one or more sObject trees with root records of the specified type.

Parameters:

apiVersion - Salesforce API version.

objectType - Type of object requested.

objectTrees - List of {link #SObjectTree} objects.

Returns:

RestRequest object that requests creation of one or more sObject trees.

Throws:

JSONException

See Also:

https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_sobject_tree.htm

getRequestForNotificationsStatus

public static RestRequest getRequestForNotificationsStatus(java.lang.String apiVersion)

Request to get status of notifications for the user.

Parameters:

apiVersion - Salesforce API version.

See Also:

https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_notifications_status.htm

getRequestForNotification

public static RestRequest getRequestForNotification(java.lang.String apiVersion,
                                                    java.lang.String notificationId)

Request to get a notification.

Parameters:

apiVersion - Salesforce API version.

notificationId - ID of notification.

See Also:

https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resource_notifications_specific.htm

getRequestForNotificationUpdate

public static RestRequest getRequestForNotificationUpdate(java.lang.String apiVersion,
                                                          java.lang.String notificationId,
                                                          java.lang.Boolean read,
                                                          java.lang.Boolean seen)

Request for updating a notification.

Parameters:

apiVersion - Salesforce API version.

notificationId - ID of notification.

read - Marks notification as read (true) or unread (false). If null, field won't be updated. Required if `seen` not provided.

seen - Marks notification as seen (true) or unseen (false). If null, field won't be updated. Required if `read` not provided.

See Also:

https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resource_notifications_specific.htm

getRequestForNotifications

public static RestRequest getRequestForNotifications(java.lang.String apiVersion,
                                                     java.lang.Integer size,
                                                     java.util.Date before,
                                                     java.util.Date after)

Request for getting notifications.

Parameters:

apiVersion - Salesforce API version.

size - Number of notifications to get.

before - Get notifications occurring before the provided date. Shouldn't be used with `after`.

after - Get notifications occurring after the provided date. Shouldn't be used with `before`.

See Also:

getRequestForNotificationsUpdate

public static RestRequest getRequestForNotificationsUpdate(java.lang.String apiVersion,
                                                           java.util.List<java.lang.String> notificationIds,
                                                           java.util.Date before,
                                                           java.lang.Boolean read,
                                                           java.lang.Boolean seen)

Request for updating notifications.

Parameters:

apiVersion - Salesforce API version.

notificationIds - IDs of notifications to get. Shouldn't be used with `before`.

before - Get notifications before the provided date. Shouldn't be used with `notificationIds`.

read - Marks notifications as read (true) or unread (false). If null, field won't be updated. Required if `seen` not provided.

seen - Marks notifications as seen (true) or unseen (false). If null, field won't be updated. Required if `read` not provided.

getRequestForPrimingRecords

public static RestRequest getRequestForPrimingRecords(java.lang.String apiVersion,
                                                      java.lang.String relayToken,
                                                      java.lang.Long changedAfterTime)
                                               throws java.io.UnsupportedEncodingException

Request for getting list of record related to offline briefcase

Parameters:

apiVersion - Salesforce API version.

relayToken - Relay token (to get next page of results) - or null

changedAfterTime - To only get ids of records that changed after given time - or null

Throws:

java.io.UnsupportedEncodingException

See Also:

https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_briefcase_priming_records.htm

getRequestForCollectionCreate

public static RestRequest getRequestForCollectionCreate(java.lang.String apiVersion,
                                                        boolean allOrNone,
                                                        JSONArray records)
                                                 throws JSONException

Request for creating multiple records with fewer round trips

Parameters:

apiVersion - Salesforce API version.

allOrNone - Indicates whether to roll back the entire request when the creation of any object fails (true) or to continue with the independent creation of other objects in the request.

records - A list of sObjects.

Throws:

JSONException

See Also:

https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_sobjects_collections_create.htm

getRequestForCollectionRetrieve

public static RestRequest getRequestForCollectionRetrieve(java.lang.String apiVersion,
                                                          java.lang.String objectType,
                                                          java.util.List<java.lang.String> objectIds,
                                                          java.util.List<java.lang.String> fieldList)
                                                   throws java.io.UnsupportedEncodingException,
                                                          JSONException

Request for retrieving multiple records with fewer round trips

Parameters:

apiVersion - Salesforce API version.

objectType - Type of the requested record.

objectIds - List of Salesforce IDs of the requested records.

fieldList - List of requested field names.

Throws:

java.io.UnsupportedEncodingException

JSONException

See Also:

https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_sobjects_collections_retrieve.htm

getRequestForCollectionUpdate

public static RestRequest getRequestForCollectionUpdate(java.lang.String apiVersion,
                                                        boolean allOrNone,
                                                        JSONArray records)
                                                 throws JSONException

Request for updating multiple records with fewer round trips

Parameters:

apiVersion - Salesforce API version.

allOrNone - Indicates whether to roll back the entire request when the update of any object fails (true) or to continue with the independent update of other objects in the request.

records - A list of sObjects.

Throws:

JSONException

See Also:

https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_sobjects_collections_update.htm

getRequestForCollectionUpsert

public static RestRequest getRequestForCollectionUpsert(java.lang.String apiVersion,
                                                        boolean allOrNone,
                                                        java.lang.String objectType,
                                                        java.lang.String externalIdField,
                                                        JSONArray records)
                                                 throws JSONException

Request for upserting multiple records with fewer round trips

Parameters:

apiVersion - Salesforce API version.

allOrNone - Indicates whether to roll back the entire request when the upsert of any object fails (true) or to continue with the independent upsert of other objects in the request.

objectType - Type of the requested record.

externalIdField - Name of ID field in source data.

records - A list of sObjects.

Throws:

JSONException

See Also:

https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_sobjects_collections_upsert.htm

getRequestForCollectionDelete

public static RestRequest getRequestForCollectionDelete(java.lang.String apiVersion,
                                                        boolean allOrNone,
                                                        java.util.List<java.lang.String> objectIds)
                                                 throws java.io.UnsupportedEncodingException

Request for deleting multiple records with fewer round trips

Parameters:

apiVersion - Salesforce API version.

allOrNone - Indicates whether to roll back the entire request when the delete of any object fails (true) or to continue with the independent delete of other objects in the request.

objectIds - List of Salesforce IDs of the records to delete.

Throws:

java.io.UnsupportedEncodingException

See Also:

https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_sobjects_collections_delete.htm

getRequestForLimits

public static RestRequest getRequestForLimits(java.lang.String apiVersion)

Request for getting information about limits in your org

Parameters:

apiVersion - Salesforce API version.

See Also:

https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_limits.htm

getCheapRequest

public static RestRequest getCheapRequest(java.lang.String apiVersion)

Cheap request to re-hydrate access token

Parameters:

apiVersion -

Returns:

a rest request