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

/jobs/{ID}

Represents a job having the specified ID.

Resource URL

The URL of the reference resource representation:

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

The URL of the entity resource representation:

http://<Enterprise-Manager>:9399/api/jobs/{ID}?format=Entity

Related Resources

Methods

The following methods are supported for the /jobs/{ID} resource:

Resource Representation

The /jobs/{ID} resource has a resource representation of the following types.

Entity reference resource representation:

Entity resource representation:

<Job xmlns="http://www.veeam.com/ent/v1.0" Type="Job" Href="http://localhost:9399/api/jobs/da4a15c2-04e7-4135-b876-577249d3d720?format=Entity" Name="Oracle Backup" UID="urn:veeam:Job:da4a15c2-04e7-4135-b876-577249d3d720">
<Links>
<Link Rel="Up" Type="BackupServerReference" Href="http://localhost:9399/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018" Name="srv02.veeam.local" />
<Link Rel="Alternate" Type="JobReference" Href="http://localhost:9399/api/jobs/da4a15c2-04e7-4135-b876-577249d3d720" Name="Oracle Backup" />
<Link Rel="Down" Type="BackupJobSessionReferenceList" Href="http://localhost:9399/api/jobs/da4a15c2-04e7-4135-b876-577249d3d720/backupSessions" />
<Link Rel="Down" Type="ObjectInJobList" Href="http://localhost:9399/api/jobs/da4a15c2-04e7-4135-b876-577249d3d720/includes" />
<Link Rel="Edit" Type="JobReference" Href="http://localhost:9399/api/jobs/da4a15c2-04e7-4135-b876-577249d3d720" Name="Oracle Backup" />
<Link Rel="Create" Type="ObjectInJob" Href="http://localhost:9399/api/jobs/da4a15c2-04e7-4135-b876-577249d3d720/includes" />
<Link Rel="Start" Href="http://localhost:9399/api/jobs/da4a15c2-04e7-4135-b876-577249d3d720?action=start" />
<Link Rel="Stop" Href="http://localhost:9399/api/jobs/da4a15c2-04e7-4135-b876-577249d3d720?action=stop" />
<Link Rel="Retry" Href="http://localhost:9399/api/jobs/da4a15c2-04e7-4135-b876-577249d3d720?action=retry" />
<Link Rel="Clone" Href="http://localhost:9399/api/jobs/da4a15c2-04e7-4135-b876-577249d3d720?action=clone" />
<Link Rel="ToggleScheduleEnabled" Href="http://localhost:9399/api/jobs/da4a15c2-04e7-4135-b876-577249d3d720?action=toggleScheduleEnabled" />
</Links>
<JobType>Backup</JobType>
<Platform>VMware</Platform>
<Description>Created by SRV02\Administrator at 10/9/2014 12:05 AM.</Description>
<ScheduleConfigured>false</ScheduleConfigured>
<ScheduleEnabled>true</ScheduleEnabled>
<JobScheduleOptions>
<RetryOptions>
<RetryTimes>3</RetryTimes>
<RetryTimeout>10</RetryTimeout>
<RetrySpecified>true</RetrySpecified>
</RetryOptions>
<WaitForBackupCompletion>true</WaitForBackupCompletion>
<BackupCompetitionWaitingPeriodMin>180</BackupCompetitionWaitingPeriodMin>
<OptionsDaily Enabled="true">
<Kind>Everyday</Kind>
<Days>Sunday</Days>
<Days>Monday</Days>
<Days>Tuesday</Days>
<Days>Wednesday</Days>
<Days>Thursday</Days>
<Days>Friday</Days>
<Days>Saturday</Days>
<Time>22:00:00.0000000-07:00</Time>
</OptionsDaily>
<OptionsMonthly Enabled="false">
<Time>22:00:00.0000000-07:00</Time>
<DayNumberInMonth>Fourth</DayNumberInMonth>
<DayOfWeek>Saturday</DayOfWeek>
<Months>January</Months>
<Months>February</Months>
<Months>March</Months>
<Months>April</Months>
<Months>May</Months>
<Months>June</Months>
<Months>July</Months>
<Months>August</Months>
<Months>September</Months>
<Months>October</Months>
<Months>November</Months>
<Months>December</Months>
</OptionsMonthly>
<OptionsPeriodically Enabled="false">
<Kind>Hours</Kind>
<FullPeriod>1</FullPeriod>
<Schedule>
<Day Name="Sunday">1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1</Day>
<Day Name="Monday">1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1</Day>
<Day Name="Tuesday">1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1</Day>
<Day Name="Wednesday">1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1</Day>
<Day Name="Thursday">1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1</Day>
<Day Name="Friday">1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1</Day>
<Day Name="Saturday">1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1</Day>
</Schedule>
</OptionsPeriodically>
<OptionsContinuous Enabled="false" />
<OptionsBackupWindow Enabled="false">
<TimePeriods>
<Day Name="Sunday">1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1</Day>
<Day Name="Monday">1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1</Day>
<Day Name="Tuesday">1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1</Day>
<Day Name="Wednesday">1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1</Day>
<Day Name="Thursday">1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1</Day>
<Day Name="Friday">1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1</Day>
<Day Name="Saturday">1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1</Day>
</TimePeriods>
</OptionsBackupWindow>
<OptionsDaisyChaining Enabled="false">
<PreviousJobUid />
</OptionsDaisyChaining>
</JobScheduleOptions>
<JobInfo>
<BackupJobInfo>
<Includes>
<ObjectInJob Type="ObjectInJob" Href="http://localhost:9399/api/jobs/da4a15c2-04e7-4135-b876-577249d3d720/includes/83071dc0-44f2-49b6-b431-1cb79ed66639">
<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>
</Includes>
<GuestProcessingOptions>
<VssSnapshotOptions>
<VssSnapshotMode>Disabled</VssSnapshotMode>
<IsCopyOnly>false</IsCopyOnly>
</VssSnapshotOptions>
<WindowsGuestFSIndexingOptions>
<FileSystemIndexingMode>Disabled</FileSystemIndexingMode>
<IncludedIndexingFolders />
<ExcludedIndexingFolders />
</WindowsGuestFSIndexingOptions>
<LinuxGuestFSIndexingOptions>
<FileSystemIndexingMode>Disabled</FileSystemIndexingMode>
<IncludedIndexingFolders />
<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>
<AdvancedStorageOptions>
<PasswordKeyId>3b39fed1-c9e8-46bf-be7e-2a096a210341</PasswordKeyId>
</AdvancedStorageOptions>
</BackupJobInfo>
</JobInfo>
</Job>