Skip to content

Commit edaa7b4

Browse files
RongqiZRongqiZ
committed
rename fullUrl to absoluteUrl
1 parent 4b13690 commit edaa7b4

File tree

1 file changed

+27
-26
lines changed

1 file changed

+27
-26
lines changed

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

Lines changed: 27 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ POST {adminSiteUrl}/_api/web/AvailableAddIns
4545
| Name | Required | Type | Description |
4646
|--------------------|----------|----------|----------------------------------------------------------------------------------|
4747
| serverRelativeUrls | no | string[] | List of the server relative url of sites that want to get the available Add-ins. |
48-
| fullUrls | no | string[] | List of the full url of sites that want to get the available Add-ins. |
49-
Max total count for serverRelativeUrls and fullUrls is 500. And they can't be both empty.
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.
5050

5151
### Responses
5252

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

8989
### SPErrorWithServerRelativeUrl
9090

91-
| Name | Type | Description |
92-
|-------------------|--------|--------------------------------------------------------|
93-
| serverRelativeUrl | string | The serverRelativeUrl or fullUrl 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 absoluteUrl 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

@@ -116,8 +116,9 @@ POST {adminSiteUrl}/_api/web/AddinPermissions
116116
| Name | Type | Description |
117117
|-------------------|----------|--------------------------------------------------------------------------------------------------------------------------------|
118118
| serverRelativeUrl | string | The server relative url of the site collection. It will return site collection scope permissions of the given site collection. |
119-
| fullUrl | string | The full 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. |
120120
| 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.
121122

122123
### Responses
123124

@@ -134,7 +135,7 @@ POST {adminSiteUrl}/_api/web/AddinPermissions
134135
| siteCollectionScopedPermissions | SPSiteCollectionScopedPermissionInfo[] | This is the permissions grant in site collection scope level. |
135136
| appIdentifier | string | The identifier of the Add-in. |
136137
| serverRelativeUrl | string | The server relative url of the site collection. |
137-
| fullUrl | string | The full url of the site collection. |
138+
| absoluteUrl | string | The absolute url of the site collection. |
138139
| allowAppOnly | bool | This identifies if the Add-in allows app only mode. For more information, see [Add-in authorization policy types in SharePoint](../sp-add-ins/add-in-authorization-policy-types-in-sharepoint.md). |
139140

140141
#### SPTenantScopedPermissionInfo
@@ -159,11 +160,11 @@ POST {adminSiteUrl}/_api/web/AddinPermissions
159160

160161
#### SPAddinPermissionFailedInfo
161162

162-
| Name | Type | Description |
163-
|-------------------|--------|-------------------------------------------------------------|
164-
| serverRelativeUrl | string | The server relative url or full url of the site collection. |
165-
| appIdentifier | string | The identifier list of the Add-in. |
166-
| errorMessage | string | The error message why fetch the Add-in permission failed. |
163+
| Name | Type | Description |
164+
|-------------------|--------|-----------------------------------------------------------------|
165+
| serverRelativeUrl | string | The server relative url or absolute url of the site collection. |
166+
| appIdentifier | string | The identifier list of the Add-in. |
167+
| errorMessage | string | The error message why fetch the Add-in permission failed. |
167168

168169
## Get tenant ACS service principals
169170

@@ -217,8 +218,8 @@ POST {adminSiteUrl}/_api/web/GetAddinPrincipalsHavingPermissionsInSites
217218
| Name | Required | Type | Description |
218219
|--------------------|----------|----------|---------------------------------------------|
219220
| serverRelativeUrls | no | string[] | List site collections' server relative url. |
220-
| fullUrls | no | string[] | List site collections' full url. |
221-
Max total count for serverRelativeUrls and fullUrls is 500. And they can't be both empty.
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.
222223

223224
### Responses
224225

@@ -234,15 +235,15 @@ Max total count for serverRelativeUrls and fullUrls is 500. And they can't be bo
234235
| title | string | The title of the Add-in. |
235236
| appIdentifier | string | The app identifier. |
236237
| serverRelativeUrl | string | The server relative url of the site collection. |
237-
| fullUrl | string | The full url of the site collection. |
238+
| absoluteUrl | string | The absolute url of the site collection. |
238239

239240

240241
#### SPErrorWithServerRelativeUrl
241242

242-
| Name | Type | Description |
243-
|-------------------|--------|----------------------------------------------------------|
244-
| serverRelativeUrl | string | The site collection's server relative url or full url. |
245-
| errorMessage | string | The error message why fetch the Add-in principal failed. |
243+
| Name | Type | Description |
244+
|-------------------|--------|------------------------------------------------------------|
245+
| serverRelativeUrl | string | The site collection's server relative url or absolute url. |
246+
| errorMessage | string | The error message why fetch the Add-in principal failed. |
246247

247248
## Uninstall Add-ins
248249

@@ -267,9 +268,9 @@ POST {adminSiteUrl}/_api/web/UninstallAddins
267268
| Name | Type | Description |
268269
|-------------------|--------|----------------------------------|
269270
| serverRelativeUrl | string | The site's server relative url. |
270-
| fullUrl | string | The site's full url. |
271+
| absoluteUrl | string | The site's absolute url. |
271272
| appInstanceIds | Guid[] | The instance ids of the Add-ins. |
272-
The serverRelativeUrl and fullUrl can't be both empty.
273+
The serverRelativeUrl and absoluteUrl can't be both empty. If both serverRelativeUrl and absoluteUrl are provided, the absoluteUrl will be used.
273274

274275
### Responses
275276

@@ -284,7 +285,7 @@ The serverRelativeUrl and fullUrl can't be both empty.
284285
|-------------------|--------|---------------------------------|
285286
| appInstanceId | Guid | The instance id of the Add-in. |
286287
| serverRelativeUrl | string | The site's server relative url. |
287-
| fullUrl | string | The site's full url. |
288+
| absoluteUrl | string | The site's absolute url. |
288289
| uninstallJobId | Guid | The triggered uninstall job id. |
289290

290291
#### SPFailToTriggerUninstallAddinJobResponse
@@ -315,15 +316,15 @@ POST {adminSiteUrl}/_api/web/GetAddinUninstallJobDetail
315316
|-------------------|----------|--------|---------------------------------|
316317
| jobId | yes | Guid | This uninstall job id. |
317318
| serverRelativeUrl | no | string | The site's server relative url. |
318-
| fullUrl | no | string | The site's full url. |
319-
The serverRelativeUrl and fullUrl can't be both empty.
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.
320321

321322
### Responses
322323

323324
| Name | Type | Description |
324325
|-------------------|-------------------------------|--------------------------------------------------|
325326
| serverRelativeUrl | string | The site's server relative url. |
326-
| fullUrl | string | The site's full url. |
327+
| absoluteUrl | string | The site's absolute url. |
327328
| taskStartTime | DateTime | The time when the task starts executing. |
328329
| jobId | Guid | The uninstall job id. |
329330
| siteId | Guid | The site collection id. |

0 commit comments

Comments
 (0)