Get IBM Storage Protect for Cloud Microsoft 365 Job Information
Gets the job information of IBM Storage Protect for Cloud Microsoft 365.
Examples
var context = PublicApi.GetContext("https://api.sp4c.storage-defender.ibm.com",
"username", "password");
var records = context.CloudBackupService.GetJobs(filter);
Note: For the start time and end time of the time range, use the DateTime struct to represent
an instant in time.
Request Information
Represents the filter that you can use to get IBM Storage Protect for Cloud Microsoft 365 jobs.
| Element | Description | Type | Required |
|---|---|---|---|
| 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 |
| JobType | Sets the job types that you want to get. | Enum Valid values: 0 (for All) 1 (for Backup) 2 (for Restore) 3 (for Export) 4 (for Delete) 5 (for Retention) |
Yes |
| ObjectType | Sets the service type of the jobs to get. |
Enum Valid values: 0 (for All) 1 (for Exchange Online) 2 (for Share Point Online) 3 (for OneDrive for Business) 4 (for Microsoft 365 Groups) 5 (for Project Online) 6 (for Public Folder) 7 (for Teams) |
Yes |
| JobState | Sets the job status |
Enum Valid values: 0 (for All) 1 (for In Progress) 2 (for Finished) 3 (for Failed) 4 (for Finished with Exception) 5 (for Partially Finished) |
Yes |
| PageIndex | Sets the starting number of the page to get the jobs. The default value is 0. | int | Yes |
| PageSize | Sets the number of jobs to display on one page. The default value is 10. | int | Yes |
Response Information
| Element | Description | Type |
|---|---|---|
| TotalCount | The total count of the retrieved jobs | int |
| Jobs | A list of jobs | List |
| Element | Description | Type |
|---|---|---|
| Id | Job ID | String |
| State | Job status | String |
| StartTime | Job started time | long |
| FinishTime | Job finished time | long |
| Duration | Duration | long |
| BackupDetails | Job details | int |
| Element | Description | Type |
|---|---|---|
| TotalCount | Total count | long |
| FailedCount | Number of failed objects | long |
| SuccessfulCount | Number of successful objects | long |
| SkippedCount | Number of skipped objects | long |