Getting Job Session by Session ID

In this article

You can get a resource representation of a job session with the specified ID.

Request

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

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
jobSessionsId	string	Specifies the identification number of the job session. For more information on how to get this parameter, see Getting Job Sessions.

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 /JobSessions/{jobSessionsId} resource. The response body contains the following properties:

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 or backup copy 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 the job session with the ID d5f34eeb-17cc-48f9-bab0-4fc5cee225b5.

Request:

GET https://abc.tech.local:4443/v6/JobSessions/d5f34eeb-17cc-48f9-bab0-4fc5cee225b5

Request Header:

Authorization: Bearer <Access-Token>

Response:

200 OK

Response Body:

{

"id": "d5f34eeb-17cc-48f9-bab0-4fc5cee225b5",

"details": "Transferred: 36.1 KB (6 items) at 2.4 KB/s (0 items/s)",

"creationTime": "2022-01-31T16:08:19.6369789Z",

"endTime": "2022-01-31T16:11:55.7263477Z",

"retryCount": 0,

"progress": 76,

"status": "Success",

"statistics": {

"processingRateBytesPS": 2484,

"processingRateItemsPS": 0,

"readRateBytesPS": 0,

"writeRateBytesPS": 17,

"transferredDataBytes": 36924,

"processedObjects": 6,

"bottleneck": "Source"

"_links": {

"self": {

"href": "v6/jobsessions/d5f34eeb-17cc-48f9-bab0-4fc5cee225b5"

"log": {

"href": "v6/jobsessions/d5f34eeb-17cc-48f9-bab0-4fc5cee225b5/logitems"

"job": {

"href": "v6/jobs/1f6f7c97-0df4-4866-8c37-309fda301894"

}