CQL REST API

Overview

The Comala Document Management app provides several new CQL fields that can be used to filter search results using Confluence Search REST API.

Confluence CQL-enabled search requires Confluence 5.9 or above

You can also use Confluence CQL filters in Comala Document Management reporting macros (Comala Document Management v6.16.6+)

CQL Fields

The following workflow-related search fields are available if you are using Confluence 5.9 or above:

Filter Name	CQL Field	Type	Notes	Ver
Has Workflow	`awphasworkflow`	`TEXT`	Filter to content which has a workflow applied Use `true` as the text value.	5.1
Workflow Approval Assignee	`approvalassignee`	`USER`	Filter by assigned reviewer See also: Assigning reviewers	4.12+
Workflow Approver	`approver`	`USER`	Filter by user who approved content during a review See also: Content reviews	4.12+
Workflow State	`state`	`TEXT`	Filter by current workflow State	4.10+
Workflow State Change	`statechange`	`DATE`	Filter by date of last workflow state Transition	4.11+
Workflow State Expiry	`stateexpiry`	`DATE`	Filter by current workflow state Expiry Date See also: State expiry date	4.11+
Workflow Task Assignee	`taskassignee`	`USER`	Filter by workflow Task assignee See also: Assign a task	5.1
Workflow Name	`workflowname`	`TEXT`	Filter by workflow name	6.0
Read Confirmation Status	`readAckStatus`	`TEXT`	Filter by the read confirmation status. Possible values: pending, acknowledge, overdue	6.0

These fields can be used in Confluence Search, any macros that support CQL and the CQL REST API.

CQL Field Search Example

To search for content where the current state is "Draft" (state=Draft), the REST API URL would look like:

http://<confluence_url>/rest/api/content/search?cql=state=Draft

Content Properties

Comala Document Management uses JSON Content Properties to store and keep track of workflows data and support the new reporting utilities (for version 6.0 and later).

Workflow information is available as an API expansion point using metadata.properties.comalaworkflows

Not all values provided in the current implementation may be supported in future updates but the following core values are unlikely to change.

Name
`workflowName`
`currentState`
`currentStateColour`
`currentStateStart`

CQL REST API

Overview

CQL Fields

CQL Field Search Example

Content Properties

See also