Retrieve Job Details for Backup Services

Use this API to retrieve your customer's job details for backup services, including Cloud Backup for Microsoft 365, Cloud Backup for Google Workspace, Cloud Backup for IaaS PaaS, Cloud Backup for Dynamics 365, and Cloud Backup for Salesforce.
This API is intended specifically for customers who have subscribed to these services.

Permissions

The following permission is required to call the API.
You must register an app through Elements for Partners > API app registration to authenticate and authorize your access to AvePoint Graph API. For details, refer to App Registration.

API	Permission
/partner/customers/{id}/jobs	partner.jobs.read.all

Request

This section outlines the details on the HTTP method and endpoint used to retrieve your customer's job details for backup services.

Method	Endpoint	Description
GET	/partner/customers/{id}/jobs	Retrieves your customer's job details for backup services.

Query Parameters

This section outlines the parameters required to specify which customer's job details for backup services you want to retrieve.

Parameter	Description	Type	Required
id	The tenant owner ID of the customer.	string	Yes

Responses

If the request has been successfully processed, a 200 OK response will be returned, along with the requested information displayed in the response body.

Response	Description	Type
jobType	The service type of the job.	string
jobModule	The service module of the job.	string
status	The job status.	string
jobId	The job ID.	string
name	The job name.	string
totalCount	The count of the objects that have been processed by the job.	string
failedCount	The count of the failed objects.	string
successfulCount	The count of the successful objects.	string
skippedCount	The count of the skipped objects.	string
warningCount	The count of the warning objects.	string
backupSize	The size of the backed-up objects.	string
startTime	The start time of the job.	string
endTime	The end time of the job.	string
jobDuration	The job duration.	string
lastModifyTime	The last modified time of the job.	string

Request Sample

To use this API, send a GET request to the specified endpoint, including necessary parameters as defined in the references.

https://graph.avepointonlineservices.com/partner/customers/00427fbc-8832-46cf-a1d2-582f46e638/jobs

Response Sample

If the request has been successfully processed, a 200 OK response will be returned, along with the requested information displayed in the response body. For more details on the HTTP status code, refer to HttpStatusCode.

{
    "@odata.context": "https://graph.avepointonlineservices.com/partner/$metadata#Collection(Portal.Api.Model.BackUpJob)",
    "value": [
        {
            "jobType": "Microsoft 365", // The service type of the job
            "jobModule": "SharePoint Online", // The service module of the job
            "status": "Not Finished", // The job status
            "jobId": "N/A", // The job ID
            "name": "N/A", // The job name
            "totalCount": "0", // The count of the objects that have been processed by the job
            "failedCount": "0", // The count of the failed objects
            "successfulCount": "0", // The count of the successful objects
            "skippedCount": "0", // The count of the skipped objects
            "warningCount": "0", // The count of the warning objects
            "backupSize": "0 GB", // The size of the backed-up objects
            "startTime": "N/A", // The start time of the job
            "endTime": "N/A", // The end time of the job
            "jobDuration": "N/A", // The job duration
            "lastModifyTime": "N/A" // The last modified time of the job
        },
        {
            "jobType": "Microsoft 365",
            "jobModule": "Exchange Online",
            "status": "Not Finished",
            "jobId": "N/A",
            "name": "N/A",
            "totalCount": "0",
            "failedCount": "0",
            "successfulCount": "0",
            "skippedCount": "0",
            "warningCount": "0",
            "backupSize": "0 GB",
            "startTime": "N/A",
            "endTime": "N/A",
            "jobDuration": "N/A",
            "lastModifyTime": "N/A"
        }
    ]
}