Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt
Table of Contents
minLevel2
maxLevel4
outlinefalse
typeflat
printablefalse
separatorpipeprintablefalse

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.

If the request contains a space/page over which the user making the request does not have enough permissions then the response will be a bad request with details about the spaces/pages over which the user does not have enough permissions.

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

Document activity REST API documentation

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

...