update cloud api document

AvePoint · Oct 18, 2024 · 32fc39f · 32fc39f
1 parent e783c39
commit 32fc39f
Show file tree

Hide file tree

Showing 7 changed files with 91 additions and 84 deletions.
diff --git a/docs/docs/Use AvePoint Graph Modern API.md → docs/docs/Use-AvePoint-Graph-Modern-API.md b/docs/docs/Use AvePoint Graph Modern API.md → docs/docs/Use-AvePoint-Graph-Modern-API.md
@@ -13,8 +13,6 @@ To access the resources of AvePoint Cloud Services via the AvePoint Graph Modern
 For a step-by-step guide on creating an app registration for API authentication, refer to the [Configure App Registration](https://cdn.avepoint.com/assets/webhelp/avepoint-online-services/index.htm#!Documents/configureappregistrations.htm) section in the AvePoint Online Services User Guide.  
 
 >[!NOTE]  
-
-
 > For partner operations, go to Elements for Partner for app registration. See [App Registration in Elements for Partners guide](https://cdn.avepoint.com/assets/apelements-webhelp/avepoint-elements-for-partners/index.htm#!Documents/appregistration.htm).
 
 ## Call an API Method

diff --git a/docs/docs/Use Cases.md → docs/docs/Use-Cases.md b/docs/docs/Use Cases.md → docs/docs/Use-Cases.md
diff --git a/docs/docs/services-and-features/aos/aos.md b/docs/docs/services-and-features/aos/aos.md
@@ -5,7 +5,11 @@ Use this API to retrieve audit records (`/aos/audit` navigation property) for ac
 ## Permission
 
 The following permission is required to call this API.  
-You must register an app through AvePoint Online Services > App registrations to authenticate and authorize your access to AvePoint Graph Modern API. For details, refer to [Authentication and Authorization](/docs/Use%20AvePoint%20Graph%20Modern%20API.md/#authentication-and-authorization).
+<<<<<<< HEAD
+You must register an app through AvePoint Online Services > App registrations to authenticate and authorize your access to AvePoint Graph Modern API. For details, refer to [Authentication and Authorization](/docs/Use-AvePoint-Graph-Modern-API.md#authentication-and-authorization).
+=======
+You must register an app through AvePoint Online Services > App registrations to authenticate and authorize your access to AvePoint Graph Modern API. For details, refer to [Authentication and Authorization](/docs/docs/Use%20AvePoint%20Graph%20Modern%20API.md/#authentication-and-authorization).
+>>>>>>> c57cd990c884f8e55f033f60917ed1f1d8624f1d
 
 | API    | Permission  | 
 |-------------------|---------------------|
@@ -94,13 +98,15 @@ If an error occurs, the following information is displayed in the response body.
 
 The following request is an API call to the AvePoint Online Services (AOS) environment in the US - East region. The API method being used is `/aos/audit`. This request is designed to fetch a specific set of audit logs from the AOS portal, within a defined timeframe, and limited to a particular geographical location.
 
-`https://graph-us.avepointonlineservices.com/aos/audit?startTime=2024-10-10T08:00:00Z&endTime=2024-10-14T17:00:00Z&productTypes=Portal&geoLocations=NAM`
+```json
+https://graph-us.avepointonlineservices.com/aos/audit?startTime=2024-10-10T08:00:00Z&endTime=2024-10-14T17:00:00Z&productTypes=Portal&geoLocations=NAM
+```
 
 ## Response Sample
 
 If successful, this method returns a 200 OK response code and a collection of user activities in the response body.
 
-```ts
+```json
 {
     "nextLink": null, // No results in the next page
     "data": [

diff --git a/docs/docs/services-and-features/elements/scan-profiles/all-scan-profiles.md b/docs/docs/services-and-features/elements/scan-profiles/all-scan-profiles.md
@@ -1,6 +1,6 @@
 # Retrieve  All Scan Profiles
 
-Use this API tor retrieve your customer's information for all scan profiles configured in AvePoint Online Services. 
+Use this API tor retrieve your customer's information for all scan profiles configured in AvePoint Online Services.  
 
 ## Permissions  
 

diff --git a/docs/docs/services-and-features/iaas-paas/iaas-paas.md b/docs/docs/services-and-features/iaas-paas/iaas-paas.md
@@ -1,34 +1,34 @@
 # Retrieve Job Information
 
-Cloud Backup for IaaS + PaaS provides the `backup/vm/jobs` API to facilitate the retrieval of job-related information through a standardized HTTP GET request. By invoking the `backup/vm/jobs` endpoint, users can access detailed insights and data about specific job reports, enhancing the ability to manage and analyze job information efficiently.  
-
-This API serves as a crucial tool for developers and businesses needing to access job data programmatically, streamlining workflows and enhancing data-driven decision-making.  
+Get the job-related information (`backup/vm/jobs` navigation property) from Cloud Backup for IaaS + PaaS. By invoking the `backup/vm/jobs` endpoint, users can access detailed insights and data about specific job reports, enhancing the ability to manage and analyze job information efficiently.   
 
 ## Permission
 
 The following permission is required to call this API.  
-You must register an app through AvePoint Online Services > App registration to authenticate and authorize your access to AvePoint Graph Modern API. For details, refer to [Authentication and Authorization](/Use%20AvePoint%20Graph%20Modern%20API.md/#authentication-and-authorization)
+You must register an app through AvePoint Online Services > App registration to authenticate and authorize your access to AvePoint Graph Modern API. For details, refer to [Authentication and Authorization](/docs/docs/Use%20AvePoint%20Graph%20Modern%20API.md/#authentication-and-authorization).
 
 | API     | Permission required | Permission type |
 |-------------------|---------------|----------------------|
 | `backup/vm/jobs` | PlatformBackup.ReadWrite.All | Application|
 
 ## Request  
 
-This section outlines the details on the method used to retrieve job information from Cloud Backup for IaaS + PaaS.  
+This section outlines the HTTP method and endpoint used to retrieve job information. It provides a concise description of the action performed by the API call. 
 
 | HTTP Method | Endpoint | Description |
 | --- | --- | --- |
 | GET | `backup/vm/jobs` | Retrieves comprehensive job information. |
 
 ## Query Parameters
 
+The API supports several query parameters to refine and customize the data retrieval process. These parameters allow users to specify time ranges, service types, and other criteria to filter the results effectively.
+
 | Name | Located in | Description | Required | Schema |
 | ---- | ---------- | ----------- | -------- | ------ |
 | SearchText | query | Searches by job ID or description. | No | string |
 | StartTime | query | Sets a start time (UTC time) for the time range. | No | integer |
 | FinishTime | query | Sets an end time (UTC time) for the time range. | No | integer |
-| ServiceType | query | Sets the service type of the jobs to get.<ul>  <li>1 - VM</li>  <li>2 - AAD</li><li>4 - AzureFile</li>  <li>8 - FileShare</li><li>16 - BlobStorage</li><li>32 - AKS</li>  <li>64 - APSetting</li><li>128 - Common</li>  <li>256 - AmazonEC2</li><li>512 - AzureSQL</li><li>1024 - AzureDevOps</li></ul> | No | Enum |
+| ServiceType | query | Sets the service type of the jobs to get.<ul>  <li> **1** for VM</li>  <li> **2** for AAD</li><li> **4** for AzureFile</li>  <li> **8** for FileShare</li><li> **16** for BlobStorage</li><li> **32** for AKS</li>  <li> **64** for APSetting</li><li> **128** for Common</li>  <li> **256** for AmazonEC2</li><li> **512** for AzureSQL</li><li> **1024** for AzureDevOps</li></ul> | No | Enum |
 | JobType | query | Sets the job types that you want to get.<ul><li> **1** for Backup</li><li> **2** for Restore</li><li> **4** for Export</li><li> **8** for Report</li><li> **16** for VMSync</li><li> **32** for GenIndex</li><li> **33** for AADCompare</li><li> **34** for Retention</li><li> **64** for AADBackup</li><li> **128** for AADRestore</li><li> **256** for AADExport</li><li> **257** for FileSync</li><li> **512** for FileBackup</li><li> **1024** for FileRestore</li><li> **2048** for FileExport</li><li> **4096** for LicenseSync</li><li> **8192** for AOSUpdate</li><li> **16384** for AKSBackup</li><li> **20000** for AKSSync</li><li> **20001** for AKSRestore</li><li> **20002** for APSettingBackup</li><li> **20003** for APSettingExport</li><li> **20004** for APSettingSync</li><li> **20005** for APSettingRestore</li><li> **20006** for ExportCleanUp</li><li> **20007** for EC2Backup</li><li> **20009** for EC2Restore</li><li> **20010** for SQLSync</li><li> **20011** for SQLBackup</li><li> **20012** for SQLRestore</li><li> **20013** for DevOpsBackup</li><li> **20014** for DevOpsRestore</li><li> **20015** for SoftDelete</li><li> **30000** for HardDelete</li><li> **30001** for AdditionalType</li></ul> | No | Enum |
 | PageNumber | query | Sets the starting number of the page. The default value is 0. | No | integer |
 | PageSize | query | Sets the number of objects to display on one page. The default value is 10. | No | integer |
@@ -40,98 +40,99 @@ If the request has been successfully processed, a 200 OK response will be return
 
 |Elements|Description | Type|
 |---|---|---|
-|totalCount||int|
-|jobs|A collection of jobs|int|
-|jobId|The job ID. ||
-|state|Indicates the state of the job.<ul>  <li>0 - NotStarted</li>  <li>1 - InProgress</li>  <li>2 - Successful</li>  <li>4 - Skipped</li>  <li>8 - Exception</li>  <li>16 - Failed</li>  <li>32 - Waiting</li>  <li>64 - Stopped</li></ul> ||
-|failedCount|||
-|successfulCount|||
-|skippedCount|||
-|totalCount|||
-|startTime|||
-|finishTime|||
-|duration|||
-|comments|||
-|errorModel|Returns the request ID, date and the error code. See [HttpStatusCode](/docs/Use%20AvePoint%20Graph%20Modern%20API.md/#http-status-code)||
+|totalCount|Total count of jobs matching the query parameters.|integer|
+|jobs|A collection of jobs.|integer|
+|jobId|Unique identifier for the job. |string|
+|state|Indicates the state of the job.<ul>  <li>**0** for Not Started</li>  <li>**1** for In Progress</li>  <li>**2** for Successful</li>  <li>**4** for Skipped</li>  <li>**8** for Exception</li>  <li>**16** for Failed</li>  <li>**32** for Waiting</li>  <li>**64** for Stopped</li></ul> |Enum|
+|failedCount|Count of objects with errors.|integer|
+|successfulCount|Count of objects successfully proceed.|integer|
+|skippedCount|Count of objects skipped during processing.|integer|
+|totalCount|Total count of objects in the job.|integer|
+|startTime|The start time of the job.|integer|
+|finishTime|The end time of the job.|integer|
+|duration|Duration of the job.|integer|
+|comments|Comments for the job.|string|
+|errorModel|Returns the request ID, date and the error code. See [HttpStatusCode](/docs/docs/Use%20AvePoint%20Graph%20Modern%20API.md/#http-status-code).|string|
+|nextlink|Returns the link to the next page of results.|string|
 
 ## Request Sample
 
 To use this API, send a GET request to the specified endpoint, including necessary parameters as defined in the references. This will return the relevant job details in a structured format, enabling easy integration with other systems or applications.  
 
-```
+```json
 https://graph-us.avepointonlineservices.com/backup/vm/jobs?serviceType=1&jobType=1&pageSize=5&startTime=638527680000000000&finishTime=638633088000000000
 ```
 
 ## Response Sample  
 
-If successful, this method returns a 200 OK response code and a collection of  jobs in the response body. For more details on the HTTP status code, refer to [HTTP Status Code](/docs/Use%20AvePoint%20Graph%20Modern%20API.md/#http-status-code).
+If successful, this method returns a 200 OK response code and a collection of  jobs in the response body. For more details on the HTTP status code, refer to [HTTP Status Code](/docs/docs/Use%20AvePoint%20Graph%20Modern%20API.md/#http-status-code).
 
-```
+```json
 {
-    "totalCount": 51,
+    "totalCount": 51, // Total count of jobs
     "jobs": [
         {
-            "jobId": "IB20240822160048505",
-            "state": 2,
-            "failedCount": 0,
-            "successfulCount": 0,
-            "skippedCount": 0,
-            "totalCount": 0,
-            "startTime": 638599392481859693,
-            "finishTime": 638599398999332487,
-            "duration": 6517472794,
-            "comments": ""
+            "jobId": "IB20240822160048505", // Unique job identifier
+            "state": 2, // The job is in progress
+            "failedCount": 0, // Count of objects with errors
+            "successfulCount": 0, // Count of successful objects
+            "skippedCount": 0, // Count of skipped objects
+            "totalCount": 0, // Total count of objects
+            "startTime": 638599392481859693, // Start time of the job
+            "finishTime": 638599398999332487, // Finish time of the job
+            "duration": 6517472794, // Duration of the job
+            "comments": "" // Comments for the job
         },
         {
-            "jobId": "IB20240821160052944",
-            "state": 2,
-            "failedCount": 0,
-            "successfulCount": 0,
-            "skippedCount": 0,
-            "totalCount": 0,
-            "startTime": 638598528526352169,
-            "finishTime": 638598529278694804,
-            "duration": 752342635,
-            "comments": ""
+            "jobId": "IB20240821160052944", // Unique job identifier 
+            "state": 2, // The job is in progress
+            "failedCount": 0, // Count of objects with errors
+            "successfulCount": 0, // Count of successful objects
+            "skippedCount": 0, // Count of skipped objects
+            "totalCount": 0, // Total count of objects
+            "startTime": 638598528526352169, // Start time of the job
+            "finishTime": 638598529278694804, // Finish time of the job
+            "duration": 752342635, // Duration of the job
+            "comments": "" // Comments for the job
         },
         {
-            "jobId": "IB20240820160110886",
-            "state": 2,
-            "failedCount": 0,
-            "successfulCount": 0,
-            "skippedCount": 0,
-            "totalCount": 0,
-            "startTime": 638597664705763668,
-            "finishTime": 638597667419407597,
-            "duration": 2713643929,
-            "comments": ""
+            "jobId": "IB20240820160110886", // Unique job identifier
+            "state": 2, // The job is in progress
+            "failedCount": 0, // Count of objects with errors
+            "successfulCount": 0, // Count of successful objects
+            "skippedCount": 0, // Count of skipped objects
+            "totalCount": 0, // Total count of objects
+            "startTime": 638597664705763668, // Start time of the job
+            "finishTime": 638597667419407597, // Finish time of the job
+            "duration": 2713643929, // Duration of the job
+            "comments": "" // Comments for the job
         },
         {
-            "jobId": "IB20240819160046802",
-            "state": 2,
-            "failedCount": 0,
-            "successfulCount": 0,
-            "skippedCount": 0,
-            "totalCount": 0,
-            "startTime": 638596800464928012,
-            "finishTime": 638596802112439803,
-            "duration": 1647511791,
-            "comments": ""
+            "jobId": "IB20240819160046802", // Unique job identifier 
+            "state": 2, // The job is in progress
+            "failedCount": 0, // Count of objects with errors
+            "successfulCount": 0, // Count of successful objects
+            "skippedCount": 0, // Count of skipped objects
+            "totalCount": 0, // Total count of objects
+            "startTime": 638596800464928012, // Start time of the job
+            "finishTime": 638596802112439803, // Finish time of the job
+            "duration": 1647511791, // Duration of the job
+            "comments": "" // Comments for the job
         },
         {
-            "jobId": "IB20240818160115845",
-            "state": 2,
-            "failedCount": 0,
-            "successfulCount": 0,
-            "skippedCount": 0,
-            "totalCount": 0,
-            "startTime": 638595936755364616,
-            "finishTime": 638595939121323200,
-            "duration": 2365958584,
-            "comments": ""
+            "jobId": "IB20240818160115845", // Unique job identifier
+            "state": 2, // The job is in progress
+            "failedCount": 0, // Count of objects with errors
+            "successfulCount": 0, // Count of successful objects
+            "skippedCount": 0, // Count of skipped objects
+            "totalCount": 0, // Total count of objects
+            "startTime": 638595936755364616, // Start time of the job
+            "finishTime": 638595939121323200, // Finish time of the job
+            "duration": 2365958584, // Duration of the job
+            "comments": "" // Comments for the job
         }
     ],
     //For details on nextLink, see 
-    "nextLink": "pZ5%2FtiSPUEfNBIK13B%2BPG5WyXm4CBVPocjiPTqZQgfxHHh2isXpr6JU4eK3OYIIUBKLwoh3tWeLFiMd5fn1eytgvIE3C5qgYl1XUUiBcpv2BPmBrJlKXxLOtTDHwvlPCA4wGnuqQEhd5E8NDFbYkWDa5QwLB5mIlFJj607ZxAKvQCG7oG1BLYb0bmRUf6Wz%2B%2FMfzvDPjhV%2Fpz%2F7SwHtj034jcRrkiMkJwXWB"
+    "nextLink": "pZ5%2FtiSPUEfNBIK13B%2BPG5WyXm4CBVPocjiPTqZQgfxHHh2isXpr6JU4eK3OYIIUBKLwoh3tWeLFiMd5fn1eytgvIE3C5qgYl1XUUiBcpv2BPmBrJlKXxLOtTDHwvlPCA4wGnuqQEhd5E8NDFbYkWDa5QwLB5mIlFJj607ZxAKvQCG7oG1BLYb0bmRUf6Wz%2B%2FMfzvDPjhV%2Fpz%2F7SwHtj034jcRrkiMkJwXWB" //Link to the next page of results
 }
 ```
diff --git a/docs/docs/toc.yml b/docs/docs/toc.yml
@@ -1,8 +1,8 @@
 - href: Overview.md
 
 - name: Get Started
-  href: "Use AvePoint Graph Modern API.md" 
-- href: "Use Cases.md"
+  href: "Use-AvePoint-Graph-Modern-API.md" 
+- href: "Use-Cases.md"
 - name: Services and Features
   href: "services-and-features/toc.yml"
 
diff --git a/docs/index.md b/docs/index.md
@@ -2,6 +2,8 @@
 _layout: landing
 ---
 
+<div style="margin-left: 20%; margin-right: 20%;">
+
 <h1 style="text-align: center; margin-bottom: 32px;">Welcome to AvePoint Graph API Documentation</h1>
 
 <p style="margin-bottom: 32px;">
@@ -37,11 +39,11 @@ Unlock the full potential of AvePoint Cloud services with our comprehensive API
 
   <div style="border:1px solid #ccc; padding:24px; border-radius:8px; box-shadow:2px 2px 12px #aaa; width: 30%;">
     <h3 style="margin-bottom: 16px;">Use Cases</h3>
-    <ol>
+    <ul>
       <li><b>Secure Data Access and Management</b>: Implement robust authentication to ensure only authorized users can access or modify data, meeting stringent security and compliance standards.</li>
       <li><b>Compliance and Security Audits</b>: Retrieve audit records to facilitate compliance checks and security audits, which will help to identify unauthorized activities and maintain a secure environment.</li>
       <li><b>Streamline Partner Operations</b>: Enhance collaboration and efficiency by managing partner-related workflows through the Elements platform, using the API to integrate and automate processes.</li>
-    </ol>
+    </ul>
     <div style="text-align: right;">
       <a href="./docs/Use%20Cases.md" style="text-decoration:none; color:blue;">See More</a>
     </div>