Welcome!

Apache Authors: Elizabeth White, Pat Romanski, Liz McMillan, Christopher Harrold, Janakiram MSV

Blog Feed Post

How to: Get a ClientContext for a site given a full URL

Last week, I was faced with the challenge of determining the URL to the site (web) when I knew the URL to a document in SharePoint.  I also happened to know the URL to the site collection, but I wanted to reliably get the URL to a web so I could get a ClientContext object for it.  Why would I want to do this?  Come to my session (#SPC3000) on Display Templates at #SPC14 to find out!  I also had someone leave a comment on my blog in just the last week about this topic, so I thought now would be a good time to share it.  @JThake suggested that he would have just parsed the path, but given a complex URL, that's not going to work!

With the server-side object model, you can pass a full URL to the SPSite constructor and get a reference to an SPWeb object.  This trick doesn't work though with JSOM.  If you want a reference to a given subsite, you need to pass the exact URL.  This technique wasn't obvious to me or a few others, but luckily @Path2SharePoint shed some light on this when he mentioned I needed to use /_api/contextinfo.  For those of you who have doing a lot with client side code you are probably familiar with this end point because you can get your form digest that way.  Honestly though, there is not a lot of information out there on this particular endpoint.

I did a search on the Internet to see if I could find a complete working example and things were pretty scarce.  Luckily though, I found a snippet on the bottom of a post from @Wictor that had just enough of what I needed.  Let's put it all together.  First let's assume we have a URL like the one below.  This refers to a document in buried in a folder of a document library of a subsite. 

var documentPath = "http://server/sitecollection/site/documents/folder/mydocument.docx";

We need to make a $.ajax() cal to the /_api/contextinfo end point, but first we need to assemble a URL that works.  To do this, we need to strip off the filename.  We'll then append our end point to the path.  We'll just use the substring function and lastIndexOf to split the path off.  If you have a library loaded to work with URLs, you can use one of those methods as well.

documentPath = documentPath.substring(0, documentPath.lastIndexOf('/')) + "/_api/contextinfo";

Now, we need to call $.ajax() to get the objects we need.  One thing to know is that this endpoint requires you to use POST instead of GET.  That means, you can't just try the URL in a web browser.  Here is what the code looks like.

$.ajax({

    url: docuemntPath,

    type: "POST",

    contentType: "application/x-www-url-encoded",

    dataType: "json",

    headers: {

        "Accept": "application/json; odata=verbose",

    },

    success: function (data) {

        if (data.d) {

            var webUrl = data.d.GetContextWebInformation.WebFullUrl;

 

            var clientContext = new SP.ClientContext(webUrl);

        }

    },

    error: function (err) {

       alert(JSON.stringify(err));

    }

);

In the success function, we can get the information we need from data.d.GetContextWebInformation.WebFullUrl.  This has the full path to the site hosting the document.  From there, we can just pass it to the constructor of SP.ClientContext to get a reference to that subsite.  Now you can work directly with the objects on that site such as it's lists or whatever you need.

We'll be using this snippet of code in my talk #SPC3000 at SharePoint Conference.  If you have an interest in display templates, be sure and attend!  Thanks again to everyone that helped me with this!

Read the original blog entry...

More Stories By Corey Roth

Corey Roth, a SharePoint Server MVP, is an independent consultant specializing in Cloud technologies such as Azure and Office 365. He also specializes in mobile development. Corey serves as the product manager for two cloud-first mobile app platforms: BrewZap and HappenZap.

IoT & Smart Cities Stories
The hierarchical architecture that distributes "compute" within the network specially at the edge can enable new services by harnessing emerging technologies. But Edge-Compute comes at increased cost that needs to be managed and potentially augmented by creative architecture solutions as there will always a catching-up with the capacity demands. Processing power in smartphones has enhanced YoY and there is increasingly spare compute capacity that can be potentially pooled. Uber has successfully ...
The deluge of IoT sensor data collected from connected devices and the powerful AI required to make that data actionable are giving rise to a hybrid ecosystem in which cloud, on-prem and edge processes become interweaved. Attendees will learn how emerging composable infrastructure solutions deliver the adaptive architecture needed to manage this new data reality. Machine learning algorithms can better anticipate data storms and automate resources to support surges, including fully scalable GPU-c...
We are seeing a major migration of enterprises applications to the cloud. As cloud and business use of real time applications accelerate, legacy networks are no longer able to architecturally support cloud adoption and deliver the performance and security required by highly distributed enterprises. These outdated solutions have become more costly and complicated to implement, install, manage, and maintain.SD-WAN offers unlimited capabilities for accessing the benefits of the cloud and Internet. ...
Dion Hinchcliffe is an internationally recognized digital expert, bestselling book author, frequent keynote speaker, analyst, futurist, and transformation expert based in Washington, DC. He is currently Chief Strategy Officer at the industry-leading digital strategy and online community solutions firm, 7Summits.
As IoT continues to increase momentum, so does the associated risk. Secure Device Lifecycle Management (DLM) is ranked as one of the most important technology areas of IoT. Driving this trend is the realization that secure support for IoT devices provides companies the ability to deliver high-quality, reliable, secure offerings faster, create new revenue streams, and reduce support costs, all while building a competitive advantage in their markets. In this session, we will use customer use cases...
Machine learning has taken residence at our cities' cores and now we can finally have "smart cities." Cities are a collection of buildings made to provide the structure and safety necessary for people to function, create and survive. Buildings are a pool of ever-changing performance data from large automated systems such as heating and cooling to the people that live and work within them. Through machine learning, buildings can optimize performance, reduce costs, and improve occupant comfort by ...
René Bostic is the Technical VP of the IBM Cloud Unit in North America. Enjoying her career with IBM during the modern millennial technological era, she is an expert in cloud computing, DevOps and emerging cloud technologies such as Blockchain. Her strengths and core competencies include a proven record of accomplishments in consensus building at all levels to assess, plan, and implement enterprise and cloud computing solutions. René is a member of the Society of Women Engineers (SWE) and a m...
With 10 simultaneous tracks, keynotes, general sessions and targeted breakout classes, @CloudEXPO and DXWorldEXPO are two of the most important technology events of the year. Since its launch over eight years ago, @CloudEXPO and DXWorldEXPO have presented a rock star faculty as well as showcased hundreds of sponsors and exhibitors! In this blog post, we provide 7 tips on how, as part of our world-class faculty, you can deliver one of the most popular sessions at our events. But before reading...
Poor data quality and analytics drive down business value. In fact, Gartner estimated that the average financial impact of poor data quality on organizations is $9.7 million per year. But bad data is much more than a cost center. By eroding trust in information, analytics and the business decisions based on these, it is a serious impediment to digital transformation.
Charles Araujo is an industry analyst, internationally recognized authority on the Digital Enterprise and author of The Quantum Age of IT: Why Everything You Know About IT is About to Change. As Principal Analyst with Intellyx, he writes, speaks and advises organizations on how to navigate through this time of disruption. He is also the founder of The Institute for Digital Transformation and a sought after keynote speaker. He has been a regular contributor to both InformationWeek and CIO Insight...