Versions Compared

Old Version 3

changes.mady.by.user Robert Alexander Marshall

Saved on

compared with

New Version 4

changes.mady.by.user Robert Alexander Marshall

Saved on

Key

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

...

Comala Document Management Document Activity REST API

Status
colourGreen
titleDATA CENTER
Status
colourPurple
titleDOCUMENT ACTIVITY REST API

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 (Active Objects).

Info

The Document Activity API provides a range of capabilities for reporting on your workflow document activity that are not available in page activity.

Documentation

Panel
bgColor#EAE6FF

Public documentation for our Document Activity REST API

REST API endpoints

Filter by label (Content by label)
showLabelsfalse
cqllabel = "da_api_endpoint" and space = "CDMRA"

Permissions

For the list of pages, the workflow visibility for each page is validated for the user running the report.

Info

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 (Content by label)
showLabelsfalse
cqllabel = "da_restapi_example" and space = "CDMRA"
Info

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

Panel
bgColor#FFFAE6

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.