You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* 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
Copy file name to clipboardExpand all lines: docs/declarative-customization/site-theming/sharepoint-site-theming-rest-api.md
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -2,12 +2,12 @@
2
2
3
3
You can use the the SharePoint REST interface to perform basic create, read, update, and delete (CRUD) operations on site themes.
4
4
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).
6
6
7
7
## Prerequisites
8
8
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)
*[SharePoint site theming: JSON schema](sharepoint-site-theming-json-schema.md)
132
132
*[SharePoint site theming: PowerShell cmdlets](sharepoint-site-theming-powershell.md)
133
133
*[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)
135
135
*[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)
Copy file name to clipboardExpand all lines: docs/sp-add-ins/determine-sharepoint-rest-service-endpoint-uris.md
+8-9Lines changed: 8 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -115,7 +115,7 @@ Use `_api` to denote the SharePoint REST service in your endpoint URIs. The RES
115
115
116
116
### Specify entry points for the SharePoint REST service
117
117
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.
119
119
120
120
121
121
@@ -207,11 +207,11 @@ The following figure shows the SharePoint REST parameter syntax.
207
207
208
208
### Complex types as parameters for the REST service
209
209
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.
211
211
212
212
213
213
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:
215
215
216
216
217
217
@@ -312,13 +312,13 @@ A `Dictionary<String, object>` is represented as a multi-value object, named Ke
312
312
313
313
314
314
315
-
-**Key** The key of the multi-value object.
315
+
-**Key** The key of the multi-value object.
316
316
317
317
318
-
-**Value** The value of the object
318
+
-**Value** The value of the object
319
319
320
320
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.
322
322
323
323
324
324
@@ -359,7 +359,7 @@ To construct URIs that correspond to static methods or properties, use the corre
359
359
360
360
361
361
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:
363
363
364
364
365
365
@@ -402,8 +402,7 @@ If you want to select, filter, or order the data you requested from an endpoint,
402
402
## See also
403
403
<aname="bk_addresources"> </a>
404
404
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)
407
406
408
407
409
408
-[Complete basic operations using SharePoint REST endpoints](complete-basic-operations-using-sharepoint-rest-endpoints.md)
Copy file name to clipboardExpand all lines: docs/sp-add-ins/develop-sharepoint-add-ins.md
+18-14Lines changed: 18 additions & 14 deletions
Original file line number
Diff line number
Diff line change
@@ -1,19 +1,20 @@
1
1
---
2
2
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
4
5
ms.prod: sharepoint
5
6
---
6
7
7
8
8
9
# Develop SharePoint Add-ins
10
+
9
11
Find in-depth articles and resources to help you build advanced capabilities into your SharePoint Add-ins.
10
12
11
13
12
14
> [!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.
16
16
17
+
Under **Develop**, we've got the following to help explain all the different things you can do in a SharePoint Add-in:
17
18
18
19
- In-depth overviews
19
20
- How-to articles
@@ -26,33 +27,35 @@ You'll find articles about:
26
27
- How to build REST queries and interact with the new APIs
27
28
- How and when to configure OAuth for security
28
29
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).
30
31
31
32
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!
32
33
33
-
## Get started with SharePoint Add-ins resources
34
34
<aname="bk_gettingstarted"> </a>
35
35
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
+
39
40
<aname="bk_essentials"> </a>
40
41
42
+
### Essential tasks and resources for developing SharePoint Add-ins using the client object model, JavaScript object model, and REST endpoints in SharePoint
43
+
41
44
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.
42
45
43
46
**Table 1. Basic operations with the SharePoint client object model, JavaScript object model, and REST interface**
44
47
45
-
46
48
|**Topic**|**Description**|
47
49
|:-----|:-----|
48
50
|[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.|
49
51
|[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.|
50
52
|[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.|
51
53
52
-
## Learn the fundamental concepts for development with SharePoint Add-ins
53
54
<aname="bk_fundamentals"> </a>
54
55
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.
56
59
57
60
**Table 2. Fundamental concepts for working with SharePoint Add-ins**
58
61
@@ -62,11 +65,12 @@ In addition to understanding the basic operations, you should understand the fun
62
65
|[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.|
63
66
|[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.|
64
67
|[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.|
66
69
67
-
## Put the pieces together: Building advanced SharePoint Add-ins by integrating capabilities
68
70
<aname="bk_integrate"> </a>
69
71
72
+
## Put the pieces together: Building advanced SharePoint Add-ins by integrating capabilities
73
+
70
74
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.
71
75
72
76
**Table 3. Advanced concepts in SharePoint Add-ins**
0 commit comments