This is an archive version of the document. To get the most up-to-date information, see the current version.(GET) /jobs/{ID}/includes/{ID}
Returns a representation of a VM or a VM container having the specified ID and processed by the job having the specified ID.
Request
To get a representation of a VM or a VM container processed by the job, you need to send the GET HTTP request to the URL of the /jobs/{ID}/includes/{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 | String | ID of the VM or VM container processed by the job, for example: e310aa12-eff2-41f4-97c8-631b677fc17f. | True | True |
Name | String | Name of the VM or VM container processed by the job, for example: DC-SRV. | True | True |
Order | Int64 | Order number for processing the VM or VM container by the job. The processing sequence starts with 0. | True | True |
JobUid | URN | ID of the backup or replication job parent to the VM or VM container resource, for example: urn:veeam:Job:da736815-4fea-4c8e-b0e1-5ecdbca1c512. | True | True |
JobName | String | Name of the backup or replication job parent to the VM or VM container resource, for example: DC Backup. | True | True |
BackupServerUid | URN | ID of the Veeam backup server to which the hierarchy root parent for the VM or VM container resource has been added, for example: urn:veeam:BackupServer:15942270-fb56-4dcc-96e9-5f80e4725a15. | True | True |
BackupServerName | String | Name of the Veeam backup server to which the hierarchy root parent for the VM or VM container resource has been added, for example: BACKUPSERVER. | 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 /jobs/{ID}/includes/{ID} resource.
Example
A sample request below returns a resource representation of the VM having ID 83071dc0-44f2-49b6-b431-1cb79ed66639 that is processed by the job having ID da4a15c2-04e7-4135-b876-577249d3d720.
Request: GET https://localhost:9398/api/jobs/da4a15c2-04e7-4135-b876-577249d3d720/includes/83071dc0-44f2-49b6-b431-1cb79ed66639
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 200 OK
Response Body: <ObjectInJob xmlns="http://www.veeam.com/ent/v1.0" Type="ObjectInJob" Href="https://localhost:9398/api/jobs/da4a15c2-04e7-4135-b876-577249d3d720/includes/83071dc0-44f2-49b6-b431-1cb79ed66639"> |
