Versions Compared

Old Version 18

changes.mady.by.user Robert Alexander Marshall

Saved on

compared with

New Version 19

changes.mady.by.user Robert Alexander Marshall

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt
hiddentrue
namerefinedpageimage
Image Removed
Excerpt
Table of Contents
minLevel2
maxLevel4
outlinefalse
typeflat
separatorpipe
printablefalse

Status
colourGreen
titleDATA CENTER
Status
colourPurple
titleDocument Activity REST API

Overview

The document REST API documentation can retrieve workflow document activity information for 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

Info

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.

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.

Document activity REST API documentation

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

...