Salesforce.describeObjectType()

Describe a salseforce object type. Returns all the fields and values for type.

Requires authentication with username, password, and secret token.

Usage

Hover over inputs/exits for more info.

var Salesforce = require('machinepack-salesforce-expanded');


// Describe a salseforce object type. Returns all the fields and values for type.

Salesforce.describeObjectType({

email: 'user@gmail.com',

password: 'demo1234',

token: 'x1x2x3',

objectType: 'Lead',

url: 'https://cs2.salesforce.com/',

includeValues: {},

}).exec({

// An unexpected error occurred.

error: function (err) {

 

},

// Login was not successful

invalidLogin: function () {

 

},

// OK.

success: function () {

 

},

});

Inputs

email required

Email address used to login to your salseforce account.

'user@gmail.com'
password required

Password used to login to your salseforce account.

'demo1234'
token required

If you do not have one, visit salseforce at My settings > personal > Reset My Security Token.

'x1x2x3'
objectType required

Salseforce object type.

'Lead'
url

URL for connecting your salesforce instance, sandbox, etc.

'https://cs2.salesforce.com/'
includeValues

Salesforce objects have many properties. Optionally provide a hash of properties you are interested in.

{}

Exits

error

An unexpected error occurred.

invalidLogin

Login was not successful

success

OK.