Resource Representation for Key Resources
For key resources, or entities, Veeam Backup Enterprise Manager REST API provides two types of resource representations:
- Entity reference resource representation
- Entity resource representation
Entity Reference Resource Representation
The entity reference resource representation provides short information about the resource that is uniform for all entity resources. This type of representation typically contains the following data:
- Basic resource information: its UID, name, URL and type
- Information about resources that are related to the current resource
For example, a reference representation for a job resource looks similar to the following:
XML Representation
<EntityRef xmlns="http://www.veeam.com/ent/v1.0" Type="JobReference" Href="https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d" Name="CRM Backup" UID="urn:veeam:Job:2851cb88-37b6-46ea-b2c8-47b55270169d"> |
JSON Representation
{ "Links": [ { "Rel": "Up", "Href": "https://srv12.tech.local:9398/api/backupServers/ffa6d4ef-ea63-4fb3-88a1-84706c2430e1", "Name": "appsrv01.tech.local", "Type": "BackupServerReference" }, { "Rel": "Alternate", "Href": "https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d?format=Entity", "Name": "CRM Backup", "Type": "Job" }, { "Rel": "Down", "Href": "https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d/backupSessions", "Type": "BackupJobSessionReferenceList" } ], "UID": "urn:veeam:Job:2851cb88-37b6-46ea-b2c8-47b55270169d", "Name": "CRM Backup", "Href": "https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d", "Type": "JobReference" } |
Entity Resource Representation
The entity resource representation provides complete information about the resource:
- Basic information about the resource: its UID, name, URL and type
- Information about the related resources
- Links to actions that can be performed with the resource and information about the resource settings
- Other information related to the resource such as object settings and so on
To get an entity of the resource representation, the client should send the GET HTTP request to the URL of the resource entity:
GET https://localhost:9398/api/jobs/b04c217b-0538-4650-bec4-19deff4ea1ac?format=Entity |
In the response, the server returns an entity representation providing complete information about the resource:
XML Representation
<Job xmlns="http://www.veeam.com/ent/v1.0" Type="Job" Href="https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d?format=Entity" Name="CRM Backup" UID="urn:veeam:Job:2851cb88-37b6-46ea-b2c8-47b55270169d"> |
JSON Representation
{ "JobType": "Backup", "Platform": "VMware", "Description": "Backup of CRM system", "ScheduleConfigured": true, "ScheduleEnabled": true, "NextRun": "2020-02-04T13:00:00Z", "JobScheduleOptions": { "Standart": { "RetryOptions": { "RetryTimes": 3, "RetryTimeout": 10, "RetrySpecified1": true }, "WaitForBackupCompletion": true, "BackupCompetitionWaitingPeriodMin": 180, "OptionsDaily": { "Kind": "Everyday", "Days": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "Time": "2019-10-23T14:00:00", "TimeOffsetUtc": 2, "Enabled": true }, "OptionsMonthly": { "Time": "2019-10-23T22:00:00+02:00", "TimeOffsetUtc": 2, "DayNumberInMonth": "Fourth", "DayOfWeek": "Saturday", "Months": [ "January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December" ], "DayOfMonth": 1, "Enabled": false }, "OptionsPeriodically": { "Kind": "Hours", "FullPeriod": 1, "Schedule": { "Days": [ { "Name": "Sunday", "Value": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1" }, { "Name": "Monday", "Value": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1" }, { "Name": "Tuesday", "Value": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1" }, { "Name": "Wednesday", "Value": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1" }, { "Name": "Thursday", "Value": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1" }, { "Name": "Friday", "Value": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1" }, { "Name": "Saturday", "Value": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1" } ] }, "Enabled": false }, "OptionsContinuous": { "Schedule": { "Days": [ { "Name": "Sunday", "Value": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1" }, { "Name": "Monday", "Value": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1" }, { "Name": "Tuesday", "Value": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1" }, { "Name": "Wednesday", "Value": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1" }, { "Name": "Thursday", "Value": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1" }, { "Name": "Friday", "Value": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1" }, { "Name": "Saturday", "Value": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1" } ] }, "Enabled": false }, "OptionsBackupWindow": { "TimePeriods": { "Days": [ { "Name": "Sunday", "Value": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1" }, { "Name": "Monday", "Value": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1" }, { "Name": "Tuesday", "Value": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1" }, { "Name": "Wednesday", "Value": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1" }, { "Name": "Thursday", "Value": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1" }, { "Name": "Friday", "Value": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1" }, { "Name": "Saturday", "Value": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1" } ] }, "Enabled": false }, "OptionsDaisyChaining": { "PreviousJobUid": "", "Enabled": false } }, "ImmediateCopyMode": null, "Links": null, "Href": "" }, "JobInfo": { "BackupJobInfo": { "Includes": { "ObjectInJobs": [ { "ObjectInJobId": "fd0abfab-e931-45e0-a315-bd236a3d2788", "HierarchyObjRef": "urn:VMware:Vm:3b8ebdcc-41de-4c42-a001-a344f2e75550.vm-62230", "Name": "crm01", "DisplayName": "crm01", "GuestProcessingOptions": { "AppAwareProcessingMode": null, "FileSystemIndexingMode": null, "IncludedIndexingFolders": null, "ExcludedIndexingFolders": null, "CredentialsId": null, "VssSnapshotOptions": { "VssSnapshotMode": "RequireSuccess", "IsCopyOnly": false }, "WindowsGuestFSIndexingOptions": { "FileSystemIndexingMode": "ExceptSpecifiedFolders", "IncludedIndexingFolders": [], "ExcludedIndexingFolders": [ "%windir%", "%ProgramFiles%", "%ProgramFiles(x86)%", "%ProgramW6432%", "%TEMP%" ] }, "LinuxGuestFSIndexingOptions": { "FileSystemIndexingMode": "ExceptSpecifiedFolders", "IncludedIndexingFolders": [], "ExcludedIndexingFolders": [ "/cdrom", "/dev", "/media", "/mnt", "/proc", "/tmp", "/lost+found" ] }, "SqlBackupOptions": { "TransactionLogsProcessing": "OnlyOnSuccessJob", "BackupLogsFrequencyMin": 15, "UseDbBackupRetention": true, "RetainDays": 15 }, "WindowsCredentialsId": "", "LinuxCredentialsId": "", "FSFileExcludeOptions": null, "OracleBackupOptions": null }, "Links": null, "Href": "https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d/includes/fd0abfab-e931-45e0-a315-bd236a3d2788", "Type": "ObjectInJob" }, { "ObjectInJobId": "51e37e0e-800a-4639-a2c7-0379330ea1ee", "HierarchyObjRef": "urn:VMware:Vm:3b8ebdcc-41de-4c42-a001-a344f2e75550.vm-62228", "Name": "dbserver01", "DisplayName": "dbserver01", "GuestProcessingOptions": { "AppAwareProcessingMode": null, "FileSystemIndexingMode": null, "IncludedIndexingFolders": null, "ExcludedIndexingFolders": null, "CredentialsId": null, "VssSnapshotOptions": { "VssSnapshotMode": "RequireSuccess", "IsCopyOnly": false }, "WindowsGuestFSIndexingOptions": { "FileSystemIndexingMode": "ExceptSpecifiedFolders", "IncludedIndexingFolders": [], "ExcludedIndexingFolders": [ "%windir%", "%ProgramFiles%", "%ProgramFiles(x86)%", "%ProgramW6432%", "%TEMP%" ] }, "LinuxGuestFSIndexingOptions": { "FileSystemIndexingMode": "ExceptSpecifiedFolders", "IncludedIndexingFolders": [], "ExcludedIndexingFolders": [ "/cdrom", "/dev", "/media", "/mnt", "/proc", "/tmp", "/lost+found" ] }, "SqlBackupOptions": { "TransactionLogsProcessing": "OnlyOnSuccessJob", "BackupLogsFrequencyMin": 15, "UseDbBackupRetention": true, "RetainDays": 15 }, "WindowsCredentialsId": "", "LinuxCredentialsId": "", "FSFileExcludeOptions": null, "OracleBackupOptions": null }, "Links": null, "Href": "https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d/includes/51e37e0e-800a-4639-a2c7-0379330ea1ee", "Type": "ObjectInJob" } ] }, "GuestProcessingOptions": { "AppAwareProcessingMode": null, "FileSystemIndexingMode": null, "IncludedIndexingFolders": null, "ExcludedIndexingFolders": null, "CredentialsId": null, "VssSnapshotOptions": { "VssSnapshotMode": "Disabled", "IsCopyOnly": false }, "WindowsGuestFSIndexingOptions": { "FileSystemIndexingMode": "Disabled", "IncludedIndexingFolders": [], "ExcludedIndexingFolders": [] }, "LinuxGuestFSIndexingOptions": { "FileSystemIndexingMode": "Disabled", "IncludedIndexingFolders": [], "ExcludedIndexingFolders": [] }, "SqlBackupOptions": { "TransactionLogsProcessing": "OnlyOnSuccessJob", "BackupLogsFrequencyMin": 15, "UseDbBackupRetention": true, "RetainDays": 15 }, "WindowsCredentialsId": "", "LinuxCredentialsId": "", "FSFileExcludeOptions": null, "OracleBackupOptions": null }, "AdvancedStorageOptions": { "PasswordKeyId": "" }, "GfsRetentionPolicy": { "Weekly": { "Enabled": false, "RetentionPeriod": 1, "SelectedDay": "Sunday" }, "Monthly": { "Enabled": false, "RetentionPeriod": 1, "SelectedWeek": "First" }, "Yearly": { "Enabled": false, "RetentionPeriod": 1, "SelectedMonth": "January" }, "Enabled": false }, "SimpleRetentionPolicy": { "RetainCycles": 5, "RetainDaysToKeep": 7, "RetainLimitType": "Cycles" } }, "FileCopyJobInfo": null, "ReplicaJobInfo": null, "BackupCopyJobInfo": null, "ImmediateBackupCopyJobInfo": null }, "Name": "CRM Backup", "UID": "urn:veeam:Job:2851cb88-37b6-46ea-b2c8-47b55270169d", "Links": [ { "Rel": "Up", "Href": "https://srv12.tech.local:9398/api/backupServers/ffa6d4ef-ea63-4fb3-88a1-84706c2430e1", "Name": "appsrv01.tech.local", "Type": "BackupServerReference" }, { "Rel": "Alternate", "Href": "https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d", "Name": "CRM Backup", "Type": "JobReference" }, { "Rel": "Edit", "Href": "https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d", "Name": "CRM Backup", "Type": "JobReference" }, { "Rel": "Clone", "Href": "https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d?action=clone" }, { "Rel": "ToggleScheduleEnabled", "Href": "https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d?action=toggleScheduleEnabled" }, { "Rel": "Down", "Href": "https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d/includes", "Type": "ObjectInJobList" }, { "Rel": "Down", "Href": "https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d/backupSessions", "Type": "BackupJobSessionReferenceList" }, { "Rel": "Create", "Href": "https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d/includes", "Type": "ObjectInJob" }, { "Rel": "Start", "Href": "https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d?action=start" }, { "Rel": "Stop", "Href": "https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d?action=stop" }, { "Rel": "Retry", "Href": "https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d?action=retry" } ], "Href": "https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d?format=Entity", "Type": "Job" } |