"CRUD" Request Types
Read
Read object data from the database. This API will filter the objects based on the field names and values in the data portion of the request. There is no way to limit the fields returned by this API, so full object data will always be returned.
var request = {
"type" : "read",
"object" : "Account",
"data" : { "Name" : "John Doe Industries" }
};
bridge.sendRequest(request, function (responseData) {
alert('Javascript got its read response: ' + responseData);
});
Create
Create a Salesforce Object. This API will create only one object per request using the field names and values provided in the data portion of the request. This is equivalent to saving a new record from the Pulsar native user interface. Optionally, specifying the argument skipLayoutRequitedFieldCheck as TRUE will avoid checking for fields marked required on the Salesforce layout for the object. The default behavior for is to display Pulsar’s record create screen if a field validation error or record creation error occurs. To disable this behavior, specify the allowEditOnFailure argument with a value of FALSE.
Multiple create, update, or delete requests MUST NOT run concurrently, and should instead be run sequentially. Furthermore, this API will have the following effects (if these features are enabled):
run PSL Object Triggers for the record(s) in question
process SFDC ValidationRules for the record(s) in question
re-calculate and save formula fields for the record(s) in question
re-calculate roll-up summary fields on parent object(s) records(s) for record(s) in question
var request = {
"type" : "create",
"object" : "Account",
"data" : { "Name" : "John Doe Industries", "Phone" : "867-5309" },
"args" : {
"allowEditOnFailure" : "FALSE", // OPTIONAL : DEFAULT IS "TRUE"-- Allow editing the record using the Pulsar object edit screen to fix errors on a create failure
"skipLayoutRequiredFieldCheck" : "FALSE" // <-- OPTIONAL : if specified as "TRUE", will avoid checking for missing layout required fields
}};
bridge.sendRequest(request, function (responseData) {
alert('Javascript got its create response: ' + responseData);
});
Update (single record only)
Update an existing Salesforce Object. This API will update only one object per request using the field names and values provided in the data portion of the request. The Id field is required to identify the record to update. This is equivalent to saving a record from the Pulsar native user interface. Optionally, specifying the argument skipLayoutRequiredFieldCheck as TRUE will avoid checking for fields marked required on the Salesforce layout for the object.
Multiple create, update, or delete requests MUST NOT run concurrently, and should instead be run sequentially. Furthermore, this API will have the following effects (if these features are enabled):
run PSL Object Triggers for the record(s) in question
process SFDC ValidationRules for the record(s) in question
re-calculate and save formula fields for the record(s) in question
re-calculate roll-up summary fields on parent object(s) records(s) for record(s) in question
var request = {
"type" : "update",
"object" : "Account",
"data" : { "Id" : "001234567891234", "Name" : "John Doe Industries, Inc", "Phone" : "(555) 867-5309" },
// Id is a required field to identify the record to update
"args" : {
"skipLayoutRequiredFieldCheck" : "FALSE" // OPTIONAL : if specified as "TRUE", will avoid checking for missing layout required fields
}
};
bridge.sendRequest(request, function (responseData) {
alert('Javascript got its update response: ' + responseData);
});
Delete (single record only)
Delete an existing Salesforce Object. This API will delete only one object per request using the Id field to identify the record. This is equivalent to deleting a record from the Pulsar native user interface.
Multiple create, update, or delete requests MUST NOT run concurrently, and should instead be run sequentially. Furthermore, this API will have the following effects (if these features are enabled):
run PSL Object Triggers for the record(s) in question
process SFDC ValidationRules for the record(s) in question
re-calculate and save formula fields for the record(s) in question
re-calculate roll-up summary fields on parent object(s) records(s) for record(s) in question
var request = {
"type" : "delete",
"object" : "Account",
"data" : { "Id" : "001234567891234" } // only Id is required
};
bridge.sendRequest(request, function (responseData) {
alert('Javascript got its delete response: ' + responseData);
});
Batch Delete
Deletes an existing set of Salesforce objects. This API will delete multiple objects per request using the objectIdList paramter to identify the records. This is equivalent to deleting the records sequentially from the Pulsar native user interface.
Multiple create, update, or delete requests MUST NOT run concurrently, and should instead be run sequentially. Furthermore, this API will have the following effects (if these features are enabled):
run PSL Object Triggers for the record(s) in question
process SFDC ValidationRules for the record(s) in question
re-calculate and save formula fields for the record(s) in question
re-calculate roll-up summary fields on parent object(s) records(s) for record(s) in question
The deletebatch API allows efficiently deleting multiple objects, provided as an array of object Ids. See the example syntax below.
var request = {
"type" : "deletebatch",
"object" : "Account",
"data" : { "objectIdList" : [ "001234567891234","001234567891235","001234567891236" ] } // only Ids are required
};
bridge.sendRequest(request, function (responseData) {
console.log('Javascript got its response: ' + responseData);
if (results.type === "deletebatchResponse") {
var resultObject = results.data;
var wasSuccessful = resultObject.summary.success; // overall success encoded here as "TRUE" or "FALSE"
var resultIds = Object.keys(resultObject.results); // results are encoded as a dictionary, keyed by object id
for (var objId in resultIds) { // results is a dictionary of objects with a success flag, object id, and error message (if unsuccessful)
var objectResult = resultObject.results[objId];
if (objectResult.success === "FALSE") { // success encoded here as "TRUE" or "FALSE"
alert('This object failed to delete: ' + objectResult.objectId);
}
}
} else if (results.type == 'error') {
errStr = results.data;
alert('A problem occurred:\n' + errStr);
} });
Sample response:
{
"type": "deletebatchResponse",
"object": "Account",
"fieldName": null,
"data": {
"summary": {
"success": "FALSE"
},
"results": {
"001234567891234": {
"objectId": "001234567891234",
"success": "TRUE",
"error": ""
},
"001234567891235": {
"objectId": "001234567891235",
"success": "FALSE",
"error": "delete failed - Error occurred during object delete"
},
"001234567891236": {
"objectId": "001234567891236",
"success": "TRUE",
"error": ""
}
}
}
}
Local SQL Queries
Select (read-only local query)
The select request allows advanced users to create an arbitrary select query using Pulsar's built in database engine.
var request = {
"type" : "select",
"object" : "Account",
"data" : { "query" : "Select Id from Account Where Name like '%hello%'" }
};
bridge.sendRequest(request, function (responseData) {
alert('Javascript got its select response: ' + responseData);
});
Update (local update query)
We encourage you to use the standard CRUD update request, (see above). The updateQuery request allows developers to issue a raw UPDATE to the local database.
Caveat Programmer!
updateQuery is an advanced request for custom/batch updates, and extreme care should be taken with its use
Does not perform processing of ValidationRules for the record(s) in question
Will not re-calculate and save formula fields for the record(s) in question
Will not re-calculate roll-up summary fields on parent object(s) records(s) for record(s) in question
It is possible to write values to the Db offline that will not sync cleanly to Salesforce or may damage your Salesforce instance when synced
It is possible to write values to the Db that will break functionality across the Pulsar app
var request = {
"type" : "updateQuery",
"object" : "Account",
"data" : { "query" : "UPDATE Account SET ActiveCustomer__c = 'TRUE' WHERE OpportunityCount__c > 0;" }
};
bridge.sendRequest(request, function (responseData) {
alert('Javascript got its update query response: ' + responseData);
});