View source for REST API

<noinclude>__NUMBEREDHEADINGS__</noinclude>The REST (REpresentational State Transfer) API is a mechanism that lets you send and receive data over an HTTP interface. With the REST API, XML and/or JSON messages can be exchanged with the platform, to integrate an enterprise application. The REST API exposes objects, files, actions and transactions for integration with external (third-party) enterprise applications. 
<!--
;Suggested frameworks:Any of the following server-side frameworks can be used to build a complete new UI with the help of the REST API
:*[http://www.smartclient.com/ SmartClient/SmartGWT]
:*[http://www.extjs.com/ ExtJS]
:*[http://www.dojotoolkit.org/ Dojo]
:*[http://developer.yahoo.com/yui/ YUI]
-->

== Requirements ==
There are a number of considerations to take into account when writing a program that uses the REST APIs.

:'''''Chief among them is the need to include the login cookie string in each REST request.'''''

For more on that subject, and for other things you need to know, make sure to review and understand the programming [[#Considerations|Considerations]].

== REST Resources (categorized) ==
This is a categorized list of available Resources.

''See also:'' [[REST API:REST Resources (alphabetical)|REST Resources (alphabetical)]], [[REST API:REST API CheatSheet|REST API CheatSheet]]

===Session Management Resources===
:{| border="0" cellpadding="5" cellspacing="0
|-valign="top"
|[[REST API:login_Resource|<tt>login</tt>]]||Perform a [[Login]] action 

|-valign="top"
|[[REST API:logout_Resource|<tt>logout</tt>]]||Perform a [[Logout]] action

|-valign="top"
|[[REST_API:isSessionValid_Resource|<tt>isSessionValid</tt>]] || Determine if a valid session is in progress

|-valign="top"
|[[REST API:user/info Resource|<tt>user/info</tt>]] || Get information about the logged-in user
|}

===Administration Resources===
:{| border="0" cellpadding="5" cellspacing="0
|-valign="top"
|[[REST_API:accessProfile_Resource|<tt>accessProfile</tt>]] || Manage [[Access Profiles]]

|-valign="top"
|[[REST_API:applicationAccess_Resource|<tt>applicationAccess</tt>]] || Manage [[Application Access]]

|-valign="top"
|[[REST_API:auditLog_Resource|<tt>auditLog</tt>]] || Access the [[Audit Logs]]

|-valign="top"
|[[REST API:companyInfo_Resource|<tt>companyInfo</tt>]]||Manage [[Company Information]]

|-valign="top"
|[[REST API:passwordPolicy_Resource|<tt>passwordPolicy</tt>]]||Manage the [[Password Policy]]

|-valign="top"
|[[REST API:user_Resource|<tt>user</tt>]]||Manage User Records 

|-valign="top"
|[[REST API:team_Resource|<tt>team</tt>]]||Manage Team Records 

|-valign="top"
|[[REST API:role_Resource|<tt>role</tt>]]||Manage Role Records 

|-valign="top"
|[[REST API:teamDataSharingPolicy Resource|<tt>teamDataSharingPolicy </tt>]]||Manage the way in which data is shared among teams

|-valign="top"
|[[REST API:tenantDataSharingPolicy Resource|<tt>tenantDataSharingPolicy </tt>]]||Manage the way in which data is shared among tenants

|-valign="top"
|[[REST API:userTeam Resource|<tt>userTeam</tt>]]||Manage User Team Records
|}

===Data Management Resources===
:{| border="0" cellpadding="5" cellspacing="0
|-valign="top"
|[[REST API:record_Resource|<tt>record</tt>]] || Manage [[Record]]s in an [[Object]]

|-valign="top"
|[[REST API:bulk record Resource|<tt>bulk record</tt>]] || Manage multiple [[Record]]s in one call

|-valign="top"
|[[REST API:composite record Resource|<tt>composite record</tt>]] || Manage [[Composite Object]]s

|-valign="top"
|[[REST API:recordLocator_Resource|<tt>recordLocator</tt>]] || Manage methods by which [[Record]]s can be found

|-valign="top"
|[[REST API:import Mapping Profile Resource|<tt>import mapping profile</tt>]] || Manage field-mapping profiles used in an import

|-valign="top"
|[[REST API:bulk_Resource|<tt>bulk</tt>]] || Perform a mass data import

|-valign="top"
|[[REST_API:document_Resource|<tt>document</tt>]] || Access stored [[Documents]]

|-valign="top"
|[[REST API:execSQL Resource|<tt>execSQL</tt>]] || Make SQL queries
|}

===Workflow Record-Management Resources===
:{| border="0" cellpadding="5" cellspacing="0
|-valign="top"
|[[REST API:Workflow Resources#Identify Workflow Owners|<tt>workflowOwners</tt>]]||Identify [[Workflow]] owners for a record
|-valign="top"
|[[REST API:Workflow Resources#List Available Actions|<tt>workflowAction</tt>]]||Retrieve available  [[Workflow]] actions for a record
|-valign="top"
|[[REST_API:Workflow Resources#Transition_a_Record_to_a_New_State|<tt>changeWorkflowState</tt>]]||Transition a record to a new state
|}

===Social Networking (Relay) Resources===
:{| border="0" cellpadding="5" cellspacing="0
|-valign="top" id="relay"
|[[REST API:social group Resource|<tt>social/group</tt>]]||Manage groups

|-valign="top"
|[[REST API:social feed Resource|<tt>social/feed</tt>]]||Manage feed postings

|-valign="top"
|[[REST API:social vote Resource|<tt>social/feed/{id}/vote</tt>]] || Manage votes on postings

|-valign="top"
|[[REST API:social notification Resource|<tt>social/notification</tt>]]||Manage notifications

|-valign="top"
|[[REST API:socialDocument Element|<tt>socialDocument</tt>]]||Work with document feeds.

|-valign="top"
|[[REST API:socialRecord Element|<tt>socialRecord</tt>]]||Work with record feeds.

|-valign="top"
|[[REST API:socialUser Element|<tt>socialUser</tt>]]||Work with user feeds.
|}

===Customization Resources===
:{| border="0" cellpadding="5" cellspacing="0
|-valign="top"
|[[REST API:object_Resource|<tt>object</tt>]]||Manage [[Object]] metadata

|-valign="top"
|[[REST API:field_Resource|<tt>field</tt>]]||Manage [[Field]] metadata

|-valign="top"
|[[REST API:index_Resource|<tt>index</tt>]]||Manage [[Index]] metadata

<!-- HIDE
|-valign="top"
|[[REST API:form_Resource|<tt>form</tt>]]||Manage [[Form]] metadata 
}}
-->
|-valign="top"
|[[REST API:globalPicklist_Resource|<tt>globalPicklist</tt>]] || Manage [[Global Picklists]]

|-valign="top"
|[[REST API:translationWorkbench_Resource|<tt>translationWorkbench</tt>]] 
| Get translated strings from the [[Translation Workbench]]

|-valign="top"
|[[REST API:package_Resource|<tt>package</tt>]]
| Download or subscribe to a [[Package]]
|}

===Development Resources===
:{| border="0" cellpadding="5" cellspacing="0
<!--deprecated
|-valign="top"
|[[REST API:repository_Resource|<tt>repository</tt>]]||Manage [[Metadata Repository]] settings
-->
|-valign="top"
| [[REST API:class Resource|<tt>class</tt>]] || Manage [[Classes|Class]] definitions
|-valign="top"
| [[REST API:exec Resource|<tt>exec</tt>]] || Execute [[Classes|Class]] methods

|-valign="top"
|[[REST API:utility Resource|<tt>utility</tt>]]||Manage [[Time Zone Codes]]
|-
|[[REST API:customPage_Resource|<tt>customPage</tt>]] ||Manage [[Custom Page]]s
|-valign="top"
|[[REST API:staticResource Resource|<tt>staticResource</tt>]]||Manage [[Static Resources]]
|}

===Job and Status Resources===
:{| border="0" cellpadding="5" cellspacing="0
<!--
|-valign="top"
|[[REST API:application_Resource|<tt>application</tt>]]||Access platform applications and the data they present to users.
-->
|-valign="top"
|[[REST API:scheduledJob_Resource|<tt>scheduledJob</tt>]]||Manage scheduled jobs & check their status.
|-valign="top"
|[[REST API:import Status Resource|<tt>import Status</tt>]] || Check on the status of CSV data import.
|-valign="top"
|[[REST API:packageDeploy Status Resource|<tt>packageDeploy Status</tt>]] || Check on the status of a package deployment.
|}

===Service Provider Resources===
:{| border="0" cellpadding="5" cellspacing="0
|-valign="top"
|[[REST API:license_Resource|<tt>license</tt>]]||Retrieve Platform License Information
|-valign="top"
|[[REST API:tenant_Resource|<tt>tenant</tt>]]||Manage a [[Tenant]]
|-valign="top"
|[[REST API:tenantCapabilities_Resource|<tt>tenantCapabilities</tt>]]|| Manage [[Tenant Capabilities]]
|}

===Community Resources===
:{| border="0" cellpadding="5" cellspacing="0
|-
|[[REST API:community_Resource|<tt>community</tt>]]||Actions related to [[Community Tenancy]]
|}

== Sample Programs ==
:{| border="0" cellpadding="5" cellspacing="0
|-valign="top"
|[[REST API:BaseClient|BaseClient]] || Login, display sessionId, and logout.
|-valign="top"
|[[REST API:BaseUtil|BaseUtil]] || Utility classes used by BaseClient, mostly for message formatting.
|-valign="top"
|[[REST_API:bulk_Resource#Sample_Http_Client_for_bulk_uploads|BulkUploadClient]] || Import CSV data
|-valign="top"
|[[REST_API:package_Resource#Sample_Package_Download_Client_Program | PackageDownloadClient]] || Download a package
|-valign="top"
|[[REST_API:package_Resource#Sample_Package_Subscribe_Client | PackageSubscribeClient]] || Subscribe to a package
|-valign="top"
|[[REST API:StaticResourceUploadClient|StaticResourceUploadClient]] || Upload a resource file to the platform.
|}

== Conventions and Considerations ==
===Considerations===
{{:REST API/Considerations}}

=== Conventions ===
{{:REST API/Conventions}}

== Error Codes ==
{{:REST API:Error Codes}}

[[Category:REST API|1]]
[[Category:Learning Resources]]