Getting Information on Operations by Session ID

This section explains how to get information about the operations performed during the backup job session.

Request

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

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

An identification number of the backup session.

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/{sessionId}/LogItems resource.

Property

Type

Description

offset

integer

Shows the offset value.

limit

integer

Shows the limit of records to be displayed on the page.

id

string

Specifies the ID of the operation performed during the backup job.

usn

integer

Specifies the order number of the operation performed during the backup job.

title

string

Specifies status and short description of the operation performed during the backup job.

creationTime

UTC

Specifies date and time of the operation start.

endTime

string

Specifies date and time of the operation end.

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

Example

The example below returns a resource representation of the operations that were performed during the backup job run.

Request:

GET https://abc.tech.local:4443/v5/JobSessions/be376069-2865-4156-a9bc-825cef7d687e/LogItems

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

{

 "offset": 0,

 "limit": 30,

 "results": [

   {

     "id": "6e61733d-738b-41e1-bd0d-d0b3340159d5",

     "usn": 1,

     "title": "[Success] Job started at 2/26/2021 1:00:00 AM",

     "creationTime": "2021-02-26T01:00:00.1732347+03:00",

     "endTime": "2021-02-26T01:00:00.1732347+03:00",

     "_links": {

       "self": {

         "href": "https://172.28.1.46:4443/v5/jobsessions/859277ed-b238-458c-9dec-2830e45e15fc/logitems/6e61733d-738b-41e1-bd0d-d0b3340159d5"

       },

       "jobsessions": {

         "href": "https://172.28.1.46:4443/v5/jobsessions/859277ed-b238-458c-9dec-2830e45e15fc"

       }

     }

   },

   {

     "id": "b48ebd60-abb9-4427-8d58-c01237a812a0",

     "usn": 2,

     "title": "[Success] Connected to organization",

     "creationTime": "2021-02-26T01:00:01.7353734+03:00",

     "endTime": "2021-02-26T01:00:02.4253569+03:00",

     "_links": {

       "self": {

         "href": "https://172.28.1.46:4443/v5/jobsessions/859277ed-b238-458c-9dec-2830e45e15fc/logitems/b48ebd60-abb9-4427-8d58-c01237a812a0"

       },

       "jobsessions": {

         "href": "https://172.28.1.46:4443/v5/jobsessions/859277ed-b238-458c-9dec-2830e45e15fc"

       }

     }

   },

   ..]

I want to report a typo

There is a misspelling right here:

 

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