Versions Compared

Old Version 4

changes.mady.by.user Robert Alexander Marshall

Saved on

compared with

New Version 5

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

Table of Contents
minLevel1
maxLevel7
typeflat
separatorpipe

Status
colourGreen
titleDATA CENTER
Status
colourPurple
titleDOCUMENT ACTIVITY REST API
Status
colourBlue
titlePREUPGRADE CHECKS REST API

Public documentation for our

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 pre-upgrade checks REST API

contentbylabel

Permissions

Permissions

For the list of

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.

list of
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 REST API provides a range of capabilities for reporting retrieving event information on your workflow document activity.

The document activity

that are not available in page activity.

Documentation

Panel
bgColor#EAE6FF
showLabelsfalse
cqllabel = "da_api_endpoint" and space = "CDMRA"
Info

In each space, ensure the Workflow Activity and Drafts Visibility configuration option is set as

  • Space Administrators and Page Editors

For the

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 running the reportrequesting 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.

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)showLabelsfalsecql

label = "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.

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

Panel
bgColor#FFFAE6

A different The document activity REST API should cannot be used for instances/spaces using page activity workflow data if the space has not been ugraded spaces that have not been upgraded. The workflow data in these legacy workflow spaces must be upgraded to use document activity.