Skip to content

Commit 81d43c4

Browse files
authored
SharePoint APIs edit pass (SharePoint#1338)
* Edit in progress * Edit in progress * Edit in progress * Edit in progress * Adjusted spacing in tables
1 parent 27ac9c4 commit 81d43c4

12 files changed

+509
-364
lines changed

docs/apis/alm-api-for-spfx-add-ins.md

Lines changed: 59 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,37 @@
11
---
22
title: Application Lifecycle Management (ALM) APIs
3-
ms.date: 12/19/2017
3+
description: ALM APIs provide simple APIs to manage deployment of your SharePoint Framework solutions and add-ins across your tenant.
4+
ms.date: 02/08/2018
45
ms.prod: sharepoint
56
ms.assetid: fdf7ecb2-8851-425b-b058-3285fba77b68
67
---
78

89
# Application Lifecycle Management (ALM) APIs
910

10-
ALM APIs are providing simple APIs to manage deployment of your SharePoint Framework solutions and add-ins cross your tenant. ALM APIs support following capabilities.
11+
ALM APIs provide simple APIs to manage deployment of your SharePoint Framework solutions and add-ins across your tenant. ALM APIs support the following capabilities:
1112

12-
- Add SharePoint Framework solution or SharePoint add-in to tenant app catalog
13-
- Enable SharePoint Framework solution or SharePoint add-in to be available for installation in tenant app catalog
14-
- Disable SharePoint Framework solution or SharePoint add-in not to be available for installation in tenant app catalog
15-
- Install SharePoint Framework solution or SharePoint add-in from tenant app catalog to a site
16-
- Upgrade SharePoint Framework solution or SharePoint add-in to a site, which has a newer version available in the tenant app catalog
17-
- Uninstall SharePoint Framework solution or SharePoint add-in from the site
13+
- Add SharePoint Framework solution or SharePoint Add-in to tenant App Catalog.
14+
- Enable SharePoint Framework solution or SharePoint Add-in to be available for installation in tenant App Catalog.
15+
- Disable SharePoint Framework solution or SharePoint Add-in not to be available for installation in tenant App Catalog.
16+
- Install SharePoint Framework solution or SharePoint Add-in from tenant App Catalog to a site.
17+
- Upgrade SharePoint Framework solution or SharePoint Add-in to a site, which has a newer version available in the tenant App Catalog.
18+
- Uninstall SharePoint Framework solution or SharePoint Add-in from the site.
1819

19-
ALM APIs can be used to perform exactly the same operations which are available from UI perspective. When these APIs are used, all typical actions will be performed. Here are some of the characteristics for ALM APIs.
20+
ALM APIs can be used to perform exactly the same operations that are available from a UI perspective. When these APIs are used, all typical actions are performed. Following are some of the characteristics of ALM APIs:
2021

21-
- Install and UnInstall events are being fired for provider hosted add-ins when corresponding operations are occurred
22-
- ALM APIs supports app-only based operations
22+
- `Install` and `UnInstall` events are being fired for provider-hosted add-ins when corresponding operations occur.
23+
- ALM APIs support app-only-based operations.
2324

24-
ALM APIs are natively provided using REST APIs, but there is also additional CSOM extensions and PowerShell commandlets available through SharePoint Patterns and Practices.
25+
ALM APIs are natively provided by using REST APIs, but there are also additional CSOM extensions and PowerShell cmdlets available through SharePoint Patterns and Practices.
2526

2627
> [!NOTE]
27-
> ALM APIs are not currently supported for [site collection app catalog](../general-development/site-collection-app-catalog.md). Support will be added early 2018.
28+
> ALM APIs are not currently supported for the [site collection App Catalog](../general-development/site-collection-app-catalog.md). Support will be added in early 2018.
2829
2930
## REST API
3031

31-
### Add solution package to tenant app catalog
32+
### Add solution packages to the tenant App Catalog
3233

33-
Adding solution to the tenant app catalog. This API is designed to be executed in the context of the tenant app catalog site.
34+
This API is designed to be executed in the context of the tenant App Catalog site.
3435

3536
```
3637
url: /_api/web/tenantappcatalog/Add(overwrite=true, url='test.txt')
@@ -39,148 +40,156 @@ binaryStringRequestBody: true
3940
body: 'byte array of the file'
4041
```
4142

42-
### Deploy solution package in tenant app catalog
43+
### Deploy solution packages in the tenant App Catalog
4344

44-
Enable solution to be available to install to specific sites. This API is designed to be executed in the context of the tenant app catalog site.
45+
This enables the solution to be available to install to specific sites. This API is designed to be executed in the context of the tenant App Catalog site.
4546

4647
```
4748
url: /_api/web/tenantappcatalog/AvailableApps/GetById('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx')/Deploy
4849
```
4950

5051
> [!NOTE]
51-
> This operation is required to be completed after add, before you can install packages to specific sites.
52+
> This operation is required to be completed after Add before you can install packages to specific sites.
5253
53-
### Retract solution package in the tenant app catalog
54+
### Retract solution packages in the tenant App Catalog
5455

55-
Retract solution to be available from the sites. This API is designed to be executed in the context of the tenant app catalog site.
56+
This retracts the solution to be available from the sites. This API is designed to be executed in the context of the tenant App Catalog site.
5657

5758
```
5859
url: /_api/web/tenantappcatalog/AvailableApps/GetById('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx')/Retract
5960
```
6061

6162
> [!NOTE]
62-
> If you run this operation after you have already installed solutions to site, they will stop working since solution is disabled from the tenant level.
63+
> If you run this operation after you have installed solutions to the site, they will stop working because the solution is disabled from the tenant level.
6364
64-
### Remove solution package from tenant app catalog
65+
### Remove solution packages from the tenant App Catalog
6566

66-
Remove the solution package from the tenant app catalog. This API is designed to be executed in the context of the tenant app catalog site.
67+
This API is designed to be executed in the context of the tenant App Catalog site.
6768

6869
```
6970
url: /_api/web/tenantappcatalog/AvailableApps/GetById('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx')/Remove
7071
```
7172

7273
> [!NOTE]
73-
> Solution will be also automatically retracted, if that operation has not performed before Remove operation.
74+
> If the Retract operation is not performed before the Remove operation, the solution is automatically retracted.
7475
75-
### List available packages from tenant app catalog
76+
### List available packages from the tenant App Catalog
7677

77-
REST API for getting list of available SharePoint Framework solutions or add-ins in tenant app catalog.
78+
Use this REST API for getting a list of available SharePoint Framework solutions or add-ins in the tenant App Catalog.
7879

7980
```
8081
url: /_api/web/tenantappcatalog/AvailableApps
8182
method: GET
8283
```
8384

84-
### Details on individual solution package from tenant app catalog
85+
### Details about individual solution packages in the tenant App Catalog
8586

86-
REST API for getting details on individual SharePoint Framework solution or add-in available in the tenant app catalog.
87+
Use this REST API for getting details about individual SharePoint Framework solutions or add-ins available in the tenant App Catalog.
8788

8889
```
8990
url: /_api/web/tenantappcatalog/AvailableApps/GetById('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx')
9091
method: GET
9192
```
9293

93-
### Install solution package from tenant app catalog to SharePoint site
94+
### Install solution package from the tenant App Catalog to a SharePoint site
9495

95-
Install a solution package with specific identifier from tenant app catalog to the site based on URL context. This REST call can be executed in the context of the site where the install operation should happen.
96+
Install a solution package with a specific identifier from the tenant App Catalog to the site based on URL context. This REST call can be executed in the context of the site where the install operation should happen.
9697

9798
```
9899
url: /_api/web/tenantappcatalog/AvailableApps/GetById('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx')/Install
99100
method: POST
100101
```
101102

102-
### Upgrade solution package in SharePoint site
103+
### Upgrade solution packages on the SharePoint site
103104

104-
Upgrade a solution package from the site to a newer version available in the tenant app catalog. This REST call can be executed in the context of the site where the upgrade operation should happen.
105+
Upgrade a solution package from the site to a newer version available in the tenant App Catalog. This REST call can be executed in the context of the site where the upgrade operation should happen.
105106

106107
```
107108
url: /_api/web/tenantappcatalog/AvailableApps/GetById('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx')/Upgrade
108109
method: POST
109110
```
110111

111-
### Uninstall solution package from SharePoint site
112+
### Uninstall solution packages from the SharePoint site
112113

113-
Uninstall a solution package from the site. This REST call can be executed in the context of the site where the uninstall operation should happen.
114+
This REST call can be executed in the context of the site where the uninstall operation should happen.
114115

115116
```
116117
url: /_api/web/tenantappcatalog/AvailableApps/GetById('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx')/Uninstall
117118
method: POST
118119
```
119120
> [!NOTE]
120-
> When you use the REST API to uninstall solution package from the site, it is not relocated to the recycle bin.
121+
> When you use the REST API to uninstall a solution package from the site, it is not relocated to the recycle bin.
121122
122123

123-
## SharePoint PnP PowerShell cmdlets to programmatically add and deploy SharePoint Apps
124+
## SharePoint PnP PowerShell cmdlets
124125

125-
Using [PnP PowerShell](https://msdn.microsoft.com/en-us/pnp_powershell/pnp-powershell-overview) you can automate the deployment, publishing, installing, upgrading and retracting your apps. Checkout below chapter to learn more about this cmdlets.
126+
By using [PnP PowerShell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-pnp/sharepoint-pnp-cmdlets?view=sharepoint-ps), you can automate deploying, publishing, installing, upgrading, and retracting your apps.
126127

127-
### Adding and publishing your app to the app catalog
128-
Adding your app (.sppkg file, .app file) to the tenant app catalog is a per-requisite to later on make your app available for use in your SharePoint sites. Doing so can be done using below simple cmdlet:
128+
### Add and publish your app to the App Catalog
129+
130+
Adding your app (.sppkg file, .app file) to the tenant App Catalog is a prerequisite to making your app available for use on your SharePoint sites. You can do so by using the following cmdlet:
129131

130132
```PowerShell
131133
Add-PnPApp -Path ./myapp.sppkg
132134
```
133135

134-
Once added you'll need to continue with publishing your app, effectively making the app available to be used by the users of your tenant. Below PnP PowerShell cmdlets shows how this can be done:
136+
After you add it, you need to continue with publishing your app, effectively making the app available to the users of your tenant. The following PnP PowerShell cmdlet shows how this can be done:
135137

136138
```PowerShell
137139
Publish-PnPApp -Identity <app id> -SkipFeatureDeployment
138140
```
139141

140142

141143
> [!NOTE]
142-
> Use the SkipFeatureDeployment flag to allow an app that was developed for tenant wide deployment to be actually available as a tenant wide deployed app.
144+
> Use the `SkipFeatureDeployment` flag to allow an app that was developed for tenant-wide deployment to be actually available as a tenant-wide deployed app.
145+
143146

144147

148+
### Remove the app from the App Catalog
145149

146-
### Removing the app from the app catalog
147-
Obviously you might also want to remove an earlier added app and that can be done using the following cmdlet:
150+
To remove an app added earlier, use the following cmdlet:
148151

149152
```PowerShell
150153
Remove-PnPApp -Identity <app id>
151154
```
152155

153156

154-
### Using apps on your site
155-
Once the app was added to the app catalog and published you can continue with installing the app to your site.
157+
### Use apps on your site
158+
159+
After the app is added to the App Catalog and published, you can install the app to your site:
156160

157161
```PowerShell
158162
Install-PnPApp -Identity <app id>
159163
```
160164

161165

162-
An added app also needs be upgraded:
166+
To upgrade the app:
163167

164168
```PowerShell
165169
Update-PnPApp -Identity <app id>
166170
```
167171

168172

169-
And you off course also uninstall the app again from your site:
173+
To uninstall the app from your site:
170174

171175
```PowerShell
172176
Uninstall-PnPApp -Identity <app id>
173177
```
174178

175179

176180
> [!NOTE]
177-
> When you uninstall an app from your site the app is completely deleted, so it will not end up in the site's recycle bin.
181+
> When you uninstall an app from your site, the app is completely deleted, so it does not end up in the site's recycle bin.
178182
179183

180184

181-
### Knowing which apps are there for you to use
182-
Getting a list of apps that can be added to the site is possible using:
185+
### Know which apps are there for you to use
186+
187+
You can get a list of apps that can be added to the site by using:
183188

184189
```PowerShell
185190
Get-PnPApp
186191
```
192+
193+
## See also
194+
195+
- [Get to know the SharePoint REST service](../sp-add-ins/get-to-know-the-sharepoint-rest-service.md)

docs/apis/communication-site-creation-rest.md

Lines changed: 32 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,30 @@
1-
# Creating SharePoint Communication Site using REST
1+
---
2+
title: Create SharePoint Communication site using REST
3+
description: Create and get the status of a new modern SharePoint Communication site by using the REST interface.
4+
ms.date: 02/08/2018
5+
ms.prod: sharepoint
6+
---
27

3-
Learn how to create and get the status of a new modern SharePoint Communication site with the REST interface.
8+
# Create SharePoint Communication site using REST
49

5-
## Prerequisites
10+
This topic assumes that you are already familiar with the following topics:
611

7-
This topic assumes that you are already familiar with the topics Get to know the SharePoint REST service and Complete basic operations using SharePoint REST endpoints. It does not provide code snippets.
12+
- [Get to know the SharePoint REST service](../sp-add-ins/get-to-know-the-sharepoint-rest-service.md)
13+
- [Complete basic operations using SharePoint REST endpoints](../sp-add-ins/complete-basic-operations-using-sharepoint-rest-endpoints.md)
814

9-
The following REST commands are available for creating a modern SharePoint Communication site.
15+
This topic does not provide code snippets.
1016

11-
- **Create** - Create a new SharePoint Communication site
12-
- **Status** - Get the status of a SharePoint Communication site
17+
The following REST commands are available for creating a modern SharePoint Communication site:
1318

14-
The URL for communication site REST commands is based on `_api/sitepages/communicationsite`. For example, these are the endpoints for the commands listed above:
19+
- **Create**. Create a new SharePoint Communication site.
20+
- **Status**. Get the status of a SharePoint Communication site.
21+
22+
The URL for Communication site REST commands is based on `_api/sitepages/communicationsite`. For example, these are the endpoints for the REST commands listed earlier:
1523

1624
- `http:///_api/sitepages/communicationsite/create`
1725
- `http:///_api/sitepages/communicationsite/status`
1826

19-
## Create Communication Site
27+
## Create Communication site
2028

2129
```
2230
url: /_api/sitepages/communicationsite/create
@@ -39,17 +47,17 @@ body:
3947
```
4048

4149
> [!IMPORTANT]
42-
> lcid parameter is not currently supported with this API. You can currently only create English sites.
50+
> The `lcid` parameter is not currently supported with this API. You can currently only create English sites.
4351
44-
New in this API is the concept of SiteDesignID. Much like the in-product site creation flow, the SiteDesignID parameter maps to the included site designs. They are:
52+
New in this API is the concept of `SiteDesignID`. Much like the in-product site creation flow, the `SiteDesignID` parameter maps to the included site designs. They are:
4553

4654
- Topic: null
4755
- Showcase: 6142d2a0-63a5-4ba0-aede-d9fefca2c767
4856
- Blank: f6cc5403-0d63-442e-96c0-285923709ffc
4957

50-
**Response**
58+
### Response
5159

52-
If successful, this method returns 200, OK response code and simple JSON object in the response body with following details.
60+
If successful, this method returns a `200, OK` response code and simple JSON object in the response body with the following details.
5361

5462
```
5563
{
@@ -64,21 +72,21 @@ If successful, this method returns 200, OK response code and simple JSON object
6472
```
6573

6674

67-
## Get Communication Site Status
75+
## Get Communication site status
6876

69-
REST API for getting the status of a modern SharePoint Communication site
77+
The REST API for getting the status of a modern SharePoint Communication site:
7078

7179
```
7280
url: /_api/sitepages/communicationsite/status?url='https%3A%2F%2Fcontoso.sharepoint.com%2Fsites%2Fcomm1'
7381
method: GET
7482
body: none
7583
```
7684

77-
**Response**
85+
### Response
7886

79-
If successful, this method returns 200, OK response code and simple JSON object in the response body with following details.
87+
If successful, this method returns a `200, OK` response code and simple JSON object in the response body with the following details.
8088

81-
If the site exists, the response will return the site status and site URL.
89+
If the site exists, the response returns the site status and site URL:
8290

8391
```
8492
{
@@ -92,7 +100,7 @@ If the site exists, the response will return the site status and site URL.
92100
}
93101
```
94102

95-
If the site does not exist, the response will return site status of 0 with no URL.
103+
If the site does not exist, the response returns a site status of 0 with no URL.
96104

97105
```
98106
{
@@ -104,4 +112,8 @@ If the site does not exist, the response will return site status of 0 with no UR
104112
}
105113
}
106114
}
107-
```
115+
```
116+
117+
## See also
118+
119+
- [Get to know the SharePoint REST service](../sp-add-ins/get-to-know-the-sharepoint-rest-service.md)

0 commit comments

Comments
 (0)