Salesforce (version v1.*.*)

delete_apex#

Calling DELETE on your apex endpoint

Parameters

apexPath (required)#

Path to reach your REST Apex resource. E.g Account/accountId

Type: string

$body#

entity data

Type: string

delete_sobject_record#

deletes an SObject instance

Parameters

apiVersion (required)#

Version of API you are calling

Type: string

id (required)#

The ID of the SObject to delete

Type: array

[ "string" ]

sobjectName (required)#

Name of the salesforce Object

Type: string

describe_sobject#

describe a new instance of SObject entity

Parameters

apiVersion (required)#

Version of API you are calling

Type: string

sobjectName (required)#

Name of the salesforce Object

Type: string

get_apex#

Calling GET on your apex endpoint

Parameters

apexPath (required)#

Path to reach your REST Apex resource. E.g Account/accountId

Type: string

$body#

entity data

Type: string

get_deleted_sobject#

Retrieves the list of individual records that have been deleted within the given timespan for SObject

Parameters

apiVersion (required)#

Version of API you are calling

Type: string

end (required)#

The end time of the timespan for which to retrieve data. eg 2013-05-07T22:07:19.000+0000

Type: string

sobjectName (required)#

Name of the salesforce Object

Type: string

start (required)#

The start time of the timespan for which to retrieve data. eg 2013-05-07T22:07:19.000+0000

Type: string

get_sobject_record#

Returns sf instances by id

Parameters

apiVersion (required)#

Version of API you are calling

Type: string

id (required)#

The ID of the SObject to get

Type: array

[ "string" ]

sobjectName (required)#

Name of the salesforce Object

Type: string

get_sobjects#

Lists the available objects and their metadata for your organization’s data.

Parameters

apiVersion (required)#

Version of API you are calling

Type: string

get_updated_sobjects#

Retrieves the list of individual records that have been deleted within the given timespan for sobject

Parameters

apiVersion (required)#

Version of API you are calling

Type: string

end (required)#

The end time of the timespan for which to retrieve data. eg 2013-05-07T22:07:19.000+0000

Type: string

sobjectName (required)#

Name of the salesforce Object

Type: string

start (required)#

The start time of the timespan for which to retrieve data. eg 2013-05-07T22:07:19.000+0000

Type: string

post_apex#

Calling POST on your apex endpoint

Parameters

apexPath (required)#

Path to reach your REST Apex resource. E.g Account/accountId

Type: string

$body#

entity data

Type: string

put_apex#

Calling PUT on your apex endpoint

Parameters

apexPath (required)#

Path to reach your REST Apex resource. E.g Account/accountId

Type: string

$body#

entity data

Type: string

put_sobject_record#

updates an SObject instance

Parameters

apiVersion (required)#

Version of API you are calling

Type: string

id (required)#

The ID of the SObject to update

Type: array

[ "string" ]

sobjectName (required)#

Name of the salesforce Object

Type: string

$body#

entity data

Type: string

query#

Executes the specified SOQL query.If the query results are too large, the response contains the first batch of results and a query identifier in the nextRecordsUrl field of the response. The identifier can be used in an additional request to retrieve the next batch.

Parameters

apiVersion (required)#

Type: string

q (required)#

A SOQL query.

Type: string

explain#

A SOQL query to get performance feedback on. Use explain instead of q to get a response that details how Salesforce will process your query.

Type: string

query_all#

Executes the specified SOQL query. Unlike the Query resource, QueryAll will return records that have been deleted because of a merge or delete. QueryAll will also return information about archived Task and Event records. QueryAll is available in API version 29.0 and later.

Parameters

apiVersion (required)#

Type: string

q (required)#

A SOQL query.

Type: string