This is an archive version of the document. To get the most up-to-date information, see the current version.Getting Sessions by Session ID
This section explains how to get a list with properties for the specified session.
Request
GET https://<hostname>/api/v1/jobSessions/{sessionId} |
Request Headers
The request header must contain an authorization token of the current session.
Request Parameters
The following parameters must be posted as URL.
Parameter | Description |
sessionId | The identification number of the session. Can be obtained as described in Getting 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
Property | Type | Description |
|---|---|---|
id | string | Shows the identification number of the session. |
type | string | Shows the type of the session. |
localizedType | string | Shows the type of the session. |
executionStartTime | string | Shows the time when the session started. |
executionStopTime | string | Shows the time when the session stopped. |
executionDuration | string | Shows the duration of the session. |
status | string | Shows the status of the session. |
usn | integer | Shows the version of the backup policy. Used by platform services to detect if a backup policy has been hanged since the last sync. |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
Example
Request: GET https://abc.ukwest.cloudapp.azure.com/api/v1/jobSessions/39
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: { "id": "39", "type": "BackupRetention", "localizedType": "Backup Retention", "executionStartTime": "2020-02-05T11:07:10.002679Z", "executionStopTime": "2020-02-05T11:09:57.775353Z", "executionDuration": "00:02:47.7726740", "status": "Success", "usn": 275, "_links": { "self": {"href": "https://abc.ukwest.cloudapp.azure.com/api/v1/jobSessions/39"}, "log": {"href": "https://abc.ukwest.cloudapp.azure.com/api/v1/jobSessions/39/log"} } } |