Help Center
Choose product document...
Veeam Backup for Microsoft Office 365
RESTful API Reference

/JobSessions/{ID}

Represents a job session with the specified ID.

Resource URL

The URL of the reference resource representation:

https://<Backup-Office365>:<Port>/v1/JobSessions/{ID}

Related Resources

Methods

The following methods are supported for the /JobSessions/{ID} resource:

(GET) /JobSessions/{ID}

Properties

The /JobSessions/{ID} resource has the following properties:

Property

Type

Description

Id

string

Specifies the ID of the job session.

For example, "Id": "be376069-2865-4156-a9bc-825cef7d687e".

Creation
Time

UTC

Specifies date and time when the job session was created.

For example, "creationTime": "2017-04-04T00:07:21.3994255-07:00".

EndTime

UTC

Specifies date and time when the latest job session ended.

For example, "endTime": "2017-04-04T00:11:36.9857918-07:00".

Progress

int

Specifies the number of processed mailboxes during the job session.

For example, "progress": "2".

Status

string

Specifies the status of the backup job:

  • Failed
  • Running
  • Stopped
  • Success
  • Warning

For example, "status": "success".

Statistics

JobStatistics

Specifies the job session statistics.

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

JobStatistics

Specifies the following job session statistics:

Property

Type

Description

Processing
Rate

string

Specifies the average speed of mailbox item processing. This counter is a ratio between the amount of data that has actually been read and job duration.

For example, "processingRate": "99.1 KB/s (6 items/s)".

ReadRate

string

Specifies the average speed of reading data from the backup repository.

For example, "readRate": "1.0 MB/s".

WriteRate

string

Specifies the average speed of writing data to the backup repository.

For example, "writeRate": "20.8 MB/s".

Transferred
Data

string

Specifies the amount of data transferred from the source-side to the target-side after applying compression and deduplication.

For example, "transferredData": "12345 B".

Processed
Objects

int

Specifies the number of mailbox items processed by the backup job.

For example, "processedObjects": 1655.

BottleNeck

string

Specifies the bottleneck in the data transmission process:

  • Source
  • Target
  • Detecting
  • N/A

For example, "bottleneck": "Source".

Resource Representation

The /JobSessions/{ID} resource has the following representation:

 {

   "id": "be376069-2865-4156-a9bc-825cef7d687e",

   "creationTime": "2017-04-04T00:07:21.3994255-07:00",

   "endTime": "2017-04-04T00:11:36.9857918-07:00",

   "progress": 3,

   "status": "Success",

   "statistics": {

     "processingRate": "99.1 KB/s (6 items/s)",

     "readRate": "1.0 MB/s",

     "writeRate": "20.8 MB/s",

     "transferredData": "12345 B",

     "processedObjects": 1655,

     "bottleneck": "Source"

   },

   "_links": {

     "self": {

       "href": "https://support.east.local:4443/v1/JobSessions/be376069-2865-4156-a9bc-825cef7d687e"

     },

     "log": {

       "href": "https://support.east.local:4443/v1/JobSessions/be376069-2865-4156-a9bc-825cef7d687e/log"

     },

     "job": {

       "href": "https://support.east.local:4443/v1/Jobs/00b96531-1a68-4c90-a398-91141ffedb3b"

     }

   }

 }

Related Topics

Viewing Job Statistics

Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference