Comala Document Management Document Activity REST API
DATA CENTER DOCUMENT ACTIVITY REST API
The Document Activity REST API can be used with Confluence instances that have the workflow data upgraded to use the document activity data (Active Objects).
The Document Activity API provides a range of capabilities for reporting on your workflow document activity that are not available in page activity.
Documentation
Public documentation for our Document Activity REST API
REST API endpoints
-
Upgrade and Pre-Upgrade checks REST API endpoints (Appfire Comala Document Management REST API)
-
Document Activity Entries REST API endpoints (Appfire Comala Document Management REST API)
Permissions
For the list of pages, the workflow visibility for each page is validated for the user running the report.
In each space, ensure the Workflow Activity and Drafts Visibility configuration option is set as
Space Administrators and Page Editors
For the list of spaces, we have to validate space administrator permission over each space for the user running the report.
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.
Report display
report pagination will be implemented the same as the Java API
report offset and display limit will be set by the document activity REST API
page updates and page comments will not be included in the response, only document activity records.
REST API examples
Filter by label
There are no items with the selected labels at this time.
All new spaces created after the installation/upgrade to Comala Document Management 7.0+ will, by default, utilize document activity data.
A different REST API should be used for instances/spaces using page activity workflow data if the space has not been ugraded to use document activity.