├── README.md
└── SharePointRESTtester.html


/README.md:
--------------------------------------------------------------------------------
  1 | # SharePointRESTtester
  2 | A JavaScript project to use with a Content Editor Web Part to test SharePoint REST API calls. It also creates AJAX sample code and SharePoint Designer 2013 Workflow steps.
  3 | 
  4 | Screen captures and a detailed install can be found at: http://techtrainingnotes.blogspot.com/2017/04/a-sharepoint-rest-api-tester-with-ajax.html
  5 | 
  6 | Now has over 80 SharePoint REST API examples!  (see list below)
  7 | 
  8 | To use:
  9 | ---------
 10 | 
 11 |  1. If your master page is not already loading jQuery, download jQuery (just about any version) and upload to the Site Pages library.
 12 |  2. Download the SharePointRESTtester.html file to your PC.
 13 |  3. Edit the file and update the line that loads jQuery to point your jQuery file. If your master page already loads jQuery, then delete the <script> block that loads the jQuery file. (the first line of the file)
 14 |  4. Upload the SharePointRESTtester.html file to your Site Pages library. (Copy the URL to the file.)
 15 |  5. Add a Web Part Page to your project:
 16 |  5.1 In the Site Pages library, click the **FILES** ribbon, click **New Document** and click Web **Part Page**.
 17 |  5.2 Enter a page name like "SharePointRESTtester".
 18 |  5.3 From the library dropdown select **Site Pages**.
 19 |  5.4 Click Create.
 20 |  6. Click **Add a Web Part**.
 21 |  7. Add a Content Editor Web Part.
 22 |  8. Click the web part's dropdown and click **Edit Web Part**.
 23 |  9. Enter or paste the path to the SharePointRESTtester.html file. 
 24 |  10. Click **OK** and then in the ribbon click **Stop Editing**.
 25 |  11. You should now see the tester. Click the dropdown and you should see data in the boxes. If not, then the jQuery library did not get loaded.
 26 | 
 27 | <br><br>
 28 | 
 29 | **Examples included**
 30 | 
 31 | **Search Queries (/_api/search/query)**
 32 | 
 33 |  - Keyword Search
 34 |  - Keyword Search with refinement filters (this one for file type)
 35 |  - Keyword Search with OR'd refinement filters (ANDs are similar)
 36 |  - People Search
 37 |  - List of all Site Collections for current user using search  (No direct REST API).
 38 |  - List of all Web Sites for current user using search  (No direct REST API).
 39 | 
 40 | **Misc REST Queries**
 41 | 
 42 |  - Get SharePoint's list of Time Zones.
 43 |  - Get Context info.
 44 | 
 45 | **CAML Queries**
 46 | 
 47 |  - CAML Query to find documents by Created date.
 48 |  - CAML Query to return all folders in a library. Uses FSObjType=1 and CAML recursive.
 49 |  
 50 |  **List items and documents**
 51 |  
 52 |  - Get a count of items in a library.
 53 |  - Get a count of items in a library. (Option #2)
 54 |  - Get all items in a list/library.
 55 |  - Get all items in a library with filename and path.
 56 |  - Get a list/library item by property and display the Title.
 57 |  - Get info about list attachments.
 58 |  - Get info about a single list attachment.
 59 |  - Get a library item by Filename and display the Title and ID.
 60 |  - Get a list/library item by ID and display the Title.
 61 |  - Get all items in a list/library filtered by date.
 62 |  - Add a new item to a list
 63 |  - Delete an item from a list using ID
 64 |  - Delete an item from a list using its URL
 65 |  - Delete an item, to the Recycle Bin, from a list using ID
 66 |  - Update an item using ID
 67 |  - Download a file.
 68 | 
 69 | **Folders**
 70 | 
 71 |  - CAML Query to return all folders in a library. Uses FSObjType=1 and CAML recursive.
 72 |  - Get a list folder's properties.
 73 |  - Get a count of items in a list folder.
 74 |  - Add a folder
 75 |  - Rename a folder
 76 | 
 77 | **Lists**
 78 | 
 79 |  - Get a list of lists from the current web. (all data)
 80 |  - Get a list of lists from the current web. (Just the title)
 81 |  - Get a list of Content Types for the current web.
 82 |  - Get a list of list columns. (Title,InternalName,FieldTypeKind,Formula,Hidden,Indexed)
 83 |  - Get a list of list columns by type. This one returns Calculated Columns.
 84 |  - Create a new list
 85 |  - Add a new folder to a list
 86 |  - Delete a list
 87 |  - Delete a list to the Recycle Bin
 88 | 
 89 | **Recycle Bins**
 90 | 
 91 |  - Get all items in web level recycle bin.
 92 |  - Get selected properties of all items in web level recycle bin.
 93 | 
 94 | **Site Collections**
 95 | 
 96 |  - Get information about the current site collection.
 97 |  - Get the size of the content in the current site collection.
 98 |  - Get the primary site collection administrator (Owner).
 99 |  - Get the primary site collection Secondary Contact.
100 | 
101 | **Webs (subsites)**
102 | 
103 |  - Get information about the current web.
104 |  - Get the Regional Settings for the current web.
105 |  - Get the Time Zone for the current web.
106 |  - Get a list of all webs below the current web.
107 |  - Get a list of all webs below the current web using "webinfos".
108 |  - Get a web's LastItemModifiedDate
109 |  - Create a new subsite.
110 |  - Delete a site (Warning Will Robinson! Does not go to the Recycle Bin!)
111 | 
112 | **User Profiles**
113 | 
114 |  - Get User Profile info about the current user.
115 |  - Get all User Profile properties for a user.
116 |  - Get User Profile info about a user's manager. (Set "propertyName=" to any User Profile Services property.)
117 | 
118 | **Permissions**
119 | 
120 |  - Get a list of Role Definitions for a site.
121 |  - Get a list of Site Users. The ID is useful when setting permissions.
122 |  - Get a list of Site Groups. The ID is useful when setting permissions.
123 |  - Get a list of Site Groups by name (filter).
124 |  - Get info about a Site Group using the ID.
125 |  - Get info about a Site Group using the Name.
126 |  - Get a list of users in a Site Group.
127 |  - Get a user by id from a Site Group.
128 |  - Get a user by email address from a Site Group by ID.
129 |  - Get a user by email address from a Site Group by Name.
130 |  - Get a user by partial email address from a Site Group by Name.
131 |  - Add a user to a Site Group by login name.
132 |  - Remove a user from an Site Group by user ID.
133 |  - Get a list of Site Groups where name contains 'string'.
134 |  - Break inheritance on a subsite.
135 |  - Break inheritance on a list.
136 |  - Break inheritance on a list item.
137 |  - Grant permissions (Role Assignment) on a list.
138 |  - Remove permissions (Role Assignment) on a list.
139 | 
140 | **Filter Select and OrderBy**
141 | 
142 |  - Get a list of Site Users who are not Site Collection admins. Get selected fields and sort.
143 | 
144 | **SharePoint 2010 style REST - _vti_bin/ListData.svc**
145 | 
146 |  - Get a list of lists and libraries (EntitySets).
147 |  - Find list items greater than a date.
148 |  - Find list items between two dates.
149 | 


--------------------------------------------------------------------------------
/SharePointRESTtester.html:
--------------------------------------------------------------------------------
   1 | <script language="javascript" src="jquery-3.1.0.min.js"></script>
   2 | <!-- delete the previous line if your master page already loads jQuery. -->
   3 | 
   4 | <script language="javascript">
   5 | 
   6 |     // Mike Smith
   7 |     // http://TechTrainingNotes.blogspot.com
   8 |     // 
   9 |     // Copyright (c) 2017, 2018 Microsmith, Inc.
  10 |     // You may use this code for personal use to write and test SP REST or just to study!
  11 |     // You may not republish this in another blog, or other format.
  12 |     
  13 |     // Last updated: 7/6/18
  14 | 
  15 |     // metadata info: /_vti_bin/Client.svc/$metadata
  16 | 
  17 |     var testJSONdata;  // data returned from the AJAX call
  18 |     var testNID;       // id for SP Notification popup so it can be closed later on
  19 | 
  20 | 
  21 |     function testWebService () {
  22 |         // display "Working" messages.
  23 |         $('#testWebServiceWorking').text("Working...         ");
  24 |         testNID = SP.UI.Notify.addNotification("<span style='color:blue'>Working...</span>");
  25 |         setTimeout(testWebServiceContinue , 1);  // to update page display...
  26 |     }
  27 | 
  28 |     function testWebServiceContinue () {
  29 | 
  30 |         // clean up from last run.
  31 |         $('#testResults').html("&nbsp;");
  32 |         $('#testJSONResults').html("");
  33 |         $('#testAJAXobject').html("");
  34 |         $('#ttnWFrequestHeaders').html("");
  35 |         $('#ttnWFdatatype').html("");
  36 |         $('#ttnWFmoredata').html("");
  37 |         $('#testWFthis').html("");
  38 |         $('#testWFrequestType').html("");
  39 | 
  40 | 
  41 |         // This is the code to build the AJAX object and call AJAX
  42 | 
  43 |         $('#outputBlock').show();
  44 | 
  45 |         try {
  46 |             // get the SharePoint generated __REQUESTDIGEST value
  47 |             var requestDigest = $("#__REQUESTDIGEST").val();
  48 | 
  49 |             var restUrl = $("#testWebServiceURL").val();
  50 |             var restMethod =  $("#testWebServiceMethod").val();
  51 | 
  52 |             var restBodyText = $("#testWebServiceBody").val();
  53 |             var restHeadersText =  $("#testWebServiceHeaders").val();
  54 |             restHeadersText = restHeadersText.replace("__len__",restBodyText.length);
  55 |             restHeadersText = restHeadersText.replace("__yourRequestDigest__",requestDigest);
  56 |             $("#testWebServiceHeaders").innerText = restHeadersText;
  57 | 
  58 | 
  59 |             // Note: JSON.parse() is more strict than eval(). For example, JSON.parse requires double quotes while most
  60 |             // JSON parsers will accept a single quote. JSON.parse also requires quoted names while many other parsers do not.
  61 |             // Use the eval() version for more flexibility.
  62 | 
  63 |             // validate the header JSON
  64 |             try { restHeaders = JSON.parse(restHeadersText); }
  65 |             catch (err) {  alert("Error parsing Headers: " + err.message + "\n" + restHeadersText); return  }
  66 | 
  67 | 
  68 |             // validate the body JSON
  69 |             if (restBodyText == "") {restBody=""} else
  70 |             {
  71 |                 try { restBody = JSON.parse(restBodyText); }
  72 |                 catch (err) {  alert("Error parsing Body: " + err.message); return  }
  73 |                 try { eval("restBody = " + restBodyText); }
  74 |                 catch (err) {  alert("Error parsing Body: " + err.message); return  }
  75 |             }
  76 | 
  77 |             // build the $.AJAX object
  78 |             var ajaxcall =    {
  79 |                 url: restUrl,
  80 |                 method: restMethod,
  81 |                 data: restBodyText,
  82 |                 headers: restHeaders,
  83 |                 success: function(data){testJSONdata = data; $("#testResults").html("<pre>" + JSON.stringify(data, undefined, 4) + "</pre>"); testCleanUp()},
  84 |                 error: function(err){$("#testResults").html("ERROR:  <pre>" + JSON.stringify(err, undefined, 4) + "</pre>"); testCleanUp()}
  85 |         };
  86 | 
  87 |             // remove the data property from the object if not needed.
  88 |             if (restBodyText=="") { delete ajaxcall['data'] }
  89 | 
  90 | 
  91 |             // display the AJAX script
  92 |             var ajaxcallForDisplay = JSON.stringify(ajaxcall, undefined, 4);
  93 | 
  94 |             ajaxcallForDisplay =  ajaxcallForDisplay.substring(0,ajaxcallForDisplay.length-2) + ',\n    "success" : successfunction,\n' + '    "error" : errorfunction\n}';
  95 |             ajaxcallForDisplay = ajaxcallForDisplay.replace(/\\n/g,"");
  96 |             ajaxcallForDisplay = ajaxcallForDisplay.replace(/\\"/g,"\"");
  97 |             ajaxcallForDisplay = ajaxcallForDisplay.replace(/               /g," ");
  98 |             ajaxcallForDisplay = ajaxcallForDisplay.replace(/"data": "{"/g,"\"data\": \'{\"");
  99 |             ajaxcallForDisplay = ajaxcallForDisplay.replace(/ } }",/g," } }',");
 100 |             ajaxcallForDisplay = ajaxcallForDisplay.replace(requestDigest ,"yourRequestDigestGoesHere");
 101 | 
 102 |             $("#testAJAXobject").html("<pre>$.ajax(\n" + ajaxcallForDisplay + "\n);</pre>");
 103 | 
 104 | 
 105 |             $('#SP2013wf').show();
 106 | 
 107 | 
 108 |             $("#testWFthis").html(restUrl.substring(restUrl.indexOf("_api")));
 109 | 
 110 | 
 111 |             // get rid of the X-RequestDigest - not needed for workflows
 112 |             if (restHeadersText.indexOf("X-RequestDigest")>0)
 113 |             {
 114 |                 var restHeadersText2 = restHeadersText.split(",");
 115 |                 restHeadersText2 = restHeadersText2.slice(0,restHeadersText2.length-2)
 116 |                 restHeadersText = restHeadersText2.join(",") + " }";
 117 |                 
 118 |                 $("#testAJAXobjectNote").show();
 119 |             }
 120 | 
 121 |             var headerData = JSON.parse(restHeadersText);
 122 | 
 123 |             var headers = $("#ttnWFrequestHeaders").get(0);
 124 |             
 125 |             headers.innerHTML = "";
 126 |             for (var name in headerData ) {
 127 |                 if (name != "content-length") {
 128 |                     headers.innerHTML +=
 129 |                         '&nbsp;&nbsp;Name:  <span class="ttnWFspan">' + name + '</span> <br>' +
 130 |                         '&nbsp;&nbsp;Type:  <span class="ttnWFspan">String</span>  <br>' +
 131 |                         '&nbsp;&nbsp;Value: <span class="ttnWFspan">' + headerData[name] + '</span> <br><br>  '
 132 |                 }
 133 |             }
 134 | 
 135 |             $("#testWFrequestType").text(restMethod);
 136 | 
 137 |             if (restBodyText == "")
 138 |             {
 139 |                 $("#ttnHasBody01").hide();
 140 |                 $("#ttnWFrequestData").hide();
 141 |             }
 142 |             else
 143 |             {
 144 |                 $("#ttnWFrequestData").show();
 145 |                 $("#ttnHasBody01").show();
 146 |                 var bodyData = JSON.parse(restBodyText);
 147 |                 $("#ttnHasBody02").hide();
 148 | 
 149 | 
 150 |                 // are there three tiers to the body JSON?
 151 |                 if(bodyData.hasOwnProperty("parameters") | bodyData.hasOwnProperty("query")) 
 152 |                 { 
 153 |                     $("#ttnHasBody02").show();
 154 |                     $("#ttnContentDataName").text("requestData")
 155 |                     // drill down one level for the metadata
 156 |                     if(bodyData.parameters)
 157 |                     {
 158 |                         bodyData = bodyData.parameters;
 159 |                     }
 160 |                     else
 161 |                     {
 162 |                         bodyData = bodyData.query;
 163 |                     }
 164 |                 }
 165 |                 else
 166 |                 {
 167 |                     $("#ttnContentDataName").text("requestContent")
 168 |                 }
 169 | 
 170 | 
 171 |                 var moredata = $("#ttnWFmoredata").get(0);
 172 |                 moredata.innerHTML = "<br>";
 173 |                 for (var name in bodyData ) {
 174 |                     if (name != "__metadata") {
 175 |                         var spanData = "" + bodyData[name];
 176 |                         spanData = spanData.replace(/</g, "&lt;").replace(/>/g, "&gt;")
 177 |                         moredata.innerHTML +=
 178 |                             '&nbsp;&nbsp;Name:  <span class="ttnWFspan">' + name + '</span> <br>' +
 179 |                             '&nbsp;&nbsp;Type:  <span class="ttnWFspan">String</span>  <br>' +
 180 |                             '&nbsp;&nbsp;Value: <span class="ttnWFspan">' + spanData + '</span> <br><br>  '
 181 |                     }                    
 182 |                 }
 183 |                 $("#ttnWFdatatype").text(bodyData.__metadata.type);
 184 |             }
 185 | 
 186 | 
 187 | 
 188 |             // run the code! Select, change, create and delete stuff!
 189 |             if ($('#testResultsBlock').is(':visible'))
 190 |             {
 191 |                 try {
 192 |                     var testSuccessFail = $.ajax( ajaxcall )
 193 |                 }
 194 |                 catch(err) {
 195 |                     alert(err.message)
 196 |                 }
 197 |             }
 198 |             else
 199 |             {
 200 |                 testCleanUp();
 201 |             }
 202 | 
 203 | 
 204 |         } catch(err) {
 205 |             $('#testWebServiceWorking').text("Error!         ");
 206 |             alert(err);
 207 |         }
 208 | 
 209 |     }
 210 | 
 211 | 
 212 | 
 213 |     function testCleanUp() {
 214 |         $('#testWebServiceWorking').text("");
 215 |         SP.UI.Notify.removeNotification(testNID);
 216 |     }
 217 | 
 218 | 
 219 |     // called from the select dropdown to dislay a sample REST call
 220 |     function displayTestWebServiceSample() {
 221 |         var siteUrl = L_Menu_BaseUrl;  //ctx.HttpRoot;  //built-in SharePoint value 
 222 |         var myselect = document.getElementById("testWebServiceSamples");
 223 |         document.getElementById("testWebServiceURL").value =  siteUrl + myselect.options[myselect.selectedIndex].value;
 224 |         document.getElementById("testWebServiceMethod").value = myselect.options[myselect.selectedIndex].getAttribute("method");
 225 |         document.getElementById("testWebServiceHeaders").value = myselect.options[myselect.selectedIndex].getAttribute("headers");
 226 |         document.getElementById("testWebServiceBody").value = myselect.options[myselect.selectedIndex].getAttribute("body");
 227 |         document.getElementById("testNotes").innerText = myselect.options[myselect.selectedIndex].getAttribute("notes");
 228 |         document.getElementById("testJSONpath").value = myselect.options[myselect.selectedIndex].getAttribute("sampleJSON");
 229 | 
 230 |         document.getElementById("testWFJSONpath").innerText = myselect.options[myselect.selectedIndex].getAttribute("sampleJSON").replace("data.d.","");
 231 | 
 232 |         AutoSizeTextAreas();
 233 | 
 234 |     }
 235 | 
 236 | 
 237 | 
 238 |     // process "Experiment with the JSON results" button.
 239 |     // This takes the returned data and extracts data using data.d.someobject...
 240 |     function testParseSomeJSON(path)
 241 |     {
 242 |         // take user input in the form of "data.d.something" and see if we can EVAL it.
 243 |         try {
 244 |             var testJSONquery = "";
 245 |             path = path.replace(/data.d./g,"testJSONdata.d.");
 246 |             eval("testJSONquery = " + path);
 247 |             document.getElementById("testJSONResults").innerText = JSON.stringify(testJSONquery, undefined, 4);
 248 |         } catch (err) {alert("Error for " + path + ":\n" +err.message)}
 249 |     }
 250 | 
 251 | </script>
 252 | 
 253 | 
 254 | <style type="text/css">
 255 |   .ttnResultDiv {
 256 |         border: thin blue solid;
 257 |         width: 800px;
 258 |         display: inline-flex;
 259 |         overflow-x: scroll;
 260 |         white-space: nowrap;
 261 |     }
 262 | 
 263 |     .ttnWFspan {
 264 |         color: blue;
 265 |         font-weight: bold;
 266 |     }
 267 | 
 268 |   .ttnOptGroup {
 269 |       color:#0000FF!important;
 270 |   }
 271 |   .ttnOptGroup option {
 272 |       color:black;
 273 |   } 
 274 | </style>
 275 | 
 276 | 
 277 | <!-- The UI -->
 278 | 
 279 | <div style="max-width:400">
 280 | 
 281 |     <h2>SharePoint 2013 and later REST Tester!  (SharePointRESTtester)</h2><br>
 282 |     This tool is used to build and test the REST API for SharePoint 2013 and later. It currently only supports JSON data and not XML.<br>
 283 |     For info see <a href="http://TechTrainingNotes.blogspot.com">Tech Training Notes blog</a> or <a href="https://github.com/microsmith/SharePointRESTtester">GitHub</a>. 
 284 |     <a href="/_vti_bin/Client.svc/$metadata" target="_new">SharePoint REST metadata</a> from your farm.<br><br>
 285 | 
 286 |     <!--
 287 |         // The following SELECT is the Sample list
 288 |         //
 289 |         // The following are replaced when clicking "Call the web service" button:
 290 |         //  __len__ will be replaced in the headers with the length of the body text
 291 |         //  __yourRequestDigest__ will be replaced with the current RequestDigest found in the page.
 292 |         //                        (document.getElementById("__REQUESTDIGEST").value)
 293 |         //
 294 |         // a future version will store these values in a SharePoint list.
 295 |     -->
 296 | 
 297 |     <b>Select a sample from this list, or add your URL and JSON to test.</b> <span id="ExampleCount"></span><br>
 298 |     <select id="testWebServiceSamples" onchange="displayTestWebServiceSample(); return false;">
 299 |         <option value="">Samples</option>
 300 |         <optgroup class="ttnOptGroup"  label="Search Queries (/_api/search/query)">
 301 |             <option method="GET"
 302 |                     body=""
 303 |                     headers='{"accept": "application/json; odata=verbose"}'
 304 |                     notes="Change the querytext, StartRow and RowLimit in the URL. (Max of 500 rows per query!)"
 305 |                     sampleJSON="data.d.query.PrimaryQueryResult.RelevantResults.RowCount"
 306 |                     value="/_api/search/query?querytext='sharepoint'&selectproperties='Title,Author'&StartRow=1&RowLimit=100">
 307 |                 Keyword Search
 308 |             </option>
 309 |             <option method="GET"
 310 |                     body=""
 311 |                     headers='{"accept": "application/json; odata=verbose"}'
 312 |                     notes="Change the querytext in the URL."
 313 |                     sampleJSON="data.d.query.PrimaryQueryResult.RelevantResults.RowCount"
 314 |                     value="/_api/search/query?querytext='sharepoint'&selectproperties='Title,Author'&refinementfilters='fileExtension:equals(&quot;docx&quot;)'&StartRow=1&RowLimit=100">
 315 |                 Keyword Search with refinement filters (this one for file type)
 316 |             </option>
 317 |             <option method="GET"
 318 |                     body=""
 319 |                     headers='{"accept": "application/json; odata=verbose"}'
 320 |                     notes="Change the querytext in the URL."
 321 |                     sampleJSON="data.d.query.PrimaryQueryResult.RelevantResults.RowCount"
 322 |                     value="/_api/search/query?querytext='sharepoint'&selectproperties='Title,Author'&refinementfilters='or(fileExtension:equals(&quot;docx&quot;),fileExtension:equals(&quot;pptx&quot;))'&StartRow=1&RowLimit=100">
 323 |                 Keyword Search with OR'd refinement filters (ANDs are similar)
 324 |             </option>
 325 |             <option method="GET"
 326 |                     body=""
 327 |                     headers='{"accept": "application/json; odata=verbose"}'
 328 |                     notes="Change the querytext in the URL. The SourceId GUID represents the People content source."
 329 |                     sampleJSON="data.d.query.PrimaryQueryResult.RelevantResults.RowCount   // or data.d.query.PrimaryQueryResult.RelevantResults.Table.Rows.results.length"
 330 |                     value="/_api/search/query?querytext='*'&sourceid='B09A7990-05EA-4AF9-81EF-EDFAB16C4E31'&rowlimit=100&selectproperties='PreferredName,Birthday'">
 331 |                 People Search
 332 |             </option>
 333 |             <option method="GET"
 334 |                     body=""
 335 |                     headers='{"accept": "application/json; odata=verbose"}'
 336 |                     notes="Returns site collects for the current user only! Note the 'rowlimit'."
 337 |                     sampleJSON="data.d.query.PrimaryQueryResult.RelevantResults.RowCount"
 338 |                     value="/_api/search/query?querytext='contentclass:sts_site'&selectproperties='SiteId,Path,Title'&trimduplicates=true&rowlimit=1000">
 339 |                 List of all Site Collections for current user using search  (No direct REST API).
 340 |             </option>
 341 |             <option method="GET"
 342 |                     body=""
 343 |                     headers='{"accept": "application/json; odata=verbose"}'
 344 |                     notes="Returns site collects for the current user only! Note the 'rowlimit'."
 345 |                     sampleJSON="data.d.query.PrimaryQueryResult.RelevantResults.RowCount"
 346 |                     value="/_api/search/query?querytext='contentclass:sts_web'&selectproperties='SiteId,Path,Title'&trimduplicates=true&rowlimit=1000">
 347 |                 List of all Web Sites for current user using search  (No direct REST API).
 348 |             </option>
 349 |         </optgroup>
 350 | 
 351 |         <optgroup class="ttnOptGroup"  label="Misc REST Queries">
 352 |             <option method="GET"
 353 |                     body=""
 354 |                     headers='{"accept": "application/json; odata=verbose"}'
 355 |                     notes=""
 356 |                     sampleJSON="data.d.results[5].Description"
 357 |                     value="/_api/web/RegionalSettings/TimeZones">
 358 |                 Get SharePoint's list of Time Zones.
 359 |             </option>
 360 |             <option method="POST"
 361 |                     body=''
 362 |                     headers='{"accept": "application/json;odata=verbose"}'
 363 |                     notes="Must be a POST."
 364 |                     sampleJSON="data.d.results.length"
 365 |                     value="/_api/contextinfo">
 366 |                 Get Context info.
 367 |             </option>
 368 |         </optgroup>
 369 | 
 370 |         <optgroup class="ttnOptGroup"  label="CAML Queries">
 371 |             <option method="POST"
 372 |                     body=''
 373 |                     headers='{"accept": "application/json;odata=verbose",
 374 |                        "content-type": "application/json;odata=verbose",
 375 | 	                   "content-length":__len__,
 376 | 	                   "X-RequestDigest&quot;: &quot;__yourRequestDigest__"}'
 377 |                     notes="Change the entire query! Or at least the dates for this example. CAML queries must be sent as a POST."
 378 |                     sampleJSON="data.d.results.length"
 379 |                     value="/_api/web/lists/getbytitle('Documents')/GetItems(query=@v1)?@v1={'ViewXml':'<View><Query><Where><Geq><FieldRef Name=\'Created\' /><Value Type=\'DateTime\'>2018-02-01T10:10:03</Value></Geq></Where></Query></View>'}">
 380 |                 CAML Query to find documents by Created date.
 381 |             </option>
 382 |             <option method="POST"
 383 |                     body=''
 384 |                     headers='{"accept": "application/json;odata=verbose",
 385 |                        "content-type": "application/json;odata=verbose",
 386 | 	                   "content-length":__len__,
 387 | 	                   "X-RequestDigest&quot;: &quot;__yourRequestDigest__"}'
 388 |                     notes="Change the entire query! Or at least the dates for this example. CAML queries must be sent as a POST."
 389 |                     sampleJSON="data.d.results.length"
 390 |                     value="/_api/web/lists/getbytitle('Documents')/GetItems(query=@v1)?@v1={'ViewXml':'<View Scope=\'RecursiveAll\'><Query><Where><Eq><FieldRef Name=\'FSObjType\' /><Value Type=\'LookUp\'>1</Value></Eq></Where></Query></View>'}&$select=FileDirRef,fileleafref">
 391 |                 CAML Query to return all folders in a library. Uses FSObjType=1 and CAML recursive.
 392 |             </option>
 393 |         </optgroup>
 394 | 
 395 |         <optgroup class="ttnOptGroup"  label="List items and documents">
 396 |             <option method="GET"
 397 |                     body=""
 398 |                     headers='{"accept": "application/json; odata=verbose"}'
 399 |                     notes="Change the list/library name"
 400 |                     sampleJSON="data.d.ItemCount"
 401 |                     value="/_api/web/lists/getbytitle('Documents')?$Select=ItemCount">
 402 |                 Get a count of items in a library.
 403 |             </option>
 404 |             <option method="GET"
 405 |                     body=""
 406 |                     headers='{"accept": "application/json; odata=verbose"}'
 407 |                     notes="Change the list/library name"
 408 |                     sampleJSON="data.d.ItemCount"
 409 |                     value="/_api/web/lists/getbytitle('Documents')/itemcount">
 410 |                 Get a count of items in a library. (Option #2)
 411 |             </option>
 412 |             <option method="GET"
 413 |                     body=""
 414 |                     headers='{"accept": "application/json; odata=verbose"}'
 415 |                     notes="Change the library name"
 416 |                     sampleJSON="data.d.results.length"
 417 |                     value="/_api/web/lists/getbytitle('Documents')/items?$select=FileDirRef,FileDirRef,Title">
 418 |                 Get all items in a list/library.
 419 |             </option>
 420 |             <option method="GET"
 421 |                     body=""
 422 |                     headers='{"accept": "application/json; odata=verbose"}'
 423 |                     notes="Change the library name. Must use internal field names. (i.e. use FileLeafRef, not Name)"
 424 |                     sampleJSON="data.d.results.length"
 425 |                     value="/_api/web/lists/getbytitle('Documents')/items?$select=FileDirRef,FileLeafRef,Title,Created,Modified">
 426 |                 Get all items in a library with filename and path.
 427 |             </option>
 428 |             <option method="GET"
 429 |                     body=""
 430 |                     headers='{"accept": "application/json; odata=verbose"}'
 431 |                     notes="Change the list name and the filter text. "
 432 |                     sampleJSON="data.d.results.length"
 433 |                     value="/_api/web/lists/getbytitle('Announcements')/items?$filter=Title eq 'Test announcement'">
 434 |                 Get a list/library item by property and display the Title.
 435 |             </option>
 436 |             <option method="GET"
 437 |                     body=""
 438 |                     headers='{"accept": "application/json; odata=verbose"}'
 439 |                     notes="Change the list name and the item ID. "
 440 |                     sampleJSON="data.d.results.length"
 441 |                     value="/_api/web/lists/getbytitle('Tasks')/Items/GetById(7)/AttachmentFiles">
 442 |                 Get info about list attachments.
 443 |             </option>
 444 |             <option method="GET"
 445 |                     body=""
 446 |                     headers='{"accept": "application/json; odata=verbose"}'
 447 |                     notes="Change the list name, the item ID and the document name. "
 448 |                     sampleJSON="data.d.results.length"
 449 |                     value="/_api/web/lists/getbytitle('Tasks')/Items/GetById(7)/AttachmentFiles('SomeDocument.docx')">
 450 |                 Get info about a single list attachment.
 451 |             </option>
 452 |             <option method="GET"
 453 |                     body=""
 454 |                     headers='{"accept": "application/json; odata=verbose"}'
 455 |                     notes="Change the list/library name and the file name. "
 456 |                     sampleJSON="data.d.results.length"
 457 |                     value="/_api/web/lists/getbytitle('Documents')/Items?$filter=FileLeafRef eq 'AdventureWorksBikes.xlsx'&$select=Title,Id">
 458 |                 Get a library item by Filename and display the Title and ID.
 459 |             </option>
 460 |             <option method="GET"
 461 |                     body=""
 462 |                     headers='{"accept": "application/json; odata=verbose"}'
 463 |                     notes="Change the list/library name. "
 464 |                     sampleJSON="data.d.results.length"
 465 |                     value="/_api/web/lists/getbytitle('Tasks')/Items/GetById(2)?$select=Title">
 466 |                 Get a list/library item by ID and display the Title.
 467 |             </option>
 468 |             <option method="GET"
 469 |                     body=""
 470 |                     headers='{"accept": "application/json; odata=verbose"}'
 471 |                     notes="Change the library name. Date must be yyyy-mm-ddT00:00:00"
 472 |                     sampleJSON="data.d.results.length"
 473 |                     value="/_api/web/lists/getbytitle('Documents')/items?$select=Title&$filter=Created gt datetime'2016-8-6T00:00:00'">
 474 |                 Get all items in a list/library filtered by date.
 475 |             </option>
 476 |             <option method="POST"
 477 |                     body='{"__metadata":{"type":"SP.Data.AnnouncementsListItem"},
 478 | 	                "Title":"Test announcement", "Body":"hello!" }'
 479 |                     headers='{ "accept": "application/json;odata=verbose",
 480 | 	                   "content-type": "application/json;odata=verbose",
 481 | 	                   "content-length":__len__,
 482 | 	                   "X-RequestDigest&quot;: &quot;__yourRequestDigest__"}'
 483 |                     notes="Change the list title, the SP.Data.type and the item data!"
 484 |                     sampleJSON="data.d.Id"
 485 |                     value="/_api/web/lists/GetByTitle('Announcements')/Items">
 486 |                 Add a new item to a list
 487 |             </option>
 488 |             <option method="POST"
 489 |                     body=""
 490 |                     headers='{ "accept": "application/json;odata=verbose",
 491 | 	                   "content-type": "application/json;odata=verbose",
 492 | 	                   "X-HTTP-Method": "DELETE",
 493 | 	                   "If-Match": "*",
 494 | 	                   "X-RequestDigest": "__yourRequestDigest__"}'
 495 |                     notes="Change the list title, item ID! DELETE does not return any data. For more info on eTags and If-Match see: https://blogs.msdn.microsoft.com/uksharepoint/2013/02/22/manipulating-list-items-in-sharepoint-hosted-apps-using-the-rest-api/"
 496 |                     sampleJSON="data.d.Id"
 497 |                     value="/_api/web/lists/GetByTitle('Announcements')/Items(1)">
 498 |                 Delete an item from a list using ID
 499 |             </option>
 500 |             <option method="POST"
 501 |                     body=""
 502 |                     headers='{ "accept": "application/json;odata=verbose",
 503 | 	                   "content-type": "application/json;odata=verbose",
 504 | 	                   "X-HTTP-Method": "DELETE",
 505 | 	                   "If-Match": "*",
 506 | 	                   "X-RequestDigest": "__yourRequestDigest__"}'
 507 |                     notes="Change the list title, item ID! DELETE does not return any data. The item is NOT sent to the Recyle Bin! To send to the Recycle Bin add /recycle(). For more info on eTags and If-Match see: https://blogs.msdn.microsoft.com/uksharepoint/2013/02/22/manipulating-list-items-in-sharepoint-hosted-apps-using-the-rest-api/"
 508 |                     sampleJSON="data.d.Id"
 509 |                     value="/_api/web/getfilebyserverrelativeurl('/sites/workflowtest/Shared%20Documents/AirplaneLogo.jpg')">
 510 |                 Delete an item from a list using its URL
 511 |             </option>
 512 |             <option method="POST"
 513 |                     body=""
 514 |                     headers='{ "accept": "application/json;odata=verbose",
 515 | 	                   "content-type": "application/json;odata=verbose",
 516 | 	                   "X-HTTP-Method": "DELETE",
 517 | 	                   "If-Match": "*",
 518 | 	                   "X-RequestDigest": "__yourRequestDigest__"}'
 519 |                     notes="Change the list title, item ID! DELETE does not return any data. For more info on eTags and If-Match see: https://blogs.msdn.microsoft.com/uksharepoint/2013/02/22/manipulating-list-items-in-sharepoint-hosted-apps-using-the-rest-api/"
 520 |                     sampleJSON="data.d.Id"
 521 |                     value="/_api/web/lists/GetByTitle('Announcements')/Items(1)/recycle()">
 522 |                 Delete an item, to the Recycle Bin, from a list using ID
 523 |             </option>
 524 |             <option method="POST"
 525 |                     body='{ "__metadata": { "type": "SP.ListItem" }, "Title": "New title" }'
 526 |                     headers='{ "accept": "application/json;odata=verbose",
 527 | 	                   "content-type": "application/json;odata=verbose",
 528 | 	                   "X-HTTP-Method": "MERGE",
 529 | 	                   "If-Match": "*",
 530 | 	                   "X-RequestDigest": "__yourRequestDigest__"}'
 531 |                     notes="Change the list title, item ID! DELETE does not return any data. For more info on eTags and If-Match see: https://blogs.msdn.microsoft.com/uksharepoint/2013/02/22/manipulating-list-items-in-sharepoint-hosted-apps-using-the-rest-api/"
 532 |                     sampleJSON="data.d.Id"
 533 |                     value="/_api/web/lists/GetByTitle('Announcements')/Items(1)">
 534 |                 Update an item using ID
 535 |             </option>
 536 |             <option method="GET"
 537 |                     body=""
 538 |                     headers='{"accept": "application/json; odata=verbose"}'
 539 |                     notes="Change the list/library name and the file name. "
 540 |                     sampleJSON="data.d.results.length"
 541 |                     value="/_api/web/GetFileByServerRelativeUrl('/sites/training/demoworkflow/shared documents/AdventureWorksBikes.xlsx')/$value">
 542 |                 Download a file. 
 543 |             </option>            
 544 |         </optgroup>
 545 | 
 546 |         <optgroup class="ttnOptGroup"  label="Folders">
 547 |             <option method="POST"
 548 |                     body=''
 549 |                     headers='{"accept": "application/json;odata=verbose",
 550 |                        "content-type": "application/json;odata=verbose",
 551 | 	                   "content-length":__len__,
 552 | 	                   "X-RequestDigest&quot;: &quot;__yourRequestDigest__"}'
 553 |                     notes="Change the entire query! Or at least the dates for this example. CAML queries must be sent as a POST."
 554 |                     sampleJSON="data.d.results.length"
 555 |                     value="/_api/web/lists/getbytitle('Documents')/GetItems(query=@v1)?@v1={'ViewXml':'<View Scope=\'RecursiveAll\'><Query><Where><Eq><FieldRef Name=\'FSObjType\' /><Value Type=\'LookUp\'>1</Value></Eq></Where></Query></View>'}&$select=FileDirRef,fileleafref">
 556 |                 CAML Query to return all folders in a library. Uses FSObjType=1 and CAML recursive.
 557 |             </option>
 558 |             <option method="GET"
 559 |                     body=""
 560 |                     headers='{"accept": "application/json; odata=verbose"}'
 561 |                     notes="Change the site, list and folder names."
 562 |                     sampleJSON="data.d.ItemCount"
 563 |                     value="/_api/web/getfolderbyserverrelativeurl('/sites/yourSite/Lists/yourList/yourFolder')">
 564 |                 Get a list folder's properties.
 565 |             </option>
 566 |             <option method="GET"
 567 |                     body=""
 568 |                     headers='{"accept": "application/json; odata=verbose"}'
 569 |                     notes="Change the site, list and folder names."
 570 |                     sampleJSON="data.d.ItemCount"
 571 |                     value="/_api/web/getfolderbyserverrelativeurl('/sites/yourSite/Lists/yourList/yourFolder')/itemcount">
 572 |                 Get a count of items in a list folder.
 573 |             </option>
 574 |             <option method="POST"
 575 |                     body=""
 576 |                     headers='{ "accept": "application/json;odata=verbose",
 577 |                        "content-type": "application/json;odata=verbose",
 578 |                        "If-Match":  "*",
 579 |                        "content-length":0,
 580 |                        "X-RequestDigest": "__yourRequestDigest__"}'
 581 |                     notes="Update the URL to select the folder, and update the Body to supply the new names."
 582 |                     sampleJSON="data.d.Id"
 583 |                     value="/_api/Web/Folders/add('Shared Documents/TestFolder')">
 584 |                 Add a folder
 585 |             </option>
 586 |             <option method="POST"
 587 |                     body='{"__metadata":{"type":"SP.Data.Shared_x0020_DocumentsItem"},
 588 |                            "Title":"TestToysDocs", "FileLeafRef":"TestToysDocs" }'
 589 |                     headers='{ "accept": "application/json;odata=verbose",
 590 |                        "content-type": "application/json;odata=verbose",
 591 |                        "X-HTTP-Method": "MERGE",
 592 |                        "If-Match":  "*",
 593 |                        "content-length":__len__,
 594 |                        "X-RequestDigest": "__yourRequestDigest__"}'
 595 |                     notes="Update the URL to select the folder, and update the Body to supply the new names."
 596 |                     sampleJSON="data.d.Id"
 597 |                     value="/_api/web/GetFolderByServerRelativeUrl('Shared Documents/Toys')/ListItemAllFields">
 598 |                 Rename a folder
 599 |             </option>
 600 |         </optgroup>
 601 | 
 602 |         <optgroup class="ttnOptGroup"  label="Lists">
 603 |             <option method="GET"
 604 |                     body=""
 605 |                     headers='{"accept": "application/json; odata=verbose"}'
 606 |                     notes=""
 607 |                     sampleJSON="data.d.results.length"
 608 |                     value="/_api/web/lists">
 609 |                 Get a list of lists from the current web. (all data)
 610 |             </option>
 611 |             <option method="GET"
 612 |                     body=""
 613 |                     headers='{"accept": "application/json; odata=verbose"}'
 614 |                     notes=""
 615 |                     sampleJSON="data.d.results.length"
 616 |                     value="/_api/web/lists?$select=Title">
 617 |                 Get a list of lists from the current web. (Just the title)
 618 |             </option>
 619 |             <option method="GET"
 620 |                     body=""
 621 |                     headers='{"accept": "application/json; odata=verbose"}'
 622 |                     notes=""
 623 |                     sampleJSON="data.d.results.length"
 624 |                     value="/_api/Web/ContentTypes">
 625 |                 Get a list of Content Types for the current web. 
 626 |             </option>
 627 |             <option method="GET"
 628 |                     body=""
 629 |                     headers='{"accept": "application/json; odata=verbose"}'
 630 |                     notes=""
 631 |                     sampleJSON="data.d.results.length"
 632 |                     value="/_api/web/lists/getbytitle('Documents')/Fields?$select=Title,InternalName,FieldTypeKind,Formula,Hidden,Indexed">
 633 |                 Get a list of list columns. (Title,InternalName,FieldTypeKind,Formula,Hidden,Indexed)
 634 |             </option>
 635 |             <option method="GET"
 636 |                     body=""
 637 |                     headers='{"accept": "application/json; odata=verbose"}'
 638 |                     notes="(For FieldTypeKind IDs see: <a href='https://msdn.microsoft.com/en-us/library/office/microsoft.sharepoint.client.fieldtype.aspx'>https://msdn.microsoft.com/en-us/library/office/microsoft.sharepoint.client.fieldtype.aspx</a>)"
 639 |                     sampleJSON="data.d.results.length"
 640 |                     value="/_api/web/lists/getbytitle('Documents')/Fields?$filter=FieldTypeKind eq 17&$select=Title,FieldTypeKind,Formula">
 641 |                 Get a list of list columns by type. This one returns Calculated Columns. 
 642 |             </option>
 643 |             <option method="POST"
 644 |                     body='{"__metadata": { "type": "SP.List" },
 645 | 	               "AllowContentTypes": true,
 646 | 	               "BaseTemplate": 100,
 647 | 	               "ContentTypesEnabled": true,
 648 | 	               "Description": "My list description",
 649 | 	               "Title": "Test" }'
 650 |                     headers='{"accept": "application/json;odata=verbose",
 651 |                        "content-type": "application/json;odata=verbose",
 652 | 	                   "content-length":__len__,
 653 | 	                   "X-RequestDigest&quot;: &quot;__yourRequestDigest__"}'
 654 |                     notes="Change the list title."
 655 |                     sampleJSON="data.d.Id"
 656 |                     value="/_api/web/lists">
 657 |                 Create a new list
 658 |             </option>
 659 | 
 660 |             <option method="POST"
 661 |                     body='{"__metadata":{"type":"SP.Folder"}, "ServerRelativeUrl": "/document library relative url/folder name"}',
 662 |                     headers='{ "accept": "application/json;odata=verbose",
 663 | 	                   "content-type": "application/json;odata=verbose",
 664 | 	                   "content-length":__len__,
 665 | 	                   "X-RequestDigest&quot;: &quot;__yourRequestDigest__"}'
 666 |                     notes="Change the folder title and the ServerRelativeUrl!"
 667 |                     sampleJSON="data.d.Id"
 668 |                     value="/_api/web/folders">
 669 |                 Add a new folder to a list
 670 |             </option>
 671 |             <option method="POST"
 672 |                     body=""
 673 |                     headers='{ "accept": "application/json;odata=verbose",
 674 | 	                   "content-type": "application/json;odata=verbose",
 675 | 	                   "X-HTTP-Method": "DELETE",
 676 | 	                   "If-Match": "*",
 677 | 	                   "X-RequestDigest": "__yourRequestDigest__"}'
 678 |                     notes="Change the list title in the URL! DELETE does not return any data.  For more info on eTags and If-Match see: https://blogs.msdn.microsoft.com/uksharepoint/2013/02/22/manipulating-list-items-in-sharepoint-hosted-apps-using-the-rest-api/"
 679 |                     sampleJSON="data.d.Id"
 680 |                     value="/_api/web/lists/GetByTitle('Announcements')">
 681 |                 Delete a list
 682 |             </option>
 683 |             <option method="POST"
 684 |                     body=""
 685 |                     headers='{ "accept": "application/json;odata=verbose",
 686 | 	                   "content-type": "application/json;odata=verbose",
 687 | 	                   "X-RequestDigest": "__yourRequestDigest__"}'
 688 |                     notes="Change the list title in the URL!"
 689 |                     sampleJSON="data.d.Id"
 690 |                     value="/_api/web/lists/GetByTitle('Announcements')/recycle()">
 691 |                 Delete a list to the Recycle Bin
 692 |             </option>
 693 |         </optgroup>
 694 | 
 695 |         <optgroup class="ttnOptGroup"  label="Recycle Bins">
 696 |             <option method="GET"
 697 |                     body=""
 698 |                     headers='{"accept": "application/json; odata=verbose"}'
 699 |                     notes=""
 700 |                     sampleJSON="data.d.results.length"
 701 |                     value="/_api/web/Recyclebin">
 702 |                 Get all items in web level recycle bin.
 703 |             </option>
 704 |             <option method="GET"
 705 |                     body=""
 706 |                     headers='{"accept": "application/json; odata=verbose"}'
 707 |                     notes=""
 708 |                     sampleJSON="data.d.results.length"
 709 |                     value="/_api/web/RecycleBin?$select=LeafName,DeletedByName,DeletedDateLocalFormatted">
 710 |                 Get selected properties of all items in web level recycle bin.
 711 |             </option>
 712 |         </optgroup>
 713 | 
 714 | 
 715 | 
 716 |         <optgroup class="ttnOptGroup"  label="Site Collections">
 717 |             <option method="GET"
 718 |                     body=""
 719 |                     headers='{"accept": "application/json; odata=verbose"}'
 720 |                     notes=""
 721 |                     sampleJSON="data.d.PrimaryUri"
 722 |                     value="/_api/site">
 723 |                 Get information about the current site collection.
 724 |             </option>
 725 |             <option method="GET"
 726 |                     body=""
 727 |                     headers='{"accept": "application/json; odata=verbose"}'
 728 |                     notes=""
 729 |                     sampleJSON="data.d.PrimaryUri"
 730 |                     value="/_api/site/usage">
 731 |                 Get the size of the content in the current site collection.
 732 |             </option>
 733 |             <option method="GET"
 734 |                     body=""
 735 |                     headers='{"accept": "application/json; odata=verbose"}'
 736 |                     notes=""
 737 |                     sampleJSON="data.d.Email"
 738 |                     value="/_api/site/Owner">
 739 |                 Get the primary site collection administrator (Owner).
 740 |             </option>
 741 |             <option method="GET"
 742 |                     body=""
 743 |                     headers='{"accept": "application/json; odata=verbose"}'
 744 |                     notes=""
 745 |                     sampleJSON="data.d.Email"
 746 |                     value="/_api/site/SecondaryContact">
 747 |                 Get the primary site collection Secondary Contact.
 748 |             </option>
 749 |            
 750 |         </optgroup>
 751 | 
 752 | 
 753 |         <optgroup class="ttnOptGroup"  label="Webs (subsites)">
 754 |             <option method="GET"
 755 |                     body=""
 756 |                     headers='{"accept": "application/json; odata=verbose"}'
 757 |                     notes=""
 758 |                     sampleJSON="data.d.Created"
 759 |                     value="/_api/web">
 760 |                 Get information about the current web.
 761 |             </option>
 762 |             <option method="GET"
 763 |                     body=""
 764 |                     headers='{"accept": "application/json; odata=verbose"}'
 765 |                     notes=""
 766 |                     sampleJSON="data.d.LocaleId"
 767 |                     value="/_api/web/RegionalSettings">
 768 |                 Get the Regional Settings for the current web.
 769 |             </option>
 770 |             <option method="GET"
 771 |                     body=""
 772 |                     headers='{"accept": "application/json; odata=verbose"}'
 773 |                     notes=""
 774 |                     sampleJSON="data.d.Description"
 775 |                     value="/_api/web/RegionalSettings/TimeZone">
 776 |                 Get the Time Zone for the current web.
 777 |             </option>
 778 |             <option method="GET"
 779 |                     body=""
 780 |                     headers='{"accept": "application/json; odata=verbose"}'
 781 |                     notes="for a list of perperties see: https://msdn.microsoft.com/en-us/library/office/dn499819.aspx"
 782 |                     sampleJSON="data.d.results[0].Title"
 783 |                     value="/_api/web/webs?$select=Title,Url">
 784 |                 Get a list of all webs below the current web.
 785 |             </option>            
 786 |             <option method="GET"
 787 |                     body=""
 788 |                     headers='{"accept": "application/json; odata=verbose"}'
 789 |                     notes=""
 790 |                     sampleJSON="data.d.results[0].Title"
 791 |                     value="/_api/web/webinfos">
 792 |                 Get a list of all webs below the current web using "webinfos".
 793 |             </option>
 794 |             
 795 |             <option method="GET"
 796 |                     body=""
 797 |                     headers='{"accept": "application/json; odata=verbose"}'
 798 |                     notes=""
 799 |                     sampleJSON="((new Date())- (new Date( data.d.LastItemUserModifiedDate))) / 86400000 + ' days'"
 800 |                     value="/_api/web?$select=LastItemModifiedDate,LastItemUserModifiedDate">
 801 |                 Get a web's LastItemModifiedDate
 802 |             </option>
 803 |             <option method="POST"
 804 |                     body='{"parameters":{ "__metadata":{"type":"SP.WebInfoCreationInformation"},
 805 | 	               "Url":"testsub",
 806 | 	               "Title":"Test subsite",
 807 | 	               "Description":"This is test site",
 808 | 	               "Language":1033,
 809 | 	               "WebTemplate":"sts#0",
 810 | 	               "UseUniquePermissions":"false" } }' ,
 811 |                     headers='{ "accept": "application/json;odata=verbose",
 812 | 	                    "content-type": "application/json;odata=verbose",
 813 | 	                    "content-length":__len__,
 814 | 	                    "X-RequestDigest": "__yourRequestDigest__"}'
 815 |                     notes="Change the details in the Body!"
 816 |                     sampleJSON="data.d.Id"
 817 |                     value="/_api/web/webinfos/add">
 818 |                 Create a new subsite.
 819 |             </option>
 820 |             <option method="POST"
 821 |                     body=""
 822 |                     headers='{ "accept": "application/json;odata=verbose",
 823 | 	                   "content-type": "application/json;odata=verbose",
 824 | 	                   "X-HTTP-Method": "DELETE",
 825 | 	                   "X-RequestDigest": "__yourRequestDigest__"}'
 826 |                     notes="Change the 'sitename' in the URL! DELETE does not return any data."
 827 |                     sampleJSON="data.d"
 828 |                     value="/sitename/_api/web">
 829 |                 Delete a site (Warning Will Robinson! Does not go to the Recycle Bin!)
 830 |             </option>
 831 |         </optgroup>
 832 | 
 833 |         <optgroup class="ttnOptGroup"  label="User Profiles">
 834 |             <option method="GET"
 835 |                     body=""
 836 |                     headers='{"accept": "application/json; odata=verbose"}'
 837 |                     notes=""
 838 |                     sampleJSON="data.d.UserProfileProperties.results"
 839 |                     value="/_api/SP.UserProfiles.PeopleManager/GetMyProperties">
 840 |                 Get User Profile info about the current user.
 841 |             </option>
 842 |             <option method="GET"
 843 |                     body=""
 844 |                     headers='{"accept": "application/json; odata=verbose"}'
 845 |                     notes="replace 'spdemo\samc' with a user's ID. For SharePoint Online use something like i:0%23.f|membership|samc@yourdomain.onmicrosoft.com "
 846 |                     sampleJSON="data.d.UserProfileProperties.results[10]"
 847 |                     value="/_api/SP.UserProfiles.PeopleManager/GetPropertiesFor(accountName=@v)?@v='spdemo\samc'">
 848 |                 Get all User Profile properties for a user.
 849 |             </option>
 850 |             <option method="GET"
 851 |                     body=""
 852 |                     headers='{"accept": "application/json; odata=verbose"}'
 853 |                     notes="replace 'spdemo\samc' with a user's ID.  For SharePoint Online use something like i:0%23.f|membership|samc@yourdomain.onmicrosoft.com "
 854 |                     sampleJSON="data.d.Manager"
 855 |                     value="/_api/SP.UserProfiles.PeopleManager/GetUserProfilePropertyFor(accountName=@v,propertyName='Manager')?@v='spdemo\samc'">
 856 |                 Get User Profile info about a user's manager. (Set "propertyName=" to any User Profile Services property.)
 857 |             </option>
 858 |         </optgroup>
 859 | 
 860 |         <optgroup class="ttnOptGroup"  label="Permissions">
 861 |             <option method="GET"
 862 |                     body=""
 863 |                     headers='{"accept": "application/json; odata=verbose"}'
 864 |                     notes="This is useful to get the Permission Level's ID for use with AddRoleAssignment."
 865 |                     sampleJSON="data.d.results[0].Name + ' ' + data.d.results[0].Id"
 866 |                     value="/_api/web/roledefinitions">
 867 |                 Get a list of Role Definitions for a site.
 868 |             </option>
 869 |             <option method="GET"
 870 |                     body=""
 871 |                     headers='{"accept": "application/json; odata=verbose"}'
 872 |                     notes=""
 873 |                     sampleJSON="data.d.results[6].LoginName + ' ' + data.d.results[6].Id"
 874 |                     value="/_api/web/siteusers?$select=Title,LoginName,Id">
 875 |                 Get a list of Site Users. The ID is useful when setting permissions.
 876 |             </option>
 877 |             <option method="GET"
 878 |                     body=""
 879 |                     headers='{"accept": "application/json; odata=verbose"}'
 880 |                     notes=""
 881 |                     sampleJSON="data.d.results[1].LoginName + ' ' + data.d.results[1].Id"
 882 |                     value="/_api/web/sitegroups">
 883 |                 Get a list of Site Groups. The ID is useful when setting permissions.
 884 |             </option>
 885 |             <option method="GET"
 886 |                     body=""
 887 |                     headers='{"accept": "application/json; odata=verbose"}'
 888 |                     notes="Name text is case sensitive!"
 889 |                     sampleJSON="data.d.results[1].LoginName + ' ' + data.d.results[1].Id"
 890 |                     value="/_api/web/sitegroups?$filter=LoginName eq 'Permissions Test Owners'">
 891 |                 Get a list of Site Groups by name (filter).
 892 |             </option>
 893 |             <option method="GET"
 894 |                     body=""
 895 |                     headers='{"accept": "application/json; odata=verbose"}'
 896 |                     notes="Replace 49 with the site group ID"
 897 |                     sampleJSON="data.d.results[1].LoginName + ' ' + data.d.results[1].Id"
 898 |                     value="/_api/web/sitegroups(49)">
 899 |                 Get info about a Site Group using the ID.
 900 |             </option>
 901 |             <option method="GET"
 902 |                     body=""
 903 |                     headers='{"accept": "application/json; odata=verbose"}'
 904 |                     notes="Replace 49 with the site group ID"
 905 |                     sampleJSON="data.d.results[1].LoginName + ' ' + data.d.results[1].Id"
 906 |                     value="/_api/web/sitegroups/getbyname('Training Members')">
 907 |                 Get info about a Site Group using the Name.
 908 |             </option>            
 909 |             <option method="GET"
 910 |                     body=""
 911 |                     headers='{"accept": "application/json; odata=verbose"}'
 912 |                     notes="Replace 49 with the site group ID"
 913 |                     sampleJSON="data.d.results[1].LoginName + ' ' + data.d.results[1].Id"
 914 |                     value="/_api/web/sitegroups(49)/users">
 915 |                 Get a list of users in a Site Group.
 916 |             </option>
 917 |             <option method="GET"
 918 |                     body=""
 919 |                     headers='{"accept": "application/json; odata=verbose"}'
 920 |                     notes="Replace 49 with the site group ID and 12 with the user id"
 921 |                     sampleJSON="data.d.LoginName + ' ' + data.d.Id"
 922 |                     value="/_api/web/sitegroups(49)/users/getbyid(9)">
 923 |                 Get a user by id from a Site Group.
 924 |             </option>            
 925 |             <option method="GET"
 926 |                     body=""
 927 |                     headers='{"accept": "application/json; odata=verbose"}'
 928 |                     notes="Replace 49 with the site group ID and user email"
 929 |                     sampleJSON="data.d.LoginName + ' ' + data.d.Id"
 930 |                     value="/_api/web/sitegroups(49)/users/getbyemail('mike@yourdomain.onmicrosoft.com')">
 931 |                 Get a user by email address from a Site Group by ID.
 932 |             </option>
 933 |             <option method="GET"
 934 |                     body=""
 935 |                     headers='{"accept": "application/json; odata=verbose"}'
 936 |                     notes="Replace group name and the user email"
 937 |                     sampleJSON="data.d.LoginName + ' ' + data.d.Id"
 938 |                     value="/_api/web/sitegroups/getbyname('Training Members')/users/getbyemail('mike@yourdomain.onmicrosoft.com')">
 939 |                 Get a user by email address from a Site Group by Name.
 940 |             </option>
 941 |             <option method="GET"
 942 |                     body=""
 943 |                     headers='{"accept": "application/json; odata=verbose"}'
 944 |                     notes="Replace group name and the user name"
 945 |                     sampleJSON="data.d.LoginName + ' ' + data.d.Id"
 946 |                     value="/_api/web/sitegroups/getbyname('Training Members')/users?$filter=substringof('sam',Email)">
 947 |                 Get a user by partial email address from a Site Group by Name.
 948 |             </option>
 949 |             
 950 |             <option method="POST"
 951 |                     body='{ "__metadata": { "type": "SP.User" }, "LoginName":"i:0#.f|membership|susanj@yourDomain.onmicrosoft.com" }'
 952 |                     headers='{ "accept": "application/json;odata=verbose",
 953 | 	                   "content-type": "application/json;odata=verbose",
 954 | 	                   "content-length":__len__,
 955 | 	                   "X-RequestDigest": "__yourRequestDigest__"}'
 956 |                     notes="Replace 49 with the site group ID"
 957 |                     sampleJSON=""
 958 |                     value="/_api/web/sitegroups(49)/users">
 959 |                 Add a user to a Site Group by login name.
 960 |             </option>
 961 |             <option method="POST"
 962 |                     body=''
 963 |                     headers='{ "accept": "application/json;odata=verbose",
 964 | 	                   "content-type": "application/json;odata=verbose",
 965 | 	                   "X-HTTP-Method": "DELETE",
 966 | 	                   "If-Match": "*",
 967 | 	                   "X-RequestDigest": "__yourRequestDigest__"}'
 968 |                     notes="Replace 49 with the site group ID and the 12 with the user ID"
 969 |                     sampleJSON=""
 970 |                     value="/_api/web/sitegroups(49)/users/getbyid(12)">
 971 |                 Remove a user from an Site Group by user ID.
 972 |             </option>
 973 |             
 974 |             <option method="GET"
 975 |                     body=""
 976 |                     headers='{"accept": "application/json; odata=verbose"}'
 977 |                     notes="Name text is case sensitive!"
 978 |                     sampleJSON="data.d.results[1].LoginName + ' ' + data.d.results[1].Id"
 979 |                     value="/_api/web/sitegroups?$filter=substringof('Owners',LoginName)">
 980 |                 Get a list of Site Groups where name contains 'string'.
 981 |             </option>
 982 |             <option method="POST"
 983 |                     body=""
 984 |                     headers='{ "accept": "application/json;odata=verbose",
 985 | 	                   "content-type": "application/json;odata=verbose",
 986 | 	                   "X-RequestDigest": "__yourRequestDigest__"}'
 987 |                     notes="Change the 'sitename' in the URL! "
 988 |                     sampleJSON="data.d"
 989 |                     value="/_api/web/breakroleinheritance(copyRoleAssignments=true, clearSubscopes=true)">
 990 |                 Break inheritance on a subsite.
 991 |             </option>
 992 |             <option method="POST"
 993 |                     body=""
 994 |                     headers='{ "accept": "application/json;odata=verbose",
 995 | 	                   "content-type": "application/json;odata=verbose",
 996 | 	                   "X-RequestDigest": "__yourRequestDigest__"}'
 997 |                     notes="Change list name in the URL! Note the copyRoleAssignments and clearSubscopes options."
 998 |                     sampleJSON="data.d"
 999 |                     value="/_api/web/lists/getByTitle('Test')/breakroleinheritance(copyRoleAssignments=true, clearSubscopes=true)">
1000 |                 Break inheritance on a list.
1001 |             </option>
1002 |             <option method="POST"
1003 |                     body=""
1004 |                     headers='{ "accept": "application/json;odata=verbose",
1005 | 	                   "content-type": "application/json;odata=verbose",
1006 | 	                   "X-RequestDigest": "__yourRequestDigest__"}'
1007 |                     notes="Change list name and item ID in the URL! Note the copyRoleAssignments and clearSubscopes options."
1008 |                     sampleJSON="data.d"
1009 |                     value="/_api/web/lists/getByTitle('Test')/Items(1)/breakroleinheritance(copyRoleAssignments=true, clearSubscopes=true)">
1010 |                 Break inheritance on a list item.
1011 |             </option>
1012 |             <option method="POST"
1013 |                     body=""
1014 |                     headers='{ "accept": "application/json;odata=verbose",
1015 | 	                   "content-type": "application/json;odata=verbose",
1016 | 	                   "X-RequestDigest": "__yourRequestDigest__"}'
1017 |                     notes="You will need the user's ID (principalid) and the Role Definition ID (roleDefId). 1073741827 is Contribute."
1018 |                     sampleJSON="data.d"
1019 |                     value="/_api/web/lists/getByTitle('Test')/roleassignments/addroleassignment(principalid=20,roleDefId=1073741828)">
1020 |                 Grant permissions (Role Assignment) on a list.
1021 |             </option>
1022 |             <option method="POST"
1023 |                     body=""
1024 |                     headers='{ "accept": "application/json;odata=verbose",
1025 | 	                   "content-type": "application/json;odata=verbose",
1026 | 	                   "X-RequestDigest": "__yourRequestDigest__"}'
1027 |                     notes="You will need the user's ID (principalid) and the Role Definition ID (roleDefId). 1073741827 is Contribute."
1028 |                     sampleJSON="data.d"
1029 |                     value="/_api/web/lists/getByTitle('Test')/roleassignments/removeroleassignment(principalid=20,roleDefId=1073741828)">
1030 |                 Remove permissions (Role Assignment) on a list.
1031 |             </option>
1032 |         </optgroup>
1033 |         <optgroup class="ttnOptGroup"  label="Filter Select and OrderBy">
1034 |             <option method="GET"
1035 |                     body=""
1036 |                     headers='{"accept": "application/json; odata=verbose"}'
1037 |                     notes="PrincipalType 1 is a user, 2 is Distribution List, 4 is an AD security group, 8 is SharePoint Group, 15 is for 'All'. For more on Query String options see: https://msdn.microsoft.com/en-us/library/office/fp142385.aspx"
1038 |                     sampleJSON="data.d.results[6].LoginName + ' ' + data.d.results[6].Id"
1039 |                     value="/_api/web/siteusers?$filter=IsSiteAdmin eq false&$select=Title,LoginName,Id,PrincipalType&$orderby=PrincipalType">
1040 |                 Get a list of Site Users who are not Site Collection admins. Get selected fields and sort.
1041 |             </option>
1042 | 
1043 | 
1044 |         </optgroup>
1045 | 
1046 | 
1047 | 
1048 |         <optgroup class="ttnOptGroup"  label="SharePoint 2010 style REST - _vti_bin/ListData.svc">
1049 |             <option method="GET"
1050 |                     body=""
1051 |                     headers='{"accept": "application/json; odata=verbose"}'
1052 |                     notes="Date must be in the form of yyyy-mm-dd" (two digits for month and year)
1053 |                     value="/_vti_bin/ListData.svc">
1054 |                 Get a list of lists and libraries (EntitySets).
1055 |             </option>
1056 |             <option method="GET"
1057 |                     body=""
1058 |                     headers='{"accept": "application/json; odata=verbose"}'
1059 |                     notes="Date must be in the form of yyyy-mm-dd" (two digits for month and year)
1060 |                     value="/_vti_bin/ListData.svc/Documents?$select=Title,Created&$filter=Created gt datetime'2016-08-06'">
1061 |                 Find list items greater than a date.
1062 |             </option>
1063 |             <option method="GET"
1064 |                     body=""
1065 |                     headers='{"accept": "application/json; odata=verbose"}'
1066 |                     notes="Date must be in the form of yyyy-mm-dd" (two digits for month and year)
1067 |                     value="/_vti_bin/ListData.svc/Documents?$select=Title,Created&$filter=Created gt datetime'2015-08-06' and Created lt datetime'2016-08-06'">
1068 |                 Find list items between two dates.
1069 |             </option>
1070 |         </optgroup>
1071 |     </select>
1072 | 
1073 | 
1074 |     <!-- display the editing boxes -->
1075 |     <br>
1076 |     Notes:<br>
1077 |     <div style="color:red" id="testNotes">&nbsp;</div>
1078 |     <br>
1079 | 
1080 |     <!-- URL, Method, Headers and Body -->
1081 |     <table>
1082 |         <tr><td><b>URL:</b>    </td><td><input type="text" id="testWebServiceURL" style="width:500px" /></td></tr>
1083 |         <tr><td><b>Method:</b> </td><td><input type="text" id="testWebServiceMethod" style="width:50px" /><br>
1084 |         ODATA options:  odata=verbose, odata=nometadata, odata=minimalmetadata
1085 |         </td></tr>
1086 |         <tr><td><b>Headers:</b></td><td><textarea rows="1" cols="60" id="testWebServiceHeaders" style="width:600px"></textarea> </td></tr>
1087 |         <tr><td><b>Body:</b><br>Must use single quotes!</td><td><textarea rows="1" cols="60" id="testWebServiceBody" style="width:600px"></textarea></td></tr>
1088 |     </table>
1089 | 
1090 | 
1091 | 
1092 | 
1093 |     <!-- the buttons -->
1094 | 
1095 |     <br><br>
1096 |     <input type="checkbox" id="runCode" onclick="$('#testResultsBlock').toggle()" /> Call the web service and run the code!<br>
1097 |     <input type="checkbox" id="showAJAXCode" onclick="$('#AjaxResultsBlock').toggle()" /> Show the AJAX Code <br>
1098 |     <input type="checkbox" id="showWFCode" onclick="$('#WFResultsBlock').toggle() " /> Show the workflow steps<br>
1099 | 
1100 |     <button onclick="if(!window.jQuery) {alert('jQuery not loaded yet!');return false;} testWebService(); return false;" style="color:red;font-weight:bold">Do It!</b></button>
1101 |     <marquee style="width:100px">
1102 |       <span id="testWebServiceWorking" style="color:blue;font-weight:bold"></span></marquee>
1103 |     <br><br><br>
1104 | 
1105 | 
1106 | 
1107 |     <!-- the output -->
1108 | 
1109 |     <div id="outputBlock" style="display:none">
1110 | 
1111 |         <div id="testResultsBlock" style="display:none">
1112 | 
1113 | 
1114 |             <!-- The result of the call in JSON  -->
1115 |             Results:<br>
1116 | 
1117 |             <div id="resultsError" style="color:red"></div>
1118 | 
1119 |             <div id="testResults" class="ttnResultDiv" style="border:thin blue solid">&nbsp;</div>
1120 |             <br><br>
1121 | 
1122 | 
1123 |             <!-- the "test the data" area  -->
1124 |             Experiment with the JSON results!<br>
1125 |             &nbsp;&nbsp;JSON object path: (any expression that returns a JavaScript object that can be JSON serialized.)<br>
1126 |             For this test the JavaScript object is "data" and the top JSON node is "d".<br>
1127 |             &nbsp;&nbsp;<input type="text" id="testJSONpath" value="d" style="width:500px" onkeypress="function(e) {alert(1); var key=e.keyCode || e.which; if (key==13) {testParseSomeJSON(document.getElementById('testJSONpath').value); return false;}}" />
1128 |             <br>
1129 |             <button id="testJSONButton" onclick="testParseSomeJSON(document.getElementById('testJSONpath').value); return false;" style="color:red;font-weight:bold">Get data</button><br>
1130 |             &nbsp;&nbsp;JSON results:<br>
1131 |             <div id="testJSONResults" class="ttnResultDiv" style="">&nbsp;</div>
1132 |             <br><br>
1133 | 
1134 |         </div>
1135 | 
1136 | 
1137 |         <div id="AjaxResultsBlock" style="display:none">
1138 | 
1139 |             <!-- the AJAX code to use in web part and apps -->
1140 |             AJAX JavaScript Code:  <i>(Update with your parameters!)</i><br>
1141 |             <div id="testAJAXobject" class="ttnResultDiv" style="">&nbsp;</div>
1142 |             <div id="testAJAXobjectNote" style="display:none">
1143 |             <br>Note: If this code is in a SharePoint page, you can get the RequestDigest using $(&quot;#__REQUESTDIGEST&quot;).val()
1144 |             </div>
1145 |             <br><br><br>
1146 | 
1147 |         </div>
1148 | 
1149 | 
1150 | 
1151 | 
1152 |         <!-- Instructions for calling the web service from a SPD2013 workflow -->
1153 | 
1154 |         <div id="WFResultsBlock" style="display:none;color:black;font-size:larger">
1155 | 
1156 |             <div id="SP2013wf" style="border:thin blue solid; width:800px;padding:10px ">
1157 | 
1158 |                 <br>
1159 | 
1160 |                 <h2>Steps to add this REST call to a SharePoint 2013 workflow</h2>
1161 |                 <br>
1162 |                 These steps are for the URL, method, header and body entered above!<br><br>
1163 | 
1164 |                 <b>Add Build Dictionary Action for the header values.</b> <br>
1165 |                 Add a <b>Build Dictionary</b> action.<br>
1166 |                 Click "this". <br>
1167 |                 Click "Add", enter data and click OK for each of the following. <br>
1168 |                 <span id="ttnWFrequestHeaders"></span>
1169 |                 Click OK. <br>
1170 |                 Click "Variable:dictionary". <br>
1171 |                 Click "Create a new variable". <br>
1172 |                 Enter "requestHeaders". <br>
1173 |                 Click OK. <br>
1174 |                 <br>
1175 | 
1176 |                 <span id="ttnHasBody01" style="display:none">
1177 |                     <b>Add a second Dictionary with these values and save to a variable named dataType.</b> <br>
1178 |                     &nbsp;&nbsp;Name:  <span class="ttnWFspan">type</span> <br>
1179 |                     &nbsp;&nbsp;Type:  <span class="ttnWFspan">String</span>  <br>
1180 |                     &nbsp;&nbsp;Value: <span id="ttnWFdatatype" class="ttnWFspan"></span> <br>
1181 |                     <br>
1182 |                     <b>Add a third Dictionary with these values and save to a variable named <span id="ttnContentDataName">requestContent</span>.</b> <br>
1183 |                     &nbsp;&nbsp;Name:  <span class="ttnWFspan">__metadata</span> <br>
1184 |                     &nbsp;&nbsp;Type:  <span class="ttnWFspan">Dictionary</span>  <br>
1185 |                     &nbsp;&nbsp;Value: <span class="ttnWFspan">Variable: dataType</span> (from the fx button) <br>
1186 |                     <span id="ttnWFmoredata"></span> <br>
1187 |                 </span>
1188 | 
1189 |                 <!-- needed for "Create a Site"" -->
1190 |                 <span id="ttnHasBody02" style="display:none">
1191 |                     <b>Add a fourth Dictionary with these values and save to a variable named requestContent.</b> <br>
1192 |                     &nbsp;&nbsp;Name:  <span class="ttnWFspan">parameters</span> <br>
1193 |                     &nbsp;&nbsp;Type:  <span class="ttnWFspan">Dictionary</span>  <br>
1194 |                     &nbsp;&nbsp;Value: <span class="ttnWFspan">Variable: requestData</span> <br>
1195 |                     <br>
1196 |                 </span>
1197 |                 <br>
1198 | 
1199 | 
1200 |                 <b>Add Call HTTP Web Service Action.</b> <br>
1201 |                 Add a <b>Call HTTP Web Service</b> action.<br>
1202 |                 Click "this". <br>
1203 |                 Enter URL with the query string or... <br>
1204 |                 Click "...". <br>
1205 |                 Click "Add or Change Lookup". <br>
1206 |                 From "Data Source" select "Workflow Context". <br>
1207 |                 From "Field from source" select "Current Site URL". <br>
1208 |                 Click OK. <br>
1209 |                 Add the following: (<i>with the correct site path!</i>)  <br>
1210 |                 &nbsp;&nbsp; <span id="testWFthis" class="ttnWFspan"></span> <br>
1211 |                 Set the HTTP method to: &nbsp;&nbsp;HTTP <span id="testWFrequestType" class="ttnWFspan"></span>. <br>
1212 |                 Click OK. <br>
1213 |                 Click the dropdown and click Properties. <br>
1214 |                 Click "RequestHeaders" and select "requestHeaders" from the dropdown. <br>
1215 |                 <div id="ttnWFrequestData">
1216 |                 Click "RequestContent" and select "requestContent" from the dropdown. <br>
1217 |                 </div>
1218 |                 Click "ResponseContent" and select "Create New Variable" from the dropdown, enter "responseData" and click OK. <br>
1219 |                 <br>
1220 |                 <br>
1221 | 
1222 |                 <b>Add a Get an Item from a Dictionary Action so you can display some results.</b> <br>
1223 |                 Add a <b>Get an Item from a Dictionary</b> action.<br>
1224 |                 Click "item by name or path". 
1225 |                 (You will need to know the data that's being returned to complete this.) Example: <span id="testWFJSONpath" class="ttnWFspan">test</span><br>
1226 |                 Click "dictionary" and select "responseData". <br>
1227 |                 Click "item" and enter a variable name for your retrieved data. <br>
1228 |                 <br>
1229 | 
1230 |                 <i>Do something with your retrieved data! Log it, add to a list or send as part of an email!</i><br>
1231 | 
1232 |             </div>
1233 |             
1234 |         </div>
1235 |     </div>
1236 | 
1237 |     <br><br><br><br>
1238 | 
1239 | 
1240 | 
1241 | 
1242 |     <script>
1243 |         $("#ExampleCount").text( "(" + $("#testWebServiceSamples option").length + " samples)")
1244 | 
1245 |         // fix for SharePoint/FireFox bug! This is not part of the JSON tester code...
1246 | 
1247 |         // SharePoint input element bug handler
1248 |         // More bug: http://social.technet.microsoft.com/Forums/sharepoint/en-US/33df42ba-00b3-41a8-8fb9-f8187cfc216d/strange-behavior-in-firefox-input-text-with-enter-opens-page-for-editing?forum=sharepointgeneralprevious
1249 |         // This fix stops form submit => blocks transfer to edit mode
1250 | 
1251 |         var disableFormSubmitDueToBug = false;
1252 |         var bugSubmitHandlerAttached = false;
1253 | 
1254 |         $("input[id^='test']").keydown(function(e){
1255 |             if(e.keyCode == 13 ) {
1256 |                 disableFormSubmitDueToBug = true;
1257 |                 bindBugSubmitHandler();
1258 |             } else {
1259 |                 unbindBugSubmitHandler();
1260 |             }
1261 |         }).focusout(function(){
1262 |             unbindBugSubmitHandler();
1263 |         });
1264 | 
1265 |         function bindBugSubmitHandler(){
1266 |             $( "form" ).bind("submit", function( e ) {
1267 |                 if(disableFormSubmitDueToBug) {
1268 |                     e.preventDefault();
1269 |                     console.log('Blocked submit by SP bug handler');
1270 |                 }
1271 |                 bugSubmitHandlerAttached = true;
1272 |             });
1273 |         }
1274 | 
1275 |         function unbindBugSubmitHandler(){
1276 |             if(bugSubmitHandlerAttached){
1277 |                 $( "form" ).unbind("submit");
1278 |                 bugSubmitHandlerAttached = false;
1279 |                 console.log('SP bug submit handler unbind occurred');
1280 |             }
1281 |         }
1282 | 
1283 |         // end of fix for SharePoint / FireFox bug!
1284 | 
1285 | 
1286 | 
1287 |         // code to autosize the TEXTAREA tags
1288 |         // found here: http://stackoverflow.com/questions/454202/creating-a-textarea-with-auto-resize
1289 |         function AutoSizeTextAreas()
1290 |         {
1291 |             $('textarea').each(function () {
1292 |                 this.setAttribute('style', 'height:10px');
1293 |                 this.setAttribute('style', 'height:' + (this.scrollHeight) + 'px;overflow-y:hidden;');
1294 |             }).on('input', function () {
1295 |                 this.style.height = '10px';
1296 |                 this.style.height = 'auto';
1297 |                 this.style.height = (this.scrollHeight) + 'px';
1298 |             });
1299 |         }
1300 |         AutoSizeTextAreas();
1301 | 
1302 |     </script>
1303 | 
1304 | 


--------------------------------------------------------------------------------