Skip to content

Commit 68a3892

Browse files
author
Linda Caputo
committed
Updated Note formatting
1 parent 5c9e146 commit 68a3892

File tree

100 files changed

+443
-729
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

100 files changed

+443
-729
lines changed

docs/apis/rest/complete-basic-operations-using-sharepoint-rest-endpoints.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,8 @@ When you send a POST request, the request must include the form digest value in
224224

225225
Cloud-hosted add-ins use either OAuth or the cross-___domain library to authorize access to SharePoint data. Add-in components with code that runs on a remote web server must use OAuth to authorize access to SharePoint data. In this case, you need to include an **Authorization** header to send the access token. See [Reading data with the SharePoint REST interface](complete-basic-operations-using-sharepoint-rest-endpoints.md#ReadingData) for an example that adds an authorization header to an **HTTPWebRequest** object.
226226

227-
**Note** Cloud-hosted add-in components that are written in JavaScript must use the **SP.RequestExecutor** object in the cross-___domain library to access to SharePoint data. Cross-___domain library requests don't need to include an access token.
227+
> [!NOTE]
228+
> Cloud-hosted add-in components that are written in JavaScript must use the **SP.RequestExecutor** object in the cross-___domain library to access to SharePoint data. Cross-___domain library requests don't need to include an access token.
228229
229230
To learn more about OAuth access tokens and how to get them, see [Context Token OAuth flow for SharePoint Add-ins](https://msdn.microsoft.com/en-us/library/office/fp142382.aspx) and [Authorization Code OAuth flow for SharePoint Add-ins](https://msdn.microsoft.com/en-us/library/office/jj687470.aspx).
230231

@@ -237,7 +238,8 @@ Requests are sent to the resource endpoint that's specified in the **url** prop
237238

238239
Cross-___domain library requests use this format when they access data on the add-in web, which is the default context for cross-___domain library requests. But to access data on the host web or on another site collection, the requests need to initialize the host web or other site collection as the context. To do this, they use the **SP.AppContextSite** endpoint in the URI, as shown in Table 1. The example URIs in Table 1 use the **@target** alias to send the target URL in the query string because the URL contains a special character (':').
239240

240-
**Note** An add-in web instance is required for a cloud-hosted add-in to access SharePoint data when using the cross-___domain library.
241+
> [!NOTE]
242+
> An add-in web instance is required for a cloud-hosted add-in to access SharePoint data when using the cross-___domain library.
241243
242244
**Table 1. Using the SP.AppContextSite endpoint to change the context of the request**
243245

@@ -248,7 +250,8 @@ Cross-___domain library requests use this format when they access data on the add-i
248250
|Cloud-hosted|JavaScript add-in component accessing data in a site collection other than the host web by using the cross-___domain library (tenant-scoped add-ins only)| _<app web url>_/_api/SP.AppContextSite(@target)/web/title?@target=' _<target site url>_'|
249251
|SharePoint-hosted|Add-in web component accessing data in another site collection (tenant-scoped add-ins only)| _<app web url>_/_api/SP.AppContextSite(@target)/web/title?@target=' _<target site url>_'|
250252

251-
**Note** Cross-___domain data access scenarios also require appropriate add-in permissions. For more information, see [Access data from the host web](https://msdn.microsoft.com/en-us/library/office/fp179927.aspx#SP15Accessdatafromremoteapp_Hostweb) and [Access data across site collections](https://msdn.microsoft.com/en-us/library/office/fp179927.aspx#SP15Accessdatafromremoteapp_TenantScope).
253+
> [!NOTE]
254+
> Cross-___domain data access scenarios also require appropriate add-in permissions. For more information, see [Access data from the host web](https://msdn.microsoft.com/en-us/library/office/fp179927.aspx#SP15Accessdatafromremoteapp_Hostweb) and [Access data across site collections](https://msdn.microsoft.com/en-us/library/office/fp179927.aspx#SP15Accessdatafromremoteapp_TenantScope).
252255
253256
SharePoint Add-ins can get the add-in web URL and host web URL from the query string of the add-in page, as shown in the following code example. The example also shows how to reference the cross-___domain library, which is defined in the SP.RequestExecutor.js file on the host web. The example assumes that your add-in launches from SharePoint. See [Authorization Code OAuth flow for SharePoint Add-ins](https://msdn.microsoft.com/en-us/library/office/jj687470.aspx) for guidance on setting your SharePoint context correctly when your add-in does not launch from SharePoint.
254257

docs/apis/rest/upload-a-file-by-using-the-rest-api-and-jquery.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@ This process uses the following high-level steps:
2626
<a name="RunTheExamples"> </a>
2727
Both code examples in this article use the REST API and jQuery AJAX requests to upload a file to the **Shared Documents** folder and then change list item properties. The first example uses **SP.AppContextSite** to make calls across SharePoint domains, like a SharePoint-hosted add-in would do when uploading files to the host web. The second example makes same-___domain calls, like a SharePoint-hosted add-in would do when uploading files to the add-in web, or a solution that's running on the server would do when uploading files.
2828

29-
**Note** Provider-hosted add-ins written in JavaScript must use the SP.RequestExecutor cross-___domain library to send requests to a SharePoint ___domain. For an example, see [upload a file by using the cross-___domain library](http://msdn.microsoft.com/library/2c3d2545-1cd7-497e-b535-12199d8edfbb%28Office.15%29.aspx#bk_FileCollectionAdd).
29+
> [!NOTE]
30+
> Provider-hosted add-ins written in JavaScript must use the SP.RequestExecutor cross-___domain library to send requests to a SharePoint ___domain. For an example, see [upload a file by using the cross-___domain library](http://msdn.microsoft.com/library/2c3d2545-1cd7-497e-b535-12199d8edfbb%28Office.15%29.aspx#bk_FileCollectionAdd).
3031
3132
To use the examples in this article, you'll need the following:
3233

docs/apis/rest/use-odata-query-operations-in-sharepoint-rest-requests.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@ The SharePoint REST service supports a wide range of OData query string operator
2020
## Select fields to return
2121
Use the [$select](http://www.odata.org/documentation/odata-version-2-0/uri-conventions#SelectSystemQueryOption) query option to specify which fields to return for a given list, list item, or other SharePoint object represented by an entity set. You can use `$select=*` to return all available fields.
2222

23-
**Note** In general, if you do not specify the `$select` query option, the REST service returns all available fields by default. However, in a few cases, some SharePoint objects include properties that are very resource intensive to retrieve; to optimize REST service performance, these properties are not included in the default query, and must be explicitly requested.For example, the **SPWeb.EffectiveBasePermissions** property is not returned by default, and must be explicitly requested using the `$select` query option.
23+
> [!NOTE]
24+
> In general, if you do not specify the `$select` query option, the REST service returns all available fields by default. However, in a few cases, some SharePoint objects include properties that are very resource intensive to retrieve; to optimize REST service performance, these properties are not included in the default query, and must be explicitly requested.For example, the **SPWeb.EffectiveBasePermissions** property is not returned by default, and must be explicitly requested using the `$select` query option.
2425
2526
In addition, you can specify that the request returns projected fields from other lists and the values of lookups. To do this, specify the field name in both the `$select` and `$expand` query options. For example:
2627

@@ -37,7 +38,8 @@ Single value lookup fields are represented by two separate fields in the SharePo
3738
## Query for users
3839
In the SharePoint REST service, users are represented by the user's friendly (display) name, and not their alias or ___domain\alias combination. Therefore, you must construct user queries against users' friendly names.
3940

40-
**Note** Membership-based user queries are not supported.Usage of the **Current** operator to do queries using the ID of the current user is not supported.
41+
> [!NOTE]
42+
> Membership-based user queries are not supported.Usage of the **Current** operator to do queries using the ID of the current user is not supported.
4143
4244
## Query for multi-value lookup fields and users
4345
Because multi-value lookup fields are returned as a string of multiple values, there is no way to query for them (for example, the equivalent of an **Includes** element or **NotIncludes** element is not supported).
@@ -48,7 +50,8 @@ Use the [$orderby](http://www.odata.org/documentation/odata-version-2-0/uri-con
4850
## Page through returned items
4951
Use the [$top](http://www.odata.org/documentation/odata-version-2-0/uri-conventions#TopSystemQueryOption) and [$skiptoken](http://msdn.microsoft.com/library/dd942121.aspx) query options to select a subset of the items that would otherwise be returned by your query.
5052

51-
**Note** The $skip query option does not work with queries for SharePoint list items.
53+
> [!NOTE]
54+
> The $skip query option does not work with queries for SharePoint list items.
5255
5356
The `$top` option enables you to select the first *n* items of the return set for return. For example, the following URI requests that only the first ten items in the prospective return set actually be returned:
5457

@@ -58,7 +61,8 @@ The $skiptoken option enables you to skip over items until the specified item is
5861

5962
`$skiptoken=Paged=TRUE&amp;p_ID=5`
6063

61-
**Note** When using these query options, take into account that paging in OData is ordinal. For example, suppose you are implementing a next page button to display SharePoint list items. You use the REST service to enable the button to return items 1 through 20 when clicked, then items 21 through 40, and so on. However, suppose another user deletes items 4 and 18 between clicks of the next button. In such a case, the ordinal positioning of the remaining items is reset, and displaying items 21 through 40 actually skips over two items.
64+
> [!NOTE]
65+
> When using these query options, take into account that paging in OData is ordinal. For example, suppose you are implementing a next page button to display SharePoint list items. You use the REST service to enable the button to return items 1 through 20 when clicked, then items 21 through 40, and so on. However, suppose another user deletes items 4 and 18 between clicks of the next button. In such a case, the ordinal positioning of the remaining items is reset, and displaying items 21 through 40 actually skips over two items.
6266
6367
## OData query operators supported in the SharePoint REST service
6468
<a name="bk_supported"> </a>

docs/apis/rest/working-with-folders-and-files-with-rest.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,8 @@ Headers:
121121

122122
The following example shows how to **update** a file by using the **PUT** method.
123123

124-
**Note** **PUT** is the only method that you can use to update a file. The **MERGE** method is not allowed.
124+
> [!NOTE]
125+
> **PUT** is the only method that you can use to update a file. The **MERGE** method is not allowed.
125126
126127
```
127128
url: http://site url/_api/web/GetFileByServerRelativeUrl('/Folder Name/file name')/$value
@@ -248,7 +249,8 @@ headers:
248249

249250
The following example shows how to **update** a file attachment to a list item by using the **PUT** method.
250251

251-
**Note** **PUT** is the only method that you can use to update a file. The **MERGE** method is not allowed.
252+
> [!NOTE]
253+
> **PUT** is the only method that you can use to update a file. The **MERGE** method is not allowed.
252254
253255
```
254256
url: http://site url/_api/web/lists/getbytitle('list title')/items(item id)/AttachmentFiles('file name')/$value

docs/apis/rest/working-with-lists-and-list-items-with-rest.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@ Headers:
2525
accept: "application/json;odata=verbose" or "application/atom+xml"
2626
2727
```
28-
**Note** Use `application/json;odata=verbose` in the `accept` header if you want the response in JSON. Use `application/atom+xml` in the `accept` header if you want the response in Atom format.
28+
> [!NOTE]
29+
> Use `application/json;odata=verbose` in the `accept` header if you want the response in JSON. Use `application/atom+xml` in the `accept` header if you want the response in Atom format.
2930
3031
The following example shows how to **retrieve** a specific list if you know its title.
3132

@@ -82,7 +83,8 @@ The following XML shows an example of the list properties that are returned when
8283
</m:properties>
8384
</content>
8485
```
85-
**Note** The **ListItemEntityTypeFullName** property ( **SP.Data.ProjectPolicyItemListItem** in the previous example) is especially important if you want to create and update list items. This value must be passed as the **type** property in the metadata that you pass in the body of the HTTP request whenever you create and update list items.
86+
> [!NOTE]
87+
> The **ListItemEntityTypeFullName** property ( **SP.Data.ProjectPolicyItemListItem** in the previous example) is especially important if you want to create and update list items. This value must be passed as the **type** property in the metadata that you pass in the body of the HTTP request whenever you create and update list items.
8688
8789
## Working with lists by using REST
8890
<a name="WorkLists"> </a>
@@ -146,7 +148,8 @@ Headers:
146148
<a name="ListItems"> </a>
147149
The following example shows how to **retrieve** all of a list's items.
148150

149-
**Note** The OData $skip query option does not work when querying list items. In may situations, you can use the [$skiptoken](http://msdn.microsoft.com/library/4dda9434-c2c5-4577-8e01-7bf9e822d90a.aspx) option instead.
151+
> [!NOTE]
152+
> The OData $skip query option does not work when querying list items. In may situations, you can use the [$skiptoken](http://msdn.microsoft.com/library/4dda9434-c2c5-4577-8e01-7bf9e822d90a.aspx) option instead.
150153
151154
```
152155
url: http://site url/_api/web/lists/GetByTitle('Test')/items
@@ -191,7 +194,8 @@ The following XML shows an example of the list item properties that are returned
191194

192195
The following example shows how to **create** a list item.
193196

194-
**Note** To do this operation, you must know the **ListItemEntityTypeFullName** property of the list and pass that as the value of **type** in the HTTP request body.
197+
> [!NOTE]
198+
> To do this operation, you must know the **ListItemEntityTypeFullName** property of the list and pass that as the value of **type** in the HTTP request body.
195199
196200
```
197201
url: http://site url/_api/web/lists/GetByTitle('Test')/items
@@ -207,7 +211,8 @@ headers:
207211

208212
The following example shows how to **update** a list item.
209213

210-
**Note** To do this operation, you must know the **ListItemEntityTypeFullName** property of the list and pass that as the value of **type** in the HTTP request body.
214+
> [!NOTE]
215+
> To do this operation, you must know the **ListItemEntityTypeFullName** property of the list and pass that as the value of **type** in the HTTP request body.
211216
212217
```
213218
url: http://site url/_api/web/lists/GetByTitle('Test')/items(item id)

docs/apis/webhooks/get-started-webhooks.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,8 @@ For this project, use the Visual Studio Web API project to build the webhook rec
5959
* Change the authentication to **No Authentication** by choosing the **Change Authentication** button.
6060
* Choose **OK** to create the Web API project.
6161

62-
> **Note:** You can uncheck the **Host in the cloud** option because this project will not be deployed to the cloud.
62+
> [!NOTE]
63+
> You can uncheck the **Host in the cloud** option because this project will not be deployed to the cloud.
6364
6465
Visual Studio will create your project.
6566

docs/apis/webhooks/sharepoint-webhooks-using-azure-functions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ This will offer you to start your function from a template, in the case of Share
2626

2727
![Choosing an Azure Function template](../../images/webhook-azure-function3.png)
2828

29-
>**Note:**
29+
> [!NOTE]
3030
> - Using the **GenericWebHook** template currently does not yet work for SharePoint webhooks but the SharePoint product team is aware of this problem and will address it.
3131
> - If you get "Failed to validate the notification URL" errors when using your Azure function based webhook you might be able to resolve this by setting the Authorization level to **Function** and define your function for anonymous access
3232

docs/apis/webhooks/webhooks-reference-implementation.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,8 @@ Property|Description
100100
**resource**|The ID of the list for which the change happened.
101101
**siteUrl**|The server relative URL of the site holding the resource for which the change happened.
102102

103-
> **Note:** SharePoint only sends a notification that a change happened, but the notification does not include what actually changed. Because you get information about the web and list that were changed, this means that you can use the same service endpoint to handle webhook events from multiple sites and lists.
103+
> [!NOTE]
104+
> SharePoint only sends a notification that a change happened, but the notification does not include what actually changed. Because you get information about the web and list that were changed, this means that you can use the same service endpoint to handle webhook events from multiple sites and lists.
104105
105106
When your service is called, it's important that your service replies with an HTTP 200 message in under 5 seconds. Later in this article you'll learn more about the response time, but essentially this requires that you **asynchronously** handle the notifications. In this reference implementation you'll do this by using Azure Web Jobs and Azure Storage Queues.
106107

@@ -149,7 +150,8 @@ When your service receives a notification it also gets information about the sub
149150

150151
Create a web job that on a weekly basis reads all the subscription IDs from the persistent storage. One-by-one extend the found subscriptions each time.
151152

152-
> **Note:** This web job is not part of this reference implementation.
153+
> [!NOTE]
154+
> This web job is not part of this reference implementation.
153155
154156
The actual renewal of a SharePoint list webhook can be done using a [`PATCH /_api/web/lists('list-id')/subscriptions(‘subscriptionID’)`](./lists/update-subscription.md) REST call. In the reference implementation, updating of webhooks is implemented in the [WebHookManager](https://github.com/SharePoint/sp-dev-samples/blob/master/Samples/WebHooks.List/SharePoint.WebHooks.Common/WebHookManager.cs) class of the **SharePoint.WebHooks.Common** project. Updating a webhook is done using the **UpdateListWebHookAsync** method:
155157

docs/declarative-customization/site-theming/sharepoint-site-theming-csom.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ You will also need to reference the [Microsoft.SharePointOnline.CSOM](https://ww
1313

1414
The following example shows how to create a __Microsoft.Online.SharePoint.TenantAdministration.Tenant__ object and call the __GetAllTenantThemes__ method to return a list of themes.
1515

16-
>**Note:**
17-
>* The URL used to create the context object includes the _-admin_ suffix, because **TenantAdministration** methods work with the admin site.
18-
>* Create a __Tenant__ instance with the [Tenant constructor](https://msdn.microsoft.com/en-us/library/dn174852.aspx), and then call the methods on that instance.
19-
>* You can use the same approach to call other theme management methods.
16+
> [!NOTE]
17+
> * The URL used to create the context object includes the _-admin_ suffix, because **TenantAdministration** methods work with the admin site.
18+
> * Create a __Tenant__ instance with the [Tenant constructor](https://msdn.microsoft.com/en-us/library/dn174852.aspx), and then call the methods on that instance.
19+
> * You can use the same approach to call other theme management methods.
2020
2121
```C#
2222
using System.Security;

docs/general-development/accessing-a-schema.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,8 @@ ms.assetid: 02613912-36f6-4edc-a915-165d12e60bc8
1010

1111
This topic shows one example of how you can access and look at a schema for the REST service in Excel Services. This topic assumes that you have read [Sample URI For Excel Services REST API](sample-uri-for-excel-services-rest-api.md).d
1212

13-
14-
15-
16-
17-
> **Note:**
13+
> [!NOTE]
14+
>
1815
> The Excel Services REST API applies to SharePoint and SharePoint 2016 on-premises. For Office 365 Education, Business, and Enterprise accounts, use the Excel REST APIs that are part of the [Microsoft Graph](http://graph.microsoft.io/en-us/docs/api-reference/v1.0/resources/excel
1916
) endpoint.
2017

0 commit comments

Comments
 (0)