Skip to content

Latest commit

 

History

History
213 lines (121 loc) · 11 KB

query-string-url-tricks-sharepoint-m365.md

File metadata and controls

213 lines (121 loc) · 11 KB
title ms.date author ms.reviewer manager ms.topic ms.author ms.service localization_priority description ms.collection
Query String URL Tricks for SharePoint and Microsoft 365
03/22/2022
PatD
daisyfeller
pamgreen-msft
article
daisyfeller
sharepoint-online
Creative ways to filter, embed, and change page content by learning the secrets of URL query strings.
M365Community

Query String URL Tricks for SharePoint and Microsoft 365

[!INCLUDE content-disclaimer]

The URL is a core tenet of our online lives. Despite all the apps, browsers, and tools that occasionally obfuscate it, behind the scenes the Internet is glued together in part by the Uniform Resource Locator (URL). The data that populates the Teams app on your phone wouldn't make it there without the URL of the Graph API endpoint.

As a site owner or Microsoft 365 admin, you'll see URLs all the time: SharePoint sites, Microsoft Forms, shared links, and even application shortcuts like https://office.com/launch/onedrive.

This article will cover some powerful parameters that you can stick on the tail end of a URL to change what's shown on the page... and to make your job easier. These URL parameters will give you more options for solving problems.

Overview

The thing about query strings is… they are everywhere

You know this URL brings you to a website:

https://docs.microsoft.com

And this one brings you to a specific section of that same website:

https://docs.microsoft.com/search/

What about this URL?

https://docs.microsoft.com/search/?terms=community%20content

It has a ? at the end with a key (terms) and a value (community content). This is a query string. Based on the key and value in it, we can infer that it might affect or influence the page to show different content.

In this example, we can change the value in our address bar (and hit return) and the page content may be different. Example:

https://docs.microsoft.com/search/?terms=large%lists

Multiple filters

Here's an example of multiple filtering with two keys (products and languages) with their corresponding values (m365 and javascript):

https://docs.microsoft.com/samples/browse

https://docs.microsoft.com/samples/browse?products=m365&languages=javascript

And here's that same page loads different content with different values (ms-graph and html)

https://docs.microsoft.com/samples/browse/?products=ms-graph&languages=html

How does this mental modal of URL-as-page-transformer work in Microsoft 365? Keep reading!

Useful Query String Tricks

Put a Modern SharePoint page into Edit mode

Any Modern SharePoint Online page can be placed into Edit Mode by adding this query string URL: ?Mode=Edit

https://<yoursite>.sharepoint.com/sites/<sitename>/SitePages/default.aspx

https://<yoursite>.sharepoint.com/sites/<sitename>/SitePages/default.aspx?Mode=Edit

This isn't really easier than clicking the button on the page, but it's a good example of changing a page's look or function dramatically with a query string URL.

Tip

Sharing (links) is caring - The URL, like the one in your browser's address bar, usually support spaces. So something like ?terms=policy security works just fine. Where it might not work consistently is when you share the URL via Email, text or Teams by copying and pasting it. As a best practice, replace any space in your URL query string with a %20, like ?terms=policy%20security.

Safety first.

Put a Modern SharePoint page into Maintenance mode

Any Modern SharePoint Online page, like:

https://<yoursite>.sharepoint.com/sites/<sitename>/SitePages/home.aspx

… can be placed into Maintenance Mode by adding this query string to the URL: ?maintenancemode=true

https://<yoursite>.sharepoint.com/sites/<sitename>/SitePages/home.aspx?maintenancemode=true

This gives you a behind-the-scenes view of the web parts on the page, and the data being sent back and forth between the page and the browser. This is helpful for diagnosing issues with pages including those using the SharePoint Framework (SPFx).

Read the official documentation on this in the article Maintenance mode for client-side web parts

Put (Nearly) Anything in SharePoint into Focused Mode

In the Classic SharePoint days, there was a way to create a focused view of just content by appending isDLg=1 as a query string to your URL. Those days are in the rear-view, but there's an updated version for Modern SharePoint: ?env=Embedded

This hides the main navigation, footer, side navigation (and App bar) on just about anything in your SharePoint site, including:

  • Pages
  • List views
  • Site Contents
  • Site Analytics
  • Recycle Bin

For example in a list it would be:

https://<yoursite>.sharepoint.com/sites/<sitename>/Lists/<yourlistname>/allitems.aspx?env=Embedded

In a page it would be:

https://<yoursite>.sharepoint.com/sites/<sitename>/SitePages/default.aspx?env=Embedded

If your page or list are living on a Hub Site, you may notice the Hub Site navigation will remain when using env=Embedded. If this is not desirable, e.g. if you are embedding a page using the embed webpart, you can append ?env=WebView instead.

Show Any SharePoint List as a Microsoft Lists List

If you've been building in Microsoft 365 for a while, you're probably used to working in SharePoint sites with pages, web parts, workflows, and navigations. Sometimes you just want to share the context of a single list or library within that site – and with a URL query string you can do just that.

Take your list, remove any existing query string on the end down to this:

https://<yoursite>.sharepoint.com/sites/<sitename>/Lists/<yourlistname>/allitems.aspx

…and append this to the end of it:

?env=WebViewList

Like this:

https://<yoursite>.sharepoint.com/sites/<sitename>/Lists/<yourlistname>/allitems.aspx?env=WebViewList

That's it! Now your SharePoint list displays in Microsoft Lists. This is a great way to maximize screen real estate and help focus people during collaboration. This list remains housed in the original SharePoint site, but now with all the user interface polish of Microsoft Lists.

Tip

Filter your filters - Sometimes you need to apply two or more query string filters to the same URL – two keys and two values. The format for that is generally to use the question mark (?) first, and the ampersand (&) for every additional key/value pair.

Example: page.aspx?mykey=myvalue&thisotherkey=someothervalue

Create a Link to a List or Library Search Result

Within the Modern user interface, the search bar sets its context (or scope) to the List, Library, or site you're in. When you perform a search from a list or library, it appends a query string of the search term to the URL. This link is sharable/bookmarkable.

Here's my example list:

https://<greatsharepointsite>.sharepoint.com/sites/Lists/<ListName>/AllItems.aspx

Here it is after a search for the phrase tax documents:

https://<greatsharepointsite>.sharepoint.com/sites/Lists/<ListName>/AllItems.aspx?view=7&q=tax%20documents

And if you change the value of the q key in the URL query string, the results shown on the page will change:

https://<greatsharepointsite>.sharepoint.com/sites/Lists/<ListName>/AllItems.aspx?view=7&q=consultants

You can share this link, in a way that works almost like a SharePoint list view.

Tip

Kick things up a notch by also adding the focused-mode query string filter in combination, like:

https://<greatsharepointsite>.sharepoint.com/sites/Lists/<ListName>/AllItems.aspx?view=7&q=engineering&env=Embedded

Debug SharePoint Framework Web Parts and Extensions

You can troubleshoot a SharePoint page to see if there is a SharePoint Framework (SPFx) extension or web part causing trouble. Add this ?disable3PCode=1 to the end of the URL to disable loading anything SPFx-related:

https://<yoursite>.sharepoint.com/sites/<sitename>/SitePages/default.aspx?disable3PCode=1

Read the official documentation on Disable SPFx web parts and extensions.

Filter Lists and Library views in SharePoint and Microsoft Lists

SharePoint Lists and Libraries let you filter by specific column values with a query string URL. This might let you have a URL that filters a status column, or shows only items where some value is true.

A use-case might be using Power Automate Flow to email a list view status report based on a given product in a list… with hundreds of possible products. You wouldn't want to make separate views for each product. So, you make a single base view and append URL query strings to create dynamic URLs for your Flow emails.

The basic syntax for this is:

?useFiltersInViewXml=1&FilterField1=<internalFieldName>&FilterValue1=<value>

(No < > brackets, you'd type the actual column value)

  • The useFiltersInViewXml=1 tells the List or Library you're appending some filtering criteria.
  • The FilterField key needs to be the internal name of the SharePoint column. If you rename 'Title' to 'Product' in your list, you'll need to use 'Title' in your query string URL.

Tip

You can find out the internal name by going to List Settings, choosing the column, and looking after the &Field= key in the URL. That's using a query string URL to help you make a query string URL!

  • When filtering yes/no columns, use the number 0 for no and the number 1 for yes.

  • Filtering like this (with the query string URL) means never having to wait for search. SharePoint Search can sometimes take a few minutes to pick up on a change, but this filtering is immediate.

  • You can filter by multiple keys/values by incrementing the numbers, like this:

?useFiltersInViewXml=1&FilterField1=[internalFieldName]&FilterValue1=[value]&FilterField2=[internalFieldName2]&FilterValue2=[value]&FilterField3=[internalFieldName3]&FilterValue3=[value]

Further view filter reading from the experts

The list/library view filtering capabilities are extensive. These articles go into further detail, including filtering with managed metadata.

Conclusion ?article=done

This article has hopefully given you awareness of the hidden power of query string URLs, and how they can let the platform do some of the work for you.

If you know of other useful query strings like these, you should consider contributing them to these Microsoft Community Content documents. You can open an issue in the GitHub repo, or submit your own pull request!

Principal author: Patrick M. Doran