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
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
4
5
ms.prod: sharepoint
5
6
ms.assetid: fdf7ecb2-8851-425b-b058-3285fba77b68
6
7
---
7
8
8
9
# Application Lifecycle Management (ALM) APIs
9
10
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:
11
12
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.
18
19
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:
20
21
21
-
- Install and UnInstall events are being fired for providerhosted add-ins when corresponding operations are occurred
22
-
- ALM APIs supports app-onlybased 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.
23
24
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.
25
26
26
27
> [!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.
28
29
29
30
## REST API
30
31
31
-
### Add solution package to tenant app catalog
32
+
### Add solution packages to the tenant App Catalog
32
33
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.
### Deploy solution packages in the tenant App Catalog
43
44
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.
> 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.
63
64
64
-
### Remove solution package from tenant app catalog
65
+
### Remove solution packages from the tenant App Catalog
65
66
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.
### Install solution package from tenant app catalog to SharePoint site
94
+
### Install solution package from the tenant App Catalog to a SharePoint site
94
95
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.
### Upgrade solution packages on the SharePoint site
103
104
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.
> 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.
121
122
122
123
123
-
## SharePoint PnP PowerShell cmdlets to programmatically add and deploy SharePoint Apps
124
+
## SharePoint PnP PowerShell cmdlets
124
125
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.
126
127
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:
129
131
130
132
```PowerShell
131
133
Add-PnPApp -Path ./myapp.sppkg
132
134
```
133
135
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:
> 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
+
143
146
144
147
148
+
### Remove the app from the App Catalog
145
149
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:
148
151
149
152
```PowerShell
150
153
Remove-PnPApp -Identity <app id>
151
154
```
152
155
153
156
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:
156
160
157
161
```PowerShell
158
162
Install-PnPApp -Identity <app id>
159
163
```
160
164
161
165
162
-
An added app also needs be upgraded:
166
+
To upgrade the app:
163
167
164
168
```PowerShell
165
169
Update-PnPApp -Identity <app id>
166
170
```
167
171
168
172
169
-
And you off course also uninstall the app again from your site:
173
+
To uninstall the app from your site:
170
174
171
175
```PowerShell
172
176
Uninstall-PnPApp -Identity <app id>
173
177
```
174
178
175
179
176
180
> [!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.
178
182
179
183
180
184
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:
183
188
184
189
```PowerShell
185
190
Get-PnPApp
186
191
```
192
+
193
+
## See also
194
+
195
+
-[Get to know the SharePoint REST service](../sp-add-ins/get-to-know-the-sharepoint-rest-service.md)
Copy file name to clipboardExpand all lines: docs/apis/communication-site-creation-rest.md
+32-20Lines changed: 32 additions & 20 deletions
Original file line number
Diff line number
Diff 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
+
---
2
7
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
4
9
5
-
## Prerequisites
10
+
This topic assumes that you are already familiar with the following topics:
6
11
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)
8
14
9
-
The following REST commands are available for creating a modern SharePoint Communication site.
15
+
This topic does not provide code snippets.
10
16
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:
13
18
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:
> 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.
43
51
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:
45
53
46
54
- Topic: null
47
55
- Showcase: 6142d2a0-63a5-4ba0-aede-d9fefca2c767
48
56
- Blank: f6cc5403-0d63-442e-96c0-285923709ffc
49
57
50
-
**Response**
58
+
### Response
51
59
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.
53
61
54
62
```
55
63
{
@@ -64,21 +72,21 @@ If successful, this method returns 200, OK response code and simple JSON object
64
72
```
65
73
66
74
67
-
## Get Communication Site Status
75
+
## Get Communication site status
68
76
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:
0 commit comments