Versions Compared

Old Version 7

changes.mady.by.user Robert Alexander Marshall

Saved on

compared with

New Version 8

changes.mady.by.user Robert Alexander Marshall

Saved on

Key

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

...

Excerpt
nameda_restapi_summary

The Document Activity REST API can be used with Confluence instances that have the workflow data upgraded to use the document activity data.

Info

The Document Activity REST API provides a range of capabilities for retrieving event information on your workflow document activity.

The document activity REST API does not include Confluence activities like page updates and page comments.

REST API documentation

The REST API documentation is available in the following pages

There is also a upgrade and pre-upgrade checks REST API

Permissions

Pages

For an API request for a list of one or more pages, the workflow visibility for each page is validated for the user running the report.

Info

In each space, the Workflow Activity and Drafts Visibility configuration option will determine the users who can retrieve document activity about the pages.

Spaces

For an API request for one or more spaces, we have to validate space administrator permission over each space for the user requesting the information through the API.

If a REST API request contains a space/page over which the user making the request does not have enough permissions, the response is shown as a bad request. The response will include details about the spaces/pages over which the user does not have enough permissions. These should be removed from the request.

Info

All new spaces created after the installation/upgrade to Comala Document Management 7.0+ will, by default, utilize document activity data.

Existing spaces that have not previously used a workflow, when a workflow is applied, will utilize document activity.

Panel
bgColor#FFFAE6

The document activity REST API cannot be used for spaces that have not been upgraded. The workflow data in these legacy workflow spaces must be upgraded to use document activity.