Skip to content

Commit 81425f2

Browse files
authored
Final edit pass through sp-dev-docs (SharePoint#1145)
* Fixed YAML header * Updated Develop Overview topic * Final edit * Final edit * Final edit * Final edit * Final edit * Final edit * Final edit * Final edit * Final edit * Final edit * Final edit * Removed md from dev.office.com links
1 parent 8e63066 commit 81425f2

18 files changed

+523
-1092
lines changed

docs/declarative-customization/site-theming/sharepoint-site-theming-rest-api.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22

33
You can use the the SharePoint REST interface to perform basic create, read, update, and delete (CRUD) operations on site themes.
44

5-
The SharePoint Online (and SharePoint 2016 and later on-premises) REST service supports combining multiple requests into a single call to the service by using the OData $batch query option. For details and links to code samples, see [Make batch requests with the REST APIs](https://dev.office.com/sharepoint/docs/apis/rest/make-batch-requests-with-the-rest-apis.md).
5+
The SharePoint Online (and SharePoint 2016 and later on-premises) REST service supports combining multiple requests into a single call to the service by using the OData $batch query option. For details and links to code samples, see [Make batch requests with the REST APIs](https://dev.office.com/sharepoint/docs/apis/rest/make-batch-requests-with-the-rest-apis).
66

77
## Prerequisites
88
Before you get started, make sure that you're familiar with the following:
9-
- [Get to know the SharePoint REST service](https://dev.office.com/sharepoint/docs/apis/rest/get-to-know-the-sharepoint-rest-service.md)
10-
- [Complete basic operations using SharePoint REST endpoints](https://dev.office.com/sharepoint/docs/apis/rest/complete-basic-operations-using-sharepoint-rest-endpoints.md)
9+
- [Get to know the SharePoint REST service](https://dev.office.com/sharepoint/docs/apis/rest/get-to-know-the-sharepoint-rest-service)
10+
- [Complete basic operations using SharePoint REST endpoints](https://dev.office.com/sharepoint/docs/apis/rest/complete-basic-operations-using-sharepoint-rest-endpoints)
1111

1212
## REST commands for site themes
1313

@@ -131,6 +131,6 @@ RestRequest("/_api/thememanager/GetTenantThemingOptions");
131131
* [SharePoint site theming: JSON schema](sharepoint-site-theming-json-schema.md)
132132
* [SharePoint site theming: PowerShell cmdlets](sharepoint-site-theming-powershell.md)
133133
* [SharePoint site theming: CSOM](sharepoint-site-theming-csom.md)
134-
* [Complete basic operations using SharePoint REST endpoints](https://dev.office.com/sharepoint/docs/apis/rest/complete-basic-operations-using-sharepoint-rest-endpoints.md)
134+
* [Complete basic operations using SharePoint REST endpoints](https://dev.office.com/sharepoint/docs/apis/rest/complete-basic-operations-using-sharepoint-rest-endpoints)
135135
* [Making REST calls with C# and JavaScript for SharePoint 2013](http://www.microsoft.com/resources/msdn/en-us/office/media/video/video.mdl?cid=sdc&from=mscomsdc&VideoID=4e4cc094-ff69-405b-852f-2ac7c41293c5)
136136

docs/sp-add-ins/access-sharepoint-data-from-add-ins-using-the-cross-___domain-library.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
---
1+
---
22
title: Access SharePoint data from add-ins using the cross-___domain library
33
ms.date: 09/25/2017
44
ms.prod: sharepoint

docs/sp-add-ins/complete-basic-operations-using-javascript-library-code-in-sharepoint.md

Lines changed: 92 additions & 226 deletions
Large diffs are not rendered by default.

docs/sp-add-ins/complete-basic-operations-using-sharepoint-client-library-code.md

Lines changed: 109 additions & 241 deletions
Large diffs are not rendered by default.

docs/sp-add-ins/complete-basic-operations-using-sharepoint-rest-endpoints.md

Lines changed: 93 additions & 202 deletions
Large diffs are not rendered by default.

docs/sp-add-ins/determine-sharepoint-rest-service-endpoint-uris.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ Use `_api` to denote the SharePoint REST service in your endpoint URIs. The RES
115115

116116
### Specify entry points for the SharePoint REST service
117117

118-
The main entry points for the REST service represent the site collection and site of the specified context. In this way, these entry points correspond to the **ClientContext.Site** property and **ClientContext.Web** property in the client object models.
118+
The main entry points for the REST service represent the site collection and site of the specified context. In this way, these entry points correspond to the **ClientContext.Site** property and **ClientContext.Web** property in the client object models.
119119

120120

121121

@@ -207,11 +207,11 @@ The following figure shows the SharePoint REST parameter syntax.
207207

208208
### Complex types as parameters for the REST service
209209

210-
Some methods in the client object model require a large payload as a parameter. For REST endpoints to maintain functionality parity with their corresponding client object model APIs, the endpoints must accept a complex type as a parameter. In these cases, the REST service extends the existing OData protocol to enable these REST endpoints to accept a single complex type as a parameter. This applies to **POST** operations only, and you have to pass the complex type in [Atom](http://www.odata.org/developers/protocols/atom-format#RepresentingComplexTypesProperties) format or [JSON](http://www.odata.org/developers/protocols/json-format#RepresentingComplexTypeProperties) format, according to OData standards.
210+
Some methods in the client object model require a large payload as a parameter. For REST endpoints to maintain functionality parity with their corresponding client object model APIs, the endpoints must accept a complex type as a parameter. In these cases, the REST service extends the existing OData protocol to enable these REST endpoints to accept a single complex type as a parameter. This applies to **POST** operations only, and you have to pass the complex type in [Atom](http://www.odata.org/developers/protocols/atom-format#RepresentingComplexTypesProperties) format or [JSON](http://www.odata.org/developers/protocols/json-format#RepresentingComplexTypeProperties) format, according to OData standards.
211211

212212

213213

214-
For example, the **ListCollection.Add** method takes a **Microsoft.SharePoint.Client.ListCreationInformation** object as a parameter. To add a list to a specified site, construct the appropriate REST endpoint as follows:
214+
For example, the **ListCollection.Add** method takes a **Microsoft.SharePoint.Client.ListCreationInformation** object as a parameter. To add a list to a specified site, construct the appropriate REST endpoint as follows:
215215

216216

217217

@@ -312,13 +312,13 @@ A `Dictionary<String, object>` is represented as a multi-value object, named Ke
312312

313313

314314

315-
- **Key** The key of the multi-value object.
315+
- **Key** The key of the multi-value object.
316316

317317

318-
- **Value** The value of the object
318+
- **Value** The value of the object
319319

320320

321-
- **ValueType** The value type of the object. For simple value types that map to existing Entity Data Model (EDM) types, the REST service returns the appropriate EDM type string; for example, "Edm.String." If not, the REST service returns the value type returned by the **Type.ToString** function.
321+
- **ValueType** The value type of the object. For simple value types that map to existing Entity Data Model (EDM) types, the REST service returns the appropriate EDM type string; for example, "Edm.String." If not, the REST service returns the value type returned by the **Type.ToString** function.
322322

323323

324324

@@ -359,7 +359,7 @@ To construct URIs that correspond to static methods or properties, use the corre
359359

360360

361361

362-
However, static properties can be accessed only directly, and are not allowed as part of a larger URI composition. For example, directly accessing the **SP.Utility.AssetsLibrary** method in REST is allowable, as follows:
362+
However, static properties can be accessed only directly, and are not allowed as part of a larger URI composition. For example, directly accessing the **SP.Utility.AssetsLibrary** method in REST is allowable, as follows:
363363

364364

365365

@@ -402,8 +402,7 @@ If you want to select, filter, or order the data you requested from an endpoint,
402402
## See also
403403
<a name="bk_addresources"> </a>
404404

405-
406-
- [Get to know the SharePoint REST service](get-to-know-the-sharepoint-rest-service.md)
405+
- [Get to know the SharePoint REST service](get-to-know-the-sharepoint-rest-service.md)
407406

408407

409408
- [Complete basic operations using SharePoint REST endpoints](complete-basic-operations-using-sharepoint-rest-endpoints.md)

docs/sp-add-ins/develop-sharepoint-add-ins.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,20 @@
11
---
22
title: Develop SharePoint Add-ins
3-
ms.date: 09/25/2017
3+
description: In-depth articles and resources to help you build advanced capabilities into your SharePoint Add-ins.
4+
ms.date: 12/13/2017
45
ms.prod: sharepoint
56
---
67

78

89
# Develop SharePoint Add-ins
10+
911
Find in-depth articles and resources to help you build advanced capabilities into your SharePoint Add-ins.
1012

1113

1214
> [!NOTE]
13-
> This article assumes that you are familiar with the article [SharePoint Add-ins](sharepoint-add-ins.md) and the getting started material that it links to.
14-
15-
Under **Develop**, we've got the following to help explain all the different things you can do in a SharePoint Add-in:
15+
> This article assumes that you are familiar with the article [SharePoint Add-ins](sharepoint-add-ins.md) and the getting started material that it links to.
1616
17+
Under **Develop**, we've got the following to help explain all the different things you can do in a SharePoint Add-in:
1718

1819
- In-depth overviews
1920
- How-to articles
@@ -26,33 +27,35 @@ You'll find articles about:
2627
- How to build REST queries and interact with the new APIs
2728
- How and when to configure OAuth for security
2829

29-
SharePoint has enterprise social features like activity feeds and user profiles, along with enterprise content management features, line-of-business (LOB) interoperability features, and website design features that can really make your add-ins stand out. Learn more about them in [Add SharePoint capabilities](http://msdn.microsoft.com/library/11ecb65e-6dc5-4cf1-80ca-3c16418697b6%28Office.15%29.aspx).
30+
SharePoint has enterprise social features such as activity feeds and user profiles, along with enterprise content management features, line-of-business (LOB) interoperability features, and website design features that can really make your add-ins stand out. Learn more about them in [Add SharePoint capabilities](../general-development/add-sharepoint-capabilities.md).
3031

3132
And, code is key, so take a look at the "Samples" menu in the Dev Center. It's a direct link to our code samples for add-ins. As soon as you've set up your development environment, you should check out a few of our samples. Take advantage of a community feature that lets you request a code sample if we don't have one you'd like to see. We take those requests, along with other doc feedback and use them in our continuous updates to the content and samples. So please, let us know if you'd like to see something!
3233

33-
## Get started with SharePoint Add-ins resources
3434
<a name="bk_gettingstarted"> </a>
3535

36-
If you're just getting started with developing SharePoint Add-ins, first take a look a [SharePoint Add-ins](sharepoint-add-ins.md). That page points you to key articles to get you acquainted quickly with the different kinds of SharePoint Add-ins. Before doing more advanced kinds of development with SharePoint Add-ins, you should start with a good idea of the kinds of add-ins that you want to build, the technologies that you will want to include, and the hosting options that you will want to use.
37-
38-
### Essential tasks and resources for developing SharePoint Add-ins using the client object model, JavaScript object model, and REST endpoints in SharePoint
36+
## Get started with SharePoint Add-ins resources
37+
38+
If you're just getting started with developing SharePoint Add-ins, first take a look at [SharePoint Add-ins](sharepoint-add-ins.md). That page points you to key articles to get you acquainted quickly with the different kinds of SharePoint Add-ins. Before doing more advanced kinds of development with SharePoint Add-ins, you should start with a good idea of the kinds of add-ins that you want to build, the technologies that you want to include, and the hosting options that you want to use.
39+
3940
<a name="bk_essentials"> </a>
4041

42+
### Essential tasks and resources for developing SharePoint Add-ins using the client object model, JavaScript object model, and REST endpoints in SharePoint
43+
4144
No matter what kind of SharePoint Add-in you decide to build, your add-in will always interact in some way with a SharePoint site. The articles in Table 1 describe how to do many of the most important kinds of work with SharePoint sites by using three interfaces that are available for you to use in your SharePoint Add-ins: the client object model, the JavaScript object model, and REST endpoints.
4245

4346
**Table 1. Basic operations with the SharePoint client object model, JavaScript object model, and REST interface**
4447

45-
4648
|**Topic**|**Description**|
4749
|:-----|:-----|
4850
| [Complete basic operations using SharePoint client library code](complete-basic-operations-using-sharepoint-client-library-code.md)|Explains how to do common operations by using C# and the client object model.|
4951
| [Complete basic operations using JavaScript library code in SharePoint](complete-basic-operations-using-javascript-library-code-in-sharepoint.md)|Explains how to do common operations by using the JavaScript object model.|
5052
| [Complete basic operations using SharePoint REST endpoints](complete-basic-operations-using-sharepoint-rest-endpoints.md)|Explains how to do common operations by using the REST interface.|
5153

52-
## Learn the fundamental concepts for development with SharePoint Add-ins
5354
<a name="bk_fundamentals"> </a>
5455

55-
In addition to understanding the basic operations, you should understand the fundamental concepts of the SharePoint add-in development model. Every kind of SharePoint Add-in contains an add-in manifest file and is built into an add-in package that you deploy to a SharePoint site. And when you develop any kind of add-in you must consider a range of issues related to authentication and authorization, data access, and usability. The articles in Table 2 acquaint you with these issues and explain their implications for any kind of that you want to create.
56+
## Learn the fundamental concepts for development with SharePoint Add-ins
57+
58+
In addition to understanding the basic operations, you should understand the fundamental concepts of the SharePoint add-in development model. Every kind of SharePoint Add-in contains an add-in manifest file and is built into an add-in package that you deploy to a SharePoint site. When you develop any kind of add-in, you must consider a range of issues related to authentication and authorization, data access, and usability. The articles in Table 2 acquaint you with these issues and explain their implications for any kind of add-in that you want to create.
5659

5760
**Table 2. Fundamental concepts for working with SharePoint Add-ins**
5861

@@ -62,11 +65,12 @@ In addition to understanding the basic operations, you should understand the fun
6265
| [Explore the app manifest structure and the package of a SharePoint Add-in](explore-the-app-manifest-structure-and-the-package-of-a-sharepoint-add-in.md)|Explains how add-in manifests work and how add-in packages are built.|
6366
| [Create UX components in SharePoint](create-ux-components-in-sharepoint.md)|Explores the ways in which you can build a rich user experience in SharePoint Add-ins.|
6467
| [Work with external data in SharePoint](work-with-external-data-in-sharepoint.md)|Explains the data access options and techniques that are available in different kinds of SharePoint Add-ins.|
65-
| [License your Office and SharePoint Add-ins](http://msdn.microsoft.com/library/license-your-office-and-sharepoint-add-ins%28Office.15%29.aspx)|Guides you through the add-in license framework for Office and SharePoint Add-ins.|
68+
| [License your Office and SharePoint Add-ins](https://docs.microsoft.com/en-us/office/dev/store/license-your-add-ins)|Guides you through the add-in license framework for Office and SharePoint Add-ins.|
6669

67-
## Put the pieces together: Building advanced SharePoint Add-ins by integrating capabilities
6870
<a name="bk_integrate"> </a>
6971

72+
## Put the pieces together: Building advanced SharePoint Add-ins by integrating capabilities
73+
7074
When you are familiar with the capabilities and features of SharePoint Add-ins, you can start building more complex add-ins by putting all of the pieces together in ways that suit your requirements. The articles in Table 3 demonstrate how to integrate capabilities and create more fully featured SharePoint Add-ins.
7175

7276
**Table 3. Advanced concepts in SharePoint Add-ins**

0 commit comments

Comments
 (0)