Getting Information on Operations by Session ID

You can get information about the operations performed during a backup or backup copy job session with the specified ID.

Request

GET https://<hostname>:4443/v6/JobSessions/{sessionId}/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

sessionId

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

Property

Type

Description

id

string

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

usn

integer

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

title

string

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

creationTime

UTC

Specifies date and time of the operation start.

endTime

UTC

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 returns a resource representation of the operations that were performed during the specified backup job session.

Request:

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

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

{

 "offset": 0,

 "limit": 30,

 "_links": {

   "self": {

     "href": "/v6/JobSessions/d5f34eeb-17cc-48f9-bab0-4fc5cee225b5/LogItems?offset=0&limit=30"

   },

   "next": {

     "href": "/v6/JobSessions/d5f34eeb-17cc-48f9-bab0-4fc5cee225b5/LogItems?offset=30&limit=30"

   }

 },

 "results": [

   {

     "id": "e4d5f4b7-1e4c-4c60-858e-daf9f1e339fe",

     "usn": 1,

     "title": "[Success] Job started at 1/31/2022 5:08:19 PM",

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

     "endTime": "2022-01-31T16:08:19.7539769Z",

     "_links": {

       "self": {

         "href": "/v6/jobsessions/d5f34eeb-17cc-48f9-bab0-4fc5cee225b5/logitems/e4d5f4b7-1e4c-4c60-858e-daf9f1e339fe"

       },

       "jobsessions": {

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

       }

     }

   },

   {

     "id": "5fc92272-270e-4b2f-b63b-5732fb215d8a",

     "usn": 1000,

     "title": "[Success] Found 76 objects",

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

     "endTime": "2022-01-31T16:08:23.9842197Z",

     "_links": {

       "self": {

         "href": "/v6/jobsessions/d5f34eeb-17cc-48f9-bab0-4fc5cee225b5/logitems/5fc92272-270e-4b2f-b63b-5732fb215d8a"

       },

       "jobsessions": {

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

       }

     }

   },

...

],

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

}