This is an archive version of the document. To get the most up-to-date information, see the current version.(GET) /replicaSessions/{ID}
Returns a resource representation of a replication job session having the specified ID.
Request
To get a job session, you need to send the GET HTTP request to the URL of the /replicaSessions/{ID} resource.
HTTP Request
Request Headers
The request contains the following headers:
Header | Required | Description |
|---|---|---|
X-RestSvcSessionId | True | The request requires authorization. In the header, the client must send a session ID copied from the server reply to the request creating a new logon session. To learn more, see Authentication and Security. |
Accept | False | Identifies the format of the response. Possible values:
If the request does not contain the header, the server will return the response in the XML format. |
Request Body
None.
Query Parameters
The following parameters can be used in queries.
Parameter | Type | Description | Can Be Used for Filtering | Can Be Used for Sorting |
|---|---|---|---|---|
Uid | URN | ID of the replication job session resource, for example: 88b395e2-81ff-439c-558c-188d97274c15. | True | True |
Name | String | Name of the replication job session resource, for example: exch@2013-08-26 22:28:51. | True | True |
JobType | String | Type of the replication job session. Possible values: Replica. | True | True |
JobUid | URN | ID of the replication job parent to the replication job session resource, for example: urn:veeam:Job:dce85686-59c8-42c4-8766-f1c00a5b8067. | True | True |
JobName | String | Name of the replication job parent to the replication job session resource, for example: SQL Replica. | True | True |
CreationTime | DateTime | Date and time when the replication job session was started. The parameter accepts only UTC-formatted DateTime values. | True | True |
EndTime | DateTime | Date and time when the replication job session was ended. The parameter accepts only UTC-formatted DateTime values | True | True |
State | String | State of the replication job session. Possible values:
| True | True |
Result | String | Result of the replication job session. Possible values:
| True | True |
IsRetry | Boolean | Defines whether the replication job session has been retried or not. Possible values:
| True | True |
BackupServerUid | URN | ID of the Veeam backup server parent to the replication job session resource. | True | True |
BackupServerName | String | Name of the Veeam backup server parent to the replication session resource. | True | True |
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns response code 200 OK.
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTP headers.
Header | Description |
|---|---|
Content-length | The length of the response body. |
Content-type | The media type and syntax of the request body message. Possible values:
|
Response Body
In the response body, Veeam Backup Enterprise Manager returns a representation of the /replicaSessions/{ID} resource.
Example
A sample request below returns an entity representation of the replica job session resource having ID 0bcf5a1e-866c-4b40-8bc3-ce64753b9a6b.
Request: GET https://localhost:9398/api/replicaSessions/0bcf5a1e-866c-4b40-8bc3-ce64753b9a6b?format=Entity
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 200 OK
Response Body: <ReplicaJobSession xmlns="http://www.veeam.com/ent/v1.0" Type="ReplicaJobSession" Href="https://localhost:9398/api/replicaSessions/0bcf5a1e-866c-4b40-8bc3-ce64753b9a6b?format=Entity" Name="Fileserver02 Replication@2014-10-19 06:46:31" UID="urn:veeam:ReplicaJobSession:0bcf5a1e-866c-4b40-8bc3-ce64753b9a6b"> |
