Skip to content

Commit b0e2a1e

Browse files
RongqiZRongqiZ
committed
update it to url accept both relative and absolute
1 parent edaa7b4 commit b0e2a1e

File tree

1 file changed

+32
-32
lines changed

1 file changed

+32
-32
lines changed

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

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,11 @@ 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-
| absoluteUrls | no | string[] | List of the absolute url of sites that want to get the available Add-ins. |
49-
Max total count for serverRelativeUrls and absoluteUrls 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. |
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.
5050

5151
### Responses
5252

@@ -88,10 +88,10 @@ Max total count for serverRelativeUrls and absoluteUrls is 500. And they can't b
8888

8989
### SPErrorWithServerRelativeUrl
9090

91-
| Name | Type | Description |
92-
|-------------------|--------|-----------------------------------------------------------|
93-
| serverRelativeUrl | string | The serverRelativeUrl or absoluteUrl in the request body. |
94-
| errorMessage | string | The error message why fetch the site's Add-ins failed. |
91+
| Name | Type | Description |
92+
|-------------------|--------|--------------------------------------------------------|
93+
| serverRelativeUrl | string | The serverRelativeUrl or url in the request body. |
94+
| errorMessage | string | The error message why fetch the site's Add-ins failed. |
9595

9696
## Get Add-in permissions in site collections
9797

@@ -113,12 +113,12 @@ POST {adminSiteUrl}/_api/web/AddinPermissions
113113

114114
#### SPAddinPermissionRequest
115115

116-
| Name | Type | Description |
117-
|-------------------|----------|--------------------------------------------------------------------------------------------------------------------------------|
118-
| serverRelativeUrl | string | The server relative url of the site collection. It will return site collection scope permissions of the given site collection. |
119-
| absoluteUrl | string | The absolute url of the site collection. It will return site collection scope permissions of the given site collection. |
120-
| appIdentifiers | string[] | The identifier list of the Add-ins. |
121-
The serverRelativeUrl and absoluteUrl can't be both empty. If both serverRelativeUrl and absoluteUrl are provided, the absoluteUrl will be used.
116+
| Name | Type | Description |
117+
|-------------------|----------|-------------------------------------------------------------------------------------------|
118+
| serverRelativeUrl | string | The server relative url of the site collection. |
119+
| url | string | The url of the site collection, both server relative url and absolute url are acceptable. |
120+
| 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.
122122

123123
### Responses
124124

@@ -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-
| absoluteUrls | no | string[] | List site collections' absolute url. |
222-
Max total count for serverRelativeUrls and absoluteUrls 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. |
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.
223223

224224
### Responses
225225

@@ -265,12 +265,12 @@ POST {adminSiteUrl}/_api/web/UninstallAddins
265265

266266
#### SPUninstallAddinRequest
267267

268-
| Name | Type | Description |
269-
|-------------------|--------|----------------------------------|
270-
| serverRelativeUrl | string | The site's server relative url. |
271-
| absoluteUrl | string | The site's absolute url. |
272-
| appInstanceIds | Guid[] | The instance ids of the Add-ins. |
273-
The serverRelativeUrl and absoluteUrl can't be both empty. If both serverRelativeUrl and absoluteUrl are provided, the absoluteUrl will be used.
268+
| Name | Type | Description |
269+
|-------------------|--------|---------------------------------------------------------------------------|
270+
| serverRelativeUrl | string | The site's server relative url. |
271+
| url | string | The site's url, both server relative url and absolute url are acceptable. |
272+
| 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.
274274

275275
### Responses
276276

@@ -312,12 +312,12 @@ POST {adminSiteUrl}/_api/web/GetAddinUninstallJobDetail
312312

313313
### Request body
314314

315-
| Name | Required | Type | Description |
316-
|-------------------|----------|--------|---------------------------------|
317-
| jobId | yes | Guid | This uninstall job id. |
318-
| serverRelativeUrl | no | string | The site's server relative url. |
319-
| absoluteUrl | no | string | The site's absolute url. |
320-
The serverRelativeUrl and absoluteUrl can't be both empty. If both serverRelativeUrl and absoluteUrl are provided, the absoluteUrl will be used.
315+
| Name | Required | Type | Description |
316+
|-------------------|----------|--------|----------------------------------------------------------------------------|
317+
| jobId | yes | Guid | This uninstall job id. |
318+
| serverRelativeUrl | no | string | The site's server relative url. |
319+
| 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.
321321

322322
### Responses
323323

0 commit comments

Comments
 (0)