Help Center
Choose product document...
Veeam Backup & Replication 9.5
RESTful API Reference

Special Characters in Responses

Responses from the server may contain special characters that cannot be displayed directly in an XML document. Such characters are replaced with character entity references, or predefined entities. For example, resource representations of VM guest OS file systems and responses from the query service and lookup service contain the '&' character entity reference instead of the ‘&’ character itself.

HTTP responses received via Veeam Backup Enterprise Manager RESTful API may contain the following character entity references:

Character

Character entity reference

Description

&

&

Ampersand

<

&lt;

Greater-than sign

>

&gt;

Less-than sign

"

&quot;

Quotation mark

'

&#39;

Apostrophe

/

&#x2F;

Slash

The example below represents a list of links in the paginated response from the query service. The ‘&’ (ampersand) character used as a separator for query parameters in the query string is replaced with the '&amp;' character entity reference.

<Links>
  <Link Rel="First" Href="http://localhost:9399/api/query?type=BackupServer&amp;pageSize=1&amp;page=1" />
  <Link Rel="Next" Href="http://localhost:9399/api/query?type=BackupServer&amp;pageSize=1&amp;page=2" />
  <Link Rel="Last" Href="http://localhost:9399/api/query?type=BackupServer&amp;pageSize=1&amp;page=3" />
</Links>

When the client parses a response and retrieves a link that contains a character entity reference, the client must replace the character entity reference with the corresponding character before using the link in a request. If the client sends a request that contains a character entity reference, the server may ignore the subsequent parameter while processing the request or completely fail to process the request.

Special Characters in Responses Note:

You do not need to perform this operation when you evaluate and test capabilities of Veeam Backup Enterprise Manager RESTful API using Veeam Backup Enterprise Manager Web Client. For your convenience, Veeam Backup Enterprise Manager Web Client automatically replaces character entity references with corresponding characters and displays responses in a readable way.

 

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation