update cloud api document

AvePoint · Oct 14, 2024 · f31fde8 · f31fde8
1 parent 655cc3a
commit f31fde8
Show file tree

Hide file tree

Showing 6 changed files with 78 additions and 43 deletions.
diff --git a/docs/docs/Use AvePoint Graph Modern API.md b/docs/docs/Use AvePoint Graph Modern API.md
@@ -13,7 +13,7 @@ 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 Partner guide](https://cdn.avepoint.com/assets/apelements-webhelp/avepoint-elements-for-partners/index.htm#!Documents/appregistration.htm).
+> 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/services-and-features/aos/aos.md b/docs/docs/services-and-features/aos/aos.md
@@ -1,11 +1,11 @@
 # Retrieve Audit Records
 
-AvePoint Online Services provides the `/aos/audit` API to retrieve audit records for activities within your AOS tenant. This section outlines the necessary permissions, available methods, and models used for interacting with the API.  
+Retrieve audit records (`/aos/audit` navigation property) for activities within your AOS tenant. This article outlines the necessary permissions, available methods, and models used for interacting with the API.  
 
 ## Permissions
 
 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](/docs/docs/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/Use%20AvePoint%20Graph%20Modern%20API.md/#authentication-and-authorization)
 
 | API   | Permission required | Permission type |
 |-------------------|---------------|----------------------|

diff --git a/docs/docs/services-and-features/d365/d365.md b/docs/docs/services-and-features/d365/d365.md
@@ -5,80 +5,115 @@ Get the job-related information (`/dynamicsbackup/jobs` navigation property) fro
 ## 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](/docs/docs/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/Use%20AvePoint%20Graph%20Modern%20API.md/#authentication-and-authorization)
 
 | API    | Permission required | Permission type |
 |-------------------|---------------|----------------------|
 | `/dynamicsbackup/jobs` | Dynamics.ReadWrite.All | Application       |
 
-## API Method
+## Request
+
+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.  
 
 | Method | Endpoint | Description |
 | --- | --- | --- |
 | GET | `/dynamicsbackup/jobs` | Retrieves comprehensive job information. |
 
 ## Query Parameters
 
+The API supports several query parameters to refine and customize the data retrieval process. These parameters allow uses to specify pagination, job types, time ranges, and other criteria to filter the results effectively.  
+
 |Elements|Description | Type|Required?|
 |---|---|---|---|
 |pageIndex|Sets the starting number of the page to get the jobs. The default value is 1.|int|Yes|
 |pageSize|Sets the number of jobs to display on one page. The default value is 10.|int|Yes|
-|type|Sets the job types that you want to get.<br> Valid values:<br> <ul><li> 0 for all.</li><li> 1 for backup. </li><li> 2 for restore. </li><li>4 for Dryrun</li><li>8 for Retention</li><li>16 for AuditBackup</li><li>32 for Export</li></ul>|Enum  |Yes|
+|type|Sets the job types that you want to get.<br> Valid values:<br> <ul><li> **0** for all.</li><li> **1** for backup. </li><li> **2** for restore. </li><li>**4** for Dryrun</li><li>**8** for Retention</li><li>16 for AuditBackup</li><li>**32** for Export</li></ul>|Enum  |Yes|
 |startTime|Sets a start time (UTC time) for the time range.|long|Yes|
 |finishTime|Sets an end time (UTC time) for the time range.|long|Yes|
 |status| Sets the job status.<ul><li> **2** for In progress</li><li> **3** for Finished</li><li>**4** for Failed </li><li>**7** for Finished with Exception</li><ul>|Enum |Yes|  
 |organizationId|Sets the organization that you want to get.|GUID|Yes|
 <!-- |objectType|Sets the module type of the jobs to get.|Enum|Yes| -->
 
-## Request Example
+## Request Sample
 
 The following request structure is designed to query a collection of jobs with flexible parameters, allowing you to refine your search based on various criteria. This request supports pagination and filtering to efficiently manage and retrieve job data.  
 
 ```ts
 {
-  pageIndex?: integer
-  pageSize?: integer
-  type?: enum[0, 1, 2, 4, 8, 16]
-  startTime?: string
-  endTime?: string
-  status?: integer
-  organizationId?: string
+  "pageIndex": 1,  // Starting page number
+  "pageSize": 10,  // Number of jobs per page
+  "type": 0,  // Job type: 0 for all
+  "startTime": "2023-10-01T00:00:00Z",  // Start time in ISO 8601 format
+  "endTime": "2023-10-31T23:59:59Z",  // End time in ISO 8601 format
+  "status": 2,  // Status: 2 for In progress
+  "organizationId": "123e4567-e89b-12d3-a456-426614174000"  // Organization GUID
 }
+
 ```
 
-## Response Example
+## Response
+
+The API response provides detailed information about the jobs retrieved. Each job in the response includes various attributes that describe its properties and status.
+
+| Elements           | Description                                                           | Type   | Required? |
+|--------------------|-----------------------------------------------------------------------|--------|-----------|
+| totalNumber        | Total number of jobs matching the query parameters.                   | int    | Yes       |
+| result             | A list containing job objects with detailed information.              | Array  | Yes       |
+| module             | The module associated with the job.                                   | string | Yes       |
+| type               | The type of job performed.                                            | string | Yes       |
+| jobId              | Unique identifier for the job.                                        | string | Yes       |
+| startTime          | The start time of the job in ISO 8601 format.                         | string | No        |
+| finishTime         | The end time of the job in ISO 8601 format.                           | string | No        |
+| durationHours      | Duration of the job in hours.                                         | double | No        |
+| status             | Status of the job.                                            | string | Yes       |
+| successfulEntity   | Number of entities successfully processed.                            | int    | Yes       |
+| failedEntity       | Number of entities with errors.                            | int    | Yes       |
+| skippedEntity      | Number of entities skipped during processing.                         | int    | Yes       |
+| warningEntity      | Number of entities with warnings.                                     | int    | Yes       |
+| totalEntity        | Total number of entities involved in the job.                         | int    | Yes       |
+| successfulRecord   | Number of records successfully processed.                             | int    | Yes       |
+| failedRecord       | Number of records with errors.                             | int    | Yes       |
+| skippedRecord      | Number of records skipped during processing.                          | int    | Yes       |
+| warningRecord      | Number of records with warnings.                                      | int    | Yes       |
+| totalRecord        | Total number of records involved in the job.                          | int    | Yes       |
+| backupSize         | Size of the backup created during the job, if applicable.             | long   | Yes       |
+| organizationId     | GUID of the organization associated with the job.                     | guid   | Yes       |
+| organizationName   | Name of the organization associated with the job.                     | string | Yes       |
+
+## Response Sample
 
 If successful, this method returns a 200 OK response code and a collection of  jobs in the response body.  
-For details on the HTTP status code, refer to [HTTP Status Code](/docs/docs/Use%20AvePoint%20Graph%20Modern%20API.md/#http-status-code).  
+For details on the HTTP status code, refer to [HTTP Status Code](/docs/Use%20AvePoint%20Graph%20Modern%20API.md/#http-status-code).  
 
 ```ts
 {
-  totalNumber: integer
-  result: [
+  "totalNumber": 100,  // Total number of jobs
+  "result": [
     {
-      module: string
-      type: string
-      jobId: string
-      startTime?: string
-      finishTime?: string
-      durationHours?: double
-      status: string
-      successfulEntity: integer
-      failedEntity: integer
-      skippedEntity: integer
-      warningEntity: integer
-      totalEntity: integer
-      successfulRecord: integer
-      failedRecord: integer
-      skippedRecord: integer
-      warningRecord: integer
-      totalRecord: integer
-      backupSize: long
-      organizationId: guid
-      organizationName: string
+      "module": "Backup",  // Module type
+      "type": "Full",  // Job type
+      "jobId": "job-123456",  // Unique job identifier
+      "startTime": "2023-10-01T14:30:00Z",  // Start time in ISO 8601 format
+      "finishTime": "2023-10-01T15:30:00Z",  // Finish time in ISO 8601 format
+      "durationHours": 1.0,  // Duration in hours
+      "status": "Finished",  // Job status
+      "successfulEntity": 50,  // Number of successfully processed entities
+      "failedEntity": 0,  // Number of entities that failed to process
+      "skippedEntity": 0,  // Number of entities skipped
+      "warningEntity": 0,  // Number of entities with warnings
+      "totalEntity": 50,  // Total entities involved
+      "successfulRecord": 1000,  // Number of successful records
+      "failedRecord": 0,  // Number of records that failed
+      "skippedRecord": 0,  // Number of records skipped
+      "warningRecord": 0,  // Number of records with warnings
+      "totalRecord": 1000,  // Total records processed
+      "backupSize": 2048000,  // Size of the backup in bytes
+      "organizationId": "123e4567-e89b-12d3-a456-426614174000",  // Organization GUID
+      "organizationName": "Example Organization"  // Name of the organization
     }
   ]
 }
+
 ```
 
 <!-- ### Responses

diff --git a/docs/docs/services-and-features/elements/customers/all-customers.md b/docs/docs/services-and-features/elements/customers/all-customers.md
@@ -31,7 +31,6 @@ If the request has been successfully processed, a 200 OK response will be return
 | JobStatus | The status of the customer’s tenant. | String |
 | CountryOrRegion | The country or region name of the customer. | String |
 
-## Response Example  
+## Response Sample  
 
 This section provides an example of the response you can expect when the API request is successfully processed.  
-
diff --git a/docs/docs/services-and-features/elements/index.md b/docs/docs/services-and-features/elements/index.md
@@ -22,6 +22,7 @@ Built on a foundation of security and scalability, the Elements APIs ensure that
 
 - **Real-Time Responses**: Gain instant access to the data you need with efficient, real-time API responses, ensuring timely insights and actions.
 
-## Get Started Now!
+## Get Started Now! 
+
+Harness the power of Elements APIs to drive your business forward. With our cutting-edge technology and expert support, you'll transform the way you manage customers, ensuring seamless monitoring of backup protection and precise tracking of subscription usage. Detect and adapt to Auto Discovery scan changes with unparalleled efficiency. Our comprehensive resources, including in-depth documentation, coupled with expert support, provide everything you need to embark on a successful integration journey today.  
 
-Harness the power of Elements APIs to drive your business forward. With our cutting-edge technology and expert support, you'll transform the way you manage cloud services. Access detailed documentation, tutorials, and support to begin your integration journey today.
diff --git a/docs/learntemplate/public/main.css b/docs/learntemplate/public/main.css
@@ -3,7 +3,7 @@
     padding: 0;
     margin-right: 20px;
   }
-  .navbar-brand #logo {
+.navbar-brand #logo {
     margin-right: 10px;
     width: 30px;
   }