This is an archive version of the document. To get the most up-to-date information, see the current version.

/Jobs/{id}/JobSessions

In this article

    Represents job sessions created for a backup job with a specified ID.

    Resource URL

    The URL of the reference resource representation:

    https://<Backup-Office365>:4443/v3/Jobs/{id}/JobSessions

    Related Resources

    Methods

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

    Properties

    The /Jobs/{id}/JobSessions 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
    RateBytesPS

    string

    Specifies the average speed of data processing. This counter is a ratio between the amount of data that has actually been read and job duration. The value is given in bytes per second.

    For example, "processingRateBytesPS": 1683256".

    Processing
    RateItemsPS

    string

    Specifies the average speed of data processing. This counter is a ratio between the amount of data that has actually been read and job duration. The value is given in items per second.

    For example, "processingRateItemsPS": 20.

    ReadRateBytesPS

    string

    Specifies the average speed of reading data from the backup repository. The value is given in bytes per second.

    For example, "readRateBytesPS": 5383429.

    WriteRateBytesPS

    string

    Specifies the average speed of writing data to the backup repository. The value is given in bytes per second.

    For example, "writeRateBytesPS": 26015396.

    Transferred
    DataBytesPS

    string

    Specifies the amount of data transferred from the source-side to the target-side after applying compression and deduplication. The value is given in bytes per second.

    For example, "transferredDataBytes": 98142970.

    BottleNeck

    string

    Specifies the bottleneck in the data transmission process:

    • Source
    • Target
    • Detecting
    • N/A

    For example, "bottleneck": "Source".

    Resource Representation

    The /Jobs/{id}/JobSessions resource has the following representation:

    [

     {

       "id": "a8cf9a63-64c3-4748-9c95-b1fbac0cce1d",

       "creationTime": "2019-02-04T16:49:22.8529769Z",

       "endTime": "2019-02-04T16:50:21.3024288Z",

       "progress": 1,

       "status": "Success",

       "statistics": {

         "processingRateBytesPS": 1683256,

         "processingRateItemsPS": 20,

         "readRateBytesPS": 5383429,

         "writeRateBytesPS": 26015396,

         "transferredDataBytes": 98142970,

         "processedObjects": 1193,

         "bottleneck": "Source"

       },

       "_links": {

         "self": {

           "href": "https://support.east.local:4443/v3/jobsessions/a8cf9a63-64c3-4748-9c95-b1fbac0cce1d"

         },

         "log": {

           "href": "https://support.east.local:4443/v3/jobsessions/a8cf9a63-64c3-4748-9c95-b1fbac0cce1d/log"

         },

         "job": {

           "href": "https://support.east.local:4443/v3/jobs/b20cedd4-66b2-49b1-86de-a575dc67e83b"

         }

       }

     },

    ...]

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.