Last updatedDec 8, 2017
Improve this page

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

Value

majorVersion

the major version number of the Confluence instance

Type: int

minorVersion

the minor version number of the Confluence instance

Type: int

patchLevel

the patch-level of the Confluence instance

Type: int

buildId

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

Type: String

developmentBuild

Whether the build is a developer-only release or not

Type: Boolean

baseUrl

The base URL for the confluence instance

Type: int

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

Value

key

the space key

Type: String

name

the name of the space

Type: String

type

type of the space

Type: String

url

the url to view this space online

Type: String

Space

Key

Value

key

the space key

Type: String

name

the name of the space

Type: String

url

the url to view this space online

Type: String

homePage

the id of the space homepage

Type: long

description

the HTML rendered space description

Type: String

PageSummary

Key

Value

id

the id of the page

Type: long

space

the key of the space that this page belongs to

Type: String

parentId

the id of the parent page

Type: long

title

the title of the page

Type: String

url

the url to view this page online

Type: String

permissions

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

Type: int

Page

Key

Value

id

the id of the page

Type: long

space

the key of the space that this page belongs to

Type: String

parentId

the id of the parent page

Type: long

title

the title of the page

Type: String

url

the url to view this page online

Type: String

version

the version number of this page

Type: int

content

the page content

Type: String

created

timestamp page was created

Type: Date

creator

username of the creator

Type: String

modified

timestamp page was modified

Type: Date

modifier

username of the page's last modifier

Type: String

homePage

whether or not this page is the space's homepage

Type: Boolean

permissions

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

Type: int

contentStatus

status of the page (eg. current or deleted)

Type: String

current

whether the page is current and not deleted

Type: Boolean

PageUpdateOptions

Key

Value

versionComment

Edit comment for the updated page

Type: String

minorEdit

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

Type: Boolean

PageHistorySummary

Key

Value

id

the id of the historical page

Type: long

version

the version of this historical page

Type: int

modifier

the user who made this change

Type: String

modified

timestamp change was made

Type: Date

versionComment

the comment made when the version was changed

Type: String

BlogEntrySummary

Key

Value

id

the id of the blog entry

Type: long

space

the key of the space that this blog entry belongs to

Type: String

title

the title of the blog entry

Type: String

url

the url to view this blog entry online

Type: String

permissions

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

Type: int

publishDate

the date the blog post was published

Type: Date

BlogEntry

Key

Value

id

the id of the blog entry

Type: long

space

the key of the space that this blog entry belongs to

Type: String

title

the title of the page

Type: String

url

the url to view this blog entry online

Type: String

version

the version number of this blog entry

Type: int

content

the blog entry content

Type: String

permissions

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

Type: int

SearchResult

Key

Value

title

the feed's title

Type: String

url

the remote URL needed to view this search result online

Type: String

excerpt

a short excerpt of this result if it makes sense

Type: String

type

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

Type: String

id

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

Type: long

Attachment

Key

Value

id

numeric id of the attachment

Type: long

pageId

page ID of the attachment

Type: String

title

title of the attachment

Type: String

fileName

file name of the attachment (Required)

Type: String

fileSize

numeric file size of the attachment in bytes

Type: String

contentType

mime content type of the attachment (Required)

Type: String

created

creation date of the attachment

Type: Date

creator

creator of the attachment

Type: String

url

url to download the attachment online

Type: String

comment

comment for the attachment (Required) 

Type: String

Comment

Key

Value

id

numeric id of the comment

Type: long

pageId

page ID of the comment

Type: String

title

title of the comment

Type: String

content

notated content of the comment (use renderContent to render)

Type: String

url

url to view the comment online

Type: String

created

creation date of the attachment

Type: Date

creator

creator of the attachment

Type: String

User

Key

Value

name

the username of this user

Type: String

fullname

the full name of this user

Type: String

email

the email address of this user

Type: String

url

the url to view this user online

Type: String

ContentPermission

Key

Value

type

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

Type: String

userName

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

Type: String

groupName

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

Type: String

ContentPermissionSet

Key

Value

type

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

Type: String

contentPermissions

The permissions. Each item is a ContentPermission.

Type: List

SpacePermissionSet

Key

Value

type

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

Type: String

contentPermissions

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.

Type: List

Label

Key

Value

name

the name of the label

Type: String

owner

the username of the owner

Type: String

namespace

the namespace of the label

Type: String

id

the ID of the label

Type: long

UserInformation

Key

Value

username

the username of this user

Type: String

content

the user description

Type: String

creatorName

the creator of the user

Type: String

lastModifierName

the url to view this user online

Type: String

version

the version

Type: int

id

the ID of the user

Type: long

creationDate

the date the user was created 

Type: Date

lastModificationDate

the date the user was last modified 

Type: Date

ClusterInformation

Key

Value

isRunning

true if this node is part of a cluster.

Type: Boolean

name

the name of the cluster.

Type: String

memberCount

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

Type: int

description

a description of the cluster.

Type: String

multicastAddress

the address that this cluster uses for multicasr communication.

Type: String

multicastPort

the port that this cluster uses for multicast communication.

Type: String

NodeStatus

Key

Value

nodeId

an integer uniquely identifying the node within the cluster.

Type: int

jvmStats

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

Type: Map

props

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".

Type: Map

buildStats

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

Type: Map

ContentSummaries

Key

Value

totalAvailable

The total number of content available to be retrieved.

Type: int

offset

The index of the first content retrieved.

Type: int

content

list of the retrieved content.

Type: Vector of ContentSummary

ContentSummary

Key

Value

id

The ID of the content.

Type: long

type

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

Type: String

space

The key of the space to which the content belongs.

Type: String

status

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

Type: String

title

The title of the content.

Type: String

created

Timestamp page was created.

Type: Date

creator

Username of the creator.

Type: String

modified

Timestamp content was modified.

Type: Date

modifier

Username of content's last modifier.

Type: String