Table of Contents

Retrieve Job Information

Use this API to retrieve the job-related information (/dynamicsbackup/jobs navigation property) from Cloud Backup for Dynamics 365. By invoking the /dynamicsbackup/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 registrations to authenticate and authorize your access to AvePoint Graph API. For details, refer to Authentication and Authorization.

API Permission
/dynamicsbackup/jobs Dynamics.ReadWrite.All

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 users to specify pagination, job types, time ranges, and other criteria to filter the results effectively.

Parameter Description Type Required?
pageIndex Sets the starting number of the page to get the jobs. The default value is 1. integer No
pageSize Sets the number of jobs to display on one page. The default value is 10. integer No
type Sets the job types that you want to get.
Valid values:
  • 0 for all.
  • 1 for backup.
  • 2 for restore.
  • 4 for Dryrun
  • 8 for Retention
  • 16 for AuditBackup
  • 32 for Export
 Enum Yes
startTime Sets a start time (UTC time) for the time range in ISO 8601 format. string Yes
finishTime Sets an end time (UTC time) for the time range in ISO 8601 format. string Yes
status Sets the job status.
  • 2 for In progress
  • 3 for Finished
  • 4 for Failed
  • 7 for Finished with Exception
    		 Enum No
    organizationId Sets the organization that you want to get. GUID No

    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
    totalCount Total number of jobs matching the query parameters. integer
    jobs A list containing job objects with detailed information. list
    nextLink Reference to the next page of results string

    Job details

    Each job retrieved through the API includes detailed attributes that provide insight into its execution and outcome. These attributes help in assessing the performance, status, and specifics of each job, enabling effective management and analysis.

    Elements Description Type
    module The module associated with the job. string
    type The type of job performed.
    • 0 for all.
    • 1 for backup.
    • 2 for restore.
    • 4 for Dryrun
    • 8 for Retention
    • 16 for AuditBackup
    • 32 for Export
    		 enum
    jobId Unique identifier for the job. string
    startTime The start time of the job in ISO 8601 format. string
    finishTime The end time of the job in ISO 8601 format. string
    durationHours Duration of the job in hours. double
    status Status of the job.
    • 2 for In progress
    • 3 for Finished
    • 4 for Failed
    • 7 for Finished with Exception
      		 enum
      successfulEntity Number of entities successfully processed. integer
      failedEntity Number of entities with errors. integer
      skippedEntity Number of entities skipped during processing. integer
      warningEntity Number of entities with warnings. integer
      totalEntity Total number of entities involved in the job. integer
      successfulRecord Number of records successfully processed. integer
      failedRecord Number of records with errors. integer
      skippedRecord Number of records skipped during processing. integer
      warningRecord Number of records with warnings. integer
      totalRecord Total number of records involved in the job. integer
      backupSize Size of the backup created during the job. long
      organizationId GUID of the organization associated with the job. GUID
      organizationName Name of the organization associated with the job. string

      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. The following request is an API call to the Insights for Microsoft 365 environment in the US - East region.

      https://graph-us.avepointonlineservices.com/dynamicsbackup/jobs?pageIndex=1&pageSize=5&startTime=2021-05-22T11:42:00Z&finishTime=2024-09-22T11:42:00Z&type=1&status=3&organizationId=69cb1ecc-f8e8-439b-8077-a4b7fd45e87f

      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 HttpStatusCode.

      {
    "totalCount": 20, // Total number of jobs.
    "nextLink": "/jobs?pageIndex=2&pageSize=5&startTime=2021-05-22T11:42:00Z&finishTime=2024-09-22T11:42:00Z&type=1&status=3&organizationId=6cccccc-ffff-bbb-88888-aabbccdeee", //
    "jobs": [
        {
            "module": "Customer Engagement", //Service type.
            "type": 1, //Job type.
            "jobId": "DCIB2022081903124382222110", //Unique job ID.
            "startTime": "2022-08-19T03:12:43.823Z", //The start time of the job.
            "finishTime": "2022-08-19T03:13:46.633Z", //The finish time of the job.
            "durationHours": 0.01744722222222222, //The job duration in hours.
            "status": 3, //Job status.
            "successfulEntity": 1, //Number of successful entities.
            "failedEntity": 0, //Number of entities with errors.
            "skippedEntity": 0, //Number of skipped entities.
            "warningEntity": 0, //Number of warning entities. 
            "totalEntity": 1, //Total number of entities. 
            "successfulRecord": 1, //Number of successful records.
            "failedRecord": 0, //Number of records with errors.
            "skippedRecord": 0, //Number of skipped records.
            "warningRecord": 0, //Number of warning records.
            "totalRecord": 1, //Total number of records.
            "backupSize": 180832, //The backup data size in bytes.
            "organizationId": "6cccccc-ffff-bbb-88888-aabbccdeee",// Organization GUID
            "organizationName": "uatorg123"// Name of the organization
        },
        {
            "module": "Customer Engagement",
            "type": 1,
            "jobId": "DCIB2022081810345391848112",
            "startTime": "2022-08-18T10:34:53.92Z",
            "finishTime": "2022-08-18T10:36:01.603Z",
            "durationHours": 0.018800833333333333,
            "status": 3,
            "successfulEntity": 1,
            "failedEntity": 0,
            "skippedEntity": 0,
            "warningEntity": 0,
            "totalEntity": 1,
            "successfulRecord": 2,
            "failedRecord": 0,
            "skippedRecord": 0,
            "warningRecord": 0,
            "totalRecord": 2,
            "backupSize": 185440,
            "organizationId": "6cccccc-ffff-bbb-88888-aabbccdeee",
            "organizationName": "uatorg123"
        },  
        {
            "module": "Customer Engagement",
            "type": 1,
            "jobId": "DCIB2022081810345391848112",
            "startTime": "2022-08-18T10:34:53.92Z",
            "finishTime": "2022-08-18T10:36:01.603Z",
            "durationHours": 0.018800833333333333,
            "status": 3,
            "successfulEntity": 1,
            "failedEntity": 0,
            "skippedEntity": 0,
            "warningEntity": 0,
            "totalEntity": 1,
            "successfulRecord": 2,
            "failedRecord": 0,
            "skippedRecord": 0,
            "warningRecord": 0,
            "totalRecord": 2,
            "backupSize": 185440,
            "organizationId": "6cccccc-ffff-bbb-88888-aabbccdeee",
            "organizationName": "uatorg123"
        },
        {
            "module": "Customer Engagement",
            "type": 1,
            "jobId": "DCIB2022081810345391848112",
            "startTime": "2022-08-18T10:34:53.92Z",
            "finishTime": "2022-08-18T10:36:01.603Z",
            "durationHours": 0.018800833333333333,
            "status": 3,
            "successfulEntity": 1,
            "failedEntity": 0,
            "skippedEntity": 0,
            "warningEntity": 0,
            "totalEntity": 1,
            "successfulRecord": 2,
            "failedRecord": 0,
            "skippedRecord": 0,
            "warningRecord": 0,
            "totalRecord": 2,
            "backupSize": 185440,
            "organizationId": "6cccccc-ffff-bbb-88888-aabbccdeee",
            "organizationName": "uatorg123"
        },
        {
            "module": "Customer Engagement",
            "type": 1,
            "jobId": "DCIB2022081810345391848112",
            "startTime": "2022-08-18T10:34:53.92Z",
            "finishTime": "2022-08-18T10:36:01.603Z",
            "durationHours": 0.018800833333333333,
            "status": 3,
            "successfulEntity": 1,
            "failedEntity": 0,
            "skippedEntity": 0,
            "warningEntity": 0,
            "totalEntity": 1,
            "successfulRecord": 2,
            "failedRecord": 0,
            "skippedRecord": 0,
            "warningRecord": 0,
            "totalRecord": 2,
            "backupSize": 185440,
            "organizationId": "6cccccc-ffff-bbb-88888-aabbccdeee",
            "organizationName": "uatorg123"
        },
    ],
    "pageIndex": 1, //Page number.
    "pageSize": 5 //Number of jobs per page.
}