Remote Confluence Data Objects

The XML-RPC and SOAP APIs are deprecated since Confluence 5.5.
Confluence has a new REST API that is progressively replacing our existing APIs. We recommend plugin developers use the new REST APIs where possible.

The Confluence remote APIs return structures that have a summary and a detailed form.  The summary form is a primary key (ie space key, page id) and a representative form (for example, space name, page title). The detailed form has all of the entity details client might need.  Unless otherwise specified, all returned structs are in detailed form.  For information about the remote methods that act on these data objects, see Remote Confluence Methods

This page documents the following objects:

ServerInfo

Key

Type

Value

majorVersion

int

the major version number of the Confluence instance

minorVersion

int

the minor version number of the Confluence instance

patchLevel

int

the patch-level of the Confluence instance

buildId

String

the build ID of the Confluence instance (usually a number)

developmentBuild

Boolean

Whether the build is a developer-only release or not

baseUrl

String

The base URL for the confluence instance

Note: Version 1.0.3 of Confluence would be major-version: 1, minor-version: 0, patch-level: 3. Version 2.0 would have a patch-level of 0, even if it's not visible in the version number.

SpaceSummary

Key

Type

Value

key

String

the space key

name

String

the name of the space

type

String

type of the space

url

String

the url to view this space online

Space

Key

Type

Value

key

String

the space key

name

String

the name of the space

url

String

the url to view this space online

homePage

long

the id of the space homepage

description

String

the HTML rendered space description

PageSummary

Key

Type

Value

id

long

the id of the page

space

String

the key of the space that this page belongs to

parentId

long

the id of the parent page

title

String

the title of the page

url

String

the url to view this page online

permissions

int

the number of permissions on this page (deprecated: may be removed in a future version)

Page

Key

Type

Value

id

long

the id of the page

space

String

the key of the space that this page belongs to

parentId

long

the id of the parent page

title

String

the title of the page

url

String

the url to view this page online

version

int

the version number of this page

content

String

the page content

created

Date

timestamp page was created

creator

String

username of the creator

modified

Date

timestamp page was modified

modifier

String

username of the page's last modifier

homePage

Boolean

whether or not this page is the space's homepage

permissions

int

the number of permissions on this page (deprecated: may be removed in a future version)

contentStatus

String

status of the page (eg. current or deleted)

current

Boolean

whether the page is current and not deleted

PageUpdateOptions

Key

Type

Value

versionComment

String

Edit comment for the updated page

minorEdit

Boolean

Is this update a 'minor edit'? (default value: false)

PageHistorySummary

Key

Type

Value

id

long

the id of the historical page

version

int

the version of this historical page

modifier

String

the user who made this change

modified

Date

timestamp change was made

versionComment

String

the comment made when the version was changed

BlogEntrySummary

Key

Type

Value

id

long

the id of the blog entry

space

String

the key of the space that this blog entry belongs to

title

String

the title of the blog entry

url

String

the url to view this blog entry online

permissions

int

the number of permissions on this page (deprecated: may be removed in a future version)

publishDate

Date

the date the blog post was published

BlogEntry

Key

Type

Value

id

long

the id of the blog entry

space

String

the key of the space that this blog entry belongs to

title

String

the title of the page

url

String

the url to view this blog entry online

version

int

the version number of this blog entry

content

String

the blog entry content

permissions

int

the number of permissions on this page (deprecated: may be removed in a future version)

SearchResult

Key

Type

Value

title

String

the feed's title

url

String

the remote URL needed to view this search result online

excerpt

String

a short excerpt of this result if it makes sense

type

String

the type of this result - page, comment, spacedesc, attachment, userinfo, blogpost, status

id

long

the long ID of this result (if the type has one)

Attachment

Key

Type

Value

id

long

numeric id of the attachment

pageId

String

page ID of the attachment

title

String

title of the attachment

fileName

String

file name of the attachment (Required)

fileSize

String

numeric file size of the attachment in bytes

contentType

String

mime content type of the attachment (Required)

created

Date

creation date of the attachment

creator

String

creator of the attachment

url

String

url to download the attachment online

comment

String 

comment for the attachment (Required) 

Comment

Key

Type

Value

id

long

numeric id of the comment

pageId

String

page ID of the comment

title

String

title of the comment

content

String

notated content of the comment (use renderContent to render)

url

String

url to view the comment online

created

Date

creation date of the attachment

creator

String

creator of the attachment

User

Key

Type

Value

name

String

the username of this user

fullname

String

the full name of this user

email

String

the email address of this user

url

String

the url to view this user online

ContentPermission

Key

Type

Value

type

String

The type of permission. One of 'View' or 'Edit'

userName

String

The username of the user who is permitted to see or edit the content. Null if this is a group permission.

groupName

String

The name of the group who is permitted to see or edit the content. Null if this is a user permission.

ContentPermissionSet

Key

Type

Value

type

String

The type of permission. One of 'View' or 'Edit'

contentPermissions

List

The permissions. Each item is a ContentPermission.

SpacePermissionSet

Key

Type

Value

type

String

The type of permission. One of the available types listed in Remote Confluence Methods

contentPermissions

List

The permissions. Each item is a ContentPermission. The ContentPermission type was reused for brevity. In this case, the type field in each ContentPermission element will be of the available types linked above.

Label

Key

Type

Value

name

String

the name of the label

owner

String

the username of the owner

namespace

String

the namespace of the label

id

long

the ID of the label

UserInformation

Key

Type

Value

username

String

the username of this user

content

String

the user description

creatorName

String

the creator of the user

lastModifierName

String

the url to view this user online

version

int 

the version

id

long 

the ID of the user

creationDate

Date 

the date the user was created 

lastModificationDate

Date

the date the user was last modified 

ClusterInformation

Key

Type

Value

isRunning

boolean

true if this node is part of a cluster.

name

String

the name of the cluster.

memberCount

int

the number of nodes in the cluster, including this node (this will be zero if this node is not clustered.)

description

String

a description of the cluster.

multicastAddress

String

the address that this cluster uses for multicasr communication.

multicastPort

String

the port that this cluster uses for multicast communication.

NodeStatus

Key

Type

Value

nodeId

int

an integer uniquely identifying the node within the cluster.

jvmStats

Map

a Map containing attributes about the JVM memory usage of node.  Keys are "total.memory", "free.memory", "used.memory".

props

Map

a Map containing attributes of the node. Keys are "system.date", "system.time", "system.favourite.colour", "java.version", "java.vendor",
"jvm.version", "jvm.vendor", "jvm.implemtation.version", "java.runtime", "java.vm", "user.name.word", "user.timezone",
"operating.system", "os.architecture",  "fs.encoding".

buildStats

Map

a Map containing attributes of the build of Confluence running on the node. Keys are "confluence.home", "system.uptime", "system.version",
"build.number".

ContentSummaries

Key

Type

Value

totalAvailable

int

The total number of content available to be retrieved.

offset

int

The index of the first content retrieved.

content

Vector of ContentSummary

list of the retrieved content.

ContentSummary

Key

Type

Value

id

long

The ID of the content.

type

String

The type of content (e.g. "page", "comment", "blog").

space

String

The key of the space to which the content belongs.

status

String

The current status of the content (e.g. "current", "deleted").

title

String

The title of the content.

created

Date

Timestamp page was created.

creator

String

Username of the creator.

modified

Date

Timestamp content was modified.

modifier

String

Username of content's last modifier.

Was this page helpful?

Have a question about this article?

See questions about this article

Powered by Confluence and Scroll Viewport