Skip to content

elements hotfix #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alice-shi-avepoint merged 1 commit into from
Oct 23, 2025
Merged

elements hotfix #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/docs/Overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,7 @@ Refer to the data center endpoints in the table below:
| | Switzerland North (Zurich) | `https://graph-ch.avepointonlineservices.com/` |
| | UK South (London) | `https://graph-uk.avepointonlineservices.com/` |
| | US - East | `https://graph-us.avepointonlineservices.com/` |
| | United Arab Emirates (Dubai) | `https://graph-uae.avepointonlineservices.com/` |
| | AOS-US Gov | `https://graph-gov.avepointonlineservices.com/` |
| | AOS2 | `https://graph-aos2.avepointonlineservices.com/` |
| | FedRAMP Cloud (Project Hosts) | `https://graphusgovapi.online15.net/` |
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/services-and-features/enpower/exchange/resourcemailboxes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ If the request has been successfully processed, a 200 OK response will be return
{
"resourceMailboxes": [
{
"id": "73669ae7-55fe-4b47-****-47324c01d5d2",//The unique identifier of the resource mailbox in PowerShell
"id": "73669ae7-55fe-4b47-****-47324c01****",//The unique identifier of the resource mailbox in PowerShell
"userId": "",// The unique identifier of the resource mailbox in Microsoft 365
"principalName": "",// The user principal name of the resource mailbox
"name": "",// The name of the resource mailbox in PowerShell
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/services-and-features/insights/users/userPermissionsExport.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ The API response provides the export job ID and its operation status. You can us
To use this API, send a `GET` request to the specified endpoint, including necessary parameters as defined in the references. The following request is an API call to the Insights environment in the US - East region.

```json
https://graph-us.avepointonlineservices.com/insights/users/insights******001_j*****insightstest.onmicrosoft.com%2523ext%2523%2540m3********.onmicrosoft.com/access/export?exportOptionType=2&siteUrls=https%3A%2F%2Fm******.sharepoint.com%2Fsites%2Fjuly2022public****01&dataSources=microsoft%20teams&dataSources=sharepoint%20online
https://graph-us.avepointonlineservices.com/insights/users/insights******001_j*****insightstest.onmicrosoft.com%2523ext%2523%2540m3********.onmicrosoft.com/access/export?siteUrls=https%3A%2F%2Fm******.sharepoint.com%2Fsites%2Fjuly2022public****01&dataSources=microsoft%20teams&dataSources=sharepoint%20online
```

## Response Sample
Expand Down
6 changes: 3 additions & 3 deletions docs/elements/baseline-management/create-baseline.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ https://graph.avepointonlineservices.com/partner/external/v3/bm/baselines
"name": "baseline A", // The name of the baseline
"color":"0", // The color of the baseline
"description":"baseline A's description", // The description of the baseline
"customerId":"ce43e186-****-****-****-86b51b0aef92", // The ID of the customer
"tenantId":"af83b8e1-****-****-****-970f92192dc5" // The ID of the tenant
"customerId":"ce43e186-****-98b4-****-86b51b0aef92", // The ID of the customer
"tenantId":"af83b8e1-****-8b70-****-970f92192dc5" // The ID of the tenant
}
```

Expand All @@ -64,5 +64,5 @@ If the request has been successfully processed, a 201 OK response will be return

```json
{
"baselineId": "606f30c0-****-****-****-3a1c3a823ab5" // The ID of the newly created baseline
"baselineId": "606f30c0-****-47b8-****-3a1c3a823ab5" // The ID of the newly created baseline
}
26 changes: 13 additions & 13 deletions docs/elements/baseline-management/query-baselines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ You can use the following optional query parameters in the URL to control pagina

|Parameter|Description | Type|Required?|
|---|---|---|---|
|pageIndex|The starting number of the page to retrieve. The default value is 1. |integer|No|
|pageSize|The number of records to return per page. The default value is 50, and the acceptable range is from 1 to 100.|integer|No|
|pageIndex|The starting number of the page to retrieve baselines. The default value is 1. |integer|No|
|pageSize|The number of objects to display on one page. The default value is 50 and the maximum value allowed is 100.|integer|No|

## Request Body Parameters

Expand All @@ -44,8 +44,8 @@ If the request has been successfully processed, a 200 OK response will be return
| --- | --- | --- |
| baselineId | The ID of the baseline. | string |
| baselineName | The name of the baseline. | string |
| createdTime | The created time (UTC) of the baseline. | string |
| modifiedTime | The last modified time (UTC) of the baseline. | string |
| createdTime | The created time of the baseline in ISO 8601 format. | string |
| modifiedTime | The last modified time of the baseline in ISO 8601 format. | string |
| status | The status of the baseline.<ul><li>**1** - Retrieving settings</li><li>**2** - Unused</li><li>**3** - Active</li><li>**4** - Settings retrieval failed</li><li>**5** - Retrieved with exception</li><li>**6** - Draft</li></ul> | integer |

## Request Sample
Expand All @@ -58,8 +58,8 @@ https://graph-us.avepointonlineservices.com/partner/external/v3/bm/baselines/bat
{
"baselineIds":
[
"0f0cb41b-****-****-****-3a1c39554d0c", // The ID of the baseline
"5aec2275-****-****-****-3a1c307a28fa"
"0f0cb41b-****-98b6-****-3a1c39554d0c", // The ID of the baseline
"5aec2275-****-78n6-****-3a1c307a28fa"
]
}
```
Expand All @@ -72,23 +72,23 @@ If the request has been successfully processed, a 200 OK response will be return
{
"data": [
{
"baselineId": "0f0cb41b-****-****-****-3a1c39554d0c", // The ID of the baseline
"baselineId": "0f0cb41b-****98b6-****-3a1c39554d0c", // The ID of the baseline
"baselineName": "Baseline1", // The name of the baseline
"createdTime": "2025-09-04T10:30:00Z", // The created time (UTC) of the baseline
"modifiedTime": "2025-09-05T10:30:00Z", // The last modified time (UTC) of the baseline
"createdTime": "2025-09-04T10:30:00Z", // The created time of the baseline in ISO 8601 format
"modifiedTime": "2025-09-05T10:30:00Z", // The last modified time of the baseline in ISO 8601 format
"status": 1 // The status of the baseline. 1 represents "Retrieving settings"
},
{
"baselineId": "5aec2275-****-****-****-3a1c307a28fa",
"baselineId": "5aec2275-****-78n6-****-3a1c307a28fa",
"name": "Baseline2",
"createdTime": "2025-09-06T10:30:00Z",
"modifiedTime": "2025-09-07T10:30:00Z",
"status": 2
}
],
"metadata": {
"pageIndex": 1, // The page index of the current request
"pageSize": 50, // The number of baselines to be retrieved in one request
"totalCount": 2 // The total number count that matches the request
"pageIndex": 1, // The current display page
"pageSize": 50, // The number of objects on the display page
"totalCount": 2 // The total number of objects matching the query parameters
}
}
12 changes: 6 additions & 6 deletions docs/elements/baseline-management/query-create-baseline-job-report-detail.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ You can use the following optional query parameters in the URL to control pagina

|Parameter|Description | Type|Required?|
|---|---|---|---|
|pageIndex|The index of the page to retrieve. The default value is 1. |integer|No|
|pageSize|The number of records to return per page. The default value is 50, and the acceptable range is from 1 to 100.|integer|No|
|pageIndex|The starting number of the page to get the report details. The default value is 1|integer|No|
|pageSize|The number of objects to display on one page. The default value is 50 and the maximum value allowed is 100.|integer|No|

## Response

Expand All @@ -52,7 +52,7 @@ If the request has been successfully processed, a 200 OK response will be return
To use this API, send a GET request to the specified endpoint.

```json
https://graph-us.avepointonlineservices.com/partner/external/v3/bm/baselines/23351ee7-****-****-****-e8e3ffc29cd7/reports?pageIndex=1&pageSize=50
https://graph-us.avepointonlineservices.com/partner/external/v3/bm/baselines/23351ee7-****-78n6-****-e8e3ffc29cd7/reports?pageIndex=1&pageSize=50
```

## Response Sample
Expand All @@ -77,8 +77,8 @@ If the request has been successfully processed, a 200 OK response will be return
...
],
"metadata": {
"pageIndex": 1, // The page index of thecurrent request
"pageSize": 50, // The number of report data to be retrieved in one request
"totalCount": 109 // The total number count that matches the request
"pageIndex": 1, // The current display page
"pageSize": 50, // The number of objects on the display page
"totalCount": 109 // The total number of objects matching the query parameters
}
}
16 changes: 8 additions & 8 deletions docs/elements/baseline-management/query-job.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ You can use the following optional query parameters in the URL to control pagina

|Parameter|Description | Type|Required?|
|---|---|---|---|
|pageIndex|The index of the page to retrieve. The default value is 1. |integer|No|
|pageSize|The number of records to return per page. The default value is 50, and the acceptable range is from 1 to 100.|integer|No|
|pageIndex|The starting number of the page to get job information. The default value is 1. |integer|No|
|pageSize|The number of objects to display on one page. The default value is 50 and the maximum value allowed is 100.|integer|No|

## Request Body Parameters

Expand All @@ -60,12 +60,12 @@ If the request has been successfully processed, a 200 OK response will be return
To use this API, send a POST request to the specified endpoint.

```json
https://graph-us.avepointonlineservices.com/partner/external/v3/bm/customers/38c6a73d-****-****-****-75b0f1959474/tenants/a2145aa5-****-****-****-7fffd6e0cc68/process-center/jobs/batch?pageIndex=1&pageSize=50
https://graph-us.avepointonlineservices.com/partner/external/v3/bm/customers/38c6a73d-****-98b6-****-75b0f1959474/tenants/a2145aa5-****-76b8-****-7fffd6e0cc68/process-center/jobs/batch?pageIndex=1&pageSize=50

{
"jobIds":
[
"a7bd3e1b-****-****-****-243c4df89a2d" // The ID of the job
"a7bd3e1b-****-97d6-****-243c4df89a2d" // The ID of the job
]
}
```
Expand All @@ -78,14 +78,14 @@ If the request has been successfully processed, a 200 OK response will be return
{
"data": [
{
"jobId": "a7bd3e1b-****-****-****-243c4df89a2d", // The ID of the job
"jobId": "a7bd3e1b-****-97d6-****-243c4df89a2d", // The ID of the job
"type": 1, // The type of the job
"status": 2 // The status of the job
}
],
"metadata": {
"pageIndex": 1, // The page index of the current request
"pageSize": 5, // The number of jobs to be retrieved in one request
"totalCount": 1 // The total number count that matches the request
"pageIndex": 1, // The current display page
"pageSize": 50, // The number of objects on the display page
"totalCount": 1 // The total number of objects matching the query parameters
}
}
26 changes: 13 additions & 13 deletions docs/elements/baseline-management/query-tenant.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ You can use the following optional query parameters in the URL to control pagina

|Parameter|Description | Type|Required?|
|---|---|---|---|
|pageIndex|The index of the page to retrieve. The default value is 1. |integer|No|
|pageSize|The number of records to return per page. The default value is 50, and the acceptable range is from 1 to 100.|integer|No|
|pageIndex|The starting number of the page to get tenants. The default value is 1. |integer|No|
|pageSize|The number of objects to display on one page. The default value is 50 and the maximum value allowed is 100.|integer|No|

## Request Body Parameters

Expand All @@ -45,8 +45,8 @@ If the request has been successfully processed, a 200 OK response will be return
| tenantName | The name of the tenant. | string |
| status | The status of the tenant.<ul><li>**1** - Connected</li><li>**2** - Deployed with exception</li><li>**3** - Deploying</li><li>**4** - Deployment draft saved</li><li>**5** - Deployment failed </li><li>**6** - Expired</li><li>**7** - Deployed </li><li>**8** - Restore failed </li><li>**19** - Restored</li><li>**10** - Restored with exception</li><li>**11** - Restoring</li><li>**12** - Retrieving setting</li><li>**13** - Review deployment</li><li>**14** - Review restore</li><li>**15** - Scheduled deployment </li><li>**16** - Schedule restore</li><li>**17** - Settings retrieval failed</li></ul> | integer |
| driftDetected | The number of configuration deviations that have been detected for the tenant. | integer |
| driftDetectedTime | The time (UTC) when configuration deviations were detected. | string |
| lastDeployedTime | The time (UTC) when the baseline was deployed to the tenant. | string |
| driftDetectedTime | The time in ISO 8601 format when configuration deviations were detected. | string |
| lastDeployedTime | The time in ISO 8601 format when the baseline was deployed to the tenant. | string |
| customerId | The ID of the customer. | string |
| tenantId | The ID of the tenant. | string |
| autoAlignment | The status of the auto-alignment setting. <ul><li>**0** - Disabled</li><li>**1** - Enabled</li></ul>| string |
Expand All @@ -65,7 +65,7 @@ https://graph-us.avepointonlineservices.com/partner/external/v3/bm/baselines/bat
{
"tenantIds":
[
"af83b8e1-****-****-****-970f92192dc5" // The ID of the tenant
"af83b8e1-****-98a7-****-970f92192dc5" // The ID of the tenant
]
}
```
Expand All @@ -81,23 +81,23 @@ If the request has been successfully processed, a 200 OK response will be return
"tenantName": "2****l", // The name of the tenant
"status": 5, // The status of the tenant. 5 represents "Deployment failed"
"driftDetected": 51, // The number of configuration deviations that have been detected for the tenant
"driftDetectedTime": "2025-09-05T10:30:00Z", // The time (UTC) when configuration deviations were detected
"customerId": "ce43e186-****-****-****-86b51b0aef92", // The ID of the customer
"tenantId": "af83b8e1-****-****-****-970f92192dc5", // The ID of the tenant
"driftDetectedTime": "2025-09-05T10:30:00Z", // The time in ISO 8601 format when configuration deviations were detected
"customerId": "ce43e186-****-67v8-****-86b51b0aef92", // The ID of the customer
"tenantId": "af83b8e1-****-98a7-****-970f92192dc5", // The ID of the tenant
"autoAlignment": 1, // The status of the auto-alignment setting. 1 represents "Enabled"
"lastDeployedTime": "2025-09-11T02:26:34Z", // The time (UTC) when the baseline was deployed to the tenant
"lastDeployedTime": "2025-09-11T02:26:34Z", // The time in ISO 8601 format when the baseline was deployed to the tenant
"appliedBaselines": [
{
"baselineId": "de473862-****-****-****-3a1c20398d55", // The ID of the baseline
"baselineId": "de473862-****-45s6-****-3a1c20398d55", // The ID of the baseline
"baselineName": "baseline1", // The name of the baseline
"version": "4" // The version of the baseline
}
]
}
],
"metadata": {
"pageIndex": 1, // The page index of the current request
"pageSize": 50, // The number of tenants to be retrieved in one request
"totalCount": 1 // The total number count that matches the request
"pageIndex": 1, // The current display page
"pageSize": 50, // The number of objects on the display page
"totalCount": 1 // The total number of objects matching the query parameters
}
}
14 changes: 6 additions & 8 deletions docs/elements/baseline-management/tenant-action.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,16 +30,15 @@ This section describes the query parameters that can be added to the URL when se

## Request Body Parameters

You can provide a object about the action.
You can provide an object about the action.

|Parameter|Description | Type|Required?|
|---|---|---|---|
|actionType| The action that you want to perform on a tenant. (More actions will be supported in the future) <ul><li>**1** - Apply baselines to tenant</li></ul> |integer|Yes|
|data| The parameters of the action. |object|Yes|

### Apply Action Data Parameters
**Action data parameters**

For the "Apply baselines to tenant" action, the parameters of the data object are as follows.

|Parameter|Description | Type|Required?|
|---|---|---|---|
Expand All @@ -64,19 +63,18 @@ If the request has been successfully processed, a 200 OK response will be return
To use this API, send a POST request to the specified endpoint.

```json
https://graph-us.avepointonlineservices.com/partner/external/v3/bm/customers/38c6a73d-****-****-****-75b0f1959474/tenants/a2145aa5-****-****-****-7fffd6e0cc68/actions
https://graph-us.avepointonlineservices.com/partner/external/v3/bm/customers/38c6a73d-****-57c6-****-75b0f1959474/tenants/a2145aa5-****-26v7-****-7fffd6e0cc68/actions

//Apply baseline action
{
"actionType": "1", // The action that you want to perform on the tenant. 1 represents "Apply baselines to tenant"
"data":
[
{
"baselineId": "e12922f4-****-****-****-3a1c162b4cf2", // The ID of the baseline
"baselineId": "e12922f4-****-45b7-****-3a1c162b4cf2", // The ID of the baseline
"rankingOrder": 1 // The ranking order of the baseline among all applied baselines
},
{
"baselineId": "b4c84bff-****-****-****-3a1c16243555",
"baselineId": "b4c84bff-****-87b2-****-3a1c16243555",
"rankingOrder": 2
}
]
Expand All @@ -89,6 +87,6 @@ If the request has been successfully processed, a 200 OK response will be return

```json
{
"jobId": "7f3b241b-****-****-****-3a1c395524t6" // The ID of the applying baselines to tenant job
"jobId": "7f3b241b-****-27s7-****-3a1c395524t6" // The ID of the applying baselines to tenant job
}
```
2 changes: 1 addition & 1 deletion docs/elements/change-log.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This document provides a detailed log of changes, updates, and enhancements made
- `/partner/external/v3/general/customers` for onboarding a customer to the current partner.
- `/partner/external/v3/general/customers/{customerId}/services` for adding a service for a customer.
- `/partner/external/v3/general/customers/services/batch` for retrieving the services of customers managed by the current partner.
- `/partner/external/v3/general/customers/{customerId}/3rd-party-products/type/{type}/users` for retrieving the numbers of assigned and available user seats of customer's tenant.
- `/partner/external/v3/general/customers/{customerId}/3rd-party-products/type/{type}/tenants/batch` for retrieving the numbers of assigned and available user seats of customer's tenant.
- `/partner/external/v3/general/customers/{customerId}/avpt-products/type/{productType}/overview` for retrieving the purchased user seats for AvePoint products of the customer.
- `/partner/external/v3/general/customers/{customerId}/tenants/{tenantId}/cloud-backup-m365/users/batch` for retrieving the protected status of users in the customer's tenant by Cloud Backup for Microsoft 365.
- `/partner/external/v3/general/customers/{customerId}/cloud-backup-m365/overview` for retrieving the customer's protected data information of Cloud Backup for Microsoft 365.
Expand Down
Loading