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.

The links that are listed here are the most commonly used links. They can be helpful when you’re building the REST endpoints for your canvas app. For a complete list of links and related functionality, see the Force.com REST API Developer’s Guide and the Chatter REST API Developer Guide.

Note

Field Description
chatterFeedItemsUrl URL to return Chatter feed items for the context organization. This link will still work for integrations created prior to API version 39.0, because the link only points to functionality within API versions 31.0 and earlier.
chatterFeedsUrl URL to return Chatter feeds for the context organization. This link will still work for integrations created prior to API version 39.0, because the link only points to functionality within API versions 31.0 and earlier.
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.

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