On April 27, 2024, our Sign-in and Create Account options will be unavailable from 9am-12pm ET. During this maintenance window, developer account access and free trial registration will be unavailable.

How to directly access the Markup Service?

Karen Weir
Karen Weir EM, RC admin
in Hackathon #1

This question is in reference to this Viewing Service API Document.

The doc says: "Your integration does not typically have to interact directly with the Markup Service because the viewer's markup API below almost certainly does everything you need."

However, I have a requirement where I want to do "headless" modifications to the markup data for a document. That is, I don't want to open the OT2 Viewer to modify the markup data. For this, I need to interact with the Markup Service directly via REST calls, just like how the rest of the OT2 services are served. How do I do this?

Essentially, I am looking for some services like these:

  1. GET /markup/document-identifier - This should return all the existing markup IDs for a document.
  2. GET /markup/document-identifier/markup-identifier - This should return the markup XML for the given document and markup ID.
  3. POST /markup/document-identifier/markup-identifier - The body of the request should have a markup XML that I want to set for the document.


Karen Weir
Flag · 1Like

Leave a Comment

Rich Text Editor. To edit a paragraph's style, hit tab to get to the paragraph menu. From there you will be able to pick one style. Nothing defaults to paragraph. An inline formatting menu will show up when you select text. Hit tab to get into that menu. Some elements, such as rich link embeds, images, loading indicators, and error messages may get inserted into the editor. You may navigate to these using the arrow keys inside of the editor and delete them with the delete or backspace key.

Comment As ...

Categories