Page Comparison

...

Search for Confluence content and its metadata. You can search with the Confluence query language (CQL) or Lucene query language or combine them.

...

Path parameters

Parameter		Required	Default value	Possible values / type
pagenumber

the pagenumber

The page number of the result list.

INTEGER greater 0

Query parameters

Lucene queryConfluence query language

Parameter

Required

Default value

Possible values / type

cql

The query

which defines the content to be searched given in the Confluence query language (CQL).

Additional help for creating search conditions which include Metadata fields can be found in Searching with Metadata.

Either the query cql parameter or the cql query parameter has to be defined

cql

provided.

STRING

The CQL query string.

query

Status

colour	Yellow
title	DEPRECATED

please prefer the cql parameter.

The query which defines the content to be searched given in the Lucene query syntax.

Additional help for creating search conditions which include Metadata fields can be found in Searching with Metadata.

Either the query cql parameter or the cql query parameter has to be definedprovided.

STRING

The Lucene query string.

sort

The column to sort byuse for sorting the results.

STRING

the The name of the column

Metadata field keymetadatafield.status

. Examples:

sort direction

sort by page title with
- content-name-untokenized

sortdirection

sort by a Metadata field by providing the field key
- metadatafield.status

sortdirection

The order in which the result should be sorted.

ASCENDING
DESCENDING

pagesize

Result entries The number of items to return per result page.

INTEGER greater 0

fields

narrow Narrow down the list of displayed Metadata fields per result.

all All metadata fields of the content results will be showncontained.

A comma separated list of fields. Example:

metadatafield.status,metadatafield.contactperson

ceo

The ID of a page or a blogpost to define the context of the request. This is especially useful when using CQL with functions like currentSpace().

INTEGER

...

Example Request with JavaScript

Code Block

language	js

jQuery.get( contextPath + "/rest/communardo/metadata/latest/filter/1" , {
    querycql: "'global.metadatafield.contactperson:="admin"',
    pagesize: 10,
    sortdirection: "DESCENDING",
    sort: "content-name-untokenized",
	fields: "global.metadatafield.contactperson"
}, function(data) {
    console.log(data);
});

Please note: latest/filter/1 displays the first page of the results. If you have more than 10 results, you will either need to raise the pagesize or go to page 2can get the next result set by incrementing the pagenumber path parameter.

Example Response

Code Block

{
	"pageNo": "1",
	"self": "https://wiki.company.de/rest/communardo/metadata/latest/filter",
	"searchResults": [{
		"pageTitle": "Example",
		"pageUrl": "/display/~admin/Example",
		"pageId": 1234567,
		"contentType": "page",
		"values": [{
			"id": 80,
			"key": "global.metadatafield.contactperson",
			"title": "Contact Person",
			"content": "<a class=\"confluence-userlink user-mention current-user-mention\" data-username=\"admin\" href=\"https://wiki.company.de/display/~admin\" data-linked-resource-id=\"25624936\" data-linked-resource-version=\"1\" data-linked-resource-type=\"userinfo\" data-base-url=\"https://wiki.company.de\">Administrator</a>"
		},
		{
			"id": 81,
			"key": "global.metadatafield.pagestatus",
			"title": "Page Status",
			"content": "Approved"
		},
		{
			"id": 82,
			"key": "global.metadatafield.pagestatusmessage",
			"title": "Page Status Message",
			"content": "nothing to do here"
		}]
	}],
	"pager": {
		"currentPage": 1,
		"pageCount": 1,
		"elementsPerPage": 10,
		"totalElementsCount": 1
	}
}

...

Versions Compared

Old Version 2

New Version Current

Key

Example Request with JavaScript

Example Response