Filtering the Sharepoint List Taxonomy Column using Rest API

I ran into a strange issue today when using the SharePoint 2013 REST API for Lists with Managed Metadata columns  but I just had a ‘clever workaround’ moment with SharePoint’s oData/REST implementation when it comes to filtering list items based on taxonomy (managed metadata) columns. Now I do not consider myself a developer, so this article is probably a little verbose for some readers, but should be helpful to power users or IT pros.

 1. To filter the Taxonomy columns in SharePoint list using Rest API call we need to use the Post method.
2. The Rest API call will give errors some times when the Rest API Query string crosses limit 260 characters that time we will use the Query in the body. Those things are clearly explained in the below example clearly.
3. WE can use the CAMEL Query in the Rest API call this example come under that.
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js"></script>
<script>
$(document).ready(function() {
getListItemsTS();
});
function getListItemsTS()
{
var restURL= _spPageContextInfo.webAbsoluteUrl + "/_api/web/lists/getbytitle('SPFcReact')/GetItems";
//The below camel query is used to filter single taxonomy column
// var caml="<View><Query><Where><Eq><FieldRef Name='AssetFunctionTS'/>
<Value Type='TaxonomyFieldType'>Commercial</Value></Eq></Where></Query></View>";
    
    
var caml="<View><Query><Where><And><Eq><FieldRef Name='AssetFunctionTS'/>
<Value Type='TaxonomyFieldType'>Commercial</Value></Eq><Eq><FieldRef Name='BusinessSegmentTS'/>
<Value Type='TaxonomyFieldType'>LNG</Value></Eq></And></Where></Query></View>";
    
    //The requestData variable we are binding with camel query and we will use this in the rest api call body in place of data.
    var requestData = { "query" :
{
"__metadata":
{ "type": "SP.CamlQuery" }
, "ViewXml": caml
}
};
        
    
    var requestBody = JSON.stringify(requestData);
    
$.ajax
({
url: restURL,
type: "POST",
        data: requestBody,
headers:
{
"Accept": "application/json; odata=verbose",
"Content-Type": "application/json;odata=verbose",
            "X-RequestDigest": $("#__REQUESTDIGEST").val(),
            "content-length":requestBody.length
},
success: function(data)
{
            for(i=0; i< data.d.results.length; i++){
                if(data.d.results[i].AssetFunctionTS != null)
                {
                    console.log("Title : " + data.d.results[i].Title);
                    console.log("AssetFunctionTS : "+data.d.results[i].AssetFunctionTS.Label);  
                    console.log("BusinessSegmentTS : "+data.d.results[i].BusinessSegmentTS.Label)
                }
            }
        },
error: function(data)
{
            console.log(data.responseText);
alert(data.responseText);
}
});
}
</script>

Comments

Post a Comment

Popular posts from this blog

SharePoint 2013 Keyword Query (KQL) Content Class Property Restrictions

Using property restrictions in your KQL queries, you can restrict your search to only pull back certain things like calendar events for instance. This is a very powerful way to limit search results  and get exactly what you are looking for. You can use these in your query like this: " lunch contentclass:STS_ListItem_Events " This will return only calendar events with the word "lunch" in them.  Pretty powerful and pretty simple. Here is a list of available content class items: STS_Site –  Site Collection STS_Web  –  Site (Web) STS_List_850  –  Page Library STS_ListItem_850  –  Page STS_List_DocumentLibrary  –  Document Library STS_ListItem_DocumentLibrary  –  Document Library Items STS_List  –  Custom List STS_ListItem  –  Custom List Item STS_List_Links  –  Links List STS_ListItem_Links  –  Links List Item STS_List_Tasks  –  Tasks List STS_ListItem_Tasks  –  Tasks List Item STS_List_Events  –  Events List STS_ListItem_Events 
Read more

Hide Save button in New and Edit form in SharePoint 2013 list

Image
Hide Save button from New Edit form We have a SharePoint list where we have customized the input form using InfoPath. And in that customized InfoPath form we have a custom Save button and we are saving the item from the default data connection. This button also has some validation rules. So we do not want any user to insert an item by clicking on the Ribbon Save button. They should only be able to save through our Submit button which was presented inside the InfoPath form. You can disable the Save button from the InfoPath form submit properties. But we do not want to show the Save button at all. Be default the submit button appears like below:  We have written the JavaScript and css code to hide the Save button. For this Edit the page and then Insert a Script editor web part into it. Then write the below code inside the script editor web part and Save the page. <script type="text/javascript">     function hideEdit() {         var edit = docum
Read more