In Microapps
In All products
Product Documentation
In Microapps
In All products
View PDF

Salesforce connector specifications

February 7, 2020
Contributed by:  P

Integrate with Salesforce for anywhere access to leads, accounts, opportunities, cases, and contracts.

Version details

Citrix microapps supports the latest Salesforce APIs.

Endpoints

Note:

Custom endpoints are not supported.

GET

describeGlobal()
describeSObject()
query()
queryMore()
retrieve()

POST

process()
create()
update()
convertLeads()

Service Actions

  • Change Job Inbox Approval - Approve Change Job request
  • Change Job Inbox Denial - Deny Change Job request
  • Expense Report Inbox Approval - Approve Expense Report
  • Expense Report Inbox Denial - Deny Expense Report

Key Entities

The following are the main business entities that this connector addresses:

  • Account
  • Contact
  • Lead
  • Opportunity
  • Case
  • Contract
  • Event
  • Task
  • User

Entities with Attributes

The following is a full list of entities and their attributes (Salesforce v.0.1.0):

Account (List of Salesforce Accounts)

  • Id: STRING(24), PK
  • Account Number: STRING(40)
  • Account Source: STRING(64)
  • Annual Revenue: FLOAT(prec=20, scale=2)
  • Billing City: STRING(40)
  • Billing Country: STRING(80)
  • Billing Latitude: STRING(40)
  • Billing Longitude: STRING(40)
  • Billing Postal Code: STRING(20)
  • Billing State: STRING(80)
  • Billing Street: STRING(255)
  • Clean Status: STRING(64)
  • Created Date: DATETIME
  • Created By Id: STRING(24), FK(User.Id)
  • Description: STRING(-1)
  • DUNS Number: STRING(9)
  • Fax: STRING(40)
  • Industry: STRING(40)
  • Is Deleted: BOOLEAN
  • Data.com Key: STRING(20)
  • Data.com Company Id: STRING(24)
  • Last Activity Date: DATE
  • Last Modified By Id: STRING(24), FK(User.Id)
  • Last Modified Date: DATETIME
  • Last Referenced Date: DATETIME
  • Last Viewed Date: DATETIME
  • Master Record Id: STRING(24), FK(Account.Id)
  • NAICS Code: STRING(8)
  • NAICS Description: STRING(120)
  • Name: STRING(256)
  • Number of Employees: INTEGER(x32)
  • Owner Email: STRING(128)
  • Owner Name: STRING(256)
  • Ownership: STRING(40)
  • Parent Id: STRING(24), FK(Account.Id)
  • Phone: STRING(40)
  • Photo Url: STRING(255)
  • Rating: STRING(64)
  • Shipping City: STRING(40)
  • Shipping Country: STRING(80)
  • Shipping Latitude: STRING(40)
  • Shipping Longitude: STRING(40)
  • Shipping Postal Code: STRING(20)
  • Shipping State: STRING(80)
  • Shipping Street: STRING(255)
  • SIC Code: STRING(20)
  • SIC Description: STRING(80)
  • Site: STRING(80)
  • SystemMod Stamp: DATETIME
  • Ticker Symbol: STRING(20)
  • Trade Style: STRING(255)
  • Type: STRING(64)
  • Website: STRING(255)
  • Year Started: STRING(4)

Case (List of Salesforce Cases)

  • Id: STRING(24), PK
  • Account Id: STRING(24), FK(Account.Id)
  • Case Number: STRING(24)
  • Closed Date: DATE
  • Contact Id: STRING(24), FK(Contact.Id)
  • Created By Id: STRING(24), FK(User.Id)
  • Created by Email: STRING(128)
  • Created by Name: STRING(256)
  • Created Date: DATETIME
  • Description: STRING(-1)
  • Is Closed: BOOLEAN
  • Is Deleted: BOOLEAN
  • Is Escalated: BOOLEAN
  • Last Modified By Id: STRING(24), FK(User.Id)
  • Last Modified by Email: STRING(128)
  • Last Modified by Name: STRING(256)
  • Last Modified Date: DATETIME
  • Last Referenced Date: DATETIME
  • Last Viewed Date: DATETIME
  • Origin: STRING(64)
  • Owner Id: STRING(24)
  • Owner Email: STRING(128)
  • Owner Name: STRING(256)
  • Parent Id: STRING(24), FK(Case.Id)
  • Priority: STRING(64)
  • Reason: STRING(64)
  • Status: STRING(80)
  • Subject: STRING(256)
  • Supplied City: STRING(256)
  • Supplied Email: STRING(128)
  • Supplied Name: STRING(256)
  • Supplied Phone: STRING(40)
  • SystemMod Stamp: DATETIME
  • Type: STRING(64)

Contact (List of Salesforce Contacts)

  • Id: STRING(24), PK
  • Account Id: STRING(24), FK(Account.Id)
  • Assistant Name: STRING(40)
  • Assistant Phone: STRING(40)
  • Birthdate: DATE
  • Clean Status: STRING(64)
  • Created By Id: STRING(24), FK(User.Id)
  • Created Date: DATETIME
  • Department: STRING(80)
  • Description: STRING(-1)
  • Email: STRING(128)
  • Email Bounced Date: DATETIME
  • Email Bounced Reason: STRING(255)
  • Fax: STRING(40)
  • First Name: STRING(64)
  • Home Phone: STRING(40)
  • Is Deleted: BOOLEAN
  • Is Email Bounced: BOOLEAN
  • Data.com Key: STRING(20)
  • Data.com Contact Id: STRING(24)
  • Last Activity Date: DATE
  • Last Stay-in-Touch Req Date: DATETIME
  • Last Stay-in-Touch Save Date: DATETIME
  • Last Modified By Id: STRING(24), FK(User.Id)
  • Last Modified Date: DATETIME
  • Last Name: STRING(128)
  • Last Referenced Date: DATETIME
  • Last Viewed Date: DATETIME
  • Lead Source: STRING(64)
  • Mailing City: STRING(40)
  • Mailing Country: STRING(80)
  • Mailing Latitude: STRING(40)
  • Mailing Longitude: STRING(40)
  • Mailing Postal Code: STRING(20)
  • Mailing State: STRING(80)
  • Mailing Street: STRING(255)
  • Master Record Id: STRING(24), FK(Contact.Id)
  • Mobile Phone: STRING(40)
  • Name: STRING(256)
  • Other City: STRING(40)
  • Other Country: STRING(80)
  • Other Latitude: STRING(40)
  • Other Longitude: STRING(40)
  • Other Postal Code: STRING(20)
  • Other State: STRING(80)
  • Other Street: STRING(255)
  • Owner Email: STRING(128)
  • Owner Name: STRING(256)
  • Phone: STRING(40)
  • Photo Url: STRING(255)
  • Reports To Id: STRING(24), FK(Contact.Id)
  • Salutation: STRING(40)
  • SystemMod Stamp: DATETIME
  • Title: STRING(128)

Contract (List of Salesforce Contracts)

  • Id: STRING(24), PK
  • Account Id: STRING(24), FK(Account.Id)
  • Activated by Email: STRING(128)
  • Activated by Name: STRING(256)
  • Activated Date: DATETIME
  • Billing City: STRING(40)
  • Billing Country: STRING(80)
  • Billing GeocodeAccuracy: STRING(255)
  • Billing Latitude: STRING(40)
  • Billing Longitude: STRING(40)
  • Billing Postal Code: STRING(20)
  • Billing State: STRING(80)
  • Billing Street: STRING(255)
  • Company Signed Email: STRING(128)
  • Company Signed Name: STRING(256)
  • Company Signed Date: DATETIME
  • Contract Number: STRING(24)
  • Contract Term: INTEGER(x32)
  • Created By Id: STRING(24), FK(User.Id)
  • Created by Email: STRING(128)
  • Created by Name: STRING(256)
  • Created Date: DATETIME
  • Customer Signed Id: STRING(24), FK(Contact.Id)
  • Customer Signed Date: STRING(256)
  • Customer Signed Title: STRING(256)
  • Description: STRING(-1)
  • End Date: DATE
  • Is Deleted: BOOLEAN
  • Last Activity Date: DATE
  • Last Approved Date: DATE
  • Last Modified By Id: STRING(24), FK(User.Id)
  • Last Modified by Email: STRING(128)
  • Last Modified by Name: STRING(256)
  • Last Modified Date: DATETIME
  • Last Referenced Date: DATETIME
  • Last Viewed Date: DATETIME
  • Owner Id: STRING(24)
  • Owner Email: STRING(128)
  • Owner Name: STRING(256)
  • Special Terms: STRING(256)
  • Start Date: DATE
  • Status: STRING(80)
  • Status Code: STRING(80)
  • SystemMod Stamp: DATETIME

Event (List of Salesforce Events)

  • Id: STRING(24), PK
  • Account Id: STRING(24), FK(Account.Id)
  • Activity Date: DATE
  • Activity Date Time: DATETIME
  • Created By Id: STRING(24), FK(User.Id)
  • Created by Email: STRING(128)
  • Created by Name: STRING(256)
  • Created Date: DATETIME
  • Description: STRING(-1)
  • Duration In Minutes: INTEGER(x32)
  • End Date Time: DATETIME
  • Event SubType: STRING(64)
  • Group Event Type: STRING(64)
  • Is All Day Event: BOOLEAN
  • Is Archived: BOOLEAN
  • Is Child: BOOLEAN
  • Is Deleted: BOOLEAN
  • Is Private: BOOLEAN
  • Is Recurrence: BOOLEAN
  • Is Reminder Set: BOOLEAN
  • Last Modified By Id: STRING(24), FK(User.Id)
  • Last Modified by Email: STRING(128)
  • Last Modified by Name: STRING(256)
  • Last Modified Date: DATETIME
  • Location: STRING(256)
  • Owner Id: STRING(24)
  • Owner Email: STRING(128)
  • Owner Name: STRING(256)
  • Recurrence Activity Id: STRING(24), FK(Event.Id)
  • Recurrence Day Of Month: INTEGER(x32)
  • Recurrence Day Of Week Mask: INTEGER(x32)
  • Recurrence End Date Only: DATE
  • Recurrence Instance: STRING(256)
  • Recurrence Interval: INTEGER(x32)
  • Recurrence Month Of Year: STRING(64)
  • Recurrence Start Date Time: DATE
  • Recurrence TimeZone Sid Key: STRING(256)
  • Recurrence Type: STRING(256)
  • Reminder Date Time: DATETIME
  • Show As: STRING(256)
  • Start Date Time: DATETIME
  • Subject: STRING(256)
  • SystemMod Stamp: DATETIME
  • Who Id: STRING(24)
  • Who Type: STRING(64)
  • Who Name: STRING(256)
  • Who Email: STRING(128)
  • What Id: STRING(24)
  • What Type: STRING(64)
  • What Name: STRING(256)

Lead (List of Salesforce Leads)

  • Id: STRING(24), PK
  • Annual Revenue: FLOAT(prec=20, scale=2)
  • City: STRING(40)
  • Clean Status: STRING(64)
  • Company: STRING(256)
  • Company DUNS Number: STRING(9)
  • Converted Account Id: STRING(24), FK(Account.Id)
  • Converted Contact Id: STRING(24), FK(Contact.Id)
  • Converted Date: DATE
  • Converted Opportunity Id: STRING(24), FK(Opportunity.Id)
  • Country: STRING(80)
  • Created By Id: STRING(24), FK(User.Id)
  • Created Date: DATETIME
  • Description: STRING(-1)
  • Email: STRING(128)
  • Email Bounced Date: DATETIME
  • Email Bounced Reason: STRING(255)
  • Fax: STRING(40)
  • First Name: STRING(64)
  • Industry: STRING(64)
  • Is Converted: BOOLEAN
  • Is Deleted: BOOLEAN
  • Is Unread By Owner: BOOLEAN
  • Data.com Key: STRING(20)
  • Data.com Contact Id: STRING(24)
  • Last Activity Date: DATE
  • Last Modified By Id: STRING(24), FK(User.Id)
  • Last Modified Date: DATETIME
  • Last Name: STRING(128)
  • Last Referenced Date: DATETIME
  • Last Viewed Date: DATETIME
  • Latitude: STRING(40)
  • Lead Source: STRING(64)
  • Longitude: STRING(40)
  • Master Record Id: STRING(24), FK(Lead.Id)
  • Mobile Phone: STRING(40)
  • Name: STRING(256)
  • Number of Employees: INTEGER(x32)
  • Owner Email: STRING(128)
  • Owner Name: STRING(256)
  • Phone: STRING(40)
  • Photo Url: STRING(255)
  • Postal Code: STRING(20)
  • Rating: STRING(64)
  • Salutation: STRING(40)
  • State: STRING(80)
  • Lead Status: STRING(64)
  • Street: STRING(255)
  • SystemMod Stamp: DATETIME
  • Title: STRING(128)
  • Website: STRING(255)

Opportunity (List of Salesforce Opportunities)

  • Id: STRING(24), PK
  • Account Id: STRING(24), FK(Account.Id)
  • Amount: FLOAT(prec=16, scale=2)
  • Close Date: DATE
  • Created By Id: STRING(24), FK(User.Id)
  • Created Date: DATETIME
  • Description: STRING(-1)
  • Expected Revenue: FLOAT(prec=16, scale=2)
  • Fiscal: STRING(20)
  • Fiscal Quarter: INTEGER(x32)
  • Fiscal Year: INTEGER(x32)
  • Forecast Category: STRING(80)
  • Forecast Category Name: STRING(80)
  • Has Opportunity Line Item: BOOLEAN
  • Is Closed: BOOLEAN
  • Is Deleted: BOOLEAN
  • Is Private: BOOLEAN
  • Is Won: BOOLEAN
  • Last Activity Date: DATE
  • Last Modified By Id: STRING(24), FK(User.Id)
  • Last Modified Date: DATETIME
  • Last Referenced Date: DATETIME
  • Last Viewed Date: DATETIME
  • Lead Source: STRING(64)
  • Name: STRING(256)
  • Next Step: STRING(255)
  • Owner Email: STRING(128)
  • Owner Name: STRING(256)
  • Stage: STRING(64)
  • SystemMod Stamp: DATETIME
  • Probability: FLOAT(prec=5, scale=4)
  • Quantity: FLOAT(prec=16, scale=4)
  • Type: STRING(64)

ProcessInstance (List of Salesforce ProcessInstances)

  • Id: STRING(24), PK
  • Process Definition Id: STRING(24)
  • Status: STRING(80)
  • Completed Date: DATE
  • Last Actor Id User: STRING(24), FK(User.Id)
  • Last Actor Id Group: STRING(24)
  • Last Modified By Id User: STRING(24), FK(User.Id)
  • Last Modified Date: DATE
  • Elapsed Time In Days: FLOAT(prec=16, scale=2)
  • Elapsed Time In Hours: FLOAT(prec=16, scale=2)
  • Elapsed Time In Minutes: FLOAT(prec=16, scale=2)
  • Submitted By: STRING(24), FK(User.Id)
  • Is Deleted: BOOLEAN
  • Created Date: DATE
  • Created By Id: STRING(24), FK(User.Id)
  • ToId Contract: STRING(24), FK(Contract.Id)
  • TargetObjectId Contact: STRING(24), FK(Contact.Id)
  • TargetObjectId Account: STRING(24), FK(Account.Id)
  • System Modstamp: DATETIME

ProcessInstanceWorkitem (List of Salesforce ProcessInstanceWorkItems)

  • Id: STRING(24), PK
  • Process Instance Id: STRING(24), FK(ProcessInstance.Id)
  • Original Actor Id User: STRING(24), FK(User.Id)
  • Original Actor Id Group: STRING(24)
  • Actor Id User: STRING(24), FK(User.Id)
  • Actor Id Group: STRING(24)
  • Elapsed Time In Days: FLOAT(prec=16, scale=2)
  • Elapsed Time In Hours: FLOAT(prec=16, scale=2)
  • Elapsed Time In Minutes: FLOAT(prec=16, scale=2)
  • Is Deleted: BOOLEAN
  • Created Date: DATE
  • Created By: STRING(24), FK(User.Id)
  • System Modstamp: DATETIME
  • Target Object Id: STRING(24)
  • Table Enum Or Id: STRING(24)
  • Actor User Name: STRING(128)
  • Actor User Email: STRING(128)

ProcessInstanceStep (List of Salesforce ProcessInstanceWorkItems)

  • Id: STRING(24), PK
  • Process Instance Id: STRING(24), FK(ProcessInstance.Id)
  • Step Status: STRING(64)
  • Original Actor Id User: STRING(24), FK(User.Id)
  • Original Actor Id Group: STRING(24)
  • Actor Id User: STRING(24), FK(User.Id)
  • Actor Id Group: STRING(24)
  • Comments: STRING(255)
  • Step Node Id: STRING(24)
  • Elapsed Time In Days: FLOAT(prec=16, scale=2)
  • Elapsed Time In Hours: FLOAT(prec=16, scale=2)
  • Elapsed Time In Minutes: FLOAT(prec=16, scale=2)
  • Created Date: DATETIME
  • Created By Id: STRING(24), FK(User.Id)
  • System Modstamp: DATETIME
  • Actor User Name: STRING(128)

Task (List of Salesforce Tasks)

  • Id: STRING(24), PK
  • Account Id: STRING(24), FK(Account.Id)
  • Activity Date: DATETIME
  • Call Disposition: STRING(256)
  • Call Duration In Seconds: INTEGER(x32)
  • Call Object: STRING(256)
  • Call Type: STRING(256)
  • Created By Id: STRING(24), FK(User.Id)
  • Created by Email: STRING(128)
  • Created by Name: STRING(256)
  • Created Date: DATETIME
  • Description: STRING(-1)
  • Is Archived: BOOLEAN
  • Is Closed: BOOLEAN
  • Is Deleted: BOOLEAN
  • Is High Priority: BOOLEAN
  • Is Recurrence: BOOLEAN
  • Is Reminder Set: BOOLEAN
  • Last Modified By Id: STRING(24), FK(User.Id)
  • Last Modified by Email: STRING(128)
  • Last Modified by Name: STRING(256)
  • Last Modified Date: DATETIME
  • Owner Id: STRING(24)
  • Owner Email: STRING(128)
  • Owner Name: STRING(256)
  • Priority: STRING(64)
  • Recurrence Activity Id: STRING(24), FK(Task.Id)
  • Recurrence Day Of Month: INTEGER(x32)
  • Recurrence Day Of Week Mask: INTEGER(x32)
  • Recurrence End Date Only: DATE
  • Recurrence Instance: STRING(256)
  • Recurrence Interval: INTEGER(x32)
  • Recurrence Month Of Year: STRING(64)
  • Recurrence Regenerated Type: STRING(256)
  • Recurrence Start Date Only: DATE
  • Recurrence TimeZone Sid Key: STRING(256)
  • Recurrence Type: STRING(256)
  • Reminder Date Time: DATETIME
  • Status: STRING(80)
  • Subject: STRING(256)
  • Task SubType: STRING(64)
  • Who Id: STRING(24)
  • Who Type: STRING(64)
  • Who Name: STRING(256)
  • Who Email: STRING(128)
  • What Id: STRING(24)
  • What Type: STRING(64)
  • What Name: STRING(256)

User (List of Salesforce Users)

  • Id: STRING(24), PK
  • About Me: STRING(1000)
  • Is Active: BOOLEAN
  • Account Id: STRING(24), FK(Account.Id)
  • Alias: STRING(8)
  • Badge Text: STRING(8)
  • City: STRING(40)
  • Community Nickname: STRING(40)
  • Company Name: STRING(80)
  • Contact Id: STRING(24), FK(Contact.Id)
  • Country: STRING(80)
  • Created By Id: STRING(24), FK(User.Id)
  • Created Date: DATETIME
  • Notification Joining Frequency: STRING(64)
  • Delegate Approver Id: STRING(24), FK(User.Id)
  • Department: STRING(80)
  • Chatter Email Highlights Freq: STRING(64)
  • Division: STRING(80)
  • Email: STRING(128)
  • Email Encoding: STRING(64)
  • Auto Bcc: BOOLEAN
  • Auto Bcc Stay-in-Touch: BOOLEAN
  • Stay-in-Touch Reminder: BOOLEAN
  • Employee Number: STRING(20)
  • Extension: STRING(40)
  • Fax: STRING(40)
  • SAML Federation ID: STRING(512)
  • First Name: STRING(64)
  • Allow Forecasting: BOOLEAN
  • Full Photo Url: STRING(255)
  • Data.com Monthly Add Limit: FLOAT(prec=9, scale=0)
  • Language: STRING(64)
  • Last Login Date: DATETIME
  • Last Modified By Id: STRING(24), FK(User.Id)
  • Last Modified Date: DATETIME
  • Last Name: STRING(128)
  • Last Password Change Date: DATETIME
  • Last Referenced Date: DATETIME
  • Last Viewed Date: DATETIME
  • Latitude: STRING(40)
  • Locale: STRING(64)
  • Longitude: STRING(40)
  • Manager Id: STRING(24), FK(User.Id)
  • Mobile Phone: STRING(40)
  • Name: STRING(256)
  • Phone: STRING(40)
  • Postal Code: STRING(20)
  • Receives Admin Info Emails: BOOLEAN
  • Receives Info Emails: BOOLEAN
  • Sender Email Address: STRING(128)
  • Sender Name: STRING(256)
  • Email Signature: STRING(-1)
  • Small Photo Url: STRING(255)
  • State: STRING(80)
  • Stay-in-Touch Email Note: STRING(512)
  • Stay-in-Touch Email Signature: STRING(512)
  • Stay-in-Touch Email Subject: STRING(80)
  • Street: STRING(255)
  • SystemMod Stamp: DATETIME
  • Timezone: STRING(64)
  • Title: STRING(128)
  • UserType: STRING(80)
  • Username: STRING(80)

Salesforce connector specifications

February 7, 2020
Contributed by:  P

In this article

Edit this article