Cameo Collaborator for Teamwork Cloud allows you to import comments to a specific document if you have exported these comments earlier. This can be useful when you need to republish the document, e.g., after the system upgrade.


To import comments to a Cameo Collaborator for TWC document

  1. Use an HTTP client to send an HTTP POST request with the following URL, headers, and body:

    • URL: http://<host>:<port>/<web_app_platform_root>/api/collaborator/document/<uuid>/branch/<uuid>/comments/import. Learn how to find document and branch IDs (UUIDs) you need to add to the URL.

      Add actual values

      Make sure that you replace the placeholders in the URL (between angle brackets (<>) with the actual data, e.g., Cameo Collaborator for TWC host, port, document and branch IDs, etc.

    • Headers: Cookie, Connection, User-Agent. Learn how to find headers for the HTTP request.

    • Body: the data you retrieved from an HTTP GET request when exporting comments from this document.

      Set data type and format

      When you specify the body of the HTTP request, select the raw data type, and JSON data format.

  2. Reload the document to which you have imported comments.


After completing the above steps and reloading the document, the imported comments should be visible in the comments pane.

How to find document and branch IDs

When creating an HTTP request to import comments to a Cameo Collaborator for TWC document, you need to form a URL with document and branch IDs. The following steps explain how to find these IDs.


To find document and branch IDs

  1. In a web browser, open a network monitor in developer tools and go to the document from which you want to export comments.
  2. Select the "comments" HTTP request and locate Request URL in request headers.
  3. Find target document and target branch IDs in the Request URL.


How to find HTTP request headers

When creating an HTTP request to import comments to a Cameo Collaborator for TWC document, you need to know the Cookie, Connection, and User-Agent headers. The following steps explain how to find them.


To find Cookie, Connection, and User-Agent request headers

  1. In a web browser, open a network monitor in developer tools and go to the document from which you want to export comments.
  2. Select the "comments" HTTP request.
  3. Find the Cookie, Connection, and User-Agent request headers.