REST API Known Issues & Constraints

Updated by Stefenie Stockbridge

The Blueprint API has some known issues and constraints associated with transmitting formatted text. Please be advised of the following known issues when using the Blueprint REST API to write to Rich Text Properties in Blueprint:

  • Any rich text formatting needs to be formatted using HTML tags, including being contained in an <html> tag. Text not included in an <html> tag is treated as plain text
  • Line breaks must be represented using a <br> tag, not the line break character “\n”
  • Any tags not recognized in HTML5 are translated into URL encoding when pushed into Blueprint Rich Text Properties (ex. “<blueprint>” would be translated into “&lt;blueprint&rt;”)
  • The following URL encodings should be used to ensure proper representation of characters in formatted text:

    HTML Encoding

    Resulting Character in Blueprint

    &lt;

    <

    &gt;

    >

    &quot;

    “

    &amp;

    &

    &apos;

    ‘

For a complete list of all URL Encodings, please refer to: https://www.rapidtables.com/web/html/html-codes.html

How did we do?