This site has moved to the integrated Appfire documentation and information site for our apps.

From February 2024 this site is no longer updated.

Take a look here! If you have any questions please email support@appfire.com

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 24 Next »

DATA CENTER DOCUMENT ACTIVITY REST API

Overview

Endpoints

The Document Activity REST API can retrieve workflow document activity entries from the following endpoints

Pages

  • http://<confluencehostname>/rest/cw/2/documentactivity/pages

Spaces

  • http://localhost:8090/rest/cw/2/documentactivity/spaces

The requests can include filters, for example

  • scope to filter the pageids and spaceKeys

  • actors to filter by one or more users (by userid) who undertook a document activity

  • participants to filter by one or more users (by userid) who were assigned, commented

To include the information for all workflow states in the specified pages/specified spaces, stateNames [ ] is empty and will be limited to 100 items.

The REST API Models in the documentation define the document activity information retrieved in a request.

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.

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.

Document activity REST API documentation

The document activity REST API is provided as Open API (Swagger) Documentation.

  • No labels