Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Cameo Collaborator for Teamwork Cloud allows you to export comments from a specific document for back-up purposes. You can import these comments later, e.g., if you republish the document after the system upgrade.


To export comments from a Cameo Collaborator for TWC document


  1. Use an HTTP client to send an HTTP GET request with the following URL and headers:
    • URL: http://<host>:<port>/<web_app_platform_root>/api/collaborator/document/<uuid>/branch/<uuid>/comments/export. Learn how to find document and branch IDs (UUIDs) you need to add to the URL.

      Warning
      titleAdd 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.
  2. Save the retrieved data as a plain text file.


The text file with retrieved data is your comment back-up. You will need that data if you want to import the comments to this specific Cameo Collaborator for TWC document.

How to find document and branch IDs

When creating an HTTP request to export comments from 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 export comments from 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.