קאַטעגאָריע אַרטשיוועס: REST

HTTP 406 Error When Using Angular $http.get Against SharePoint REST End Points

דערהייַנטיקן: Marc AD ndersson pointed out this great piece of info: הטטפּ://blogs.office.com/2014/08/13/json-light-support-rest-sharepoint-api-released/. That explains a lot :).

That may be the worst title of a blog post ever! Anyhoo.

I typically do all of my prototyping against an O365 instance. I have my personal instance so that I don’t have to be worried about affecting anyone else. As an aside – remember when we call carried around virtual machines on our laptops with MOSS – SQL Server, IIS, deciding Hyper-V vs. VMWare? Anyhoo…

I had developed an app using Angular in this environment that does, צווישן אנדערע זאכן, דעם:

$http.get(serverUrl)
.success(פונקציע(דאַטע, מאַצעוו, headers, config) {

var getLinksResponse = data;

getLinksResponse.value.forEach(פונקציע(theResult) {

// and so on and so froth

This was working just fine in two different SharePoint online environments. אָבער, when my colleague ported it to a Cloudshare instance, he was getting an HTTP 406 גרייַז (which was the first time I ever got that one, so … yay, I guess). We did a bit of research and noticed that the “Accept” header was off. SharePoint online was perfectly happy with:

Accept: application/json

But the cloudshare instance (which is SP on prem, hosted in a virtual server) wanted the classic “odata=verbose” added in as well:

Accept: application/json;odata=verbose

To fix that, we added the header as such:

var config = {headers: {
‘Accept’: ‘application/json;odata=verbose’
}
};

$http.get(serverUrl,config)
.success(פונקציע(דאַטע, מאַצעוו, headers, config) {

var getLinksResponse = data;

getLinksResponse.value.forEach(פונקציע(theResult) {

// and so on and so froth

That got rid of the 406, but it also changed the format of the response. It was more … verbose. (haha!) More changes were required and here’s the final result:

var config = {headers: {
‘Accept’: ‘application/json;odata=verbose’
}
};

$http.get(serverUrl,config)
.success(פונקציע(דאַטע, מאַצעוו, headers, config) {

var getLinksResponse = data;

getLinksResponse.d.results.forEach(פונקציע(theResult) {

// and so on and so froth

This only turned into a 30 minute problem for us, so we lucked out. Hopefully someone finds this useful.

</עק>

ווי צו ספּעציפיצירן מענטשן ווי אַ זוכן פאַרנעם / אינהאַלט מקור ניצן שאַרעפּאָינט 2013 מנוחה אַפּי

2 רעפּליעס

I had reason to work with the SharePoint 2013 Search API via REST for the first time. I wanted to search for people, not documents. The key learning here is that you specify content sources via its GUID (or at least in this case). The following jQuery snippet shows how:

    loadExpertsAsync: פונקציע() {

        jQuery.support.cors = ריכטיק;

        $.ajax({
            URL: דעם.CreateFullApiUrl() +
                "?querytext='portals'&sourceid='b09a7990-05ea-4af9-81ef-edfab16c4e31'" +
                "&selectproperties='LinkedInProfileUrl,GoogleCirclesProfileUrl,BALargeProfilePictureUrls,BAGridPictures,WorkEmail,Skills,AboutMe,Interests,JobTitle,PastProjects,PictureURL,PreferredName,TwitterHandle,LinkedInProfileUrl,PreferredName,GoogleCirclesProfileUrl'" +
                "&rowlimit=99",
            מעטאָד: "GET",
            headers: { "Accept": "application/json; odata=verbose" },
            cache: פאַלש,
            success: פונקציע (טאַכלעס) {

אין מיין פאַל, I’m running the API against SharePoint online. To get the GUID, I followed these steps:

Access the SharePoint admin center
Select “search” from the left hand navigation
Select “Manage Result Sources”
Select “Local People Results”
Look at the URL.

My URL looked something like:

https://xyzzy-admin.sharepoint.com/_layouts/15/searchadmin/EditResultSource.aspx?level=tenant&sourceid=b09a7990%2D05ea%2D4af9%2D81ef%2Dedfab16c4e31&view=1

The sourceid parameter is what worked for me.

(I understand that the sourceid may actually be a sort of permanent thing with SP, but I’ll always check anyway 🙂 ).

</עק>

אַבאָנירן צו מיין בלאָג.

גיי מיר אויף טוויטטער בייַ http://www.twitter.com/pagalvin

בייַשפּיל שאַרעפּאָינט מנוחה קאַללס

לאָזן אַ ענטפער

Here’s a set of sample REST calls that work for me and may help you out as well. ווי פון 02/2014, there are two examples 🙂

Reference a Column With Spaces In Its Name
Reference a Multi-Select Column
Perform a People Search via REST

I’ll add to this as time passes.

Here are some useful inks I’ve found as well:

Reference a Column With Spaces In Its Name

I create a custom list with a column named “Blog Author” (space between Blog and Author).

The $select to reference that column is:

Simply replace the space with “_x0020_”. We see the _x0020_ in many examples across the internets and REST is no different.

If you don’t do that, you’re liable to get an error message like this:

The expression “Blog Author” is not valid.

Easy enough.

Reference a Multi-Select Lookup Column

Set up:

Create a custom list named Categories.
Add some categories. I added categories thusly:
Create another custom list called MockBlog and add Categories as a multi-select list column (or site column if that’s how you roll).

Add some items to your Mockblog list and you’re ready.

An Ajax style call using jQuery will look something like this:

serverUrl  = "/_api/web/lists/GetByTitle('MockBlog')/זאכן" +
             "?$select=Title,Categories/Title,Blog_x0020_Author/Title" + 
             "&$expand=Blog_x0020_Author,Categories";

We’re telling SharePoint “Give me the title for all the Categories (Categories/Title). Get the actual values for טיטל דורך $expanding the Categories list.” (My RESTful paraphrasing is probably pretty loose, but this how I’m interpreting it).

If you’re doing this via JavaScript and using Fiddler to look at the output, you get something like this in return:

(The above is a JSON object)

Perform a People Search via REST

I blogged about this separately. The key is to specify a sourceid parameter whose value is the GUID of the Local People content source. (Content sources used to be called scopes and it’s my-oh-my so hard not to call everything a scope for me!).

לייענען מער וועגן אים דאָ: http://www.mstechblogs.com/paul/?p=10385

</עק>

אַבאָנירן צו מיין בלאָג.

גיי מיר אויף טוויטטער בייַ http://www.twitter.com/pagalvin

שנעל און יזי: שאַפֿן אַ שאַרעפּאָינט מאַפּע ניצן מנוחה

לאָזן אַ ענטפער

There are a lot of resources around that show how to do this, but I couldn’t find a comprehensive go-to link, so here we are.

You can create a SharePoint site using the REST API. Here’s a fully baked example:

<!--
    SiteRequestForm.html: Collect information and create a site for the user.
-->

<צענטער>
<טיש>
    <טר>
        <טד>Site Name:</טד>
        <טד><אַרייַנשרייַב טיפּ="text" נאָמען="SiteName" שייַן="SiteName" /></טד>
    </טר>
    <טר>
        <טד colspan="2">
            <אַרייַנשרייַב טיפּ="submit" שייַן="CreateSiteButton" ווערט="Create the Site" />
        </טד>
    </טר>
</טיש>
</צענטער>

<שריפט סרק="../Plugins/jquery-1.11.0.min.js"></שריפט>

<שריפט>
איז געווען CreateSiteLogicContainer = {

    createSiteData: {
            "parameters": {
                __metadata: { "type": "SP.WebInfoCreationInformation" },
                URL: "Paultest1",
                טיטל: "Paultest1",
                באַשרייַבונג: "rest-created web by Paul!",
                שפּראַך: 1033,
                WebTemplate: "sts",
                UseUniquePermissions: פאַלש
            }
    },

    createSite: פונקציע () {

        jQuery.support.cors = ריכטיק;

        CreateSiteLogicContainer.createSiteData.parameters.Url = $("#SiteName").וואַל();
        
        $.ajax({
            URL: "https://bigapplesharepoint.sharepoint.com/NBAIADev/_api/web/webinfos/add",
            מעטאָד: "POST",

            headers: {
                "Accept": "application/json; odata=verbose",
                "content-type": "application/json;odata=verbose",
                "X-RequestDigest": $("#__REQUESTDIGEST").וואַל()
            },

            דאַטע: JSON.stringify(CreateSiteLogicContainer.createSiteData),

            success: פונקציע () { פלינק("success"); },
            גרייַז: פונקציע () { פלינק("error"); }

        });
    },

    wireUpForm: פונקציע () {
        $("#CreateSiteButton").גיט(פונקציע () {
            פלינק("About to try and create the site.");
            CreateSiteLogicContainer.createSite();
        });
    }


}

CreateSiteLogicContainer.wireUpForm();

</שריפט>

When successful, you get a JSON packet in response like this:

My key thoughts and learnings from this include:

This approach uses jQuery. אין מיין פאַל, my jQuery library is located in “../plugins.” You’ll want to change that to point to your favorite JQ location.
You can copy and paste that whole snippet into a Content Editor Web Part on a page and it should work just fine. You’ll want to change the end point of the API call and make sure you reference JQ correctly.
The URL is relative to your API’s endpoint. אין מיין פאַל, it’s creating sub-sites underneath https://bigapplesharepoint.com
You don’t need to provide a content-length. Some blog posts and MSDN document implies that you do, but happened for me automatically, which I assume is being handled by the $.ajax call itself.
This line is required in order to avoid a “forbidden” response: "X-RequestDigest": $("#__REQUESTDIGEST").וואַל(). There are other ways to do it, but this is pretty nice. I have lost the link to blog that provided this shortcut. H/T to you, mysterious blogger!

Good luck and hope this helps someone out.

</עק>

אַבאָנירן צו מיין בלאָג.

גיי מיר אויף טוויטטער בייַ http://www.twitter.com/pagalvin

שנעל און סימפּלע: שאַרעפּאָינט מנוחה רוף בלויז רעטורנס 100 רעקאָרדס

2 רעפּליעס

I’ve been working on a public facing web site for my SharePoint practice here in New York and it uses a lot of JavaScript and REST calls to show content.

During mainline development, I create a small dataset with just 10 or so rows in a custom list and my REST calls all pulled from there. Once I bumped up the list to have a few hundred rows of data to test for anticipated growth, I found that I was getting exactly 100 rows returned back on my REST calls.

This is a very simple thing to address. אין מיין פאַל (and I believe in most cases), the default REST calls to SharePoint (and possibly as an industry standard?) צוריקקומען 100 rows. To return more than the default, use the $top parameter on your call, ווי אין:

GET /Insights Dev/_api/web/lists/GetByTitle(‘MockBlog’)/זאכן?$select=ID,טיטל,Categories/Title,Blog_x0020_Author/Title,DatePublished,BlogSummary&$expand=Blog_x0020_Author,Categories&$filter=&$top=9999

I picked 9999 in this case since I know that growth-wise, there won’t be more than 200 or so rows added to this list in a year. If it becomes ungainly, we can implement some paging down the road.

</עק>

אַבאָנירן צו מיין בלאָג.

גיי מיר אויף טוויטטער בייַ http://www.twitter.com/pagalvin