146 namespace SalesforceRestClient {
275 "oauth_url_auth":
"https://login.salesforce.com/services/oauth2/authorize",
276 "oauth_url_token":
"https://login.salesforce.com/services/oauth2/token",
277 "oauth_url_revoke":
"https://login.salesforce.com/services/oauth2/revoke",
419 hash patch(
string path,
auto body, *reference<hash> info, *
hash hdr);
460 hash doRequest(
string m,
string path,
auto body, *reference<hash> info, softbool decode_errors =
True, *
hash hdr);
543 hash bulkGet(
string path,
auto body, *reference<hash> info, *
hash hdr);
616 hash bulkJobCreate(
string operation,
string object,
string job_content_type, *reference<hash> info, *
hash hdr);
649 hash bulkJobAddBatch(
string jobid, data batch_data,
string job_content_type, *reference<hash> info, *
hash hdr);
694 login(*reference<hash> info);
717 logout(*reference<hash> info);
783 "client_secret":
True,
786 const OptionList =
Options.keys();
login(*reference< hash > info)
logs in to Salesforce.com with the credentials provided in the constructor()
constructor(string name, string desc, string url, bool monitor, *hash opts, hash urlh)
creates the SalesforceRestConnection object
hash bulkJobCreate(string operation, string object, string job_content_type, *reference< hash > info, *hash hdr)
creates a Salesforce.com batch job and returns the job information as a hash
string oauth_url_revoke
Salesforce.com OAuth2 Revoke Token URL.
Definition: SalesforceRestClient.qm.dox.h:316
hash patch(string path, auto body, *reference< hash > info, *hash hdr)
sends an HTTP PATCH request to the Salesforce.com REST server and returns the response; performs an i...
const DefaultSendEncoding
default send encoding
Definition: SalesforceRestClient.qm.dox.h:282
Mutex m()
Mutex for token acquisition.
hash doBulkRequest(string m, string path, auto body, *reference< hash > info, softbool decode_errors=True, *hash hdr)
sends a Bulk API REST request to the Salesforce.com server using "rawxml" serialization and returns t...
const BulkJobCsv
Salesforce.com bulk job "CSV" content type.
Definition: SalesforceRestClient.qm.dox.h:187
const RequiredOptions
required options
Definition: SalesforceRestClient.qm.dox.h:285
this class provides the REST client API for communication with Salesforce.com
Definition: SalesforceRestClient.qm.dox.h:269
const JobInfoAttributes
Salesforce.com XML jobInfo attributes.
Definition: SalesforceRestClient.qm.dox.h:300
const BulkJobContentTypes
a hash of Salesforce.com bulk job content types; keys are Salesforce.com Bulk REST API Job Content Ty...
Definition: SalesforceRestClient.qm.dox.h:214
static string getGmtDate(date d)
returns a date string in GMT for use in Salesforce.com requests
const BulkJobXml
Salesforce.com bulk job "XML" content type.
Definition: SalesforceRestClient.qm.dox.h:193
string getType()
returns "rest"
hash bulkPost(string path, auto body, *reference< hash > info, *hash hdr)
sends an HTTP POST request to the REST server using the Salesforce.com Bulk REST API and returns the ...
logout(*reference< hash > info)
logs out of Salesforce.com by revoking the access token
const Defaults
defaults for direct member values
Definition: SalesforceRestClient.qm.dox.h:274
hash doRequest(string m, string path, auto body, *reference< hash > info, softbool decode_errors=True, *hash hdr)
sends an HTTP request to the REST server and returns the response; performs an implicit login to Sale...
string client_id
Salesforce.com "consumer key".
Definition: SalesforceRestClient.qm.dox.h:325
const BulkJobZipCsv
Salesforce.com bulk job "ZIP_CSV" content type.
Definition: SalesforceRestClient.qm.dox.h:196
const BulkJobOperations
a hash of Salesforce.com bulk job operations; keys are Salesforce.com Bulk REST API Job Operations ...
Definition: SalesforceRestClient.qm.dox.h:175
const BulkJobZipXml
Salesforce.com bulk job "ZIP_XML" content type.
Definition: SalesforceRestClient.qm.dox.h:202
SalesforceRestClient getImpl(bool connect=True, *hash rtopts)
returns a SalesforceRestClient::SalesforceRestClient object
hash bulkJobClose(string jobid, *reference< hash > info, *hash hdr)
sends a Bulk REST API job close POST request to the server and returns the deserialized result messag...
static SalesforceRestConnection make(string name, string desc, string url, bool monitor, *hash opts, hash urlh)
static constructor
const BulkJobUpdate
Salesforce.com bulk job "update" operation.
Definition: SalesforceRestClient.qm.dox.h:158
*hash getDefaultOptions()
returns default options
string oauth_url_auth
Salesforce.com OAuth2 Authorization URL.
Definition: SalesforceRestClient.qm.dox.h:310
static string getBulkDate(date d)
returns a date string for use with Salesforce.com Bulk REST API requests
hash api_hash
hash of APIs retrieved from GET /services/data; keyed by API version string; values: "label"...
Definition: SalesforceRestClient.qm.dox.h:343
const BulkJobUpsert
Salesforce.com bulk job "upsert" operation.
Definition: SalesforceRestClient.qm.dox.h:161
const BulkJobDelete
Salesforce.com bulk job "delete" operation.
Definition: SalesforceRestClient.qm.dox.h:164
const BulkJobQuery
Salesforce.com bulk job "query" operation.
Definition: SalesforceRestClient.qm.dox.h:152
loginIntern(*reference< hash > info)
performs authentication and authorization with Salesforce.com using the OAuth2 authorization URL ...
*string getToken()
returns the access token
const BulkJobInsert
Salesforce.com bulk job "insert" operation.
Definition: SalesforceRestClient.qm.dox.h:155
const BulkJobJson
Salesforce.com bulk job "JSON" content type.
Definition: SalesforceRestClient.qm.dox.h:190
string username
Salesforce.com username.
Definition: SalesforceRestClient.qm.dox.h:331
const AsyncDataloadNs
Salesforce.com async dataload namespace.
Definition: SalesforceRestClient.qm.dox.h:297
string getApi()
returns the Salesforce.com REST API version currently in use
string token
Salesforce.com token.
Definition: SalesforceRestClient.qm.dox.h:322
static hash getOptions(*hash opts)
returns options for the RestClient::constructor()
class for Salesforce.com REST connections; returns SalesforceRestClient::SalesforceRestClient objects...
Definition: SalesforceRestClient.qm.dox.h:775
string client_secret
Salesforce.com "consumer secret".
Definition: SalesforceRestClient.qm.dox.h:328
hash bulkJobAddBatch(string jobid, data batch_data, string job_content_type, *reference< hash > info, *hash hdr)
add a batch to a job using the Bulk REST API
const Options
SalesforceRestConnection object connection options.
Definition: SalesforceRestClient.qm.dox.h:780
hash bulkGet(string path, auto body, *reference< hash > info, *hash hdr)
sends an HTTP GET request to the REST server using the Salesforce.com Bulk REST API and returns the r...
string password
Salesforce.com password.
Definition: SalesforceRestClient.qm.dox.h:334
string api
Salesforce.com REST API version to be used ("auto" = latest version)
Definition: SalesforceRestClient.qm.dox.h:337
const BulkJobZipJson
Salesforce.com bulk job "ZIP_JSON" content type.
Definition: SalesforceRestClient.qm.dox.h:199
hash getOptions()
gets options
string api_used
Salesforce.com REST API version currently in use.
Definition: SalesforceRestClient.qm.dox.h:340
string oauth_url_token
Salesforce.com OAuth2 Get Token URL.
Definition: SalesforceRestClient.qm.dox.h:313