Export (0) Print
Expand All
12 out of 16 rated this helpful - Rate this topic

URL strings and tokens in apps for SharePoint

apps for SharePoint

Learn which URL tokens are available for use in apps for SharePoint.

Last modified: October 31, 2013

Applies to: apps for SharePoint | Office 365 | SharePoint Foundation 2013 | SharePoint Server 2013

Important note Important

For general information about constructing URLs in SharePoint 2013 and the use of tokens in those URLs, see URLs and tokens in SharePoint 2013. This topic describes the tokens that are available in apps for SharePoint.

SharePoint 2013 supports the tokens listed in the following tables for use in apps for SharePoint.

The tokens in the tables of this section can be used in URLs in a wide variety of situations in development of apps for SharePoint, such as in Custom Actions and in links on custom pages. In some contexts, some of these tokens cannot be used. Three of the most important places where only a restricted list of tokens can be used are the start page of an app, a custom action on the host web, and the Src property of an app part. These are called out in separate columns, but these three are not an exhaustive list of places where tokens can be used.

The StartPage column specifies whether the token can be used in the StartPage element of an app manifest. The Custom Action column specifies whether the token can be used in the URL of a custom action on a host web. The App Part column specifies whether the token can be used in the Src property of the app part.

Tokens that can be used at the beginning of a URL in an app for SharePoint

Token

Resolves to

StartPage

Custom Action

App Part

Remarks

~appWebUrl

The URL of the app web of an app for SharePoint.

Yes

Yes

Yes

This token should be used only outside an app web. Within the app web itself, use ~site for the URL of the app web.

~controlTemplates

The URL of the ControlTemplates virtual folder for the current website.

No

No

No

~hostUrl

The URL of the host web.

No

No

Yes

~hostLogoUrl

The URL of the logo of the host web.

No

No

No

~layouts

The URL of the Layouts virtual folder for the current website.

No

No

No

~remoteAppUrl

The URL of a remote web application in an app for SharePoint.

Yes

Yes, in the host web, but No in the app web.

Yes

If you are not using Visual Studio and Microsoft Office Developer Tools to develop your app for SharePoint, you can use ~remoteAppUrl only in the StartPage URL of autohosted apps. However, when you are using Visual Studio and the tools, you can use this token for any provider-hosted app and it is resolved when Visual Studio packages the app. In this usage, it is really more of a Visual Studio token than a SharePoint token. It can be used outside the app manifest for both provider-hosted and autohosted apps.

~site

The URL of the current website.

No

No

Yes

~sitecollection

The URL of the parent site collection of the current website.

No

No

Yes

Except where indicated otherwise, none of the tokens in the next table can be used in the path portion of the Src property value of the app part. The App Part column refers to their use in the query string portion of the value.

Tokens that can be used inside a URL

Token

Resolves to

StartPage

Custom Action

App Part

Remarks

{AppContextToken}

The OAuth context token for the app.

No

No

No

{AppWebUrl}

The URL of the app web in an app for SharePoint.

Yes

Yes

Yes

This token should be used only outside an app web. Within the app web itself, use {Site} for the URL of the app web.

{ClientTag}

The client cache control number (client tag) for the current website.

Yes

Yes

Yes

{HostLogoUrl}

The logo for the host web of an app for SharePoint.

Yes

Yes

Yes

{HostTitle}

The title of the host web of an app for SharePoint.

Yes

Yes

Yes

{HostUrl}

The URL of the host web of an app for SharePoint.

Yes

Yes

Yes

{ItemId}

The ID of an item in a list or library (an integer).

No

Yes

No

{ItemUrl}

The URL of the item being acted upon.

No

Yes

No

{Language}

The current language/culture of the host web of an app for SharePoint.

Yes

Yes

Yes

{ListId}

The ID of the current list (a GUID).

No

Yes

No

{ProductNumber}

The full build version number of the SharePoint farm.

Yes

Yes

Yes

An example value is "15.0.4433.1011".

{RecurrenceId}

The recurrence index of a recurring event.

No

Yes

No

This token is not supported for use in the context menus of list items.

{RemoteAppUrl}

The URL of a remote web application in an app for SharePoint.

Yes

Yes

Yes

{Site}

The URL of the current website.

No

Yes

Yes

{SiteCollection}

The URL of the parent site of the current website.

No

Yes

Yes

{SiteUrl}

The URL of the current website.

No

Yes

No

{Source}

The HTTP Request URL.

No

Yes

No

{StandardTokens}

See Remarks.

Yes

Yes

Yes

This combines five other tokens. It initially resolves to SPHostUrl={HostUrl}&SPAppWebUrl={AppWebUrl}&SPLanguage={Language}&SPClientTag={ClientTag}&SPProductNumber={ProductNumber}. Then each of these tokens resolves. If there is no app web, the portion &SPAppWebUrl={AppWebUrl} is not present.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.