Force.com Canvas Developer's Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Links

The Links object is a JSON-formatted object containing URLs that can be helpful when integrating your canvas app. For example, use the enterpriseUrl to make calls into Salesforce using the enterprise WSDL.

Field Description
chatterFeedItemsUrl URL to return Chatter feed items for the context organization.
chatterFeedsUrl URL to return Chatter feeds for the context organization.
chatterGroupsUrl URL to return Chatter groups for the context organization.
chatterUsersUrl URL that returns Chatter users for the context organization.
enterpriseUrl URL to make API calls back to Salesforce using the enterprise WSDL.
loginUrl URL of the login server for the instance the context user is logged into. Used internally.
metadataUrl URL to make calls to the Metadata API.
partnerUrl URL to make API calls back to Salesforce using the partner WSDL.
queryUrl URL to issue a SOQL query.
recentItemsUrl URL to access recent items.
restUrl URL to return a list of REST API resources.
searchUrl URL to issue a SOSL search.
sobjectUrl URL that retrieves metadata or data from Salesforce objects.
userUrl URL for the context user.

The following code snippet shows an example of the Links object.

1"links":
2{
3    "chatterFeedItemsUrl":"/services/data/v31.0/chatter/feed-items", 
4    "chatterFeedsUrl":"/services/data/v31.0/chatter/feeds", 
5    "chatterGroupsUrl":"/services/data/v31.0/chatter/groups", 
6    "chatterUsersUrl":"/services/data/v31.0/chatter/users", 
7    "enterpriseUrl":"/services/Soap/c/31.0/00Dx00000001hxy", 
8    "loginUrl":"http://login.salesforce.com",
9    "metadataUrl":"/services/Soap/m/31.0/00Dx00000001hxy", 
10    "partnerUrl":"/services/Soap/u/31.0/00Dx00000001hxy", 
11    "queryUrl":"/services/data/v31.0/query/", 
12    "recentItemsUrl":"/services/data/v31.0/recent/", 
13    "restUrl":"/services/data/v31.0/", 
14    "searchUrl":"/services/data/v31.0/search/", 
15    "sobjectUrl":"/services/data/v31.0/sobjects/", 
16    "userUrl":"/005x0000001SyyEAAS" 
17}

Available Links and OAuth Scopes

Links that the canvas app can use depend on what OAuth scopes are selected when you create the connected app.

Scope Description
Access your basic information
  • userUrl
  • loginUrl
Access and manage your data
  • enterpriseUrl
  • metadataUrl
  • partnerUrl
  • queryUrl
  • recentItemsUrl
  • restUrl
  • searchUrl
  • sobjectUrl
Access and manage your Chatter data
  • chatterFeedItemsUrl
  • chatterFeedsUrl
  • chatterGroupsUrl
  • chatterUsersUrl
Full access All links