Special Characters in Responses

In this article

    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 from Veeam Backup Enterprise Manager REST API may contain the following character entity references:

    Character

    Character Entity Reference

    Description

    &

    &

    Ampersand

    <

    &lt;

    Less-than sign

    >

    &gt;

    Greater-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="https://localhost:9398/api/query?type=BackupServer&amp;pageSize=1&amp;page=1" />
      <Link Rel="Next" Href="https://localhost:9398/api/query?type=BackupServer&amp;pageSize=1&amp;page=2" />
      <Link Rel="Last" Href="https://localhost:9398/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 character itself 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.

    Note

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

     

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.