Getting Backup Job Session by Job ID

You can get a resource representation of a collection of job sessions created for a backup job with the specified ID.

Request

GET https://<hostname>:4443/v6/Jobs/{jobId}/JobSessions

Request Headers

The request header must contain an authorization token of the current session.

Request Parameters

The following parameter must be specified in the URL of the request:

Parameter

Type

Description

jobId

string

Specifies the identification number of the backup job. For more information on how to get this parameter, see Getting Backup Jobs.

Request Body

None.

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns a response code 200 OK.

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTPS headers.

Header

Description

Content-length

The length of the response body.

Content-type

The media type and syntax of the response body message: application/json; charset=utf-8

Response Body

In the response body, the server returns a resource representation of the /Jobs/{jobId}/JobSessions collection resource. The response body contains the following properties:

Property

Type

Description

results

Results Object

Contains the Results object.

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

Results Object

Property

Type

Description

id

string

Specifies the job session ID.

details

string

Specifies the job session details.

creationTime

UTC

Specifies date and time when the job session was created.

endTime

UTC

Specifies date and time when the latest job session ended.

retryCount

integer

Specifies the order number of the job session retry.

progress

integer

Specifies the number of processed objects during the job session.

status

string

Specifies the status of the backup job. The following values are available:

  • Stopped
  • Running
  • Success
  • Warning
  • Failed
  • Disconnected
  • NotConfigured
  • Queued

statistics

jobStatistics

Specifies the job session statistics.

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

jobStatistics

The job session statistics has the following properties:

Property

Type

Description

processingRateBytesPS

integer

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.

processingRateItemsPS

integer

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.

readRateBytesPS

integer

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

writeRateBytesPS

integer

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

transferredDataBytes

integer

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.

processedObjects

integer

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

bottleneck

string

Specifies the bottleneck in the data transmission process. The following values are available:

  • Source
  • Target
  • Detecting
  • NA

Example

The example returns a resource representation of all job sessions created for a backup job with the ID b7c1cc0b-2b3c-4096-9ba1-2d665b4ae504.

Request:

GET https://abc.tech.local:4443/v6/Jobs/b7c1cc0b-2b3c-4096-9ba1-2d665b4ae504/JobSessions

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

{

 "offset": 0,

 "limit": 30,

 "_links": {

   "self": {

     "href": "/v6/Jobs/b7c1cc0b-2b3c-4096-9ba1-2d665b4ae504/JobSessions?offset=0&limit=30"

   },

   "next": {

     "href": "/v6/Jobs/b7c1cc0b-2b3c-4096-9ba1-2d665b4ae504/JobSessions?offset=30&limit=30"

   }

 },

 "results": [

   {

     "id": "b39e52fd-a835-44f1-ad0b-4d8886533b91",

     "details": "Some objects were processed with warnings",

     "creationTime": "2022-01-31T18:29:17.4040891Z",

     "endTime": "2022-01-31T18:29:35.3931186Z",

     "retryCount": 2,

     "progress": 0,

     "status": "Warning",

     "statistics": {

       "processingRateBytesPS": 32037,

       "processingRateItemsPS": 0,

       "readRateBytesPS": 305570,

       "writeRateBytesPS": 0,

       "transferredDataBytes": 355786,

       "processedObjects": 0,

       "bottleneck": "Target"

     },

     "_links": {

       "self": {

         "href": "/v6/jobsessions/b39e52fd-a835-44f1-ad0b-4d8886533b91"

       },

       "log": {

         "href": "/v6/jobsessions/b39e52fd-a835-44f1-ad0b-4d8886533b91/logitems"

       },

       "job": {

         "href": "/v6/jobs/b7c1cc0b-2b3c-4096-9ba1-2d665b4ae504"

       }

     }

   },

   {

     "id": "50b6c38b-686e-4558-b5bd-990d77a0f7f8",

     "details": "Some objects were processed with warnings",

     "creationTime": "2022-01-31T18:18:55.2604465Z",

     "endTime": "2022-01-31T18:19:17.4797346Z",

     "retryCount": 1,

     "progress": 0,

     "status": "Warning",

     "statistics": {

       "processingRateBytesPS": 33241,

       "processingRateItemsPS": 0,

       "readRateBytesPS": 318317,

       "writeRateBytesPS": 0,

       "transferredDataBytes": 359459,

       "processedObjects": 0,

       "bottleneck": "Target"

     },

     "_links": {

       "self": {

         "href": "/v6/jobsessions/50b6c38b-686e-4558-b5bd-990d77a0f7f8"

       },

       "log": {

         "href": "/v6/jobsessions/50b6c38b-686e-4558-b5bd-990d77a0f7f8/logitems"

       },

       "job": {

         "href": "/v6/jobs/b7c1cc0b-2b3c-4096-9ba1-2d665b4ae504"

       }

     }

   },

...

],

 "setId": "00000000-0000-0000-0000-000000000000"

}