Skip to content

Commit 641ab38

Browse files
RongqiZRongqiZ
committed
urls and serverReltiveUrls will accept only one
1 parent b0e2a1e commit 641ab38

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

‎docs/apis/addin-management-apis.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -42,15 +42,15 @@ POST {adminSiteUrl}/_api/web/AvailableAddIns
4242

4343
### Request body
4444

45-
| Name | Required | Type | Description |
46-
|--------------------|----------|----------|----------------------------------------------------------------------------------------------------------------------------|
47-
| serverRelativeUrls | no | string[] | List of the server relative url of sites that want to get the available Add-ins. |
48-
| urls | no | string[] | List of the url of sites that want to get the available Add-ins, both server relative url and absolute url are acceptable. |
49-
Max total count for serverRelativeUrls and urls is 500. And they can't be both empty.
45+
| Name | Required | Type | Description |
46+
|--------------------|----------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------|
47+
| serverRelativeUrls | no | string[] | List of the server relative url of sites that want to get the available Add-ins. Maximum size is 500. |
48+
| urls | no | string[] | List of the url of sites that want to get the available Add-ins, both server relative url and absolute url are acceptable. Maximum size is 500. |
49+
When urls is not null, serverRelativeUrls will be disregarded.
5050

5151
### Responses
5252

53-
| Name | Type | Description |
53+
| Name | Type | Description |
5454
|-----------------------------|--------------------------------|--------------------------------------------------------------------------------------|
5555
| addins | SPAddinInstanceInfo[] | Available Add-in instance object. |
5656
| errorsWithServerRelativeUrl | SPErrorWithServerRelativeUrl[] | Server relative urls that failed to get available add-ins and corresponding reasons. |
@@ -118,10 +118,10 @@ POST {adminSiteUrl}/_api/web/AddinPermissions
118118
| serverRelativeUrl | string | The server relative url of the site collection. |
119119
| url | string | The url of the site collection, both server relative url and absolute url are acceptable. |
120120
| appIdentifiers | string[] | The identifier list of the Add-ins. |
121-
The serverRelativeUrl and url can't be both empty. If both serverRelativeUrl and url are provided, the url will be used.
121+
The serverRelativeUrl and url can't be both null. If both serverRelativeUrl and url are provided, the url will be used.
122122

123123
### Responses
124-
124+
``
125125
| Name | Type | Description |
126126
|------------------|-------------------------------|-----------------------------------------------------------------------|
127127
| addinPermissions | SPAddinPermissionInfo[] | The returned permissions. |
@@ -215,11 +215,11 @@ POST {adminSiteUrl}/_api/web/GetAddinPrincipalsHavingPermissionsInSites
215215

216216
### Request body
217217

218-
| Name | Required | Type | Description |
219-
|--------------------|----------|----------|---------------------------------------------------------------------------------------|
220-
| serverRelativeUrls | no | string[] | List site collections' server relative url. |
221-
| urls | no | string[] | List site collections' url, both server relative url and absolute url are acceptable. |
222-
Max total count for serverRelativeUrls and urls is 500. And they can't be both empty.
218+
| Name | Required | Type | Description |
219+
|--------------------|----------|----------|------------------------------------------------------------------------------------------------------------|
220+
| serverRelativeUrls | no | string[] | List site collections' server relative url. Maximum size is 500. |
221+
| urls | no | string[] | List site collections' url, both server relative url and absolute url are acceptable. Maximum size is 500. |
222+
When urls is not null, serverRelativeUrls will be disregarded.
223223

224224
### Responses
225225

@@ -270,7 +270,7 @@ POST {adminSiteUrl}/_api/web/UninstallAddins
270270
| serverRelativeUrl | string | The site's server relative url. |
271271
| url | string | The site's url, both server relative url and absolute url are acceptable. |
272272
| appInstanceIds | Guid[] | The instance ids of the Add-ins. |
273-
The serverRelativeUrl and url can't be both empty. If both serverRelativeUrl and url are provided, the url will be used.
273+
The serverRelativeUrl and url can't be both null. If both serverRelativeUrl and url are provided, the url will be used.
274274

275275
### Responses
276276

@@ -317,7 +317,7 @@ POST {adminSiteUrl}/_api/web/GetAddinUninstallJobDetail
317317
| jobId | yes | Guid | This uninstall job id. |
318318
| serverRelativeUrl | no | string | The site's server relative url. |
319319
| url | no | string | The site's url, both server relative url and absolute url are acceptable. |
320-
The serverRelativeUrl and url can't be both empty. If both serverRelativeUrl and url are provided, the url will be used.
320+
The serverRelativeUrl and url can't be both null. If both serverRelativeUrl and url are provided, the url will be used.
321321

322322
### Responses
323323

0 commit comments

Comments
 (0)