Cmdlets for Confluence

Build 24.0.9060

Blogposts

Get information about a specific blogpost.

Table Specific Information

Select

The cmdlet will use the Confluence API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the cmdlet. You can also search for Attachments using CQL (Confluence Query Language).

  • Id supports the '=,!=,IN,NOT IN' comparisons.
  • Type supports the '=,!=,IN,NOT IN' comparisons.
  • Title supports the '=,!=,LIKE,NOT LIKE,IN,NOT IN' comparisons.
  • SpaceKey supports the '=,!=,IN,NOT IN' comparisons.
  • SpaceType supports the '=,!=,IN,NOT IN' comparisons.
  • CreatedByUserName supports the '=,!=,IN,NOT IN' comparisons.
  • CreatedDate supports the '=,!=,>,>=,<,<=' comparisons.
  • LastUpdatedDatetime supports the '=,!=,>,>=,<,<=' comparisons.

For example, the following queries are processed server side:

SQL


SELECT * FROM Blogposts WHERE Id = '1234'

SELECT * FROM Blogposts WHERE Id IN ('1234', '2345')

SELECT * FROM Blogposts WHERE Id = '123458' AND Type = 'blogpost'

SELECT * FROM Blogposts WHERE CreatedDate <= '2019/03/29 15:00' AND Id IN ('1234', '2345')

Additionally Id, Type, Title, CreatedDate, CreatedByUserName, AND LastUpdatedDatetime columns can be used in the ORDER BY clause, as following:

SELECT * FROM Blogposts ORDER BY Id DESC

SELECT * FROM Blogposts ORDER BY CreatedByUserName ASC

CQL

Note: Filtering with CQL has the highest priority and all the other filters except "Excerpt" will be ignored when CQL filter is present in the query.

SELECT * FROM Blogposts WHERE CQL = 'creator = currentUser() AND content = "1234" OR space.type = "global"'

Columns

Name Type References SupportedOperators Description
Id [KEY] String =,!=,IN,NOT IN Id of the blogpost.
Type String =,!=,IN,NOT IN Type of the content.
Title String =,!=,LIKE,IN,NOT IN Title of the blogpost.
Status String Status of the blogpost.
SpaceKey String

Spaces.Key

=,!=,IN,NOT IN The key of the space that the blogpost belongs to.
SpaceType String

Spaces.Type

=,!=,IN,NOT IN The type of the space that the blogpost belongs to.
Position String Position of the blogpost.
URL String URL of the blogpost.
Excerpt String Excerpt of the blogpost.
IsLatest Boolean Indicator if this is the latest version of the blogpost.
CreatedByUserName String =,!=,IN,NOT IN Username of the user who created the blogpost.
CreatedByUserType String Type of the user who created the blogpost.
CreatedDate Datetime =,>,>=,<,<= Datetime for the creation of the blogpost.
LastUpdatedDatetime Datetime =,>,>=,<,<= Datetime of the last updated version of the blogpost.
LastUpdatedMessage String Message of the last updated version.
LastUpdatedNumber Integer Number of the last updated version.
LastUpdatedUserName String Username of the user who updated the latest version.
LastUpdatedUserType String Type of the user who updated the latest version.
LastUpdatedIsMinorEdit Boolean Indicator if this version is a minor edit.
LastUpdatedIsHidden Boolean Indicator if the last updated version is hidden or not.
PreviousVersionUserName String Username of the user who updated the previous version.
PreviousVersionUserType String Type of the user who updated the previous version.
PreviousVersionDatetime Datetime Datetime when the previous version was edited.
PreviousVersionMessage String Message for the previously edited version.
PreviousVersionNumber String Number of the previously edited version.
PreviousVersionIsMinorEdit Boolean Indicator if the previous version was a minor edit.
PreviousVersionIsHidden Boolean Indicator if the previous version was hidden or not.
LinksEditui String The LinksEditui of the page content.
LinksSelf String The LinksSelf of the content.
LinksTinyui String The LinksTinyui of the content.
LinksWebui String The LinksWebui of the content.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
CQL String CQL (Confluence Query Language) allows you to build structured queries.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060