Soap Api Cheatsheet printable pdf download

SOAP API

Cheatsheet

Overview

Use the SOAP API to create, retrieve, update, or delete records in from any external system that supports SOAP-based Web

services, such as Java, .NET, or PHP client applications. With more than 20 different calls, the API also allows you to maintain passwords, perform

searches, retrieve metadata information about objects and more.

Getting Started

Summary Functions cont.

Same as query(), but includes deleted

To generate the WSDL representing your environment, click

queryAll()

and archived items.

Setup | Develop | API. The Enterprise WSDL is a strongly typed

representation of your data, while the Partner WSDL is a loosely

Retrieves the next batch of records

queryMore()

typed representation, ideal for writing generic clients that work

from a query.

across different organizations.

Retrieves one or more records based

retrieve()

on the specified record IDs.

Executes a text search in your

Summary Functions

search()

organization’s data.

These are the fundamental calls needed for logging in, querying,

creating, and deleting data:

Utility Calls

Logs in and starts a client session.

These calls let you retrieve user information, send emails, and

logout()

Ends the session of the logged-in user.

reset passwords:

Retrieves the current system timestamp

invalidateSessions()

getServerTimestamp()

Ends one or more sessions.

from the API.

create()

Adds one or more new individual records.

Retrieves personal information for the

getUserInfo()

user associated with the current session.

Deletes one or more individual

delete()

Changes a user’s password to a

records.

resetPassword()

system-generated value.

update()

Updates one or more existing records.

sendEmail()

Immediately sends an email message.

Undeletes records from the

Sets the specified user’s password to

undelete()

setPassword()

Recycle Bin.

the specified value.

Deletes records from the

emptyRecycleBin()

Recycle Bin immediately.

Primitive Data Types

Retrieves the IDs of individual deleted

getDeleted()

The API uses the following primitive data types:

records for a specified timespan.

base64

Base64-encoded binary data.

Retrieves the IDs of individual updated

getUpdated()

records for a specified timespan.

Boolean fields have one of these values:

boolean

true (or 1), or false (or 0).

Converts a Lead into an Account,

convertLead()

Contact, or (optionally)

byte

A set of bits.

an Opportunity.

Date data. Unlike dateTime fields, date

date

Merges records of the same

fields contain no time value.

merge()

object type.

dateTime

Date/time values (timestamps).

Submits an array of approval process

double

It's a 64 bit decimal.

instances for approval, or processes an

process()

array of approval process instances to

Fields of this type contain numbers with

be approved, rejected, or removed.

int

no fractional portion.

Executes a query against the specified

string

Character strings.

query()

object and returns data that matches

the specified criteria.

time

Time values.

Soap Api Cheatsheet

Related Articles

Related forms

Related Categories