Cisco Support Community
cancel
Showing results for 
Search instead for 
Did you mean: 

Salesforce-API - Version 2.1.0.1 (12-11-2013)

Salesforce.com API

 

 

XML based web services

Base API Structure and Background at

http://www.salesforce.com/us/developer/docs/api/index.htm

 

 

.

Current Version: 2.1.0.1

Release Date: 12/11/2013

Required CPO Version: 3.0.0.0

Required Automation Packs: Target Type Class - https://supportforums.cisco.com/document/11938656/customersupportcasetargettypes-10-11-2013-1-0-0-2zip

NOTE: all IDs are in the standard salesforce.com format. Ie. "00GS0000001K7GQ"

 

Updated:

2.1.0.1 - re-worked to use the base customer support class

2.0.0.0 - added Salesforce.com API Endpoint target type and reworked content to be in line with CPO 3.0. Only 3.0 development going forward.

 

Function List

Login to Salesforce.com - Logs into Salesforce.com instance and saves off information

Inputs:

Input.WSDL.Username - username of the user to login with
Input.WSDL.Password - password of the user to login with

Returns:

Output.Login.XML - XML output of the webcall.
Output.Server.URL  - URL to make web calls against. Note: the login URL to call against is  different than this URL. This URL is also saved to an Extended Target  Property of your salesforce.com target
Ouput.Session.ID - session ID  that you need to make further web calls after logging in. This is saved  to an ETP on your salesforce.com target as well.
Output.User.Email - email address of the user you are logging in with

 

 

CreateCase - Creates a case

Inputs:

Input.AccountId - Account ID to create case under
Input.ContractId - contract ID to create case under
Input.Description - Description of the case
Input.Origin - where the case comes from
Input.OwnerId  - what person or queue will owe the case. This is a GUID type ID that  must be pulled from the salesforce instance. Something like  00GS0000001K7GQ
Input.ParentId - ID of the parent case if such a thing exists.
Input.Priority - priority of the case
Input.Reason - reason for opening of the case
Input.RecordTypeId - the id type of the record assigned to this object
Input.Subject - Headline of the case
Input.SuppliedCompany - company opening the case
Input.SuppliedEmail - email of user opening the case
Input.SuppliedName - name of user opening the case
Input.SuppliedPhone - phone number of user opening the case
Input.Type - type of case

Returns:

Output.Result.XML - XML output of the webcall.
Output.Result.ID - id of the case opened

CreateCaseComment - Adds a comment to the case

Inputs:

Input.Case.Object.Id - object ID of the case to add the comment to
Input.Comment - actual comment to add to the case

Returns:

Output.Result.XML - XML output of the webcall.
Output.Result.ID - id of the comment added

CreateEmail - Creates an email object and attaches it to a given case

Inputs:

Input.From.Address - Who is the email from
Input.From.Name - name of the sender the email is from
Input.Parent.Id - case ID that this email should be attached to
Input.Subject - subject of the email
Input.Text.Body - body of the email
Input.To.Address - who the email should be sent to

Returns:

Output.Result.XML - XML output of the webcall.
Output.Result.ID - id of the newly created email object
Output.JSON - same as XML output but in a JSON format

GetUpdated - Returns list of recrods that have been updated

Inputs:

Input.End.Date - end date to go through
Input.Object.Type - type of object to search for, ie. "Case"
Input.Start.Date - date to begin search at

Returns:

Output.Result.XML - resultant XML of the call
Output.List.Of.IDs - table of the IDs returned from the query

Query - Runs a query into Salesforce.com database and returns data

Inputs:

Input.Query.To.Run - direct input of query to run. ie. "Select Id from Case"

Returns:

Output.Result.XML - Resultant XML output of the query

Retrieve - Retrieves fields from saleforce.com instance

Inputs:

Input.Field.List - comma delimited set of fields to look for
Input.ID - single object ID to search
Input.Object.Type - type of object to look for

Returns:

Output.Result.XML - output of web call in XML format

SendSingleEmail - Sends an email from the salesforce.com instance

Inputs:

Input.Email.Body - body of the email
Input.Email.Subject - subject of the email
Input.Reply.To - email address to reply to if that option is selected
Input.Sender.Display.Name - who sent the email
Input.To.Addresses - comma separated list of addresses to email. ie. " someone@domain.com, someone1@domain.com, someone2@domain.com"
Input.To.BCCAddresses - comma separated list of addresses to blind copy
Input.To.CCAddresses - comma separated list of addresses to carbon copy

Returns:

Output.XML - XML output of the webcall.

UpdateCase- Updates a single given field in a case

Inputs:

Input.Field.To.Update - name of the field to update, ie. "Status"
Input.Object.Id - object ID of the object to update
Input.Value.To.Update.To - value that the field needs to be changed to

Returns:

Output.XML - XML output of the webcall.
Output.Success - whether webcall succeeded or failed

 

 

CreateAndSendEmail - Combination of the create email object and send functions

Inputs:

Input.Email.Body - email body of email
Input.Email.Subject - email subject
Input.From.Address - who the email is from
Input.From.Sender.Name - who the email is from(display name)
Input.Parent.ID - what object should the email attach to
Input.Reply.To - who should get reply to from email
Input.To.Addresses - comma separated emails to send to
Input.To.BCC.Addresses - comma separated emails to BCC to
Input.To.CC.Addresses - comma separated emails to CC to
NOTE:  There is nothing different about this call versus calling the Create  and Send separately, but since they have very similar inputs, it is just  for ease of use

Returns:

No individual output from this call

  1.  
Version history
Revision #:
1 of 1
Last update:
‎10-17-2013 07:43 AM
Updated by:
 
Labels (1)
Attachments