getPageList

See also: Actions

Description

Get list of pages with regex filtering on page title. Either use cql directly to define the page list or the various other parameters that combine to define the page list including labels, space, id, or title. When the cql parameter is specified, the labels, space, id, and parent parameters are ignored. Options for including ancestors, children, or descendents are available when a specific page is specified. For example, when space and labels are both used, pages are selected from the space that have at last one of the labels. Use regex2 to additionally filter by matching on the content. Content filtering takes significant resources and time. @all can be used as a special value for the space parameter.

Required Parameters

cql or labels or space or id

Optional Parameters

title, parent, ancestors, descendents, children, limit, regex, regex2, outputFormat, dateFormat, outputType, file, append, columns, select, options, encoding

Type

Get

Category

Pages

Output Formats

1 - simple, 2 - CSV, 3 - space, 998 - all fields excluding content, 999 - all

Replacement Variables

Hostingcloud,server,datacenter
Since Version

Examples

getPageList

Related How To's

Log a request with our support team.

Confluence®, Jira®, Atlassian Bamboo®, Bitbucket®, Fisheye®, and Atlassian Crucible® are registered trademarks of Atlassian®
Copyright © 2005 - 2024 Appfire | All rights reserved. Appfire™, the 'Apps for makers™' slogan and Bob Swift Atlassian Apps™ are all trademarks of Appfire Technologies, LLC.