This is an archive version of the document. To get the most up-to-date information, see the current version.

(GET) /jobs/{ID}/includes

In this article

    Returns a list of VMs and VM containers processed by the job having the specified ID.

    Request

    To get a list of all VMs and VM containers processed by the job, you need to send the GET HTTP request to the URL of the /jobs/{ID}/includes resource.

    HTTP Request

    GET http://<Enterprise-Manager>:9399/api/jobs/{ID}/includes

    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.

    Request Body

    None.

    Query Parameters

    None.

    Response

    The server returns the following response to the client.

    Response Codes

    A successfully completed operation returns response code 200 Success.

    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: application/xml.

    Response Body

    In the response body, Veeam Backup Enterprise Manager returns a representation of the /jobs/{ID}/includes collection resource.

    Example

    A sample request below returns a list of VMs and VM containers processed by the job having ID da4a15c2-04e7-4135-b876-577249d3d720.

    Request:

    GET http://localhost:9399/api/jobs/da4a15c2-04e7-4135-b876-577249d3d720/includes

     

    Request Header:

    X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

     

    Response:

    200 Success

     

    Response Body:

    <ObjectsInJob xmlns="http://www.veeam.com/ent/v1.0">
     <ObjectInJob Type="ObjectInJob" Href="http://localhost:9399/api/jobs/da4a15c2-04e7-4135-b876-577249d3d720/includes/83071dc0-44f2-49b6-b431-1cb79ed66639">
       <Links>
         <Link Rel="Delete" Type="ObjectInJob" Href="http://localhost:9399/api/jobs/da4a15c2-04e7-4135-b876-577249d3d720/includes/83071dc0-44f2-49b6-b431-1cb79ed66639" Name="oracle" />
         <Link Rel="Up" Type="Job" Href="http://localhost:9399/api/jobs/da4a15c2-04e7-4135-b876-577249d3d720?format=Entity" Name="Oracle Backup" />
       </Links>
       <ObjectInJobId>83071dc0-44f2-49b6-b431-1cb79ed66639</ObjectInJobId>
       <HierarchyObjRef>urn:VMware:Vm:ca2f751f-8f26-4f39-815e-ce493b61fd80.20</HierarchyObjRef>
       <Name>oracle</Name>
       <DisplayName>oracle</DisplayName>
       <Order>0</Order>
       <GuestProcessingOptions>
         <VssSnapshotOptions>
           <VssSnapshotMode>RequireSuccess</VssSnapshotMode>
           <IsCopyOnly>false</IsCopyOnly>
         </VssSnapshotOptions>
         <WindowsGuestFSIndexingOptions>
           <FileSystemIndexingMode>ExceptSpecifiedFolders</FileSystemIndexingMode>
           <IncludedIndexingFolders />
           <ExcludedIndexingFolders>
             <Path>%windir%</Path>
             <Path>%ProgramFiles%</Path>
             <Path>%ProgramFiles(x86)%</Path>
             <Path>%ProgramW6432%</Path>
             <Path>%TEMP%</Path>
           </ExcludedIndexingFolders>
         </WindowsGuestFSIndexingOptions>
         <LinuxGuestFSIndexingOptions>
           <FileSystemIndexingMode>ExceptSpecifiedFolders</FileSystemIndexingMode>
           <IncludedIndexingFolders />
           <ExcludedIndexingFolders>
             <Path>/cdrom</Path>
             <Path>/dev</Path>
             <Path>/media</Path>
             <Path>/mnt</Path>
             <Path>/proc</Path>
             <Path>/tmp</Path>
             <Path>/lost+found</Path>
           </ExcludedIndexingFolders>
         </LinuxGuestFSIndexingOptions>
         <SqlBackupOptions>
           <TransactionLogsProcessing>OnlyOnSuccessJob</TransactionLogsProcessing>
           <BackupLogsFrequencyMin>15</BackupLogsFrequencyMin>
           <UseDbBackupRetention>true</UseDbBackupRetention>
           <RetainDays>15</RetainDays>
         </SqlBackupOptions>
         <WindowsCredentialsId>00000000-0000-0000-0000-000000000000</WindowsCredentialsId>
         <LinuxCredentialsId>00000000-0000-0000-0000-000000000000</LinuxCredentialsId>
       </GuestProcessingOptions>
     </ObjectInJob>
    </ObjectsInJob>