Confluence Cloud REST API Reference

This document describes the REST API and resources provided by Confluence. The REST APIs are for developers who want to integrate Confluence into their application and for administrators who want to script interactions with the Confluence server.

Confluence's REST APIs provide access to resources (data entities) via URI paths. To use a REST API, your application will make an HTTP request and parse the response. The response format is JSON. Your methods will be the standard HTTP methods like GET, PUT, POST and DELETE.

Because the REST API is based on open standards, you can use any web development language to access the API.

Structure of the REST URIs

URIs for the Confluence REST API resource have the following structure:

https://instance-name.atlassian.net/wiki/rest/api/resource-name

For example: https://instance-name.atlassian.net/wiki/rest/api/space/ds

How to use expansion in the REST APIs

In order to minimise network traffic from the client perspective, our API uses a technique called expansion.

You can use the expand query parameter to specify a comma-separated list of entities that you want expanded, identifying each entity by a given identifier. For example, the value space,attachments requests the expansion of entities for which the expand identifier is space and attachments.

You can use the . dot notation to specify expansion of entities within another entity. For example body.view would expand the content body and expand the view rendering of it.

Resources

audit

Request

Schema
{"id":"https://docs.atlassian.com/jira/REST/schema/audit-record#","title":"Audit Record","type":"object","properties":{"author":{"title":"User","type":"object","properties":{"profilePicture":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"displayName":{"type":"string"},"operations":{"type":"array","items":{"title":"Operation Check Result","type":"object","properties":{"operation":{"title":"Operation Key","type":"object"}},"additionalProperties":false}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"remoteAddress":{"type":"string"},"creationDate":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"},"category":{"type":"string"},"sysAdmin":{"type":"boolean"},"affectedObject":{"$ref":"#/definitions/affected-object"},"changedValues":{"type":"array","items":{"title":"Changed Value","type":"object","properties":{"name":{"type":"string"},"oldValue":{"type":"string"},"newValue":{"type":"string"}},"additionalProperties":false}},"associatedObjects":{"type":"array","items":{"$ref":"#/definitions/affected-object"}}},"definitions":{"affected-object":{"title":"Affected Object","type":"object","properties":{"name":{"type":"string"},"objectType":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false,"required":["sysAdmin"]}

Responses
    • Status - application/json

Fetch a paginated list of AuditRecord instances dating back to a certain time

Request
query parameters
parameter type description
startDate string
endDate string
start int

where to start within results set

limit int

Default: 1000

the maximum results to fetch

searchString string
Responses
    • Status - application/json
Request
query parameters
parameter type description
startDate string
endDate string
searchString string
format string

Default: csv

Responses
    • Status - application/zip
    • Status - text/csv

Fetches the current retention period

Responses
    • Status - application/json

Set the retention period to a new value. Can throw ServiceException if the retention period is too long

Request

Schema
{"id":"https://docs.atlassian.com/jira/REST/schema/retention-period#","title":"Retention Period","type":"object","properties":{"units":{"type":"string","enum":["Nanos","Micros","Millis","Seconds","Minutes","Hours","HalfDays","Days","Weeks","Months","Years","Decades","Centuries","Millennia","Eras","Forever"]},"number":{"type":"integer"}},"additionalProperties":false,"required":["number"]}

Responses
    • Status - application/json

Fetch a paginated list of AuditRecord instances dating back to a certain time

Request
query parameters
parameter type description
number long

Default: 3

the amount of time periods

units string

the units to use for the time periods eg. 'days', 'months' etc

start int

where to start within results set

limit int

Default: 1000

the maximum results to fetch

searchString string
Responses
    • Status - application/json

content

REST wrapper for the ContentService. Provides methods for finding, creating, modifying and deleting Content.Show more

Creates a new piece of Content or publishes the draft if the content id is present.

For the case publishing draft, a new piece of content will be created and all metadata from the draft will be transferred into the newly created content.

POST: http://localhost:9096/confluence/rest/api/content

                                 {
                                 "title":"My new title",
                                 "type":"page",
                                 "space": {
                                 "key":"TESTSPACEKEY"
                                 }
                                 "body":{
                                 "storage":{
                                 "value":"<p>New page data.</p>",
                                 "representation":"storage"
                                 }
                                 }
                                 }
                                 

For more examples see Atlassian Developers

The body property on content supports various content respresentations, the one used in the above example is storage format. The easiest way to generate storage format though is to generate it by creating a page in confluence using the confluence editor, then retrieve the storage format using the rest api by performing a GET on /rest/api/content?title=my+title&space=SPACEKEY&expand=body.storage

Request
query parameters
parameter type description
status string

Default: current

expand string

Default: body.storage,history,space,container.history,container.version,version,ancestors

Example
{"type":"page","status":"current","title":"Example Content title","space":{"key":"TST","metadata":{}},"ancestors":[],"operations":[],"children":{},"childTypes":{},"descendants":{},"body":{"storage":{"value":"<p>This is a new page</p>","representation":"storage","embeddedContent":[]}},"metadata":{},"restrictions":{}}

Schema
{"id":"https://docs.atlassian.com/jira/REST/schema/content#","title":"Content","type":"object","properties":{"id":{"$ref":"#/definitions/content-id"},"type":{"$ref":"#/definitions/content-type"},"status":{"$ref":"#/definitions/content-status"},"title":{"type":"string"},"space":{"type":"array","items":{"$ref":"#/definitions/space"}},"history":{"type":"array","items":{"$ref":"#/definitions/history"}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"$ref":"#/definitions/container"}},"body":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/content-body"}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/content-restriction"}},"additionalProperties":false}},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"container":{"title":"Container","type":"object"},"content":{"title":"Content","type":"object","properties":{"id":{"$ref":"#/definitions/content-id"},"type":{"$ref":"#/definitions/content-type"},"status":{"$ref":"#/definitions/content-status"},"title":{"type":"string"},"space":{"type":"array","items":{"$ref":"#/definitions/space"}},"history":{"type":"array","items":{"$ref":"#/definitions/history"}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"$ref":"#/definitions/container"}},"body":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/content-body"}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/content-restriction"}},"additionalProperties":false}},"additionalProperties":false},"content-body":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"content-id":{"title":"Content Id","type":"object"},"content-representation":{"title":"Content Representation","type":"object"},"content-restriction":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false},"content-status":{"title":"Content Status","type":"object"},"content-type":{"title":"Content Type","type":"object"},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"history":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"space":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}

Responses
    • Status 200 - application/json
      Returns a full JSON representation of a piece of content

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/content#","title":"Content","type":"object","properties":{"id":{"$ref":"#/definitions/content-id"},"type":{"$ref":"#/definitions/content-type"},"status":{"$ref":"#/definitions/content-status"},"title":{"type":"string"},"space":{"type":"array","items":{"$ref":"#/definitions/space"}},"history":{"type":"array","items":{"$ref":"#/definitions/history"}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"$ref":"#/definitions/container"}},"body":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/content-body"}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/content-restriction"}},"additionalProperties":false}},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"container":{"title":"Container","type":"object"},"content":{"title":"Content","type":"object","properties":{"id":{"$ref":"#/definitions/content-id"},"type":{"$ref":"#/definitions/content-type"},"status":{"$ref":"#/definitions/content-status"},"title":{"type":"string"},"space":{"type":"array","items":{"$ref":"#/definitions/space"}},"history":{"type":"array","items":{"$ref":"#/definitions/history"}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"$ref":"#/definitions/container"}},"body":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/content-body"}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/content-restriction"}},"additionalProperties":false}},"additionalProperties":false},"content-body":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"content-id":{"title":"Content Id","type":"object"},"content-representation":{"title":"Content Representation","type":"object"},"content-restriction":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false},"content-status":{"title":"Content Status","type":"object"},"content-type":{"title":"Content Type","type":"object"},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"history":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"space":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}

Returns a paginated list of Content.

Example request URI(s):

  • http://example.com/rest/api/content?spaceKey=TST&title=Cheese&expand=space,body.view,version,container
  • http://example.com/rest/api/content?type=blogpost&spaceKey=TST&title=Bacon&postingDay=2014-02-13&expand=space,body.view,version,container

Request
query parameters
parameter type description
type string

Default: page

the content type to return. Default value: page. Valid values: page, blogpost.

spaceKey string

the space key to find content under.

title string

the title of the page to find. Required for page type.

status string

list of statuses the content to be found is in. Defaults to current is not specified. If set to 'any', content in 'current' and 'trashed' status will be fetched. Does not support 'historical' status for now.

postingDay string

the posting day of the blog post. Required for blogpost type. Format: yyyy-mm-dd. Example: 2013-02-13

expand string

Default:

a comma separated list of properties to expand on the content. Default value: history,space,version.

trigger string
orderby string
start int

the start point of the collection to return

limit int

Default: 25

the limit of the number of items to return, this may be restricted by fixed system limits

Responses
    • Status 200 - application/json

      Example
      {"id":"1234","type":"page","status":"current","title":"Example Content title","space":{"id":11,"key":"TST","name":"Example space","description":{"plain":{"value":"This is an example space","representation":"plain","embeddedContent":[]}},"metadata":{},"_expandable":{"operations":"","permissions":""},"_links":{"self":"http://myhost:8080/confluence/rest/api/space/TST"}},"version":{"by":{"type":"known","username":"username","userKey":"","displayName":"Full Name","_expandable":{"operations":"","details":""}},"when":"2017-04-13T01:53:30.209Z","message":"change message for this edit","number":2,"minorEdit":false},"ancestors":[{"id":"123","type":"page","status":"current","ancestors":[],"operations":[],"children":{},"childTypes":{},"descendants":{},"body":{},"metadata":{},"restrictions":{},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/123"}}],"operations":[],"children":{},"childTypes":{},"descendants":{},"container":{"id":11,"key":"TST","name":"Example space","description":{"plain":{"value":"This is an example space","representation":"plain","embeddedContent":[]}},"metadata":{},"_expandable":{"operations":"","permissions":""},"_links":{"self":"http://myhost:8080/confluence/rest/api/space/TST"}},"body":{"view":{"value":"<p><h1>Example</h1>Some example content body</p>","representation":"view","embeddedContent":[],"_expandable":{"content":"/rest/api/content/1234"}}},"metadata":{},"restrictions":{},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/1234","base":"http://myhost:8080/confluence","context":"/confluence","collection":"/rest/api/content"}}

      Returns a full JSON representation of a list of content

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/page-response-of-content#","title":"Page Response of Content","type":"array","items":{"$ref":"#/definitions/content"},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"content":{"title":"Content","type":"object","properties":{"id":{"title":"Content Id","type":"object"},"type":{"title":"Content Type","type":"object"},"status":{"title":"Content Status","type":"object"},"title":{"type":"string"},"space":{"type":"array","items":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false}},"history":{"type":"array","items":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"title":"Container","type":"object"}},"body":{"type":"object","patternProperties":{".+":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"content-representation":{"title":"Content Representation","type":"object"},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}}}

    • Status 404
      Returned if the calling user does not have permission to view the content.

Updates a piece of Content, including changes to content status

To update a piece of content you must increment the version.number, supplying the number of the version you are creating. The title property can be updated on all content, body can be updated on all content that has a body (not attachments). For instance to update the content of a blogpost that currently has version 1:

PUT /rest/api/content/456


                                 {
                                 "version":{
                                 "number": 2
                                 },
                                 "title":"My new title",
                                 "type":"page",
                                 "body":{
                                 "storage":{
                                 "value":"<p>New page data.</p>",
                                 "representation":"storage"
                                 }
                                 }
                                 }
                                 

To update a page and change its parent page, supply the ancestors property with the request with the parent as the first ancestor i.e. to move a page to be a child of page with ID 789:

PUT /rest/api/content/456


                                 {
                                 "version":{
                                 "number": 2
                                 },
                                 "ancestors": [{"id":789}],
                                 "type":"page",
                                 "body":{
                                 "storage":{
                                 "value":"<p>New page data.</p>",
                                 "representation":"storage"
                                 }
                                 }
                                 }
                                 

Changing status

To restore a piece of content that has the status of trashed the content must have it's version incremented, and status set to current. No other field modifications will be performed when restoring a piece of content from the trash.

Request example to restore from trash: {"id": "557059","status": "current","version": {"number": 2}}

If the content you're updating has a draft, specifying status=draft will delete that draft and the body of the content will be replaced with the body specified in the request.

Request example to delete a draft:

PUT: http://localhost:9096/confluence/rest/api/content/2149384202?status=draft


                                 {
                                 "id":"2149384202",
                                 "status":"current",
                                 "version":{
                                 "number":4
                                 },
                                 "space":{
                                 "key":"TST"
                                 },
                                 "type":"page",
                                 "title":"page title",
                                 "body":{
                                 "storage":{
                                 "value":"<p>New page data.</p>",
                                 "representation":"storage"
                                 }
                                 }
                                 }
                                 

Updating a draft is not currently supported.

Request
query parameters
parameter type description
status string

the existing status of the content to be updated.

conflictPolicy string

Default: abort

Example
{"id":"3604482","type":"page","status":"current","title":"Example Content title","space":{"key":"TST","metadata":{}},"version":{"number":2,"minorEdit":false},"ancestors":[],"operations":[],"children":{},"childTypes":{},"descendants":{},"body":{"storage":{"value":"<p>This is the updated text for the new page</p>","representation":"storage","embeddedContent":[]}},"metadata":{},"restrictions":{}}

Schema
{"id":"https://docs.atlassian.com/jira/REST/schema/content#","title":"Content","type":"object","properties":{"id":{"$ref":"#/definitions/content-id"},"type":{"$ref":"#/definitions/content-type"},"status":{"$ref":"#/definitions/content-status"},"title":{"type":"string"},"space":{"type":"array","items":{"$ref":"#/definitions/space"}},"history":{"type":"array","items":{"$ref":"#/definitions/history"}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"$ref":"#/definitions/container"}},"body":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/content-body"}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/content-restriction"}},"additionalProperties":false}},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"container":{"title":"Container","type":"object"},"content":{"title":"Content","type":"object","properties":{"id":{"$ref":"#/definitions/content-id"},"type":{"$ref":"#/definitions/content-type"},"status":{"$ref":"#/definitions/content-status"},"title":{"type":"string"},"space":{"type":"array","items":{"$ref":"#/definitions/space"}},"history":{"type":"array","items":{"$ref":"#/definitions/history"}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"$ref":"#/definitions/container"}},"body":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/content-body"}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/content-restriction"}},"additionalProperties":false}},"additionalProperties":false},"content-body":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"content-id":{"title":"Content Id","type":"object"},"content-representation":{"title":"Content Representation","type":"object"},"content-restriction":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false},"content-status":{"title":"Content Status","type":"object"},"content-type":{"title":"Content Type","type":"object"},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"history":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"space":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}

Responses
    • Status 200 - application/json

      Example
      {"id":"1234","type":"page","status":"current","title":"Example Content title","space":{"id":11,"key":"TST","name":"Example space","description":{"plain":{"value":"This is an example space","representation":"plain","embeddedContent":[]}},"metadata":{},"_expandable":{"operations":"","permissions":""},"_links":{"self":"http://myhost:8080/confluence/rest/api/space/TST"}},"version":{"by":{"type":"known","username":"username","userKey":"","displayName":"Full Name","_expandable":{"operations":"","details":""}},"when":"2017-04-13T01:53:30.209Z","message":"change message for this edit","number":2,"minorEdit":false},"ancestors":[{"id":"123","type":"page","status":"current","ancestors":[],"operations":[],"children":{},"childTypes":{},"descendants":{},"body":{},"metadata":{},"restrictions":{},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/123"}}],"operations":[],"children":{},"childTypes":{},"descendants":{},"container":{"id":11,"key":"TST","name":"Example space","description":{"plain":{"value":"This is an example space","representation":"plain","embeddedContent":[]}},"metadata":{},"_expandable":{"operations":"","permissions":""},"_links":{"self":"http://myhost:8080/confluence/rest/api/space/TST"}},"body":{"view":{"value":"<p><h1>Example</h1>Some example content body</p>","representation":"view","embeddedContent":[],"_expandable":{"content":"/rest/api/content/1234"}}},"metadata":{},"restrictions":{},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/1234","base":"http://myhost:8080/confluence","context":"/confluence","collection":"/rest/api/content"}}

      Returns a full JSON representation of a piece of content

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/content#","title":"Content","type":"object","properties":{"id":{"$ref":"#/definitions/content-id"},"type":{"$ref":"#/definitions/content-type"},"status":{"$ref":"#/definitions/content-status"},"title":{"type":"string"},"space":{"type":"array","items":{"$ref":"#/definitions/space"}},"history":{"type":"array","items":{"$ref":"#/definitions/history"}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"$ref":"#/definitions/container"}},"body":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/content-body"}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/content-restriction"}},"additionalProperties":false}},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"container":{"title":"Container","type":"object"},"content":{"title":"Content","type":"object","properties":{"id":{"$ref":"#/definitions/content-id"},"type":{"$ref":"#/definitions/content-type"},"status":{"$ref":"#/definitions/content-status"},"title":{"type":"string"},"space":{"type":"array","items":{"$ref":"#/definitions/space"}},"history":{"type":"array","items":{"$ref":"#/definitions/history"}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"$ref":"#/definitions/container"}},"body":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/content-body"}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/content-restriction"}},"additionalProperties":false}},"additionalProperties":false},"content-body":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"content-id":{"title":"Content Id","type":"object"},"content-representation":{"title":"Content Representation","type":"object"},"content-restriction":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false},"content-status":{"title":"Content Status","type":"object"},"content-type":{"title":"Content Type","type":"object"},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"history":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"space":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}

    • Status 400
      if no space or no content type, or setup a wrong version type set to content, or status param is not draft and status content is current
    • Status 404
      if can not find draft with current content

Returns a piece of Content.

Example request URI(s):

  • http://example.com/rest/api/content/1234?expand=space,body.view,version,container
  • http://example.com/rest/api/content/1234?status=any

Request
query parameters
parameter type description
status string

list of Content statuses to filter results on. Default value: [current]

version int
embeddedContentRender string

Default: current

Mode used for rendering embedded content, such as attachments. Valid values are current (render the embedded content using the latest version) and version-at-save (render the embedded content using the version at the time of save). The default value is current.

expand string

Default: history,space,version

A comma separated list of properties to expand on the content. Default value: history,space,version We can also specify some extensions such as extensions.inlineProperties (for getting inline comment-specific properties) or extensions.resolution for the resolution status of each comment in the results

trigger string
Responses
    • Status 200 - application/json

      Example
      {"id":"1234","type":"page","status":"current","title":"Example Content title","space":{"id":11,"key":"TST","name":"Example space","description":{"plain":{"value":"This is an example space","representation":"plain","embeddedContent":[]}},"metadata":{},"_expandable":{"operations":"","permissions":""},"_links":{"self":"http://myhost:8080/confluence/rest/api/space/TST"}},"version":{"by":{"type":"known","username":"username","userKey":"","displayName":"Full Name","_expandable":{"operations":"","details":""}},"when":"2017-04-13T01:53:30.209Z","message":"change message for this edit","number":2,"minorEdit":false},"ancestors":[{"id":"123","type":"page","status":"current","ancestors":[],"operations":[],"children":{},"childTypes":{},"descendants":{},"body":{},"metadata":{},"restrictions":{},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/123"}}],"operations":[],"children":{},"childTypes":{},"descendants":{},"container":{"id":11,"key":"TST","name":"Example space","description":{"plain":{"value":"This is an example space","representation":"plain","embeddedContent":[]}},"metadata":{},"_expandable":{"operations":"","permissions":""},"_links":{"self":"http://myhost:8080/confluence/rest/api/space/TST"}},"body":{"view":{"value":"<p><h1>Example</h1>Some example content body</p>","representation":"view","embeddedContent":[],"_expandable":{"content":"/rest/api/content/1234"}}},"metadata":{},"restrictions":{},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/1234","base":"http://myhost:8080/confluence","context":"/confluence","collection":"/rest/api/content"}}

      Returns a full JSON representation of a piece of content

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/content#","title":"Content","type":"object","properties":{"id":{"$ref":"#/definitions/content-id"},"type":{"$ref":"#/definitions/content-type"},"status":{"$ref":"#/definitions/content-status"},"title":{"type":"string"},"space":{"type":"array","items":{"$ref":"#/definitions/space"}},"history":{"type":"array","items":{"$ref":"#/definitions/history"}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"$ref":"#/definitions/container"}},"body":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/content-body"}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/content-restriction"}},"additionalProperties":false}},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"container":{"title":"Container","type":"object"},"content":{"title":"Content","type":"object","properties":{"id":{"$ref":"#/definitions/content-id"},"type":{"$ref":"#/definitions/content-type"},"status":{"$ref":"#/definitions/content-status"},"title":{"type":"string"},"space":{"type":"array","items":{"$ref":"#/definitions/space"}},"history":{"type":"array","items":{"$ref":"#/definitions/history"}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"$ref":"#/definitions/container"}},"body":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/content-body"}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/content-restriction"}},"additionalProperties":false}},"additionalProperties":false},"content-body":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"content-id":{"title":"Content Id","type":"object"},"content-representation":{"title":"Content Representation","type":"object"},"content-restriction":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false},"content-status":{"title":"Content Status","type":"object"},"content-type":{"title":"Content Type","type":"object"},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"history":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"space":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}

    • Status 404
      Returned if there is no content with the given id, or if the calling user does not have permission to view the content.

Trashes or purges a piece of Content, based on its {@link ContentType} and {@link ContentStatus}.

There are three cases:

  • If the content is trashable and its status is {@link ContentStatus#CURRENT}, it will be trashed.
  • If the content is trashable, its status is {@link ContentStatus#TRASHED} and the "status" query parameter in the request is "trashed", the content will be purged from the trash and deleted permanently.
  • If the content is not trashable it will be deleted permanently without being trashed.

Request
query parameters
parameter type description
status string

the status of the content to be deleted

Responses
    • Status 200 - application/json
      Returned if successfully trashed.
    • Status 204
      Returned if successfully purged.
    • Status 404
      Returned if there is no content with the given id, or if the calling user does not have permission to trash or purge the content.

Returns the history of a particular piece of content

Example request URI(s):

  • http://example.com/rest/api/content/1234/history

Request
query parameters
parameter type description
expand string

Default: previousVersion,nextVersion,lastUpdated

the properties on content history to expand

Responses
    • Status 200 - application/json
      Returns a full JSON representation of the content's history

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/history#","title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"$ref":"#/definitions/contributors"}}},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"content":{"title":"Content","type":"object","properties":{"id":{"title":"Content Id","type":"object"},"type":{"title":"Content Type","type":"object"},"status":{"title":"Content Status","type":"object"},"title":{"type":"string"},"space":{"type":"array","items":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false}},"history":{"type":"array","items":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"$ref":"#/definitions/contributors"}}},"additionalProperties":false,"required":["latest"]}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"title":"Container","type":"object"}},"body":{"type":"object","patternProperties":{".+":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"content-representation":{"title":"Content Representation","type":"object"},"contributors":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false,"required":["latest"]}

    • Status 404
      Returned if there is no content with the given id, or if the calling user does not have permission to view the content.

Returns the body of a macro (in storage format) with the given hash. This resource is primarily used by connect applications that require the body of macro to perform their work.

The hash is generated by connect during render time of the local macro holder and is usually only relevant during the scope of one request. For optimisation purposes, this hash will usually live for multiple requests.

Collecting a macro by its hash should now be considered deprecated and will be replaced, transparently with macroIds. This resource is currently only called from connect addons which will eventually all use the {@link #getContentById(com.atlassian.confluence.api.model.content.id.ContentId, java.util.List, Integer, String)} resource.

To make the migration as seamless as possible, this resource will match macros against a generated hash or a stored macroId. This will allow add ons to work during the migration period.

Responses
    • Status 200 - application/json

      Example
      {"id":"1234","type":"page","status":"current","title":"Example Content title","space":{"id":11,"key":"TST","name":"Example space","description":{"plain":{"value":"This is an example space","representation":"plain","embeddedContent":[]}},"metadata":{},"_expandable":{"operations":"","permissions":""},"_links":{"self":"http://myhost:8080/confluence/rest/api/space/TST"}},"version":{"by":{"type":"known","username":"username","userKey":"","displayName":"Full Name","_expandable":{"operations":"","details":""}},"when":"2017-04-13T01:53:30.319Z","message":"initial edit","number":1,"minorEdit":false},"ancestors":[],"operations":[],"children":{},"childTypes":{},"descendants":{},"container":{"id":11,"key":"TST","name":"Example space","description":{"plain":{"value":"This is an example space","representation":"plain","embeddedContent":[]}},"metadata":{},"_expandable":{"operations":"","permissions":""},"_links":{"self":"http://myhost:8080/confluence/rest/api/space/TST"}},"body":{"storage":{"value":"<h1>Example</h1><ac:macro ac:name=\"macro\"><ac:rich-text-body><p>This is the body of a macro.</p></ac:rich-text-body></ac:macro>","representation":"storage","embeddedContent":[],"_expandable":{"content":"/rest/api/content/1234"}}},"metadata":{},"restrictions":{},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/1234","base":"http://myhost:8080/confluence","context":"/confluence","collection":"/rest/api/content"}}

      Returns a json representation of a macro.

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/macro-instance#","title":"Macro Instance","type":"object","properties":{"name":{"type":"string"},"body":{"type":"string"},"parameters":{"type":"object","patternProperties":{".+":{"title":"Macro Parameter Instance","type":"object","properties":{"value":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false}

    • Status 404
      Returned if there is no content with the given id, or if the calling user does not have permission to view the content, or there is no macro matching the given hash or id.

Returns the body of a macro (in storage format) with the given id. This resource is primarily used by connect applications that require the body of macro to perform their work.

When content is created, if no macroId is specified, then Confluence will generate a random id. The id is persisted as the content is saved and only modified by Confluence if there are conflicting IDs.

To preserve backwards compatibility this resource will also match on the hash of the macro body, even if a macroId is found. This check will become redundant as pages get macroId's generated for them and transparently propagate out to all instances.

Responses
    • Status 200 - application/json

      Example
      {"id":"1234","type":"page","status":"current","title":"Example Content title","space":{"id":11,"key":"TST","name":"Example space","description":{"plain":{"value":"This is an example space","representation":"plain","embeddedContent":[]}},"metadata":{},"_expandable":{"operations":"","permissions":""},"_links":{"self":"http://myhost:8080/confluence/rest/api/space/TST"}},"version":{"by":{"type":"known","username":"username","userKey":"","displayName":"Full Name","_expandable":{"operations":"","details":""}},"when":"2017-04-13T01:53:30.319Z","message":"initial edit","number":1,"minorEdit":false},"ancestors":[],"operations":[],"children":{},"childTypes":{},"descendants":{},"container":{"id":11,"key":"TST","name":"Example space","description":{"plain":{"value":"This is an example space","representation":"plain","embeddedContent":[]}},"metadata":{},"_expandable":{"operations":"","permissions":""},"_links":{"self":"http://myhost:8080/confluence/rest/api/space/TST"}},"body":{"storage":{"value":"<h1>Example</h1><ac:macro ac:name=\"macro\"><ac:rich-text-body><p>This is the body of a macro.</p></ac:rich-text-body></ac:macro>","representation":"storage","embeddedContent":[],"_expandable":{"content":"/rest/api/content/1234"}}},"metadata":{},"restrictions":{},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/1234","base":"http://myhost:8080/confluence","context":"/confluence","collection":"/rest/api/content"}}

      Returns a json representation of a macro.

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/macro-instance#","title":"Macro Instance","type":"object","properties":{"name":{"type":"string"},"body":{"type":"string"},"parameters":{"type":"object","patternProperties":{".+":{"title":"Macro Parameter Instance","type":"object","properties":{"value":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false}

    • Status 404
      Returned if there is no content with the given id, or if the calling user does not have permission to view the content, or there is no macro matching the given id or hash.

Fetch a list of content using the Confluence Query Language (CQL). See : Advanced searching using CQL

For example :

Example request URI(s):

  • http://localhost:8080/confluence/rest/api/content/search?cql=creator=currentUser()&cqlcontext={%22spaceKey%22:%22TST%22, %22contentId%22:%2255%22}
  • http://localhost:8080/confluence/rest/api/content/search?cql=space=DEV%20AND%20label=docs&expand=space,metadata.labels&limit=10

Request
query parameters
parameter type description
cql string

a cql query string to use to locate content

cqlcontext string

the context to execute a cql search in, this is the json serialized form of SearchContext

expand string

Default:

a comma separated list of properties to expand on the content.

start int

the start point of the collection to return

limit int

Default: 25

the limit of the number of items to return, this may be restricted by fixed system limits

Responses
    • Status 200 - application/json
      Returns a paginated list of content

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/page-response-of-content#","title":"Page Response of Content","type":"array","items":{"$ref":"#/definitions/content"},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"content":{"title":"Content","type":"object","properties":{"id":{"title":"Content Id","type":"object"},"type":{"title":"Content Type","type":"object"},"status":{"title":"Content Status","type":"object"},"title":{"type":"string"},"space":{"type":"array","items":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false}},"history":{"type":"array","items":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"title":"Container","type":"object"}},"body":{"type":"object","patternProperties":{".+":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"content-representation":{"title":"Content Representation","type":"object"},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}}}

    • Status 400
      Returned if the CQL is invalid or missing

content/{id}/child

REST wrapper for the {@link ChildContentService}.

Returns a map of the direct children of a piece of Content. Content can have multiple types of children - for example a Page can have children that are also Pages, but it can also have Comments and Attachments.

The {@link ContentType}(s) of the children returned is specified by the "expand" query parameter in the request - this parameter can include expands for multiple child types.
If no types are included in the expand parameter, the map returned will just list the child types that are available to be expanded for the {@link Content} referenced by the "id" path parameter.

Example request URI(s):

  • http://example.com/rest/api/content/1234/child
  • http://example.com/rest/api/content/1234/child?expand=page.body.VIEW
  • http://example.com/rest/api/content/1234/child?expand=page&start=20&limit=10

Request
query parameters
parameter type description
expand string

Default:

a comma separated list of properties to expand on the children

parentVersion int

Default: 0

an int representing the version of the content to retrieve children for

Responses
    • Status 200 - application/json

      Example
      {"page":{"results":[{"id":"1234","type":"page","status":"current","title":"Example Content title","links":{},"space":{"id":11,"key":"TST","name":"Example space","icon":null,"description":{"plain":{"representation":"plain","value":"This is an example space","webresource":null,"embeddedContent":[]}},"homepage":null,"links":{},"metadata":{},"operations":null,"permissions":null},"history":null,"version":{"by":{"type":"known","username":"username","displayName":"Full Name","userKey":"","operations":null,"details":null},"when":"2017-04-13T01:53:30.336Z","message":"change message for this edit","number":2,"minorEdit":false,"content":null},"ancestors":[{"id":"123","type":"page","status":"current","links":{},"space":null,"history":null,"version":null,"ancestors":[],"operations":[],"children":{},"childTypes":{},"descendants":{},"container":null,"body":{},"metadata":{},"extensions":{},"restrictions":{}}],"operations":[],"children":{},"childTypes":{},"descendants":{},"container":{"id":11,"key":"TST","name":"Example space","icon":null,"description":{"plain":{"representation":"plain","value":"This is an example space","webresource":null,"embeddedContent":[]}},"homepage":null,"links":{},"metadata":{},"operations":null,"permissions":null},"body":{"view":{"representation":"view","value":"<p><h1>Example</h1>Some example content body</p>","webresource":null,"embeddedContent":[],"content":null}},"metadata":{},"extensions":{},"restrictions":{}}],"size":1}}

      Returns a JSON map representing multiple ordered collections of content children, keyed by content type

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/map-of-content-type#","title":"Map of Content Type","type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"content":{"title":"Content","type":"object","properties":{"id":{"title":"Content Id","type":"object"},"type":{"title":"Content Type","type":"object"},"status":{"title":"Content Status","type":"object"},"title":{"type":"string"},"space":{"type":"array","items":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false}},"history":{"type":"array","items":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"title":"Container","type":"object"}},"body":{"type":"object","patternProperties":{".+":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"content-representation":{"title":"Content Representation","type":"object"},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}

    • Status 404
      Returned if there is no content with the given id, or if the calling user does not have permission to view the content.

Returns the direct children of a piece of Content, limited to a single child type.

The {@link ContentType}(s) of the children returned is specified by the "type" path parameter in the request.

Example request URI(s):

  • http://example.com/rest/api/content/1234/child/page
  • http://example.com/rest/api/content/1234/child/comment
  • http://example.com/rest/api/content/1234/child/page?expand=body.view
  • http://example.com/rest/api/content/1234/child/comment?start=20&limit=10

Request
query parameters
parameter type description
expand string

Default:

a comma separated list of properties to expand on the children

parentVersion int

Default: 0

an int representing the version of the content to retrieve children for

start int

(optional, default: 0) the index of the first item within the result set that should be returned

limit int

Default: 25

(optional, default: site limit) how many items should be returned after the start index

Responses
    • Status 200 - application/json

      Example
      {"page":{"results":[{"id":"1234","type":"page","status":"current","title":"Example Content title","links":{},"space":{"id":11,"key":"TST","name":"Example space","icon":null,"description":{"plain":{"representation":"plain","value":"This is an example space","webresource":null,"embeddedContent":[]}},"homepage":null,"links":{},"metadata":{},"operations":null,"permissions":null},"history":null,"version":{"by":{"type":"known","username":"username","displayName":"Full Name","userKey":"","operations":null,"details":null},"when":"2017-04-13T01:53:30.336Z","message":"change message for this edit","number":2,"minorEdit":false,"content":null},"ancestors":[{"id":"123","type":"page","status":"current","links":{},"space":null,"history":null,"version":null,"ancestors":[],"operations":[],"children":{},"childTypes":{},"descendants":{},"container":null,"body":{},"metadata":{},"extensions":{},"restrictions":{}}],"operations":[],"children":{},"childTypes":{},"descendants":{},"container":{"id":11,"key":"TST","name":"Example space","icon":null,"description":{"plain":{"representation":"plain","value":"This is an example space","webresource":null,"embeddedContent":[]}},"homepage":null,"links":{},"metadata":{},"operations":null,"permissions":null},"body":{"view":{"representation":"view","value":"<p><h1>Example</h1>Some example content body</p>","webresource":null,"embeddedContent":[],"content":null}},"metadata":{},"extensions":{},"restrictions":{}}],"size":1}}

      Returns a JSON map representing multiple ordered collections of content children, keyed by content type

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/rest-list-of-content#","title":"Rest List of Content","type":"array","items":{"$ref":"#/definitions/content"},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"content":{"title":"Content","type":"object","properties":{"id":{"title":"Content Id","type":"object"},"type":{"title":"Content Type","type":"object"},"status":{"title":"Content Status","type":"object"},"title":{"type":"string"},"space":{"type":"array","items":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false}},"history":{"type":"array","items":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"title":"Container","type":"object"}},"body":{"type":"object","patternProperties":{".+":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"content-representation":{"title":"Content Representation","type":"object"},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}}}

    • Status 404
      Returned if there is no content with the given id, or if the calling user does not have permission to view the content.

Returns the comments of a content

Example request URI(s):

  • http://example.com/rest/api/content/1234/child/comment
  • http://example.com/rest/api/content/1234/child/comment?expand=body.view
  • http://example.com/rest/api/content/1234/child/comment?start=20&limit=10
  • http://example.com/rest/api/content/1234/child/comment?location=footer&location=inline&location=resolved
  • http://example.com/rest/api/content/1234/child/comment?expand=extensions.inlineProperties,extensions.resolution

Request
query parameters
parameter type description
expand string

Default:

a comma separated list of properties to expand on the children. We can also specify some extensions such as extensions.inlineProperties (for getting inline comment-specific properties) or extensions.resolution for the resolution status of each comment in the results

parentVersion int

Default: 0

an int representing the version of the content to retrieve children for

start int

(optional, default: 0) the index of the first item within the result set that should be returned

limit int

Default: 25

(optional, default: site limit) how many items should be returned after the start index

location string

(optional, default: "" means all) the location of the comments. Possible values are: "inline", "footer", "resolved". You can define multiple location params. The results will be the comments matched by any location.

depth string

Default:

(optional, default: "") the depth of the comments. Possible values are: "" (ROOT only), "all"

Responses
    • Status 200 - application/json

      Example
      {"page":{"results":[{"id":"1234","type":"page","status":"current","title":"Example Content title","links":{},"space":{"id":11,"key":"TST","name":"Example space","icon":null,"description":{"plain":{"representation":"plain","value":"This is an example space","webresource":null,"embeddedContent":[]}},"homepage":null,"links":{},"metadata":{},"operations":null,"permissions":null},"history":null,"version":{"by":{"type":"known","username":"username","displayName":"Full Name","userKey":"","operations":null,"details":null},"when":"2017-04-13T01:53:30.336Z","message":"change message for this edit","number":2,"minorEdit":false,"content":null},"ancestors":[{"id":"123","type":"page","status":"current","links":{},"space":null,"history":null,"version":null,"ancestors":[],"operations":[],"children":{},"childTypes":{},"descendants":{},"container":null,"body":{},"metadata":{},"extensions":{},"restrictions":{}}],"operations":[],"children":{},"childTypes":{},"descendants":{},"container":{"id":11,"key":"TST","name":"Example space","icon":null,"description":{"plain":{"representation":"plain","value":"This is an example space","webresource":null,"embeddedContent":[]}},"homepage":null,"links":{},"metadata":{},"operations":null,"permissions":null},"body":{"view":{"representation":"view","value":"<p><h1>Example</h1>Some example content body</p>","webresource":null,"embeddedContent":[],"content":null}},"metadata":{},"extensions":{},"restrictions":{}}],"size":1}}

      Returns a JSON map representing multiple ordered collections of content children, keyed by content type

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/rest-list-of-content#","title":"Rest List of Content","type":"array","items":{"$ref":"#/definitions/content"},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"content":{"title":"Content","type":"object","properties":{"id":{"title":"Content Id","type":"object"},"type":{"title":"Content Type","type":"object"},"status":{"title":"Content Status","type":"object"},"title":{"type":"string"},"space":{"type":"array","items":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false}},"history":{"type":"array","items":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"title":"Container","type":"object"}},"body":{"type":"object","patternProperties":{".+":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"content-representation":{"title":"Content Representation","type":"object"},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}}}

    • Status 404
      Returned if there is no content with the given id, or if the calling user does not have permission to view the content.

content/{id}/child/attachment

CRUD operations for Attachments on Content.

Returns a paginated list of attachment Content entities within a single container.

Example request URI(s):

  • http://example.com/rest/api/content/1234/child/attachment?start=0&limit=10
  • http://example.com/rest/api/content/1234/child/attachment?filename=myfile.txt&expand=version,container

Request
query parameters
parameter type description
expand string

Default:

a comma separated list of properties to expand on the Attachments returned. Optional.

start int

the index of the first item within the result set that should be returned. Optional.

limit int

Default: 50

how many items should be returned after the start index. Optional.

filename string

(optional) filter parameter to return only the Attachment with the matching file name. Optional.

mediaType string

(optional) filter parameter to return only Attachments with a matching Media-Type. Optional.

Responses
    • Status 200 - application/json

      Example
      {"results":[{"id":"att5678","type":"attachment","status":"current","title":"myfile.txt","version":{"by":{"type":"known","username":"username","userKey":"","displayName":"Full Name","_expandable":{"operations":"","details":""}},"when":"2017-04-13T01:53:30.410Z","message":"change message for this edit","number":2,"minorEdit":false},"ancestors":[],"operations":[],"children":{},"childTypes":{},"descendants":{},"container":{"id":"1234","type":"page","status":"current","title":"Example Content title","space":{"id":11,"key":"TST","name":"Example space","description":{"plain":{"value":"This is an example space","representation":"plain","embeddedContent":[]}},"metadata":{},"_expandable":{"operations":"","permissions":""},"_links":{"self":"http://myhost:8080/confluence/rest/api/space/TST"}},"version":{"by":{"type":"known","username":"username","userKey":"","displayName":"Full Name","_expandable":{"operations":"","details":""}},"when":"2017-04-13T01:53:30.410Z","message":"change message for this edit","number":2,"minorEdit":false},"ancestors":[{"id":"123","type":"page","status":"current","ancestors":[],"operations":[],"children":{},"childTypes":{},"descendants":{},"body":{},"metadata":{},"restrictions":{},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/123"}}],"operations":[],"children":{},"childTypes":{},"descendants":{},"container":{"id":11,"key":"TST","name":"Example space","description":{"plain":{"value":"This is an example space","representation":"plain","embeddedContent":[]}},"metadata":{},"_expandable":{"operations":"","permissions":""},"_links":{"self":"http://myhost:8080/confluence/rest/api/space/TST"}},"body":{"view":{"value":"<p><h1>Example</h1>Some example content body</p>","representation":"view","embeddedContent":[],"_expandable":{"content":"/rest/api/content/1234"}}},"metadata":{},"restrictions":{},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/1234"}},"body":{},"metadata":{"comment":"This is my File","mediaType":"text/plain"},"restrictions":{},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/att5678"}}],"size":1,"_links":{"base":"http://myhost:8080/confluence","context":"/confluence"}}

      Returns a JSON representation of a list of attachment Content entities

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/rest-list-of-content#","title":"Rest List of Content","type":"array","items":{"$ref":"#/definitions/content"},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"content":{"title":"Content","type":"object","properties":{"id":{"title":"Content Id","type":"object"},"type":{"title":"Content Type","type":"object"},"status":{"title":"Content Status","type":"object"},"title":{"type":"string"},"space":{"type":"array","items":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false}},"history":{"type":"array","items":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"title":"Container","type":"object"}},"body":{"type":"object","patternProperties":{".+":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"content-representation":{"title":"Content Representation","type":"object"},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}}}

    • Status 404
      Returned if there is no content with the given id, or if the calling user does not have permission to view the content.

Add one or more attachments to a Confluence Content entity, with optional comments.

Comments are optional, but if included there must be as many comments as there are files, and the comments must be in the same order as the files.

This resource expects a multipart post. The media-type multipart/form-data is defined in RFC 1867. Most client libraries have classes that make dealing with multipart posts simple. For instance, in Java the Apache HTTP Components library provides a MultiPartEntity that makes it simple to submit a multipart POST.

In order to protect against XSRF attacks, because this method accepts multipart/form-data, it has XSRF protection on it. This means you must submit a header of X-Atlassian-Token: nocheck with the request, otherwise it will be blocked.

The name of the multipart/form-data parameter that contains attachments must be "file"

A simple example to attach a file called "myfile.txt" to the container with id "123", with a comment included:

curl -D- -u admin:admin -X POST -H "X-Atlassian-Token: nocheck" -F "file=@myfile.txt" -F "comment=This is my File" http://myhost/rest/api/content/123/child/attachment

A example to attach a file called "myfile.txt" to the container with id "123", with a comment, and set the minorEdits flag to be true:

curl -D- -u admin:admin -X POST -H "X-Atlassian-Token: nocheck" -F "file=@myfile.txt" -F "minorEdit=true" -F "comment=This
                                 is my File" http://myhost/rest/api/content/123/child/attachment

An example to attach the same file, with no comment:

curl -D- -u admin:admin -X POST -H "X-Atlassian-Token: nocheck" -F "file=@myfile.txt" http://myhost/rest/api/content/123/child/attachment

Example request URI(s):

  • http://example.com/rest/api/content/1234/child/attachment

Request
query parameters
parameter type description
status string

Default: current

a string containing the status of the attachments content container, supports current or draft, defaults to current

Responses
    • Status 200 - application/json

      Example
      {"results":[{"id":"att5678","type":"attachment","status":"current","title":"myfile.txt","version":{"by":{"type":"known","username":"username","userKey":"","displayName":"Full Name","_expandable":{"operations":"","details":""}},"when":"2017-04-13T01:53:30.410Z","message":"change message for this edit","number":2,"minorEdit":false},"ancestors":[],"operations":[],"children":{},"childTypes":{},"descendants":{},"container":{"id":"1234","type":"page","status":"current","title":"Example Content title","space":{"id":11,"key":"TST","name":"Example space","description":{"plain":{"value":"This is an example space","representation":"plain","embeddedContent":[]}},"metadata":{},"_expandable":{"operations":"","permissions":""},"_links":{"self":"http://myhost:8080/confluence/rest/api/space/TST"}},"version":{"by":{"type":"known","username":"username","userKey":"","displayName":"Full Name","_expandable":{"operations":"","details":""}},"when":"2017-04-13T01:53:30.410Z","message":"change message for this edit","number":2,"minorEdit":false},"ancestors":[{"id":"123","type":"page","status":"current","ancestors":[],"operations":[],"children":{},"childTypes":{},"descendants":{},"body":{},"metadata":{},"restrictions":{},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/123"}}],"operations":[],"children":{},"childTypes":{},"descendants":{},"container":{"id":11,"key":"TST","name":"Example space","description":{"plain":{"value":"This is an example space","representation":"plain","embeddedContent":[]}},"metadata":{},"_expandable":{"operations":"","permissions":""},"_links":{"self":"http://myhost:8080/confluence/rest/api/space/TST"}},"body":{"view":{"value":"<p><h1>Example</h1>Some example content body</p>","representation":"view","embeddedContent":[],"_expandable":{"content":"/rest/api/content/1234"}}},"metadata":{},"restrictions":{},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/1234"}},"body":{},"metadata":{"comment":"This is my File","mediaType":"text/plain"},"restrictions":{},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/att5678"}}],"size":1,"_links":{"base":"http://myhost:8080/confluence","context":"/confluence"}}

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/rest-list-of-content#","title":"Rest List of Content","type":"array","items":{"$ref":"#/definitions/content"},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"content":{"title":"Content","type":"object","properties":{"id":{"title":"Content Id","type":"object"},"type":{"title":"Content Type","type":"object"},"status":{"title":"Content Status","type":"object"},"title":{"type":"string"},"space":{"type":"array","items":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false}},"history":{"type":"array","items":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"title":"Container","type":"object"}},"body":{"type":"object","patternProperties":{".+":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"content-representation":{"title":"Content Representation","type":"object"},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}}}

    • Status 403
      Returned if attachments is disabled or if you don't have permission to add attachments to this content.
    • Status 404
      Returned if the requested content is not found, the user does not have permission to view it, or if the attachments exceeds the maximum configured attachment size.

Add or update one or more attachments to a Confluence Content entity, with optional comments.

Comments are optional, but if included there must be as many comments as there are files, and the comments must be in the same order as the files.

This resource expects a multipart post. The media-type multipart/form-data is defined in RFC 1867. Most client libraries have classes that make dealing with multipart posts simple. For instance, in Java the Apache HTTP Components library provides a MultiPartEntity that makes it simple to submit a multipart POST.

In order to protect against XSRF attacks, because this method accepts multipart/form-data, it has XSRF protection on it. This means you must submit a header of X-Atlassian-Token: nocheck with the request, otherwise it will be blocked.

The name of the multipart/form-data parameter that contains attachments must be "file"

A simple example to attach a file called "myfile.txt" to the container with id "123", with a comment included:

curl -D- -u admin:admin -X POST -H "X-Atlassian-Token: nocheck" -F "file=@myfile.txt" -F "comment=This is my File" http://myhost/rest/api/content/123/child/attachment

A example to attach a file called "myfile.txt" to the container with id "123", with a comment, and set the minorEdits flag to be true:

curl -D- -u admin:admin -X POST -H "X-Atlassian-Token: nocheck" -F "file=@myfile.txt" -F "minorEdit=true" -F "comment=This
                                 is my File" http://myhost/rest/api/content/123/child/attachment

An example to attach the same file, with no comment:

curl -D- -u admin:admin -X POST -H "X-Atlassian-Token: nocheck" -F "file=@myfile.txt" http://myhost/rest/api/content/123/child/attachment

Example request URI(s):

  • http://example.com/rest/api/content/1234/child/attachment

Request
query parameters
parameter type description
status string

Default: current

a string containing the status of the attachments content container, supports current or draft, defaults to current

Responses
    • Status 200 - application/json

      Example
      {"results":[{"id":"att5678","type":"attachment","status":"current","title":"myfile.txt","version":{"by":{"type":"known","username":"username","userKey":"","displayName":"Full Name","_expandable":{"operations":"","details":""}},"when":"2017-04-13T01:53:30.410Z","message":"change message for this edit","number":2,"minorEdit":false},"ancestors":[],"operations":[],"children":{},"childTypes":{},"descendants":{},"container":{"id":"1234","type":"page","status":"current","title":"Example Content title","space":{"id":11,"key":"TST","name":"Example space","description":{"plain":{"value":"This is an example space","representation":"plain","embeddedContent":[]}},"metadata":{},"_expandable":{"operations":"","permissions":""},"_links":{"self":"http://myhost:8080/confluence/rest/api/space/TST"}},"version":{"by":{"type":"known","username":"username","userKey":"","displayName":"Full Name","_expandable":{"operations":"","details":""}},"when":"2017-04-13T01:53:30.410Z","message":"change message for this edit","number":2,"minorEdit":false},"ancestors":[{"id":"123","type":"page","status":"current","ancestors":[],"operations":[],"children":{},"childTypes":{},"descendants":{},"body":{},"metadata":{},"restrictions":{},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/123"}}],"operations":[],"children":{},"childTypes":{},"descendants":{},"container":{"id":11,"key":"TST","name":"Example space","description":{"plain":{"value":"This is an example space","representation":"plain","embeddedContent":[]}},"metadata":{},"_expandable":{"operations":"","permissions":""},"_links":{"self":"http://myhost:8080/confluence/rest/api/space/TST"}},"body":{"view":{"value":"<p><h1>Example</h1>Some example content body</p>","representation":"view","embeddedContent":[],"_expandable":{"content":"/rest/api/content/1234"}}},"metadata":{},"restrictions":{},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/1234"}},"body":{},"metadata":{"comment":"This is my File","mediaType":"text/plain"},"restrictions":{},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/att5678"}}],"size":1,"_links":{"base":"http://myhost:8080/confluence","context":"/confluence"}}

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/rest-list-of-content#","title":"Rest List of Content","type":"array","items":{"$ref":"#/definitions/content"},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"content":{"title":"Content","type":"object","properties":{"id":{"title":"Content Id","type":"object"},"type":{"title":"Content Type","type":"object"},"status":{"title":"Content Status","type":"object"},"title":{"type":"string"},"space":{"type":"array","items":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false}},"history":{"type":"array","items":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"title":"Container","type":"object"}},"body":{"type":"object","patternProperties":{".+":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"content-representation":{"title":"Content Representation","type":"object"},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}}}

    • Status 403
      Returned if attachments is disabled or if you don't have permission to add attachments to this content.
    • Status 404
      Returned if the requested content is not found, the user does not have permission to view it, or if the attachments exceeds the maximum configured attachment size.

Update the non-binary data of an Attachment.

This resource can be used to update an attachment's filename, media-type, comment, and parent container.

Example request URI(s):

  • http://example.com/rest/api/content/1234/child/attachment/5678

Request

Example
{"id":"att5678","type":"attachment","status":"current","title":"new_file_name.txt","version":{"number":2,"minorEdit":false},"ancestors":[],"operations":[],"children":{},"childTypes":{},"descendants":{},"body":{},"metadata":{},"restrictions":{}}

Schema
{"id":"https://docs.atlassian.com/jira/REST/schema/content#","title":"Content","type":"object","properties":{"id":{"$ref":"#/definitions/content-id"},"type":{"$ref":"#/definitions/content-type"},"status":{"$ref":"#/definitions/content-status"},"title":{"type":"string"},"space":{"type":"array","items":{"$ref":"#/definitions/space"}},"history":{"type":"array","items":{"$ref":"#/definitions/history"}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"$ref":"#/definitions/container"}},"body":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/content-body"}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/content-restriction"}},"additionalProperties":false}},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"container":{"title":"Container","type":"object"},"content":{"title":"Content","type":"object","properties":{"id":{"$ref":"#/definitions/content-id"},"type":{"$ref":"#/definitions/content-type"},"status":{"$ref":"#/definitions/content-status"},"title":{"type":"string"},"space":{"type":"array","items":{"$ref":"#/definitions/space"}},"history":{"type":"array","items":{"$ref":"#/definitions/history"}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"$ref":"#/definitions/container"}},"body":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/content-body"}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/content-restriction"}},"additionalProperties":false}},"additionalProperties":false},"content-body":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"content-id":{"title":"Content Id","type":"object"},"content-representation":{"title":"Content Representation","type":"object"},"content-restriction":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false},"content-status":{"title":"Content Status","type":"object"},"content-type":{"title":"Content Type","type":"object"},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"history":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"space":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}

Responses
    • Status 200 - application/json

      Example
      {"id":"att5678","type":"attachment","status":"current","title":"myfile.txt","version":{"by":{"type":"known","username":"username","userKey":"","displayName":"Full Name","_expandable":{"operations":"","details":""}},"when":"2017-04-13T01:53:30.325Z","message":"change message for this edit","number":2,"minorEdit":false},"ancestors":[],"operations":[],"children":{},"childTypes":{},"descendants":{},"container":{"id":"1234","type":"page","status":"current","title":"Example Content title","space":{"id":11,"key":"TST","name":"Example space","description":{"plain":{"value":"This is an example space","representation":"plain","embeddedContent":[]}},"metadata":{},"_expandable":{"operations":"","permissions":""},"_links":{"self":"http://myhost:8080/confluence/rest/api/space/TST"}},"version":{"by":{"type":"known","username":"username","userKey":"","displayName":"Full Name","_expandable":{"operations":"","details":""}},"when":"2017-04-13T01:53:30.325Z","message":"change message for this edit","number":2,"minorEdit":false},"ancestors":[{"id":"123","type":"page","status":"current","ancestors":[],"operations":[],"children":{},"childTypes":{},"descendants":{},"body":{},"metadata":{},"restrictions":{},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/123"}}],"operations":[],"children":{},"childTypes":{},"descendants":{},"container":{"id":11,"key":"TST","name":"Example space","description":{"plain":{"value":"This is an example space","representation":"plain","embeddedContent":[]}},"metadata":{},"_expandable":{"operations":"","permissions":""},"_links":{"self":"http://myhost:8080/confluence/rest/api/space/TST"}},"body":{"view":{"value":"<p><h1>Example</h1>Some example content body</p>","representation":"view","embeddedContent":[],"_expandable":{"content":"/rest/api/content/1234"}}},"metadata":{},"restrictions":{},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/1234"}},"body":{},"metadata":{"comment":"This is my File","mediaType":"text/plain"},"restrictions":{},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/att5678","base":"http://myhost:8080/confluence","context":"/confluence","collection":"/rest/api/content"}}

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/content#","title":"Content","type":"object","properties":{"id":{"$ref":"#/definitions/content-id"},"type":{"$ref":"#/definitions/content-type"},"status":{"$ref":"#/definitions/content-status"},"title":{"type":"string"},"space":{"type":"array","items":{"$ref":"#/definitions/space"}},"history":{"type":"array","items":{"$ref":"#/definitions/history"}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"$ref":"#/definitions/container"}},"body":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/content-body"}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/content-restriction"}},"additionalProperties":false}},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"container":{"title":"Container","type":"object"},"content":{"title":"Content","type":"object","properties":{"id":{"$ref":"#/definitions/content-id"},"type":{"$ref":"#/definitions/content-type"},"status":{"$ref":"#/definitions/content-status"},"title":{"type":"string"},"space":{"type":"array","items":{"$ref":"#/definitions/space"}},"history":{"type":"array","items":{"$ref":"#/definitions/history"}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"$ref":"#/definitions/container"}},"body":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/content-body"}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/content-restriction"}},"additionalProperties":false}},"additionalProperties":false},"content-body":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"content-id":{"title":"Content Id","type":"object"},"content-representation":{"title":"Content Representation","type":"object"},"content-restriction":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false},"content-status":{"title":"Content Status","type":"object"},"content-type":{"title":"Content Type","type":"object"},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"history":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"space":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}

    • Status 400
      Returned if the attachment id or the attachment version number are invalid.
    • Status 403
      Returned if you are not permitted to update or move the attachment to a different container.
    • Status 404
      Returned if no attachment is found for the attachmentId.
    • Status 409
      Returned if the version of the supplied Attachment does not match the exact version of the Attachment stored in the database.

Update the binary data of an Attachment, and optionally the comment and the minor edit field.

This adds a new version of the attachment, containing the new binary data, filename, and content-type.

When updating the binary data of an attachment, the comment related to it together with the field that specifies if it's a minor edit can be updated as well, but are not required. If an update is considered to be a minor edit, notifications will not be sent to the watchers of that content.

This resource expects a multipart post. The media-type multipart/form-data is defined in RFC 1867. Most client libraries have classes that make dealing with multipart posts simple. For instance, in Java the Apache HTTP Components library provides a MultiPartEntity that makes it simple to submit a multipart POST.

In order to protect against XSRF attacks, because this method accepts multipart/form-data, it has XSRF protection on it. This means you must submit a header of X-Atlassian-Token: nocheck with the request, otherwise it will be blocked.

The name of the multipart/form-data parameter that contains attachments must be "file"

A simple example to upload a file called "myfile.txt" to the Attachment with id "456" in a container with id "123", with the comment updated, and minorEdit set to true:

curl -D- -u admin:admin -X POST -H "X-Atlassian-Token: nocheck" -F "file=@myfile.txt" -F "minorEdit=true" -F "comment=This
                                 is my updated File" http://myhost/rest/api/content/123/child/attachment/456/data

An example to upload the same file, with no comment:

curl -D- -u admin:admin -X POST -H "X-Atlassian-Token: nocheck" -F "file=@myfile.txt" http://myhost/rest/api/content/123/child/attachment/456/data

Example request URI(s):

  • http://example.com/rest/api/content/1234/child/attachment/5678/data

Responses
    • Status 200 - application/json

      Example
      {"results":[{"id":"att5678","type":"attachment","status":"current","title":"myfile.txt","version":{"by":{"type":"known","username":"username","userKey":"","displayName":"Full Name","_expandable":{"operations":"","details":""}},"when":"2017-04-13T01:53:30.410Z","message":"change message for this edit","number":2,"minorEdit":false},"ancestors":[],"operations":[],"children":{},"childTypes":{},"descendants":{},"container":{"id":"1234","type":"page","status":"current","title":"Example Content title","space":{"id":11,"key":"TST","name":"Example space","description":{"plain":{"value":"This is an example space","representation":"plain","embeddedContent":[]}},"metadata":{},"_expandable":{"operations":"","permissions":""},"_links":{"self":"http://myhost:8080/confluence/rest/api/space/TST"}},"version":{"by":{"type":"known","username":"username","userKey":"","displayName":"Full Name","_expandable":{"operations":"","details":""}},"when":"2017-04-13T01:53:30.410Z","message":"change message for this edit","number":2,"minorEdit":false},"ancestors":[{"id":"123","type":"page","status":"current","ancestors":[],"operations":[],"children":{},"childTypes":{},"descendants":{},"body":{},"metadata":{},"restrictions":{},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/123"}}],"operations":[],"children":{},"childTypes":{},"descendants":{},"container":{"id":11,"key":"TST","name":"Example space","description":{"plain":{"value":"This is an example space","representation":"plain","embeddedContent":[]}},"metadata":{},"_expandable":{"operations":"","permissions":""},"_links":{"self":"http://myhost:8080/confluence/rest/api/space/TST"}},"body":{"view":{"value":"<p><h1>Example</h1>Some example content body</p>","representation":"view","embeddedContent":[],"_expandable":{"content":"/rest/api/content/1234"}}},"metadata":{},"restrictions":{},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/1234"}},"body":{},"metadata":{"comment":"This is my File","mediaType":"text/plain"},"restrictions":{},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/att5678"}}],"size":1,"_links":{"base":"http://myhost:8080/confluence","context":"/confluence"}}

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/content#","title":"Content","type":"object","properties":{"id":{"$ref":"#/definitions/content-id"},"type":{"$ref":"#/definitions/content-type"},"status":{"$ref":"#/definitions/content-status"},"title":{"type":"string"},"space":{"type":"array","items":{"$ref":"#/definitions/space"}},"history":{"type":"array","items":{"$ref":"#/definitions/history"}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"$ref":"#/definitions/container"}},"body":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/content-body"}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/content-restriction"}},"additionalProperties":false}},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"container":{"title":"Container","type":"object"},"content":{"title":"Content","type":"object","properties":{"id":{"$ref":"#/definitions/content-id"},"type":{"$ref":"#/definitions/content-type"},"status":{"$ref":"#/definitions/content-status"},"title":{"type":"string"},"space":{"type":"array","items":{"$ref":"#/definitions/space"}},"history":{"type":"array","items":{"$ref":"#/definitions/history"}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"$ref":"#/definitions/container"}},"body":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/content-body"}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/content-restriction"}},"additionalProperties":false}},"additionalProperties":false},"content-body":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"content-id":{"title":"Content Id","type":"object"},"content-representation":{"title":"Content Representation","type":"object"},"content-restriction":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false},"content-status":{"title":"Content Status","type":"object"},"content-type":{"title":"Content Type","type":"object"},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"history":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"space":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}

    • Status 400
      Returned if the attachment id is invalid.
    • Status 404
      Returned if no attachment is found for the attachmentId.

content/{id}/descendant

REST wrapper for the {@link ChildContentService}, when {@link Depth} is ALL.

Returns a map of the descendants of a piece of Content. Content can have multiple types of descendants - for example a Page can have descendants that are also Pages, but it can also have Comments and Attachments.

The {@link ContentType}(s) of the descendants returned is specified by the "expand" query parameter in the request - this parameter can include expands for multiple descendant types.
If no types are included in the expand parameter, the map returned will just list the descendant types that are available to be expanded for the {@link Content} referenced by the "id" path parameter.

Currently the only supported descendants are comment descendants of non-comment Content.

Example request URI(s):

  • http://example.com/rest/api/content/1234/descendant
  • http://example.com/rest/api/content/1234/descendant?expand=comment.body.VIEW
  • http://example.com/rest/api/content/1234/descendant?expand=comment

Request
query parameters
parameter type description
expand string

Default:

a comma separated list of properties to expand on the descendants

Responses
    • Status 200 - application/json

      Example
      {"page":{"results":[{"id":"1234","type":"page","status":"current","title":"Example Content title","links":{},"space":{"id":11,"key":"TST","name":"Example space","icon":null,"description":{"plain":{"representation":"plain","value":"This is an example space","webresource":null,"embeddedContent":[]}},"homepage":null,"links":{},"metadata":{},"operations":null,"permissions":null},"history":null,"version":{"by":{"type":"known","username":"username","displayName":"Full Name","userKey":"","operations":null,"details":null},"when":"2017-04-13T01:53:30.336Z","message":"change message for this edit","number":2,"minorEdit":false,"content":null},"ancestors":[{"id":"123","type":"page","status":"current","links":{},"space":null,"history":null,"version":null,"ancestors":[],"operations":[],"children":{},"childTypes":{},"descendants":{},"container":null,"body":{},"metadata":{},"extensions":{},"restrictions":{}}],"operations":[],"children":{},"childTypes":{},"descendants":{},"container":{"id":11,"key":"TST","name":"Example space","icon":null,"description":{"plain":{"representation":"plain","value":"This is an example space","webresource":null,"embeddedContent":[]}},"homepage":null,"links":{},"metadata":{},"operations":null,"permissions":null},"body":{"view":{"representation":"view","value":"<p><h1>Example</h1>Some example content body</p>","webresource":null,"embeddedContent":[],"content":null}},"metadata":{},"extensions":{},"restrictions":{}}],"size":1}}

      Returns a JSON map representing multiple ordered collections of content descendants, keyed by content type

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/map-of-content-type#","title":"Map of Content Type","type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"content":{"title":"Content","type":"object","properties":{"id":{"title":"Content Id","type":"object"},"type":{"title":"Content Type","type":"object"},"status":{"title":"Content Status","type":"object"},"title":{"type":"string"},"space":{"type":"array","items":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false}},"history":{"type":"array","items":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"title":"Container","type":"object"}},"body":{"type":"object","patternProperties":{".+":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"content-representation":{"title":"Content Representation","type":"object"},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}

    • Status 404
      Returned if there is no content with the given id, or if the calling user does not have permission to view the content.

Returns the direct descendants of a piece of Content, limited to a single descendant type.

The {@link ContentType}(s) of the descendants returned is specified by the "type" path parameter in the request.

Currently the only supported descendants are comment descendants of non-comment Content.

Example request URI(s):

  • http://example.com/rest/api/content/1234/descendant/comment
  • http://example.com/rest/api/content/1234/descendant/comment?expand=body.VIEW
  • http://example.com/rest/api/content/1234/descendant/comment?start=20&limit=10

Request
query parameters
parameter type description
expand string

Default:

a comma separated list of properties to expand on the descendants

start int

(optional, default: 0) the index of the first item within the result set that should be returned

limit int

Default: 25

(optional, default: site limit) how many items should be returned after the start index

Responses
    • Status 200 - application/json

      Example
      {"page":{"results":[{"id":"1234","type":"page","status":"current","title":"Example Content title","links":{},"space":{"id":11,"key":"TST","name":"Example space","icon":null,"description":{"plain":{"representation":"plain","value":"This is an example space","webresource":null,"embeddedContent":[]}},"homepage":null,"links":{},"metadata":{},"operations":null,"permissions":null},"history":null,"version":{"by":{"type":"known","username":"username","displayName":"Full Name","userKey":"","operations":null,"details":null},"when":"2017-04-13T01:53:30.336Z","message":"change message for this edit","number":2,"minorEdit":false,"content":null},"ancestors":[{"id":"123","type":"page","status":"current","links":{},"space":null,"history":null,"version":null,"ancestors":[],"operations":[],"children":{},"childTypes":{},"descendants":{},"container":null,"body":{},"metadata":{},"extensions":{},"restrictions":{}}],"operations":[],"children":{},"childTypes":{},"descendants":{},"container":{"id":11,"key":"TST","name":"Example space","icon":null,"description":{"plain":{"representation":"plain","value":"This is an example space","webresource":null,"embeddedContent":[]}},"homepage":null,"links":{},"metadata":{},"operations":null,"permissions":null},"body":{"view":{"representation":"view","value":"<p><h1>Example</h1>Some example content body</p>","webresource":null,"embeddedContent":[],"content":null}},"metadata":{},"extensions":{},"restrictions":{}}],"size":1}}

      Returns a JSON map representing multiple ordered collections of content descendants, keyed by content type

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/rest-list-of-content#","title":"Rest List of Content","type":"array","items":{"$ref":"#/definitions/content"},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"content":{"title":"Content","type":"object","properties":{"id":{"title":"Content Id","type":"object"},"type":{"title":"Content Type","type":"object"},"status":{"title":"Content Status","type":"object"},"title":{"type":"string"},"space":{"type":"array","items":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false}},"history":{"type":"array","items":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"title":"Container","type":"object"}},"body":{"type":"object","patternProperties":{".+":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"content-representation":{"title":"Content Representation","type":"object"},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}}}

    • Status 404
      Returned if there is no content with the given id, or if the calling user does not have permission to view the content.

content/{id}/label

A REST resource for manipulating labels.

Returns the list of labels on a piece of Content.

Example request URI(s):

  • http://example.com/rest/api/content/1234/label
  • http://example.com/rest/api/content/1234/label?prefix=global&start=0&limit=200

Request
query parameters
parameter type description
prefix string

the prefixes to filter the labels with {@see Label.Prefix}

start int

the start point of the collection to return

limit int

Default: 200

the limit of the number of labels to return, this may be restricted by fixed system limits

Responses
    • Status 200 - application/json
      Returns a JSON representation of the labels on a piece of content

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/page-response-of-label#","title":"Page Response of Label","type":"array","items":{"title":"Label","type":"object","properties":{"prefix":{"type":"string"},"name":{"type":"string"},"id":{"type":"string"}},"additionalProperties":false}}

    • Status 404
      Returned if there is no content with the given id, or if the calling user does not have permission to view the content.

Adds a list of labels to the specified content.

The body is the json representation of the list.

Alternatively, you can create a list of labels in content creation request.

POST /rest/api/content/

                                 {
                                 "title": "My title",
                                 "space": {"key": "ds"},
                                 "type": "page",
                                 "metadata": {
                                 "labels": [
                                 { "prefix": "global", "name": "label1" },
                                 { "prefix": "global", "name": "label2" }
                                 ]
                                 },
                                 "body": {
                                 "storage": {
                                 "value": "New page data",
                                 "representation": "storage"
                                 }
                                 }
                                 }
                                 

The following page response format is also accepted for metadata field.


                                 {
                                 "labels": {
                                 "results": [
                                 { "prefix": "global", "name": "label1" },
                                 { "prefix": "global", "name": "label2" }
                                 ]
                                 }
                                 }
                                 

Also, the list of labels can be updated in content update request. Note: The whole list of labels will be replaced by the new list. If you want to keep the existing labels please include them as well.

PUT /rest/api/content/{contentId}

                                 {
                                 "id": "{contentId}",
                                 "title": "My new title",
                                 "type": "page",
                                 "metadata": {
                                 "labels": {
                                 "results": [
                                 { "prefix": "global", "name": "my new label" },
                                 { "prefix": "global", "name": "my another new label" }
                                 ]
                                 }
                                 },
                                 "body": {
                                 "storage": {
                                 "value": "New page data.",
                                 "representation": "storage"
                                 }
                                 },
                                 "version": {
                                 "number": 2
                                 }
                                 }
                                 

Request

Example
[{"prefix":"global","name":"label1"},{"prefix":"global","name":"label2"}]

Schema
{"id":"https://docs.atlassian.com/jira/REST/schema/string#","title":"String","type":"string"}

Responses
    • Status 200 - application/json
      Returns a JSON representation of the labels on a piece of content

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/page-response-of-label#","title":"Page Response of Label","type":"array","items":{"title":"Label","type":"object","properties":{"prefix":{"type":"string"},"name":{"type":"string"},"id":{"type":"string"}},"additionalProperties":false}}

    • Status 404
      Returned if there is no content with the given id, or if the calling user does not have permission to view the content.

Deletes a labels to the specified content.

Request
query parameters
parameter type description
name string

the name of the label to be removed from the content

Responses
    • Status 204
      Empty response on successful delete
    • Status 403
      Returned if user has view permission, but no edit permission to the content
    • Status 404
      Returned if content or label doesn't exist, or calling user doesn't have view permission to the content

Deletes a labels to the specified content. When calling this method through REST the label parameter doesn't accept "/" characters in label names, because of security constraints. For this case please use the query parameter version of this method (/content/{id}/label?name={label}

Responses
    • Status 204
      Empty response on successful delete
    • Status 400
      Returned if trying to delete a label with "/" in the name
    • Status 403
      Returned if user has view permission, but no edit permission to the content
    • Status 404
      Returned if content or label doesn't exist, or calling user doesn't have view permission to the content

content/{id}/notification

A REST resource for fetching the watchers to be notified of events on a given content.

Request
query parameters
parameter type description
start int

Default: 0

limit int

Default: 200

Responses
    • Status - application/json
Request
query parameters
parameter type description
start int

Default: 0

limit int

Default: 200

Responses
    • Status - application/json

content/{id}/property

A REST resource for manipulating content properties.

Content properties are a key / value store of properties attached to a piece of Content. The key is a string, and the value is a JSON object.

Show more

Returns a paginated list of content properties.

Example request URI:

  • http://example.com/rest/api/content/1234/property?expand=content,version

Request
query parameters
parameter type description
expand string

a comma separated list of properties to expand on the content properties. Default value: version.

start int

the start point of the collection to return

limit int

Default: 10

the limit of the number of items to return, this may be restricted by fixed system limits

Responses
    • Status 200 - application/json

      Example
      {"results":[{"content":{"id":"1234","type":"page","status":"current","ancestors":[],"operations":[],"children":{},"childTypes":{},"descendants":{},"body":{},"metadata":{},"restrictions":{},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/1234"}},"key":"example-property-key","value":{"anything":"goes"},"version":{"number":2,"minorEdit":false},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/1234/property/example-property-key"}}],"size":1,"_links":{"base":"http://myhost:8080/confluence","context":"/confluence"}}

      Returns a full JSON representation of the content property list

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/rest-list-of-json-content-property#","title":"Rest List of Json Content Property","type":"array","items":{"title":"Json Content Property","type":"object","properties":{"key":{"type":"string"},"value":{"title":"Json String","type":"object"},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"id":{"title":"Json Content Property Id","type":"object"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"content":{"title":"Content","type":"object","properties":{"id":{"title":"Content Id","type":"object"},"type":{"title":"Content Type","type":"object"},"status":{"title":"Content Status","type":"object"},"title":{"type":"string"},"space":{"type":"array","items":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false}},"history":{"type":"array","items":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"title":"Container","type":"object"}},"body":{"type":"object","patternProperties":{".+":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"content-representation":{"title":"Content Representation","type":"object"},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}}}

    • Status 404
      Returned if there is no content with the given id, or if the calling user does not have permission to view the content.

Creates a new content property.

Content properties can also be created by adding new property to metadata when creating the content, if you want to create property and content at the same time.

POST /rest/api/content

                                 {
                                 "title": "My title",
                                 "space": {"key": "ds"},
                                 "type": "page",
                                 "metadata": {
                                 "properties": {
                                 "my-property-key": {
                                 "key": "my-property-key",
                                 "value": "my-property-value"
                                 }
                                 }
                                 },
                                 "body": {
                                 "storage": {
                                 "value": "New page data",
                                 "representation": "storage"
                                 }
                                 }
                                 }
                                 

Request

Example
{"key":"example-property-key","value":{"anything":"goes"}}

Schema
{"id":"https://docs.atlassian.com/jira/REST/schema/json-content-property#","title":"Json Content Property","type":"object","properties":{"key":{"type":"string"},"value":{"title":"Json String","type":"object"},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"id":{"title":"Json Content Property Id","type":"object"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"content":{"title":"Content","type":"object","properties":{"id":{"title":"Content Id","type":"object"},"type":{"title":"Content Type","type":"object"},"status":{"title":"Content Status","type":"object"},"title":{"type":"string"},"space":{"type":"array","items":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false}},"history":{"type":"array","items":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"title":"Container","type":"object"}},"body":{"type":"object","patternProperties":{".+":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"content-representation":{"title":"Content Representation","type":"object"},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}

Responses
    • Status 200 - application/json

      Example
      {"content":{"id":"1234","type":"page","status":"current","ancestors":[],"operations":[],"children":{},"childTypes":{},"descendants":{},"body":{},"metadata":{},"restrictions":{},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/1234"}},"key":"example-property-key","value":{"anything":"goes"},"version":{"number":2,"minorEdit":false},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/1234/property/example-property-key","base":"http://myhost:8080/confluence","context":"/confluence"}}

      Returns a full JSON representation of the content property

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/json-content-property#","title":"Json Content Property","type":"object","properties":{"key":{"type":"string"},"value":{"title":"Json String","type":"object"},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"id":{"title":"Json Content Property Id","type":"object"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"content":{"title":"Content","type":"object","properties":{"id":{"title":"Content Id","type":"object"},"type":{"title":"Content Type","type":"object"},"status":{"title":"Content Status","type":"object"},"title":{"type":"string"},"space":{"type":"array","items":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false}},"history":{"type":"array","items":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"title":"Container","type":"object"}},"body":{"type":"object","patternProperties":{".+":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"content-representation":{"title":"Content Representation","type":"object"},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}

    • Status 400
      Returned if the given property has a different ContentId to the one in the path, or if the content already has a value with the given key, or the value is missing, or the value is too long.
    • Status 403
      Returned if the user does not have permission to edit the content with the given ContentId
    • Status 413
      Returned if the value is too long.

Returns a content property.

Example request URI:

  • http://example.com/rest/api/content/1234/property/example-property-key?expand=content,version

Request
query parameters
parameter type description
expand string

a comma separated list of properties to expand on the content properties. Default value: version.

Responses
    • Status 200 - application/json

      Example
      {"content":{"id":"1234","type":"page","status":"current","ancestors":[],"operations":[],"children":{},"childTypes":{},"descendants":{},"body":{},"metadata":{},"restrictions":{},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/1234"}},"key":"example-property-key","value":{"anything":"goes"},"version":{"number":2,"minorEdit":false},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/1234/property/example-property-key","base":"http://myhost:8080/confluence","context":"/confluence"}}

      Returns a full JSON representation of the content property

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/json-content-property#","title":"Json Content Property","type":"object","properties":{"key":{"type":"string"},"value":{"title":"Json String","type":"object"},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"id":{"title":"Json Content Property Id","type":"object"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"content":{"title":"Content","type":"object","properties":{"id":{"title":"Content Id","type":"object"},"type":{"title":"Content Type","type":"object"},"status":{"title":"Content Status","type":"object"},"title":{"type":"string"},"space":{"type":"array","items":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false}},"history":{"type":"array","items":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"title":"Container","type":"object"}},"body":{"type":"object","patternProperties":{".+":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"content-representation":{"title":"Content Representation","type":"object"},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}

    • Status 404
      Returned if there is no content with the given id, or no property with the given key, or if the calling user does not have permission to view the content.

Updates a content property.

The body contains the representation of the content property. Must include the property id, and the new version number.
This endpoint attempts to create a new content property if the given version number is 1, just like POST /rest/api/content/{id}/property

Content properties can also be updated in content update request. You must increment the the version number for each property correctly. Properties not included in the request will not be changed.

PUT /rest/api/content/{contentId}

                                 {
                                 "id": "{contentId}",
                                 "title": "My new title",
                                 "space": {"key": "DS"},
                                 "type": "page",
                                 "metadata": {
                                 "properties": {
                                 "my-property-key": {
                                 "key": "my-property-key",
                                 "value": "my-new-property-value",
                                 "version": {
                                 "number": 2
                                 }
                                 }
                                 }
                                 },
                                 "body": {
                                 "storage": {
                                 "value": "New page data",
                                 "representation": "storage"
                                 }
                                 },
                                 "version": {
                                 "number": 2
                                 }
                                 }
                                 

Request

Example
{"key":"example-property-key","value":{"anything":"goes"},"version":{"number":2,"minorEdit":false}}

Schema
{"id":"https://docs.atlassian.com/jira/REST/schema/json-content-property#","title":"Json Content Property","type":"object","properties":{"key":{"type":"string"},"value":{"title":"Json String","type":"object"},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"id":{"title":"Json Content Property Id","type":"object"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"content":{"title":"Content","type":"object","properties":{"id":{"title":"Content Id","type":"object"},"type":{"title":"Content Type","type":"object"},"status":{"title":"Content Status","type":"object"},"title":{"type":"string"},"space":{"type":"array","items":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false}},"history":{"type":"array","items":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"title":"Container","type":"object"}},"body":{"type":"object","patternProperties":{".+":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"content-representation":{"title":"Content Representation","type":"object"},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}

Responses
    • Status 200 - application/json

      Example
      {"content":{"id":"1234","type":"page","status":"current","ancestors":[],"operations":[],"children":{},"childTypes":{},"descendants":{},"body":{},"metadata":{},"restrictions":{},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/1234"}},"key":"example-property-key","value":{"anything":"goes"},"version":{"number":2,"minorEdit":false},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/1234/property/example-property-key","base":"http://myhost:8080/confluence","context":"/confluence"}}

      Returns a full JSON representation of a piece of content

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/json-content-property#","title":"Json Content Property","type":"object","properties":{"key":{"type":"string"},"value":{"title":"Json String","type":"object"},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"id":{"title":"Json Content Property Id","type":"object"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"content":{"title":"Content","type":"object","properties":{"id":{"title":"Content Id","type":"object"},"type":{"title":"Content Type","type":"object"},"status":{"title":"Content Status","type":"object"},"title":{"type":"string"},"space":{"type":"array","items":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false}},"history":{"type":"array","items":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"title":"Container","type":"object"}},"body":{"type":"object","patternProperties":{".+":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"content-representation":{"title":"Content Representation","type":"object"},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}

    • Status 400
      Returned if the given property has a different ContentId to the one in the path, or if the property has a different key to the one in the path, or the value is missing, or the value is too long.
    • Status 403
      Returned if the user does not have permission to edit the content with the given ContentId
    • Status 404
      Returned if there is no content with the given id, or no property with the given key, or if the calling user does not have permission to view the content.
    • Status 409
      Returned if the given version is does not match the expected target version of the updated property
    • Status 413
      Returned if the value is too long.

Deletes a content property.

Responses
    • Status 204
      Returned if successfully deleted.
    • Status 404
      Returned if there is no content with the given id, or if the calling user does not have permission to view the content.

Creates a new content property.

Content properties can also be created by adding new property to metadata when creating the content, if you want to create property and content at the same time.

POST /rest/api/content

                                 {
                                 "title": "My title",
                                 "space": {"key": "ds"},
                                 "type": "page",
                                 "metadata": {
                                 "properties": {
                                 "my-property-key": {
                                 "key": "my-property-key",
                                 "value": "my-property-value"
                                 }
                                 }
                                 },
                                 "body": {
                                 "storage": {
                                 "value": "New page data",
                                 "representation": "storage"
                                 }
                                 }
                                 }
                                 

Request

Example
{"key":"example-property-key","value":{"anything":"goes"}}

Schema
{"id":"https://docs.atlassian.com/jira/REST/schema/json-content-property#","title":"Json Content Property","type":"object","properties":{"key":{"type":"string"},"value":{"title":"Json String","type":"object"},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"id":{"title":"Json Content Property Id","type":"object"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"content":{"title":"Content","type":"object","properties":{"id":{"title":"Content Id","type":"object"},"type":{"title":"Content Type","type":"object"},"status":{"title":"Content Status","type":"object"},"title":{"type":"string"},"space":{"type":"array","items":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false}},"history":{"type":"array","items":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"title":"Container","type":"object"}},"body":{"type":"object","patternProperties":{".+":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"content-representation":{"title":"Content Representation","type":"object"},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}

Responses
    • Status 200 - application/json

      Example
      {"content":{"id":"1234","type":"page","status":"current","ancestors":[],"operations":[],"children":{},"childTypes":{},"descendants":{},"body":{},"metadata":{},"restrictions":{},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/1234"}},"key":"example-property-key","value":{"anything":"goes"},"version":{"number":2,"minorEdit":false},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/1234/property/example-property-key","base":"http://myhost:8080/confluence","context":"/confluence"}}

      Returns a full JSON representation of the content property

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/json-content-property#","title":"Json Content Property","type":"object","properties":{"key":{"type":"string"},"value":{"title":"Json String","type":"object"},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"id":{"title":"Json Content Property Id","type":"object"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"content":{"title":"Content","type":"object","properties":{"id":{"title":"Content Id","type":"object"},"type":{"title":"Content Type","type":"object"},"status":{"title":"Content Status","type":"object"},"title":{"type":"string"},"space":{"type":"array","items":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false}},"history":{"type":"array","items":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"title":"Container","type":"object"}},"body":{"type":"object","patternProperties":{".+":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"content-representation":{"title":"Content Representation","type":"object"},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}

    • Status 400
      Returned if the given property has a different ContentId to the one in the path, or if the content already has a value with the given key, or the value is missing, or the value is too long.
    • Status 403
      Returned if the user does not have permission to edit the content with the given ContentId
    • Status 413
      Returned if the value is too long.

content/{id}/restriction

Returns all the restrictions which are directly specified on a piece of content identified by {@code contentId} param

Example request URI:

  • http://example.com/confluence/rest/experimental/content/1234567/restriction?expand=

Request
query parameters
parameter type description
expand string

Default: restrictions.user,restrictions.group

a comma separated list of properties to expand in the response. Default is {@code restrictions.user,restrictions.group}

start int

Default: 0

the start point of the collection to return

limit int

Default: 100

the limit of the number of items to return, this may be restricted by fixed system limits

Responses
    • Status 200 - application/json

      Example
      {"results":[{"operation":"read","restrictions":{"user":{"results":[],"size":0},"group":{"results":[],"size":0}},"_expandable":{"content":"/rest/api/content/12345"},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/12345/restriction/byOperation/read"}},{"operation":"update","restrictions":{"user":{"results":[],"size":0},"group":{"results":[],"size":0}},"_expandable":{"content":"/rest/api/content/12345"},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/12345/restriction/byOperation/update"}}],"start":0,"limit":200,"size":2,"restrictionsHash":"this_is_hash","_links":{"base":"http://myhost:8080/confluence","context":"/confluence","byOperation":"http://example.com/some/path/byOperation"}}

      Returns a full JSON representation of the restrictions present directly on piece of content

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/page-response-of-content-restriction#","title":"Page Response of Content Restriction","type":"array","items":{"$ref":"#/definitions/content-restriction"},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"content":{"title":"Content","type":"object","properties":{"id":{"title":"Content Id","type":"object"},"type":{"title":"Content Type","type":"object"},"status":{"title":"Content Status","type":"object"},"title":{"type":"string"},"space":{"type":"array","items":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false}},"history":{"type":"array","items":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"title":"Container","type":"object"}},"body":{"type":"object","patternProperties":{".+":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/content-restriction"}},"additionalProperties":false}},"additionalProperties":false},"content-representation":{"title":"Content Representation","type":"object"},"content-restriction":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}}}

    • Status 404
      Returned if there is no content with the given id, or if the calling user does not have permission to view the content.

Sets all the restrictions specified to a piece of content identified by {@code contentId}, replacing any existing permissions. Setting per-content restrictions is currently allowed for Pages or BlogPosts only.

Example request URI:

  • http://example.com/confluence/rest/experimental/content/1234567/restriction?expand=

Accepts same input format as the response of GET to the same resource would return. For the sake of simplicity also allows stripping of {@code {"results": ... }"} part and inlining arrays of specific users/groups directly.

E.g.

Example request (simplified)


                                 [
                                 {
                                 "operation": "update",
                                 "restrictions":
                                 {
                                 "user": [
                                 {
                                 "type": "known",
                                 "username": "admin"
                                 }
                                 ]
                                 }
                                 }
                                 ]
                                 

Rules of applying restrictions via this method:

  • Provided collection of {@code ContentRestriction}s is allowed to have only 1 (ONE) {@code ContentRestriction} object for each operation.
  • Provided ContentRestrictions will replace (overwrite) any pre-existing restrictions on the Content under the corresponding operations.
  • In case provided collection of ContentRestriction does not have any of the operations supported it is assumed that restrictions for such operation should not be changed at all.
  • Restrictions with the "users" and/or "groups" map entries explicitly set to be empty arrays will result in removing corresponding restrictions for the content.
  • Restrictions with the "users" and/or "groups" map entries missing will result in not changing corresponding operation's user/group restrictions for the content.
  • It is not allowed to edit the restrictions in such a way which would remove requesting user's access.
  • Only Page and BlogPost contents are supported.

Request
query parameters
parameter type description
expand string

Default: restrictions.user,restrictions.group

a comma separated list of properties to expand in the response. Default is {@code restrictions.user,restrictions.group}

Example
{"results":[{"content":null,"operation":"update","restrictions":{"user":{"results":[{"type":"known","username":"username","displayName":"Full Name","userKey":"","operations":null,"details":null}],"size":1},"group":{"results":[],"size":0}}}],"size":1}

Schema
{"id":"https://docs.atlassian.com/jira/REST/schema/page-response-of-content-restriction#","title":"Page Response of Content Restriction","type":"array","items":{"$ref":"#/definitions/content-restriction"},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"content":{"title":"Content","type":"object","properties":{"id":{"title":"Content Id","type":"object"},"type":{"title":"Content Type","type":"object"},"status":{"title":"Content Status","type":"object"},"title":{"type":"string"},"space":{"type":"array","items":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false}},"history":{"type":"array","items":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"title":"Container","type":"object"}},"body":{"type":"object","patternProperties":{".+":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/content-restriction"}},"additionalProperties":false}},"additionalProperties":false},"content-representation":{"title":"Content Representation","type":"object"},"content-restriction":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}}}

Responses
    • Status 200 - application/json

      Example
      {"results":[{"operation":"read","restrictions":{"user":{"results":[],"size":0},"group":{"results":[],"size":0}},"_expandable":{"content":"/rest/api/content/12345"},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/12345/restriction/byOperation/read"}},{"operation":"update","restrictions":{"user":{"results":[],"size":0},"group":{"results":[],"size":0}},"_expandable":{"content":"/rest/api/content/12345"},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/12345/restriction/byOperation/update"}}],"start":0,"limit":200,"size":2,"restrictionsHash":"this_is_hash","_links":{"base":"http://myhost:8080/confluence","context":"/confluence","byOperation":"http://example.com/some/path/byOperation"}}

      Returns a full JSON representation of the restrictions present directly on piece of content after the update operation

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/page-response-of-content-restriction#","title":"Page Response of Content Restriction","type":"array","items":{"$ref":"#/definitions/content-restriction"},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"content":{"title":"Content","type":"object","properties":{"id":{"title":"Content Id","type":"object"},"type":{"title":"Content Type","type":"object"},"status":{"title":"Content Status","type":"object"},"title":{"type":"string"},"space":{"type":"array","items":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false}},"history":{"type":"array","items":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"title":"Container","type":"object"}},"body":{"type":"object","patternProperties":{".+":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/content-restriction"}},"additionalProperties":false}},"additionalProperties":false},"content-representation":{"title":"Content Representation","type":"object"},"content-restriction":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}}}

    • Status 400
      Returned if any of the above validation rules are violated
    • Status 403
      Returned if the calling user does not have permission to alter the restrictions on the content.
    • Status 404
      Returned if there is no content with the given id, or if the calling user does not have permission to view the content.

Adds all the restrictions specified to a piece of content identified by {@code contentId}. Does not replace/remove/alter any pre-existing {@link ContentRestriction}s. Provided {@link ContentRestriction}s will be added, i.e. "merged with" any pre-existing restrictions on the Content under the corresponding operations. Changing per-content restrictions is currently allowed for Pages or BlogPosts only.

Example request URI:

  • http://example.com/confluence/rest/experimental/content/1234567/restriction?expand=

Accepts same input format as the response of GET to the same resource would return. For the sake of simplicity also allows stripping of {@code {"results": ... }"} part and inlining arrays of specific users/groups directly.

E.g.

Example request (simplified)


                                 [
                                 {
                                 "operation": "update",
                                 "restrictions":
                                 {
                                 "user": [
                                 {
                                 "type": "known",
                                 "username": "admin"
                                 }
                                 ]
                                 }
                                 }
                                 ]
                                 

Alternatively you can update restrictions at the same time of creating or updating the content. The restrictions field in content request accepts the same structure as you have seen in the previous example.
Create content via POST to /rest/api/content/


                                 {
                                 "title": "My title",
                                 "space": {"key": "ds"},
                                 "type": "page",
                                 "body": {
                                 "storage": {
                                 "value": "

New page data.

", "representation": "storage" } }, "restrictions": { "read": { "restrictions": { "group":[ {"name": "administrators"} ], "user": [ {"username": "sysadmin"}, {"username": "admin"} ] } } } }

Update content via PUT to /rest/api/content/123456


                                 {
                                 "id": "123456",
                                 "title": "My new title",
                                 "space": {"key": "ds"},
                                 "type": "page",
                                 "version": {"number": "2"},
                                 "restrictions": {
                                 "read": {
                                 "restrictions": {
                                 "group":[
                                 {"name": "administrators"}
                                 ],
                                 "user": [
                                 {"username": "sysadmin"},
                                 {"username": "admin"}
                                 ]
                                 }
                                 }
                                 }
                                 }
                                 

Rules of applying restrictions via this method:

  • Provided collection of {@code ContentRestriction}s is allowed to have only 1 (ONE) {@code ContentRestriction} object for each operation.
  • Provided ContentRestrictions will be added, i.e. "merged with" any pre-existing restrictions on the Content under the corresponding operations.
  • In case provided collection of ContentRestriction does not have any of the operations supported no changes will happen.
  • Restrictions with the "users" and/or "groups" map entries explicitly set to be empty arrays, or {@code null}, or missing will result in not changing corresponding operation's user/group restrictions for the content.
  • It is not allowed to edit the restrictions in such a way which would remove requesting user's access.
  • Only Page and BlogPost contents are supported.
  • Request
    query parameters
    parameter type description
    expand string

    Default: restrictions.user,restrictions.group

    the expansions to the ContentRestriction. To be expanded on response.

    Example
    {"results":[{"content":null,"operation":"update","restrictions":{"user":{"results":[{"type":"known","username":"username","displayName":"Full Name","userKey":"","operations":null,"details":null}],"size":1},"group":{"results":[],"size":0}}}],"size":1}

    Schema
    {"id":"https://docs.atlassian.com/jira/REST/schema/page-response-of-content-restriction#","title":"Page Response of Content Restriction","type":"array","items":{"$ref":"#/definitions/content-restriction"},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"content":{"title":"Content","type":"object","properties":{"id":{"title":"Content Id","type":"object"},"type":{"title":"Content Type","type":"object"},"status":{"title":"Content Status","type":"object"},"title":{"type":"string"},"space":{"type":"array","items":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false}},"history":{"type":"array","items":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"title":"Container","type":"object"}},"body":{"type":"object","patternProperties":{".+":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/content-restriction"}},"additionalProperties":false}},"additionalProperties":false},"content-representation":{"title":"Content Representation","type":"object"},"content-restriction":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}}}

    Responses
      • Status 200 - application/json

        Example
        {"results":[{"operation":"read","restrictions":{"user":{"results":[],"size":0},"group":{"results":[],"size":0}},"_expandable":{"content":"/rest/api/content/12345"},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/12345/restriction/byOperation/read"}},{"operation":"update","restrictions":{"user":{"results":[],"size":0},"group":{"results":[],"size":0}},"_expandable":{"content":"/rest/api/content/12345"},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/12345/restriction/byOperation/update"}}],"start":0,"limit":200,"size":2,"restrictionsHash":"this_is_hash","_links":{"base":"http://myhost:8080/confluence","context":"/confluence","byOperation":"http://example.com/some/path/byOperation"}}

        Returns a full JSON representation of the restrictions present directly on piece of content after the add operation

        Schema
        {"id":"https://docs.atlassian.com/jira/REST/schema/page-response-of-content-restriction#","title":"Page Response of Content Restriction","type":"array","items":{"$ref":"#/definitions/content-restriction"},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"content":{"title":"Content","type":"object","properties":{"id":{"title":"Content Id","type":"object"},"type":{"title":"Content Type","type":"object"},"status":{"title":"Content Status","type":"object"},"title":{"type":"string"},"space":{"type":"array","items":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false}},"history":{"type":"array","items":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"title":"Container","type":"object"}},"body":{"type":"object","patternProperties":{".+":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/content-restriction"}},"additionalProperties":false}},"additionalProperties":false},"content-representation":{"title":"Content Representation","type":"object"},"content-restriction":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}}}

      • Status 400
        Returned if any of the above validation rules are violated
      • Status 403
        Returned if the calling user does not have permission to alter the restrictions on the content.
      • Status 404
        Returned if there is no content with the given id, or if the calling user does not have permission to view the content.

Removes all the restrictions specified directly on the content. I.e. makes READ and UPDATE operations unrestricted directly on the content.

User performing this operation must have enough rights to edit the content specified as well as restrictions associated with it in order to proceed.

Request
query parameters
parameter type description
expand string

Default: restrictions.user,restrictions.group

the expansions to the ContentRestriction. To be expanded on response.

Responses
    • Status 200 - application/json

      Example
      {"results":[{"operation":"read","restrictions":{"user":{"results":[],"size":0},"group":{"results":[],"size":0}},"_expandable":{"content":"/rest/api/content/12345"},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/12345/restriction/byOperation/read"}},{"operation":"update","restrictions":{"user":{"results":[],"size":0},"group":{"results":[],"size":0}},"_expandable":{"content":"/rest/api/content/12345"},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/12345/restriction/byOperation/update"}}],"start":0,"limit":200,"size":2,"restrictionsHash":"this_is_hash","_links":{"base":"http://myhost:8080/confluence","context":"/confluence","byOperation":"http://example.com/some/path/byOperation"}}

      Returns a full JSON representation of the restrictions present directly on piece of content after the delete operation (empty restrictions)

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/page-response-of-content-restriction#","title":"Page Response of Content Restriction","type":"array","items":{"$ref":"#/definitions/content-restriction"},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"content":{"title":"Content","type":"object","properties":{"id":{"title":"Content Id","type":"object"},"type":{"title":"Content Type","type":"object"},"status":{"title":"Content Status","type":"object"},"title":{"type":"string"},"space":{"type":"array","items":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false}},"history":{"type":"array","items":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"title":"Container","type":"object"}},"body":{"type":"object","patternProperties":{".+":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/content-restriction"}},"additionalProperties":false}},"additionalProperties":false},"content-representation":{"title":"Content Representation","type":"object"},"content-restriction":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}}}

    • Status 400
      Returned if any of the above validation rules are violated
    • Status 403
      Returned if the calling user does not have permission to alter the restrictions on the content.
    • Status 404
      Returned if there is no content with the given id, or if the calling user does not have permission to view the content.

Answers the question "Whether group, identified by {@code groupName} is a subject of the restriction for operation {@code operationKey} directly specified on a content with ID of {@code ccontentId}"

Content identified by the id must exist and be accessible by the user performing this operation.

Responses
    • Status 200 - application/json

      Example
      true

      Returns a Boolean result
    • Status 400
      Returned if any of the above validation rules are violated
    • Status 404
      Returned if there is no content with the given id, or if the calling user does not have permission to view the content.

Deletes singular direct {@link ContentRestriction} for {@code operationKey} and {@code user} from the content identified by {@code contentId} parameter. Throws subclasses of {@link ServiceException} in case of various problems (cannot find content, restrictions to be deleted does not exist, etc...)

Content identified by the id must exist and be accessible by the user performing this operation. User performing this operation must have all the required permissions for that Restriction to be deleted must exist

Responses
    • Status 200 - application/json
      Returns a Void result (no content)
    • Status 400
      Returned if any of the above validation rules are violated
    • Status 404
      Returned if there is no content with the given id, or if the calling user does not have permission to view the content, or the restriction to be deleted does not exist.

Adds singular direct {@link ContentRestriction} for {@code operationKey} and {@code group} for the content identified by {@code contentId} parameter. Throws subclasses of {@link ServiceException} in case of various problems (cannot find content, wrong opkey, not enought permissions, etc...)

Content identified by the id must exist and be accessible by the user performing this operation. User performing this operation must have all the required permissions for that

Responses
    • Status 200 - application/json
      Returns a Void result (no content)
    • Status 400
      Returned if any of the above validation rules are violated
    • Status 404
      Returned if there is no content with the given id, or if the calling user does not have permission to view the content, or the operation does not exist. etc

Answers the question "Whether user, identified by {@code userKey} is a subject of the restriction for operation {@code operationKey} directly specified on a content with ID of {@code ccontentId}"

Content identified by the id must exist and be accessible by the user performing this operation.

Request
query parameters
parameter type description
key string

userKey identifying the user in question

userName string
Responses
    • Status 200 - application/json

      Example
      true

      Returns a Boolean result
    • Status 400
      Returned if any of the above validation rules are violated
    • Status 404
      Returned if there is no content with the given id, or if the calling user does not have permission to view the content.

Deletes singular direct {@link ContentRestriction} for {@code operationKey} and {@code user} from the content identified by {@code contentId} parameter. Throws subclasses of {@link ServiceException} in case of various problems (cannot find content, restrictions to be deleted does not exist, etc...)

Content identified by the id must exist and be accessible by the user performing this operation. User performing this operation must have all the required permissions for that Restriction to be deleted must exist

Request
query parameters
parameter type description
key string

userKey identifying the {@link com.atlassian.confluence.api.model.people.User} who's restriction is to be deleted

userName string

userName identifying the {@link com.atlassian.confluence.api.model.people.User} who's restriction is to be deleted

Responses
    • Status 200 - application/json
      Returns a Void result (no content)
    • Status 400
      Returned if any of the above validation rules are violated
    • Status 404
      Returned if there is no content with the given id, or if the calling user does not have permission to view the content, or the restriction to be deleted does not exist.

Adds singular direct {@link ContentRestriction} for {@code operationKey} and {@code user} for the content identified by {@code contentId} parameter. Throws subclasses of {@link ServiceException} in case of various problems (cannot find content, wrong opkey, not enought permissions, etc...)

Content identified by the id must exist and be accessible by the user performing this operation. User performing this operation must have all the required permissions for that

Request
query parameters
parameter type description
key string

userKey identifying the {@link com.atlassian.confluence.api.model.people.User} who's restriction is to be added

userName string

userName identifying the {@link com.atlassian.confluence.api.model.people.User} who's restriction is to be added

Responses
    • Status 200 - application/json
      Returns a Void result (no content)
    • Status 400
      Returned if any of the above validation rules are violated
    • Status 404
      Returned if there is no content with the given id, or if the calling user does not have permission to view the content, or the operation does not exist. etc

Returns info about all restrictions by operation

Request
query parameters
parameter type description
expand string

Default: update.restrictions.user,read.restrictions.group,read.restrictions.user,update.restrictions.group

a comma separated list of properties to expand on the content properties. Default value: group.

Responses
    • Status 200 - application/json
      Returns a JSON representation of the restrictions group by operations

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/map-of-operation-key-and-content-restriction#","title":"Map of Operation Key-and-Content Restriction","type":"object","patternProperties":{".+":{"$ref":"#/definitions/content-restriction"}},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"content":{"title":"Content","type":"object","properties":{"id":{"title":"Content Id","type":"object"},"type":{"title":"Content Type","type":"object"},"status":{"title":"Content Status","type":"object"},"title":{"type":"string"},"space":{"type":"array","items":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false}},"history":{"type":"array","items":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"title":"Container","type":"object"}},"body":{"type":"object","patternProperties":{".+":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/content-restriction"}},"additionalProperties":false}},"additionalProperties":false},"content-representation":{"title":"Content Representation","type":"object"},"content-restriction":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}

Returns info about all restrictions of given operation

Request
query parameters
parameter type description
expand string

Default: restrictions.user,restrictions.group

a comma separated list of properties to expand on the content properties. Default value: group.

start int

pagination start

limit int

Default: 100

pagination limit

Responses
    • Status 200 - application/json
      Returns a JSON representation of the restrictions of given operation

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/content-restriction#","title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"content":{"title":"Content","type":"object","properties":{"id":{"title":"Content Id","type":"object"},"type":{"title":"Content Type","type":"object"},"status":{"title":"Content Status","type":"object"},"title":{"type":"string"},"space":{"type":"array","items":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false}},"history":{"type":"array","items":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"title":"Container","type":"object"}},"body":{"type":"object","patternProperties":{".+":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"content-representation":{"title":"Content Representation","type":"object"},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}

content/{id}/version

Get list of content versions in version descending order. ContentId must exist and current user must have view permission on this content. This is validated and exception will throw if they are not satisfied.

Request
query parameters
parameter type description
start int
limit int

Default: 200

expand string

Default:

Responses
    • Status 200 - application/json

      Example
      {"results":[{"by":{"type":"known","username":"username","displayName":"Full Name","userKey":"","operations":null,"details":null},"when":"2017-04-13T01:53:30.371Z","message":"This is first version","number":1,"minorEdit":false,"syncRev":"1234","content":null}],"size":1}

      Returns a full JSON representation of list of versions.

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/page-response-of-version#","title":"Page Response of Version","type":"array","items":{"$ref":"#/definitions/version"},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"content":{"title":"Content","type":"object","properties":{"id":{"title":"Content Id","type":"object"},"type":{"title":"Content Type","type":"object"},"status":{"title":"Content Status","type":"object"},"title":{"type":"string"},"space":{"type":"array","items":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false}},"history":{"type":"array","items":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"title":"Container","type":"object"}},"body":{"type":"object","patternProperties":{".+":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"content-representation":{"title":"Content Representation","type":"object"},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}}}

    • Status 400
      Returned if any of the validation rules are violated
    • Status 403
      Returned if the calling user does not have permission to view the content.

Restore a historical version to be a new current version. The result is a new version is created with the content of the historical version.

Request
query parameters
parameter type description
expand string

Default: content

Expansion on newly create current version

Schema
{"id":"https://docs.atlassian.com/jira/REST/schema/rest#","title":"Rest","type":"object","properties":{"operationKey":{"title":"Operation Key","type":"object"},"params":{"type":"object","patternProperties":{".+":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false}

Responses
    • Status 200 - application/json

      Example
      {"by":{"type":"known","username":"username","userKey":"","displayName":"Full Name","_expandable":{"operations":"","details":""}},"when":"2017-04-13T01:53:30.390Z","message":"This is first version","number":1,"minorEdit":false,"syncRev":"1234","content":{"id":"3604482","type":"page","status":"current","title":"Example Content title","space":{"key":"TST","metadata":{},"_expandable":{"operations":"","permissions":"","description":""},"_links":{"self":"http://myhost:8080/confluence/rest/api/space/TST"}},"version":{"number":2,"minorEdit":false},"ancestors":[],"operations":[],"children":{},"childTypes":{},"descendants":{},"body":{"storage":{"value":"<p>This is the updated text for the new page</p>","representation":"storage","embeddedContent":[],"_expandable":{"content":"/rest/api/content/3604482"}}},"metadata":{},"restrictions":{},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/3604482"}},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/3604482/version/1","base":"http://myhost:8080/confluence","context":"/confluence"}}

      Success to restore a version. Return the Version object of current (latest).

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/version#","title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"content":{"title":"Content","type":"object","properties":{"id":{"title":"Content Id","type":"object"},"type":{"title":"Content Type","type":"object"},"status":{"title":"Content Status","type":"object"},"title":{"type":"string"},"space":{"type":"array","items":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false}},"history":{"type":"array","items":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"title":"Container","type":"object"}},"body":{"type":"object","patternProperties":{".+":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"content-representation":{"title":"Content Representation","type":"object"},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false,"required":["number","minorEdit"]}

    • Status 400
      Returned if contentId and versionNumber cannot be found or version number is current or non-exist.
    • Status 403
      Returned if the calling user doesn't have permission to edit the content.

Delete a historical version. Current user must have edit permission on content, or it will throw a permission exception.

Responses

    Get a version of the content with option to expand on content and its sub fields, by default it expands content on version.

    Request
    query parameters
    parameter type description
    expand string

    Default: content

    Responses
      • Status 200 - application/json

        Example
        {"by":{"type":"known","username":"username","userKey":"","displayName":"Full Name","_expandable":{"operations":"","details":""}},"when":"2017-04-13T01:53:30.390Z","message":"This is first version","number":1,"minorEdit":false,"syncRev":"1234","content":{"id":"3604482","type":"page","status":"current","title":"Example Content title","space":{"key":"TST","metadata":{},"_expandable":{"operations":"","permissions":"","description":""},"_links":{"self":"http://myhost:8080/confluence/rest/api/space/TST"}},"version":{"number":2,"minorEdit":false},"ancestors":[],"operations":[],"children":{},"childTypes":{},"descendants":{},"body":{"storage":{"value":"<p>This is the updated text for the new page</p>","representation":"storage","embeddedContent":[],"_expandable":{"content":"/rest/api/content/3604482"}}},"metadata":{},"restrictions":{},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/3604482"}},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/3604482/version/1","base":"http://myhost:8080/confluence","context":"/confluence"}}

        Returns a JSON representation of a version.

        Schema
        {"id":"https://docs.atlassian.com/jira/REST/schema/version#","title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"content":{"title":"Content","type":"object","properties":{"id":{"title":"Content Id","type":"object"},"type":{"title":"Content Type","type":"object"},"status":{"title":"Content Status","type":"object"},"title":{"type":"string"},"space":{"type":"array","items":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false}},"history":{"type":"array","items":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"title":"Container","type":"object"}},"body":{"type":"object","patternProperties":{".+":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"content-representation":{"title":"Content Representation","type":"object"},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false,"required":["number","minorEdit"]}

      • Status 403
        Returned if the calling user does not have permission to view the content.
      • Status 404
        Returned if contentId+version cannot be found

    content/blueprint

    Publishes a legacy draft of a Content created from a ContentBlueprint

    Request
    query parameters
    parameter type description
    status string

    Default: draft

    expand string

    Default: body.storage,history,space,version,ancestors

    Schema
    {"id":"https://docs.atlassian.com/jira/REST/schema/content#","title":"Content","type":"object","properties":{"id":{"$ref":"#/definitions/content-id"},"type":{"$ref":"#/definitions/content-type"},"status":{"$ref":"#/definitions/content-status"},"title":{"type":"string"},"space":{"type":"array","items":{"$ref":"#/definitions/space"}},"history":{"type":"array","items":{"$ref":"#/definitions/history"}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"$ref":"#/definitions/container"}},"body":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/content-body"}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/content-restriction"}},"additionalProperties":false}},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"container":{"title":"Container","type":"object"},"content":{"title":"Content","type":"object","properties":{"id":{"$ref":"#/definitions/content-id"},"type":{"$ref":"#/definitions/content-type"},"status":{"$ref":"#/definitions/content-status"},"title":{"type":"string"},"space":{"type":"array","items":{"$ref":"#/definitions/space"}},"history":{"type":"array","items":{"$ref":"#/definitions/history"}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"$ref":"#/definitions/container"}},"body":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/content-body"}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/content-restriction"}},"additionalProperties":false}},"additionalProperties":false},"content-body":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"content-id":{"title":"Content Id","type":"object"},"content-representation":{"title":"Content Representation","type":"object"},"content-restriction":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false},"content-status":{"title":"Content Status","type":"object"},"content-type":{"title":"Content Type","type":"object"},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"history":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"space":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}

    Responses
      • Status - application/json

    Publishes a shared draft of a Content created from a ContentBlueprint

    Request
    query parameters
    parameter type description
    status string

    Default: draft

    expand string

    Default: body.storage,history,space,version,ancestors

    Schema
    {"id":"https://docs.atlassian.com/jira/REST/schema/content#","title":"Content","type":"object","properties":{"id":{"$ref":"#/definitions/content-id"},"type":{"$ref":"#/definitions/content-type"},"status":{"$ref":"#/definitions/content-status"},"title":{"type":"string"},"space":{"type":"array","items":{"$ref":"#/definitions/space"}},"history":{"type":"array","items":{"$ref":"#/definitions/history"}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"$ref":"#/definitions/container"}},"body":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/content-body"}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/content-restriction"}},"additionalProperties":false}},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"container":{"title":"Container","type":"object"},"content":{"title":"Content","type":"object","properties":{"id":{"$ref":"#/definitions/content-id"},"type":{"$ref":"#/definitions/content-type"},"status":{"$ref":"#/definitions/content-status"},"title":{"type":"string"},"space":{"type":"array","items":{"$ref":"#/definitions/space"}},"history":{"type":"array","items":{"$ref":"#/definitions/history"}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"$ref":"#/definitions/container"}},"body":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/content-body"}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/content-restriction"}},"additionalProperties":false}},"additionalProperties":false},"content-body":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"content-id":{"title":"Content Id","type":"object"},"content-representation":{"title":"Content Representation","type":"object"},"content-restriction":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false},"content-status":{"title":"Content Status","type":"object"},"content-type":{"title":"Content Type","type":"object"},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"history":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"space":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}

    Responses
      • Status - application/json

    contentbody/convert/{to}

    Used for converting ContentBody objects from one format to another.

    Converts between content body representations.

    Not all representations can be converted to/from other formats. Supported conversions:

    Source RepresentationDestination Representation Supported
    storageview,export_view,styled_view,editor
    editorstorage
    viewNone
    export_viewNone
    styled_viewNone

    Example request URI(s):

    • http://example.com/rest/api/contentbody/convert/view

    Request
    query parameters
    parameter type description
    expand string

    Default:

    A comma separated list of properties to expand on the content

    spaceKeyContext string

    Default:

    Space used for resolving the embedded content. Embedded content (page includes, files and links) in the content body are resolved using the optional space and content context parameters.
    For instance, if the spaceKeyContext=TST is provided. <ac:link><ri:page ri:content-title="test page" /><ac:link> will attempt to render a link to the page in the space with "TST" and title "test page".

    contentIdContext string

    Content used as context for converting the content body. spaceKeyContext will be ignored if this parameter is given.
    For instance, if the contentIdContext=123 is provided. <ac:link><ri:page ri:content-title="test page" /><ac:link> will attempt to render a link to "test page" in the same space as content with id of 123.

    embeddedContentRender string

    Default: current

    Mode used for rendering embedded content, such as attachments. Valid values are current (render the embedded content using the latest version) and version-at-save (render the embedded content using the version at the time of save). The default value is current.

    Example
    {"value":"<p>Some example body in storage format</p>","representation":"storage","embeddedContent":[]}

    Schema
    {"id":"https://docs.atlassian.com/jira/REST/schema/content-body#","title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"content":{"title":"Content","type":"object","properties":{"id":{"title":"Content Id","type":"object"},"type":{"title":"Content Type","type":"object"},"status":{"title":"Content Status","type":"object"},"title":{"type":"string"},"space":{"type":"array","items":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false}},"history":{"type":"array","items":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"title":"Container","type":"object"}},"body":{"type":"object","patternProperties":{".+":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"content-representation":{"title":"Content Representation","type":"object"},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}

    Responses
      • Status 200 - application/json

        Example
        {"value":"<p>Some example body in storage format</p>","representation":"storage","embeddedContent":[],"_expandable":{"content":"/rest/api/content/3604482"},"_links":{"base":"http://myhost:8080/confluence","context":"/confluence"}}

        Schema
        {"id":"https://docs.atlassian.com/jira/REST/schema/content-body#","title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"content":{"title":"Content","type":"object","properties":{"id":{"title":"Content Id","type":"object"},"type":{"title":"Content Type","type":"object"},"status":{"title":"Content Status","type":"object"},"title":{"type":"string"},"space":{"type":"array","items":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false}},"history":{"type":"array","items":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"title":"Container","type":"object"}},"body":{"type":"object","patternProperties":{".+":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"content-representation":{"title":"Content Representation","type":"object"},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}

    group

    Non-admin operations for user groups

    Get a paginated collection of user groups

    Request
    query parameters
    parameter type description
    expand string

    Default:

    start int

    the start point of the collection to return

    limit int

    Default: 200

    the limit of the number of items to return, this may be restricted by fixed system limits

    Responses
      • Status 200 - application/json

        Example
        {"results":[{"type":"group","name":"somegroup"},{"type":"group","name":"anothergroup"}],"size":2}

        Returns a full JSON representation of a list of groups

        Schema
        {"id":"https://docs.atlassian.com/jira/REST/schema/page-response-of-group#","title":"Page Response of Group","type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}

      • Status 403
        Returned if the calling user does not have permission to view groups.

    Get the user group with the group name

    Request
    query parameters
    parameter type description
    expand string
    Responses
      • Status 200 - application/json

        Example
        {"type":"group","name":"somegroup","_links":{"self":"http://myhost:8080/confluence/rest/experimental/group/somegroup","base":"http://myhost:8080/confluence","context":"/confluence"}}

        Returns a full JSON representation of a single groups

        Schema
        {"id":"https://docs.atlassian.com/jira/REST/schema/group#","title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}

      • Status 403
        Returned if the calling user does not have permission to view groups.

    Get a paginated collection of users in the given group

    Request
    query parameters
    parameter type description
    expand string
    start int

    the start point of the collection to return

    limit int

    Default: 200

    the limit of the number of items to return, this may be restricted by fixed system limits

    Responses
      • Status 200 - application/json

        Example
        {"results":[{"type":"known","profilePicture":{"path":"/wiki/relative/avatar.png","width":48,"height":48,"isDefault":true},"username":"jsmith","displayName":"Joe Smith","userKey":"402880824ff933a4014ff9345d7c0002","operations":null,"details":null}],"size":1}

        Returns a full JSON representation of a single groups

        Schema
        {"id":"https://docs.atlassian.com/jira/REST/schema/page-response-of-person#","title":"Page Response of Person","type":"array","items":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"displayName":{"type":"string"},"operations":{"type":"array","items":{"title":"Operation Check Result","type":"object","properties":{"operation":{"title":"Operation Key","type":"object"}},"additionalProperties":false}},"type":{"type":"string"}},"additionalProperties":false},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"displayName":{"type":"string"},"operations":{"type":"array","items":{"title":"Operation Check Result","type":"object","properties":{"operation":{"title":"Operation Key","type":"object"}},"additionalProperties":false}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"displayName":{"type":"string"},"operations":{"type":"array","items":{"title":"Operation Check Result","type":"object","properties":{"operation":{"title":"Operation Key","type":"object"}},"additionalProperties":false}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"displayName":{"type":"string"},"operations":{"type":"array","items":{"title":"Operation Check Result","type":"object","properties":{"operation":{"title":"Operation Key","type":"object"}},"additionalProperties":false}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false}}}

      • Status 403
        Returned if the calling user does not have permission to view users.

    longtask

    REST wrapper for the LongTaskService.

    Returns information about all tracked long-running tasks.

    Request
    query parameters
    parameter type description
    expand string

    Default:

    a comma separated list of properties to expand on the tasks

    start int
    limit int

    Default: 100

    Responses
      • Status 200 - application/json
        Returns a full JSON representation of a list of long tasks

        Schema
        {"id":"https://docs.atlassian.com/jira/REST/schema/rest-list-of-long-task-status#","title":"Rest List of Long Task Status","type":"array","items":{"title":"Long Task Status","type":"object","properties":{"id":{"title":"Long Task Id","type":"object"},"name":{"$ref":"#/definitions/message"},"elapsedTime":{"type":"integer"},"percentageComplete":{"type":"integer"},"successful":{"type":"boolean"},"messages":{"type":"array","items":{"$ref":"#/definitions/message"}}},"additionalProperties":false,"required":["elapsedTime","percentageComplete","successful"]},"definitions":{"message":{"title":"Message","type":"object","properties":{"args":{"type":"array","items":{}},"key":{"type":"string"},"translation":{"type":"string"}},"additionalProperties":false}}}

    Returns information about a long-running task.

    Request
    query parameters
    parameter type description
    expand string

    Default:

    a comma separated list of properties to expand on the task

    Responses
      • Status 200 - application/json
        Returns a full JSON representation of a long task

        Schema
        {"id":"https://docs.atlassian.com/jira/REST/schema/long-task-status#","title":"Long Task Status","type":"object","properties":{"id":{"title":"Long Task Id","type":"object"},"name":{"$ref":"#/definitions/message"},"elapsedTime":{"type":"integer"},"percentageComplete":{"type":"integer"},"successful":{"type":"boolean"},"messages":{"type":"array","items":{"$ref":"#/definitions/message"}}},"definitions":{"message":{"title":"Message","type":"object","properties":{"args":{"type":"array","items":{}},"key":{"type":"string"},"translation":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false,"required":["elapsedTime","percentageComplete","successful"]}

      • Status 404
        Returned if there is no task with the given key, or if the calling user does not have permission to view it

    relation

    A REST resource for manipulating relationships between users, spaces and content.
    Favourite relationships between users and space, page or blog post are supported, as well as arbitrary named relations.Show more

    Find relation instances of the given target type that have a relation with the relation name from the source entity

    Example request URI(s):

    • GET http://localhost:8080/confluence/rest/api/relation/favourite/from/user/current/to/space
    • GET http://localhost:8080/confluence/rest/api/relation/favourite/from/user/current/to/content

    Request
    query parameters
    parameter type description
    sourceStatus string

    The status of the source - this parameter is only used when the source has a type of content

    targetStatus string

    The status of the target - this parameter is only used when the target has a type of content

    sourceVersion int

    The version of the source - this parameter is only used when the source has a type of content and status of historical

    targetVersion int

    The version of the target - this parameter is only used when the target has a type of content and status of historical

    expand string

    Default:

    The dot separated expansion string to apply to the response, for instance : expand=source.details,target.body.view,relationData

    start int
    limit int

    Default: 25

    Responses
      • Status 200 - application/json

        Example
        {"results":[{"name":"collaborator","relationData":{"createdBy":{"type":"known","profilePicture":{"path":"/some/download/url","width":48,"height":48,"isDefault":false},"username":"euser","displayName":"Example User","userKey":"A123EDCE","operations":null,"details":null},"createdDate":"2017-04-13T01:53:30.374Z"},"target":{"type":"page","status":"current","title":"Example Content title","links":{},"space":{"key":"TST","icon":null,"description":null,"homepage":null,"links":{},"metadata":{},"operations":null,"permissions":null},"history":null,"version":null,"ancestors":[],"operations":[],"children":{},"childTypes":{},"descendants":{},"container":null,"body":{"storage":{"representation":"storage","value":"<p>This is a new page</p>","webresource":null,"embeddedContent":[],"content":null}},"metadata":{},"extensions":{},"restrictions":{}},"source":{"type":"known","profilePicture":{"path":"/some/download/url","width":48,"height":48,"isDefault":false},"username":"euser","displayName":"Example User","userKey":"A123EDCE","operations":null,"details":null}}],"size":1}

        Returns a full JSON representation of the relation instances to the given target type from the particular source

        Schema
        {"id":"https://docs.atlassian.com/jira/REST/schema/page-response-of-relation-instance#","title":"Page Response of Relation Instance","type":"array","items":{"$ref":"#/definitions/relation-instance"},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"displayName":{"type":"string"},"operations":{"type":"array","items":{"title":"Operation Check Result","type":"object","properties":{"operation":{"title":"Operation Key","type":"object"}},"additionalProperties":false}},"type":{"type":"string"}},"additionalProperties":false},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"displayName":{"type":"string"},"operations":{"type":"array","items":{"title":"Operation Check Result","type":"object","properties":{"operation":{"title":"Operation Key","type":"object"}},"additionalProperties":false}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"relation-instance":{"title":"Relation Instance","type":"object","properties":{"relationData":{"type":"array","items":{"title":"Relation","type":"object","properties":{"createdBy":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"createdDate":{"type":"string"}},"additionalProperties":false}},"target":{"type":"array","items":{"$ref":"#/definitions/relation-instance"}},"source":{"type":"array","items":{"title":"Relatable","type":"object"}},"name":{"type":"string"}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"displayName":{"type":"string"},"operations":{"type":"array","items":{"title":"Operation Check Result","type":"object","properties":{"operation":{"title":"Operation Key","type":"object"}},"additionalProperties":false}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"displayName":{"type":"string"},"operations":{"type":"array","items":{"title":"Operation Check Result","type":"object","properties":{"operation":{"title":"Operation Key","type":"object"}},"additionalProperties":false}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false}}}

      • Status 403
        Returned when the user does not have permission to inspect the relationship
      • Status 404
        Returned if the target does not exist

    Determines whether a relationship exists between two user, space or content entities.

    Example request URI(s):

    • GET http://localhost:8080/confluence/rest/api/relation/from/user/current/favourite/to/space/SPC
    • GET http://localhost:8080/confluence/rest/api/relation/from/user/current/favourite/to/content/1234

    Request
    query parameters
    parameter type description
    sourceStatus string

    The status of the source - this parameter is only used when the source has a type of content

    targetStatus string

    The status of the target - this parameter is only used when the target has a type of content

    sourceVersion int

    The version of the source - this parameter is only used when the source has a type of content and status of historical

    targetVersion int

    The version of the target - this parameter is only used when the target has a type of content and status of historical

    expand string

    Default:

    Responses
      • Status 200
        Returned if the relationship exists. For example, if a favourite relationship exists between a user and a space, page or blog post.

        Schema
        {"id":"https://docs.atlassian.com/jira/REST/schema/relation-instance-of-relatable-and-relatable#","title":"Relation Instance of Relatable-and-Relatable","type":"object","properties":{"relationData":{"type":"array","items":{"title":"Relation","type":"object","properties":{"createdBy":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"createdDate":{"type":"string"}},"additionalProperties":false}},"target":{"type":"array","items":{"$ref":"#/definitions/relatable"}},"source":{"type":"array","items":{"$ref":"#/definitions/relatable"}},"name":{"type":"string"}},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"displayName":{"type":"string"},"operations":{"type":"array","items":{"title":"Operation Check Result","type":"object","properties":{"operation":{"title":"Operation Key","type":"object"}},"additionalProperties":false}},"type":{"type":"string"}},"additionalProperties":false},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"displayName":{"type":"string"},"operations":{"type":"array","items":{"title":"Operation Check Result","type":"object","properties":{"operation":{"title":"Operation Key","type":"object"}},"additionalProperties":false}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"relatable":{"title":"Relatable","type":"object"},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"displayName":{"type":"string"},"operations":{"type":"array","items":{"title":"Operation Check Result","type":"object","properties":{"operation":{"title":"Operation Key","type":"object"}},"additionalProperties":false}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"displayName":{"type":"string"},"operations":{"type":"array","items":{"title":"Operation Check Result","type":"object","properties":{"operation":{"title":"Operation Key","type":"object"}},"additionalProperties":false}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false}

      • Status 403
        Returned when the user does not have permission to inspect the relationship
      • Status 404
        Returned if the relationship does not exist.

    Remove a relationship between two user, space, or content entities.

    For favourites, the current user can delete their own favourite relationships. A space administrator can delete a favourite relationship for any user.

    Example request URI(s):

    • DELETE http://localhost:8080/confluence/rest/api/relation/from/user/current/favourite/to/space/SPC
    • DELETE http://localhost:8080/confluence/rest/api/relation/from/user/current/favourite/to/content/1234

    Request
    query parameters
    parameter type description
    sourceStatus string

    The status of the source - this parameter is only used when the source has a type of content

    targetStatus string

    The status of the target - this parameter is only used when the target has a type of content

    sourceVersion int

    The version of the source - this parameter is only used when the source has a type of content and status of historical

    targetVersion int

    The version of the target - this parameter is only used when the target has a type of content and status of historical

    Responses
      • Status 204
        Returned if successfully removed, or the relationship was already removed
      • Status 403
        Returned when the user does not have permission to remove the relationship
      • Status 404
        Returned when the user, space or content could not be found

    Add a relationship between two user, space, or content entities.

    Favourite relationships between users and space, page or blog posts are supported. More relationship types will become available as development progresses.

    For favourites, the current user can create a favourite relationship between themselves and a space, page or blog post. A space administrator can add a favourite relationship for any user.

    Example request URI(s):

    • PUT http://localhost:8080/confluence/rest/api/relation/from/user/current/favourite/to/space/SPC
    • PUT http://localhost:8080/confluence/rest/api/relation/from/user/current/favourite/to/content/1234

    Request
    query parameters
    parameter type description
    sourceStatus string

    The status of the source - this parameter is only used when the source has a type of content

    targetStatus string

    The status of the target - this parameter is only used when the target has a type of content

    sourceVersion int

    The version of the source - this parameter is only used when the source has a type of content and status of historical

    targetVersion int

    The version of the target - this parameter is only used when the target has a type of content and status of historical

    Responses
      • Status 200
        Returned with a list of target entities if the source exists

        Schema
        {"id":"https://docs.atlassian.com/jira/REST/schema/relation-instance-of-relatable-and-relatable#","title":"Relation Instance of Relatable-and-Relatable","type":"object","properties":{"relationData":{"type":"array","items":{"title":"Relation","type":"object","properties":{"createdBy":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"createdDate":{"type":"string"}},"additionalProperties":false}},"target":{"type":"array","items":{"$ref":"#/definitions/relatable"}},"source":{"type":"array","items":{"$ref":"#/definitions/relatable"}},"name":{"type":"string"}},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"displayName":{"type":"string"},"operations":{"type":"array","items":{"title":"Operation Check Result","type":"object","properties":{"operation":{"title":"Operation Key","type":"object"}},"additionalProperties":false}},"type":{"type":"string"}},"additionalProperties":false},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"displayName":{"type":"string"},"operations":{"type":"array","items":{"title":"Operation Check Result","type":"object","properties":{"operation":{"title":"Operation Key","type":"object"}},"additionalProperties":false}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"relatable":{"title":"Relatable","type":"object"},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"displayName":{"type":"string"},"operations":{"type":"array","items":{"title":"Operation Check Result","type":"object","properties":{"operation":{"title":"Operation Key","type":"object"}},"additionalProperties":false}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"displayName":{"type":"string"},"operations":{"type":"array","items":{"title":"Operation Check Result","type":"object","properties":{"operation":{"title":"Operation Key","type":"object"}},"additionalProperties":false}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false}

      • Status 403
        Returned when the user does not have permission to use confluence
      • Status 404
        Returned when a user, space or content source could not be found

    Find relation instances to the given target entity that have a relation with the relation name from the source type

    Example request URI(s):

    • GET http://localhost:8080/confluence/rest/api/relation/collaborator/to/content/1234/from/user

    Request
    query parameters
    parameter type description
    targetStatus string

    The status of the target - this parameter is only used when the target has a type of content

    targetVersion int

    The version of the target - this parameter is only used when the target has a type of content and status of historical

    expand string

    Default:

    start int
    limit int

    Default: 25

    Responses
      • Status 200 - application/json

        Example
        {"results":[{"name":"collaborator","relationData":{"createdBy":{"type":"known","profilePicture":{"path":"/some/download/url","width":48,"height":48,"isDefault":false},"username":"euser","displayName":"Example User","userKey":"A123EDCE","operations":null,"details":null},"createdDate":"2017-04-13T01:53:30.374Z"},"target":{"type":"page","status":"current","title":"Example Content title","links":{},"space":{"key":"TST","icon":null,"description":null,"homepage":null,"links":{},"metadata":{},"operations":null,"permissions":null},"history":null,"version":null,"ancestors":[],"operations":[],"children":{},"childTypes":{},"descendants":{},"container":null,"body":{"storage":{"representation":"storage","value":"<p>This is a new page</p>","webresource":null,"embeddedContent":[],"content":null}},"metadata":{},"extensions":{},"restrictions":{}},"source":{"type":"known","profilePicture":{"path":"/some/download/url","width":48,"height":48,"isDefault":false},"username":"euser","displayName":"Example User","userKey":"A123EDCE","operations":null,"details":null}}],"size":1}

        Returns a full JSON representation of the relation instances

        Schema
        {"id":"https://docs.atlassian.com/jira/REST/schema/page-response-of-relation-instance#","title":"Page Response of Relation Instance","type":"array","items":{"$ref":"#/definitions/relation-instance"},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"displayName":{"type":"string"},"operations":{"type":"array","items":{"title":"Operation Check Result","type":"object","properties":{"operation":{"title":"Operation Key","type":"object"}},"additionalProperties":false}},"type":{"type":"string"}},"additionalProperties":false},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"displayName":{"type":"string"},"operations":{"type":"array","items":{"title":"Operation Check Result","type":"object","properties":{"operation":{"title":"Operation Key","type":"object"}},"additionalProperties":false}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"relation-instance":{"title":"Relation Instance","type":"object","properties":{"relationData":{"type":"array","items":{"title":"Relation","type":"object","properties":{"createdBy":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"createdDate":{"type":"string"}},"additionalProperties":false}},"target":{"type":"array","items":{"$ref":"#/definitions/relation-instance"}},"source":{"type":"array","items":{"title":"Relatable","type":"object"}},"name":{"type":"string"}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"displayName":{"type":"string"},"operations":{"type":"array","items":{"title":"Operation Check Result","type":"object","properties":{"operation":{"title":"Operation Key","type":"object"}},"additionalProperties":false}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"displayName":{"type":"string"},"operations":{"type":"array","items":{"title":"Operation Check Result","type":"object","properties":{"operation":{"title":"Operation Key","type":"object"}},"additionalProperties":false}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false}}}

      • Status 403
        Returned when the user does not have permission to inspect the relationship
      • Status 404
        Returned if the target does not exist
    API REST Resource for searching for entities in Confluence. Generally delegates to the CQLSearchService.Show more

    Search for entities in Confluence using the Confluence Query Language (CQL)

    For example :

    Example request URI(s):

    • http://localhost:8080/confluence/rest/api/search?cql=creator=currentUser()&type%20in%20(space,page,user)&cqlcontext={%22spaceKey%22:%22TST%22, %22contentId%22:%2255%22}
    • http://localhost:8080/confluence/rest/api/search?cql=siteSearch~'example'%20AND%20label=docs&expand=content.space,space.homepage&limit=10

    Request
    query parameters
    parameter type description
    cql string

    the CQL query see advanced searching in confluence using CQL

    cqlcontext string

    the execution context for CQL functions, provides current space key and content id. If this is not provided some CQL functions will not be available.

    excerpt string

    Default: highlight

    the excerpt strategy to apply to the result, one of : indexed, highlight, none. This defaults to highlight.

    expand string

    Default:

    the properties to expand on the search result, this may cause database requests for some properties

    start int

    the start point of the collection to return

    limit int

    Default: 25

    the limit of the number of items to return, this may be restricted by fixed system limits

    includeArchivedSpaces boolean

    Default: false

    whether to include content in archived spaces in the result, this defaults to false

    Responses
      • Status 200 - application/json

        Example
        {"results":[{"space":{"id":11,"key":"TST","name":"Example space","description":{"plain":{"value":"This is an example space","representation":"plain","embeddedContent":[]}},"metadata":{},"_expandable":{"operations":"","permissions":""},"_links":{"self":"http://myhost:8080/confluence/rest/api/space/TST"}},"title":"Example space","excerpt":"Example space","url":"/spaces/TST","breadcrumbs":[],"entityType":"space","iconCssClass":"space-css-class"},{"content":{"id":"1234","type":"page","status":"current","title":"Example Content title","space":{"id":11,"key":"TST","name":"Example space","description":{"plain":{"value":"This is an example space","representation":"plain","embeddedContent":[]}},"metadata":{},"_expandable":{"operations":"","permissions":""},"_links":{"self":"http://myhost:8080/confluence/rest/api/space/TST"}},"version":{"by":{"type":"known","username":"username","userKey":"","displayName":"Full Name","_expandable":{"operations":"","details":""}},"when":"2017-04-13T01:53:30.343Z","message":"change message for this edit","number":2,"minorEdit":false},"ancestors":[{"id":"123","type":"page","status":"current","ancestors":[],"operations":[],"children":{},"childTypes":{},"descendants":{},"body":{},"metadata":{},"restrictions":{},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/123"}}],"operations":[],"children":{},"childTypes":{},"descendants":{},"container":{"id":11,"key":"TST","name":"Example space","description":{"plain":{"value":"This is an example space","representation":"plain","embeddedContent":[]}},"metadata":{},"_expandable":{"operations":"","permissions":""},"_links":{"self":"http://myhost:8080/confluence/rest/api/space/TST"}},"body":{"view":{"value":"<p><h1>Example</h1>Some example content body</p>","representation":"view","embeddedContent":[],"_expandable":{"content":"/rest/api/content/1234"}}},"metadata":{},"restrictions":{},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/1234"}},"title":"Example Content title","excerpt":"<p><h1>Example</h1>Some example content body</p>","url":"/display/Example Content title","resultGlobalContainer":{"title":"Example space","displayUrl":"/spaces/TST"},"breadcrumbs":[],"entityType":"content","iconCssClass":"page-css-class"},{"user":{"type":"known","username":"euser","userKey":"A123EDCE","profilePicture":{"path":"/some/download/url","width":48,"height":48,"isDefault":false},"displayName":"Example User","_expandable":{"operations":"","details":""},"_links":{"self":"http://myhost:8080/confluence/rest/experimental/user?key=A123EDCE"}},"title":"Example User","url":"/display/user/euser","breadcrumbs":[],"entityType":"user","iconCssClass":"user-css-class"}],"start":0,"limit":3,"size":3,"totalSize":15,"cqlQuery":"title ~ example","searchDuration":50,"_links":{"base":"http://myhost:8080/confluence","context":"/confluence"}}

        Returns a full JSON representation of a list of search results

        Schema
        {"id":"https://docs.atlassian.com/jira/REST/schema/search-page-response-of-search-result#","title":"Search Page Response of Search Result","type":"array","items":{"title":"Search Result","type":"object","properties":{"title":{"type":"string"},"excerpt":{"type":"string"},"url":{"type":"string"},"resultParentContainer":{"type":"array","items":{"$ref":"#/definitions/container-summary"}},"resultGlobalContainer":{"type":"array","items":{"$ref":"#/definitions/container-summary"}},"breadcrumbs":{"type":"array","items":{"title":"Breadcrumb","type":"object","properties":{"label":{"type":"string"},"url":{"type":"string"},"separator":{"type":"string"}},"additionalProperties":false}},"iconCssClass":{"type":"string"},"lastModified":{"type":"string"},"friendlyLastModified":{"type":"string"}},"additionalProperties":false},"definitions":{"container-summary":{"title":"Container Summary","type":"object","properties":{"title":{"type":"string"},"displayUrl":{"type":"string"}},"additionalProperties":false}}}

      • Status 400
        Returned if the query cannot be parsed

    settings

    Endpoint to retrieve details of cloudId and other system specific details

    Responses
      • Status - application/json

    settings/lookandfeel

    A REST resource for manipulating the global and space-level look and feel settings.

    Get the current {@link LookAndFeelSettings} of the whole site or space. Response has Cache-Control header set for 10 minutes.

    Example request URI(s):

    • http://example.com/rest/api/settings/lookandfeel
    • http://example.com/rest/api/settings/lookandfeel?spaceKey=TST

    Request
    query parameters
    parameter type description
    spaceKey string

    space key identify the space, null if requesting for global site look and feel

    Responses
      • Status 200 - application/json

        Example
        {"headings":{"color":"#333333"},"links":{"color":"#3572B0"},"menus":{"hoverOrFocus":{"color":"#FFFFFF","backgroundColor":"#3873AE"},"color":"#000000"},"header":{"backgroundColor":"#661F2D","button":{"backgroundColor":"#894E59","color":"#FFFFFF"},"primaryNavigation":{"color":"#000000","hoverOrFocus":{"color":"#FFFFFF","backgroundColor":"#863647"}},"secondaryNavigation":{"color":"#000000","hoverOrFocus":{"color":"#FFFFFF","backgroundColor":"#863647"}},"search":{"backgroundColor":"#9A636B","color":"#FFFFFF"}},"content":{"screen":{"background":"linear-gradient(45deg, rgba(176,104,112,1) 0%, rgba(244,212,216,1) 100%)","layer":{"backgroundImage":"url('http://path/to/img/skyline.jpg')","backgroundSize":"cover","backgroundRepeat":"no-repeat","width":"100%","height":"250px"},"gutterTop":"20px","gutterRight":"small","gutterBottom":"10px","gutterLeft":"small"},"container":{"background":"#F4D4D8","padding":"0 20px","borderRadius":"10px"},"header":{"backgroundColor":"rgba(0, 0, 0, 0.2)","padding":"20px 0  90px 20px","borderRadius":"5px 5px 0 0"},"body":{"background":"#FFFFFF","padding":"10px","borderRadius":"0 0 5px 5px"}},"bordersAndDividers":{"color":"#0D0E0E"}}

        Returns a JSON representation of look and feel settings

        Schema
        {"id":"https://docs.atlassian.com/jira/REST/schema/look-and-feel-settings#","title":"Look And Feel Settings","type":"object","properties":{"selected":{"title":"Look And Feel Type","type":"object"},"global":{"$ref":"#/definitions/look-and-feel"},"theme":{"$ref":"#/definitions/look-and-feel"},"custom":{"$ref":"#/definitions/look-and-feel"}},"definitions":{"container-look-and-feel":{"title":"Container Look And Feel","type":"object","properties":{"background":{"type":"string"},"backgroundColor":{"type":"string"},"backgroundImage":{"type":"string"},"backgroundPosition":{"type":"string"},"backgroundSize":{"type":"string"},"backgroundRepeat":{"type":"string"},"backgroundOrigin":{"type":"string"},"backgroundClip":{"type":"string"},"backgroundAttachment":{"type":"string"},"backgroundBlendMode":{"type":"string"},"padding":{"type":"string"},"borderRadius":{"type":"string"}},"additionalProperties":false},"look-and-feel":{"title":"Look And Feel","type":"object","properties":{"headings":{"type":"object","patternProperties":{".+":{"type":"string"}},"additionalProperties":false},"links":{"type":"object","patternProperties":{".+":{"type":"string"}},"additionalProperties":false},"menus":{"title":"Menus Look And Feel","type":"object","properties":{"hoverOrFocus":{"type":"object","patternProperties":{".+":{"type":"string"}},"additionalProperties":false},"color":{"type":"string"}},"additionalProperties":false},"header":{"title":"Header Look And Feel","type":"object","properties":{"backgroundColor":{"type":"string"},"button":{"title":"Button Look And Feel","type":"object","properties":{"backgroundColor":{"type":"string"},"color":{"type":"string"}},"additionalProperties":false},"primaryNavigation":{"$ref":"#/definitions/navigation-look-and-feel"},"secondaryNavigation":{"$ref":"#/definitions/navigation-look-and-feel"},"search":{"title":"Search Field Look And Feel","type":"object","properties":{"backgroundColor":{"type":"string"},"color":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false},"content":{"title":"Content Look And Feel","type":"object","properties":{"screen":{"title":"Screen Look And Feel","type":"object","properties":{"background":{"type":"string"},"backgroundColor":{"type":"string"},"backgroundImage":{"type":"string"},"backgroundPosition":{"type":"string"},"backgroundSize":{"type":"string"},"backgroundRepeat":{"type":"string"},"backgroundOrigin":{"type":"string"},"backgroundClip":{"type":"string"},"backgroundAttachment":{"type":"string"},"backgroundBlendMode":{"type":"string"},"layer":{"title":"Layer Screen Look And Feel","type":"object","properties":{"background":{"type":"string"},"backgroundColor":{"type":"string"},"backgroundImage":{"type":"string"},"backgroundPosition":{"type":"string"},"backgroundSize":{"type":"string"},"backgroundRepeat":{"type":"string"},"backgroundOrigin":{"type":"string"},"backgroundClip":{"type":"string"},"backgroundAttachment":{"type":"string"},"backgroundBlendMode":{"type":"string"},"width":{"type":"string"},"height":{"type":"string"}},"additionalProperties":false},"gutterTop":{"type":"string"},"gutterRight":{"type":"string"},"gutterBottom":{"type":"string"},"gutterLeft":{"type":"string"}},"additionalProperties":false},"container":{"$ref":"#/definitions/container-look-and-feel"},"header":{"$ref":"#/definitions/container-look-and-feel"},"body":{"$ref":"#/definitions/container-look-and-feel"}},"additionalProperties":false},"bordersAndDividers":{"title":"Borders And Dividers Look And Feel","type":"object","properties":{"color":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false},"navigation-look-and-feel":{"title":"Navigation Look And Feel","type":"object","properties":{"color":{"type":"string"},"hoverOrFocus":{"type":"object","patternProperties":{".+":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false}

      • Status 400
        Returned if spaceKey is invalid space key
      • Status 404
        Returned if cannot find the space using spaceKey

    Submit a customised scheme for space

    Request
    query parameters
    parameter type description
    spaceKey string

    space key, null if customising a global look and feel.

    Example
    {"headings":{"color":"#333333"},"links":{"color":"#3572B0"},"menus":{"hoverOrFocus":{"color":"#FFFFFF","backgroundColor":"#3873AE"},"color":"#000000"},"header":{"backgroundColor":"#661F2D","button":{"backgroundColor":"#894E59","color":"#FFFFFF"},"primaryNavigation":{"color":"#000000","hoverOrFocus":{"color":"#FFFFFF","backgroundColor":"#863647"}},"secondaryNavigation":{"color":"#000000","hoverOrFocus":{"color":"#FFFFFF","backgroundColor":"#863647"}},"search":{"backgroundColor":"#9A636B","color":"#FFFFFF"}},"content":{"screen":{"background":"linear-gradient(45deg, rgba(176,104,112,1) 0%, rgba(244,212,216,1) 100%)","layer":{"backgroundImage":"url('http://path/to/img/skyline.jpg')","backgroundSize":"cover","backgroundRepeat":"no-repeat","width":"100%","height":"250px"},"gutterTop":"20px","gutterRight":"small","gutterBottom":"10px","gutterLeft":"small"},"container":{"background":"#F4D4D8","padding":"0 20px","borderRadius":"10px"},"header":{"backgroundColor":"rgba(0, 0, 0, 0.2)","padding":"20px 0  90px 20px","borderRadius":"5px 5px 0 0"},"body":{"background":"#FFFFFF","padding":"10px","borderRadius":"0 0 5px 5px"}},"bordersAndDividers":{"color":"#0D0E0E"}}

    Schema
    {"id":"https://docs.atlassian.com/jira/REST/schema/look-and-feel#","title":"Look And Feel","type":"object","properties":{"headings":{"type":"object","patternProperties":{".+":{"type":"string"}},"additionalProperties":false},"links":{"type":"object","patternProperties":{".+":{"type":"string"}},"additionalProperties":false},"menus":{"title":"Menus Look And Feel","type":"object","properties":{"hoverOrFocus":{"type":"object","patternProperties":{".+":{"type":"string"}},"additionalProperties":false},"color":{"type":"string"}},"additionalProperties":false},"header":{"title":"Header Look And Feel","type":"object","properties":{"backgroundColor":{"type":"string"},"button":{"title":"Button Look And Feel","type":"object","properties":{"backgroundColor":{"type":"string"},"color":{"type":"string"}},"additionalProperties":false},"primaryNavigation":{"$ref":"#/definitions/navigation-look-and-feel"},"secondaryNavigation":{"$ref":"#/definitions/navigation-look-and-feel"},"search":{"title":"Search Field Look And Feel","type":"object","properties":{"backgroundColor":{"type":"string"},"color":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false},"content":{"title":"Content Look And Feel","type":"object","properties":{"screen":{"title":"Screen Look And Feel","type":"object","properties":{"background":{"type":"string"},"backgroundColor":{"type":"string"},"backgroundImage":{"type":"string"},"backgroundPosition":{"type":"string"},"backgroundSize":{"type":"string"},"backgroundRepeat":{"type":"string"},"backgroundOrigin":{"type":"string"},"backgroundClip":{"type":"string"},"backgroundAttachment":{"type":"string"},"backgroundBlendMode":{"type":"string"},"layer":{"title":"Layer Screen Look And Feel","type":"object","properties":{"background":{"type":"string"},"backgroundColor":{"type":"string"},"backgroundImage":{"type":"string"},"backgroundPosition":{"type":"string"},"backgroundSize":{"type":"string"},"backgroundRepeat":{"type":"string"},"backgroundOrigin":{"type":"string"},"backgroundClip":{"type":"string"},"backgroundAttachment":{"type":"string"},"backgroundBlendMode":{"type":"string"},"width":{"type":"string"},"height":{"type":"string"}},"additionalProperties":false},"gutterTop":{"type":"string"},"gutterRight":{"type":"string"},"gutterBottom":{"type":"string"},"gutterLeft":{"type":"string"}},"additionalProperties":false},"container":{"$ref":"#/definitions/container-look-and-feel"},"header":{"$ref":"#/definitions/container-look-and-feel"},"body":{"$ref":"#/definitions/container-look-and-feel"}},"additionalProperties":false},"bordersAndDividers":{"title":"Borders And Dividers Look And Feel","type":"object","properties":{"color":{"type":"string"}},"additionalProperties":false}},"definitions":{"container-look-and-feel":{"title":"Container Look And Feel","type":"object","properties":{"background":{"type":"string"},"backgroundColor":{"type":"string"},"backgroundImage":{"type":"string"},"backgroundPosition":{"type":"string"},"backgroundSize":{"type":"string"},"backgroundRepeat":{"type":"string"},"backgroundOrigin":{"type":"string"},"backgroundClip":{"type":"string"},"backgroundAttachment":{"type":"string"},"backgroundBlendMode":{"type":"string"},"padding":{"type":"string"},"borderRadius":{"type":"string"}},"additionalProperties":false},"navigation-look-and-feel":{"title":"Navigation Look And Feel","type":"object","properties":{"color":{"type":"string"},"hoverOrFocus":{"type":"object","patternProperties":{".+":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false}

    Responses
      • Status 200 - application/json
        Returns a JSON representation of look and feel settings saved

        Schema
        {"id":"https://docs.atlassian.com/jira/REST/schema/look-and-feel#","title":"Look And Feel","type":"object","properties":{"headings":{"type":"object","patternProperties":{".+":{"type":"string"}},"additionalProperties":false},"links":{"type":"object","patternProperties":{".+":{"type":"string"}},"additionalProperties":false},"menus":{"title":"Menus Look And Feel","type":"object","properties":{"hoverOrFocus":{"type":"object","patternProperties":{".+":{"type":"string"}},"additionalProperties":false},"color":{"type":"string"}},"additionalProperties":false},"header":{"title":"Header Look And Feel","type":"object","properties":{"backgroundColor":{"type":"string"},"button":{"title":"Button Look And Feel","type":"object","properties":{"backgroundColor":{"type":"string"},"color":{"type":"string"}},"additionalProperties":false},"primaryNavigation":{"$ref":"#/definitions/navigation-look-and-feel"},"secondaryNavigation":{"$ref":"#/definitions/navigation-look-and-feel"},"search":{"title":"Search Field Look And Feel","type":"object","properties":{"backgroundColor":{"type":"string"},"color":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false},"content":{"title":"Content Look And Feel","type":"object","properties":{"screen":{"title":"Screen Look And Feel","type":"object","properties":{"background":{"type":"string"},"backgroundColor":{"type":"string"},"backgroundImage":{"type":"string"},"backgroundPosition":{"type":"string"},"backgroundSize":{"type":"string"},"backgroundRepeat":{"type":"string"},"backgroundOrigin":{"type":"string"},"backgroundClip":{"type":"string"},"backgroundAttachment":{"type":"string"},"backgroundBlendMode":{"type":"string"},"layer":{"title":"Layer Screen Look And Feel","type":"object","properties":{"background":{"type":"string"},"backgroundColor":{"type":"string"},"backgroundImage":{"type":"string"},"backgroundPosition":{"type":"string"},"backgroundSize":{"type":"string"},"backgroundRepeat":{"type":"string"},"backgroundOrigin":{"type":"string"},"backgroundClip":{"type":"string"},"backgroundAttachment":{"type":"string"},"backgroundBlendMode":{"type":"string"},"width":{"type":"string"},"height":{"type":"string"}},"additionalProperties":false},"gutterTop":{"type":"string"},"gutterRight":{"type":"string"},"gutterBottom":{"type":"string"},"gutterLeft":{"type":"string"}},"additionalProperties":false},"container":{"$ref":"#/definitions/container-look-and-feel"},"header":{"$ref":"#/definitions/container-look-and-feel"},"body":{"$ref":"#/definitions/container-look-and-feel"}},"additionalProperties":false},"bordersAndDividers":{"title":"Borders And Dividers Look And Feel","type":"object","properties":{"color":{"type":"string"}},"additionalProperties":false}},"definitions":{"container-look-and-feel":{"title":"Container Look And Feel","type":"object","properties":{"background":{"type":"string"},"backgroundColor":{"type":"string"},"backgroundImage":{"type":"string"},"backgroundPosition":{"type":"string"},"backgroundSize":{"type":"string"},"backgroundRepeat":{"type":"string"},"backgroundOrigin":{"type":"string"},"backgroundClip":{"type":"string"},"backgroundAttachment":{"type":"string"},"backgroundBlendMode":{"type":"string"},"padding":{"type":"string"},"borderRadius":{"type":"string"}},"additionalProperties":false},"navigation-look-and-feel":{"title":"Navigation Look And Feel","type":"object","properties":{"color":{"type":"string"},"hoverOrFocus":{"type":"object","patternProperties":{".+":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false}

      • Status 400
        Returned if spaceKey is invalid space key, or {@link LookAndFeel} contains invalid data.
      • Status 403
        Returned if the calling user doesn't have permission to edit the look and feel
      • Status 404
        Returned if cannot find the space using spaceKey

    Reset the look and feel to its default value.

    Request
    query parameters
    parameter type description
    spaceKey string

    space key, null if resetting global look and feel

    Responses

      Select the current look and feel for space or global

      Request
      query parameters
      parameter type description
      spaceKey string

      space key or null for global

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/look-and-feel-type#","title":"Look And Feel Type","type":"object"}

      Responses
        • Status 200
          select was successful

          Schema
          {"id":"https://docs.atlassian.com/jira/REST/schema/look-and-feel-type#","title":"Look And Feel Type","type":"object"}

        • Status 400
          Returned if spaceKey is invalid spaceKey or lookAndFeelType is of invalid type.
        • Status 403
          Returned if calling user doesn't have permission to change look and feel
        • Status 404
          Returned if cannot find the space using spaceKey

      settings/theme

      REST Resource which provides access to some of the {@link ThemeService} methods. Provides possibility to find all the available {@link Theme}s as well as get specific Theme with the known ID (if one exists).Show more

      Returns all the {@link Theme}s available within the Confluence instance.

      Example request URI:

      • http://example.com/confluence/rest/api/settings/theme?start=0&limit=50

      Request
      query parameters
      parameter type description
      expand string

      Default:

      a comma separated list of properties to expand in the response.

      start int

      Default: 0

      optional parameter indicating the start point of the collection to return

      limit int

      Default: 100

      optional parameter indicating the limit of the number of items to return, this may be restricted by fixed system limits

      Responses
        • Status 200 - application/json

          Example
          {"themeKey":"theme.plugin.key:theme.module.key","name":"Sample Theme","description":"Wonderful Sample Theme for Confluence","icon":{"path":"http://example.com/themeicon.gif","width":110,"height":70,"isDefault":true}}

          Returns a JSON representation of all the Themes available within the Confluence instance

          Schema
          {"id":"https://docs.atlassian.com/jira/REST/schema/page-response-of-theme#","title":"Page Response of Theme","type":"array","items":{"title":"Theme","type":"object","properties":{"themeKey":{"title":"Theme Key","type":"object"},"name":{"type":"string"},"description":{"type":"string"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]}},"additionalProperties":false}}

      Returns the {@link Theme} with specific {@code themeKey} if one is available within the Confluence instance.

      Example request URI:

      • http://example.com/confluence/rest/api/settings/theme/mytheme

      Request
      query parameters
      parameter type description
      expand string

      Default:

      a comma separated list of properties to expand in the response.

      Responses
        • Status 200 - application/json

          Example
          {"themeKey":"theme.plugin.key:theme.module.key","name":"Sample Theme","description":"Wonderful Sample Theme for Confluence","icon":{"path":"http://example.com/themeicon.gif","width":110,"height":70,"isDefault":true}}

          Returns a JSON representation of the specific Themes if one exists

          Schema
          {"id":"https://docs.atlassian.com/jira/REST/schema/theme#","title":"Theme","type":"object","properties":{"themeKey":{"title":"Theme Key","type":"object"},"name":{"type":"string"},"description":{"type":"string"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]}},"additionalProperties":false}

        • Status 404
          Returned if no such theme exists

      Returns the globally assigned {@link Theme} (if any).

      Example request URI:

      • http://example.com/confluence/rest/api/settings/theme/selected

      Request
      query parameters
      parameter type description
      expand string

      Default:

      a comma separated list of properties to expand in the response.

      Responses
        • Status 200 - application/json

          Example
          {"themeKey":"theme.plugin.key:theme.module.key","name":"Sample Theme","description":"Wonderful Sample Theme for Confluence","icon":{"path":"http://example.com/themeicon.gif","width":110,"height":70,"isDefault":true}}

          Returns a JSON representation of the Theme if one is assigned globally

          Schema
          {"id":"https://docs.atlassian.com/jira/REST/schema/theme#","title":"Theme","type":"object","properties":{"themeKey":{"title":"Theme Key","type":"object"},"name":{"type":"string"},"description":{"type":"string"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]}},"additionalProperties":false}

        • Status 404
          Returned if Confluence does not have a global Theme explicitly assigned to it

      space

      REST wrapper for the SpaceService.

      Returns information about a number of spaces.

      Example request URI(s):

      • http://example.com/rest/api/space?spaceKey=TST&spaceKey=ds

      Request
      query parameters
      parameter type description
      spaceKey string

      a list of space keys

      type string

      filter the list of spaces returned by type (global, personal)

      status string

      filter the list of spaces returned by status (current, archived)

      label string

      filter the list of spaces returned by label

      favourite boolean

      filter the list of spaces returned by favourites

      favouriteUserKey string

      the key of the user whose favourites to filter by. Leave blank for the current user

      expand string

      Default:

      a comma separated list of properties to expand on the spaces

      start int

      the start point of the collection to return

      limit int

      Default: 25

      the limit of the number of spaces to return, this may be restricted by fixed system limits

      Responses
        • Status 200 - application/json
          Returns an array of full JSON representations of found spaces

          Schema
          {"id":"https://docs.atlassian.com/jira/REST/schema/page-response-of-space#","title":"Page Response of Space","type":"array","items":{"$ref":"#/definitions/space"},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"content":{"title":"Content","type":"object","properties":{"id":{"title":"Content Id","type":"object"},"type":{"title":"Content Type","type":"object"},"status":{"title":"Content Status","type":"object"},"title":{"type":"string"},"space":{"type":"array","items":{"$ref":"#/definitions/space"}},"history":{"type":"array","items":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"title":"Container","type":"object"}},"body":{"type":"object","patternProperties":{".+":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"content-representation":{"title":"Content Representation","type":"object"},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"space":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}}}

      Creates a new space.

      The new space does not include an id, but must include a key and name, and should include a description.

      Permissions can also optionally be set on the new space for users and groups. For security reasons permissions cannot be changed via the API after the space has been created, they must be changed via the user interface.

      Example request:

      
                                       {
                                       "key": "DOC",
                                       "name": "Documentation Space",
                                       "permissions" : [{
                                       "operation": {
                                       "operation": "create",
                                       "targetType": "page"
                                       },
                                       "subjects": {
                                       "group": {
                                       "results": [{
                                       "type": "group",
                                       "name": "tech-writers"
                                       }],
                                       "size": 0
                                       }
                                       },
                                       "anonymousAccess": false,
                                       "unlicensedAccess": false
                                       }]
                                       }
                                       
      The available combinations of operations and target types are:
      • create: page, comment, attachment
      • read: space
      • update: blogpost
      • delete: page, blogpost, comment, attachment

      Request

      Example
      {"key":"TST","name":"Example space","description":{"plain":{"value":"This is an example space","representation":"plain","embeddedContent":[]}},"metadata":{},"permissions":[{"subjects":{"group":{"results":[{"type":"group","name":"confluence-users"}],"size":1}},"operation":{"operation":"delete","targetType":"blogpost"},"anonymousAccess":false,"unlicensedAccess":false}]}

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/space#","title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/formatted-body"}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"$ref":"#/definitions/space-type"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"$ref":"#/definitions/space-permission"}}},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"content":{"title":"Content","type":"object","properties":{"id":{"title":"Content Id","type":"object"},"type":{"title":"Content Type","type":"object"},"status":{"title":"Content Status","type":"object"},"title":{"type":"string"},"space":{"type":"array","items":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/formatted-body"}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"$ref":"#/definitions/space-type"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"$ref":"#/definitions/space-permission"}}},"additionalProperties":false}},"history":{"type":"array","items":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"title":"Container","type":"object"}},"body":{"type":"object","patternProperties":{".+":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"content-representation":{"title":"Content Representation","type":"object"},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"formatted-body":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"space-permission":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"space-type":{"title":"Space Type","type":"object"},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}

      Responses
        • Status 200 - application/json

          Example
          {"id":11,"key":"TST","name":"Example space","description":{"plain":{"value":"This is an example space","representation":"plain","embeddedContent":[]}},"metadata":{},"_expandable":{"operations":"","permissions":""},"_links":{"self":"http://myhost:8080/confluence/rest/api/space/TST","base":"http://myhost:8080/confluence","context":"/confluence","collection":"/rest/api/space"}}

          Returns a full JSON representation of a space

          Schema
          {"id":"https://docs.atlassian.com/jira/REST/schema/space#","title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/formatted-body"}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"$ref":"#/definitions/space-type"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"$ref":"#/definitions/space-permission"}}},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"content":{"title":"Content","type":"object","properties":{"id":{"title":"Content Id","type":"object"},"type":{"title":"Content Type","type":"object"},"status":{"title":"Content Status","type":"object"},"title":{"type":"string"},"space":{"type":"array","items":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/formatted-body"}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"$ref":"#/definitions/space-type"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"$ref":"#/definitions/space-permission"}}},"additionalProperties":false}},"history":{"type":"array","items":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"title":"Container","type":"object"}},"body":{"type":"object","patternProperties":{".+":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"content-representation":{"title":"Content Representation","type":"object"},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"formatted-body":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"space-permission":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"space-type":{"title":"Space Type","type":"object"},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}

      Creates a new private space, viewable only by its creator.

      The incoming Space does not include an id, but must include a key and name, and should include a description.

      Request

      Example
      {"key":"TST","name":"Example space","description":{"plain":{"value":"This is an example space","representation":"plain","embeddedContent":[]}},"metadata":{},"permissions":[{"subjects":{"group":{"results":[{"type":"group","name":"confluence-users"}],"size":1}},"operation":{"operation":"delete","targetType":"blogpost"},"anonymousAccess":false,"unlicensedAccess":false}]}

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/space#","title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/formatted-body"}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"$ref":"#/definitions/space-type"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"$ref":"#/definitions/space-permission"}}},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"content":{"title":"Content","type":"object","properties":{"id":{"title":"Content Id","type":"object"},"type":{"title":"Content Type","type":"object"},"status":{"title":"Content Status","type":"object"},"title":{"type":"string"},"space":{"type":"array","items":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/formatted-body"}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"$ref":"#/definitions/space-type"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"$ref":"#/definitions/space-permission"}}},"additionalProperties":false}},"history":{"type":"array","items":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"title":"Container","type":"object"}},"body":{"type":"object","patternProperties":{".+":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"content-representation":{"title":"Content Representation","type":"object"},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"formatted-body":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"space-permission":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"space-type":{"title":"Space Type","type":"object"},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}

      Responses
        • Status 200 - application/json

          Example
          {"id":11,"key":"TST","name":"Example space","description":{"plain":{"value":"This is an example space","representation":"plain","embeddedContent":[]}},"metadata":{},"_expandable":{"operations":"","permissions":""},"_links":{"self":"http://myhost:8080/confluence/rest/api/space/TST","base":"http://myhost:8080/confluence","context":"/confluence","collection":"/rest/api/space"}}

          Returns a full JSON representation of a space

          Schema
          {"id":"https://docs.atlassian.com/jira/REST/schema/space#","title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/formatted-body"}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"$ref":"#/definitions/space-type"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"$ref":"#/definitions/space-permission"}}},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"content":{"title":"Content","type":"object","properties":{"id":{"title":"Content Id","type":"object"},"type":{"title":"Content Type","type":"object"},"status":{"title":"Content Status","type":"object"},"title":{"type":"string"},"space":{"type":"array","items":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/formatted-body"}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"$ref":"#/definitions/space-type"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"$ref":"#/definitions/space-permission"}}},"additionalProperties":false}},"history":{"type":"array","items":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"title":"Container","type":"object"}},"body":{"type":"object","patternProperties":{".+":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"content-representation":{"title":"Content Representation","type":"object"},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"formatted-body":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"space-permission":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"space-type":{"title":"Space Type","type":"object"},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}

      Updates a space.

      Currently only the space name, description and homepage can be updated.

      Request

      Example
      {"key":"TST","name":"Example space","description":{"plain":{"value":"This is an example space","representation":"plain","embeddedContent":[]}},"metadata":{},"permissions":[{"subjects":{"group":{"results":[{"type":"group","name":"confluence-users"}],"size":1}},"operation":{"operation":"delete","targetType":"blogpost"},"anonymousAccess":false,"unlicensedAccess":false}]}

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/space#","title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/formatted-body"}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"$ref":"#/definitions/space-type"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"$ref":"#/definitions/space-permission"}}},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"content":{"title":"Content","type":"object","properties":{"id":{"title":"Content Id","type":"object"},"type":{"title":"Content Type","type":"object"},"status":{"title":"Content Status","type":"object"},"title":{"type":"string"},"space":{"type":"array","items":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/formatted-body"}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"$ref":"#/definitions/space-type"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"$ref":"#/definitions/space-permission"}}},"additionalProperties":false}},"history":{"type":"array","items":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"title":"Container","type":"object"}},"body":{"type":"object","patternProperties":{".+":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"content-representation":{"title":"Content Representation","type":"object"},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"formatted-body":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"space-permission":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"space-type":{"title":"Space Type","type":"object"},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}

      Responses
        • Status 200 - application/json

          Example
          {"id":11,"key":"TST","name":"Example space","description":{"plain":{"value":"This is an example space","representation":"plain","embeddedContent":[]}},"metadata":{},"_expandable":{"operations":"","permissions":""},"_links":{"self":"http://myhost:8080/confluence/rest/api/space/TST","base":"http://myhost:8080/confluence","context":"/confluence","collection":"/rest/api/space"}}

          Returns a full JSON representation of a space

          Schema
          {"id":"https://docs.atlassian.com/jira/REST/schema/space#","title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/formatted-body"}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"$ref":"#/definitions/space-type"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"$ref":"#/definitions/space-permission"}}},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"content":{"title":"Content","type":"object","properties":{"id":{"title":"Content Id","type":"object"},"type":{"title":"Content Type","type":"object"},"status":{"title":"Content Status","type":"object"},"title":{"type":"string"},"space":{"type":"array","items":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/formatted-body"}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"$ref":"#/definitions/space-type"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"$ref":"#/definitions/space-permission"}}},"additionalProperties":false}},"history":{"type":"array","items":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"title":"Container","type":"object"}},"body":{"type":"object","patternProperties":{".+":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"content-representation":{"title":"Content Representation","type":"object"},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"formatted-body":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"space-permission":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"space-type":{"title":"Space Type","type":"object"},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}

        • Status 404
          Returned if there is no space with the given key, or if the calling user does not have permission to update it.

      Deletes a Space.

      The space is deleted in a long running task, so the space cannot be considered deleted when this resource returns. Clients can follow the status link in the response and poll it until the task completes.

      Responses
        • Status 202 - application/json
          Returns a pointer to the status of the space-deletion task
        • Status 404
          Returned if there is no space with the given key, or if the calling user does not have permission to delete it.

      Returns information about a space.

      Example request URI(s):

      • http://example.com/rest/api/space/TST?expand=description

      Request
      query parameters
      parameter type description
      expand string

      Default:

      a comma separated list of properties to expand on the space

      Responses
        • Status 200 - application/json
          Returns a full JSON representation of a space

          Schema
          {"id":"https://docs.atlassian.com/jira/REST/schema/space#","title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/formatted-body"}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"$ref":"#/definitions/space-type"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"$ref":"#/definitions/space-permission"}}},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"content":{"title":"Content","type":"object","properties":{"id":{"title":"Content Id","type":"object"},"type":{"title":"Content Type","type":"object"},"status":{"title":"Content Status","type":"object"},"title":{"type":"string"},"space":{"type":"array","items":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/formatted-body"}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"$ref":"#/definitions/space-type"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"$ref":"#/definitions/space-permission"}}},"additionalProperties":false}},"history":{"type":"array","items":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"title":"Container","type":"object"}},"body":{"type":"object","patternProperties":{".+":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"content-representation":{"title":"Content Representation","type":"object"},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"formatted-body":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"space-permission":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"space-type":{"title":"Space Type","type":"object"},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}

        • Status 404
          Returned if there is no space with the given key, or if the calling user does not have permission to view the space.

      Returns the content in this given space

      Example request URI(s):

      • http://example.com/rest/api/space/TEST/content?expand=history

      Request
      query parameters
      parameter type description
      depth string

      Default: all

      a string indicating if all content, or just the root content of the space is returned. Default value: all. Valid values: all, root.

      expand string

      Default:

      a comma separated list of properties to expand on each piece of content retrieved

      start int

      the start point of the collection to return

      limit int

      Default: 25

      the limit of the number of labels to return, this may be restricted by fixed system limits

      Responses
        • Status 200 - application/json

          Example
          {"id":"1234","type":"page","status":"current","title":"Example Content title","space":{"id":11,"key":"TST","name":"Example space","description":{"plain":{"value":"This is an example space","representation":"plain","embeddedContent":[]}},"metadata":{},"_expandable":{"operations":"","permissions":""},"_links":{"self":"http://myhost:8080/confluence/rest/api/space/TST"}},"version":{"by":{"type":"known","username":"username","userKey":"","displayName":"Full Name","_expandable":{"operations":"","details":""}},"when":"2017-04-13T01:53:30.209Z","message":"change message for this edit","number":2,"minorEdit":false},"ancestors":[{"id":"123","type":"page","status":"current","ancestors":[],"operations":[],"children":{},"childTypes":{},"descendants":{},"body":{},"metadata":{},"restrictions":{},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/123"}}],"operations":[],"children":{},"childTypes":{},"descendants":{},"container":{"id":11,"key":"TST","name":"Example space","description":{"plain":{"value":"This is an example space","representation":"plain","embeddedContent":[]}},"metadata":{},"_expandable":{"operations":"","permissions":""},"_links":{"self":"http://myhost:8080/confluence/rest/api/space/TST"}},"body":{"view":{"value":"<p><h1>Example</h1>Some example content body</p>","representation":"view","embeddedContent":[],"_expandable":{"content":"/rest/api/content/1234"}}},"metadata":{},"restrictions":{},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/1234","base":"http://myhost:8080/confluence","context":"/confluence","collection":"/rest/api/content"}}

          Returns a full JSON representation of a piece of content

          Schema
          {"id":"https://docs.atlassian.com/jira/REST/schema/map-of-content-type#","title":"Map of Content Type","type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"content":{"title":"Content","type":"object","properties":{"id":{"title":"Content Id","type":"object"},"type":{"title":"Content Type","type":"object"},"status":{"title":"Content Status","type":"object"},"title":{"type":"string"},"space":{"type":"array","items":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false}},"history":{"type":"array","items":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"title":"Container","type":"object"}},"body":{"type":"object","patternProperties":{".+":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"content-representation":{"title":"Content Representation","type":"object"},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}

        • Status 404
          Returned if there is no content with the given id, or if the calling user does not have permission to view the content.

      Returns the content in this given space with the given type

      Example request URI(s):

      • http://example.com/rest/api/space/TEST/content/page?expand=history

      Request
      query parameters
      parameter type description
      depth string

      Default: all

      a string indicating if all content, or just the root content of the space is returned. Default value: all. Valid values: all, root.

      expand string

      Default:

      a comma separated list of properties to expand on each piece of content retrieved

      start int

      the start point of the collection to return

      limit int

      Default: 25

      the limit of the number of labels to return, this may be restricted by fixed system limits

      Responses
        • Status 200 - application/json

          Example
          {"id":"1234","type":"page","status":"current","title":"Example Content title","space":{"id":11,"key":"TST","name":"Example space","description":{"plain":{"value":"This is an example space","representation":"plain","embeddedContent":[]}},"metadata":{},"_expandable":{"operations":"","permissions":""},"_links":{"self":"http://myhost:8080/confluence/rest/api/space/TST"}},"version":{"by":{"type":"known","username":"username","userKey":"","displayName":"Full Name","_expandable":{"operations":"","details":""}},"when":"2017-04-13T01:53:30.209Z","message":"change message for this edit","number":2,"minorEdit":false},"ancestors":[{"id":"123","type":"page","status":"current","ancestors":[],"operations":[],"children":{},"childTypes":{},"descendants":{},"body":{},"metadata":{},"restrictions":{},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/123"}}],"operations":[],"children":{},"childTypes":{},"descendants":{},"container":{"id":11,"key":"TST","name":"Example space","description":{"plain":{"value":"This is an example space","representation":"plain","embeddedContent":[]}},"metadata":{},"_expandable":{"operations":"","permissions":""},"_links":{"self":"http://myhost:8080/confluence/rest/api/space/TST"}},"body":{"view":{"value":"<p><h1>Example</h1>Some example content body</p>","representation":"view","embeddedContent":[],"_expandable":{"content":"/rest/api/content/1234"}}},"metadata":{},"restrictions":{},"_links":{"self":"http://myhost:8080/confluence/rest/api/content/1234","base":"http://myhost:8080/confluence","context":"/confluence","collection":"/rest/api/content"}}

          Returns a full JSON representation of a piece of content

          Schema
          {"id":"https://docs.atlassian.com/jira/REST/schema/rest-list-of-content#","title":"Rest List of Content","type":"array","items":{"$ref":"#/definitions/content"},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"content":{"title":"Content","type":"object","properties":{"id":{"title":"Content Id","type":"object"},"type":{"title":"Content Type","type":"object"},"status":{"title":"Content Status","type":"object"},"title":{"type":"string"},"space":{"type":"array","items":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false}},"history":{"type":"array","items":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"title":"Container","type":"object"}},"body":{"type":"object","patternProperties":{".+":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"content-representation":{"title":"Content Representation","type":"object"},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}}}

        • Status 404
          Returned if there is no content with the given id, or if the calling user does not have permission to view the content.

      Returns the {@link SpaceSettings} of a specific {@link com.atlassian.confluence.api.model.content.Space Space} (if any).

      Example request URI:

      • http://example.com/confluence/rest/api/space/SPACE_KEY/settings

      Responses
        • Status 200 - application/json
          Returns a JSON representation of the Space Settings

          Schema
          {"id":"https://docs.atlassian.com/jira/REST/schema/space-settings#","title":"Space Settings","type":"object","properties":{"routeOverrideEnabled":{"type":"boolean"}},"additionalProperties":false,"required":["routeOverrideEnabled"]}

        • Status 404
          Returned if the Space does not exist

      Updates the Settings of a Space.

      Currently only the {@link SpaceSettings#routeOverrideEnabled} property can be updated.

      Request

      Example
      {@link com.atlassian.confluence.plugins.restapi.examples.SettingsExamples#SPACE_SETTINGS_DOC_EXAMPLE

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/space-settings#","title":"Space Settings","type":"object","properties":{"routeOverrideEnabled":{"type":"boolean"}},"additionalProperties":false,"required":["routeOverrideEnabled"]}

      Responses
        • Status 200 - application/json

          Example
          {@link com.atlassian.confluence.plugins.restapi.examples.SettingsExamples#SPACE_SETTINGS_DOC_EXAMPLE

          Returns a full JSON representation of the space settings

          Schema
          {"id":"https://docs.atlassian.com/jira/REST/schema/space-settings#","title":"Space Settings","type":"object","properties":{"routeOverrideEnabled":{"type":"boolean"}},"additionalProperties":false,"required":["routeOverrideEnabled"]}

        • Status 404
          Returned if there is no space with the given key, or if the calling user does not have permission to update it.

      space/{spaceKey}/property

      A REST resource for manipulating space properties.

      Space properties are a key / value store of properties attached to a Space. The key is a string, and the value is a JSON object.

      Show more

      Returns a paginated list of space properties.

      Example request URI:

      • http://example.com/rest/experimental/space/TST/property?expand=space,version

      Request
      query parameters
      parameter type description
      expand string

      Default: version

      a comma separated list of properties to expand on the space properties. Default value: version.

      start int

      the start point of the collection to return

      limit int

      Default: 10

      the limit of the number of items to return, this may be restricted by fixed system limits

      Responses
        • Status 200 - application/json

          Example
          {"results":[{"space":{"key":"TST","name":"Example space","description":{"plain":{"value":"This is an example space","representation":"plain","embeddedContent":[]}},"metadata":{},"permissions":[{"subjects":{"group":{"results":[{"type":"group","name":"confluence-users","_links":{"self":"http://myhost:8080/confluence/rest/experimental/group/confluence-users"}}],"size":1},"_expandable":{"user":""}},"operation":{"operation":"delete","targetType":"blogpost"},"anonymousAccess":false,"unlicensedAccess":false}],"_expandable":{"operations":""},"_links":{"self":"http://myhost:8080/confluence/rest/api/space/TST"}},"key":"example-property-key","value":{"anything":"goes"},"version":{"number":2,"minorEdit":false}}],"size":1,"_links":{"base":"http://myhost:8080/confluence","context":"/confluence"}}

          Returns a full JSON representation of the space property list

          Schema
          {"id":"https://docs.atlassian.com/jira/REST/schema/page-response-of-json-space-property#","title":"Page Response of Json Space Property","type":"array","items":{"title":"Json Space Property","type":"object","properties":{"key":{"type":"string"},"value":{"title":"Json String","type":"object"},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"space":{"type":"array","items":{"$ref":"#/definitions/space"}}},"additionalProperties":false},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"content":{"title":"Content","type":"object","properties":{"id":{"title":"Content Id","type":"object"},"type":{"title":"Content Type","type":"object"},"status":{"title":"Content Status","type":"object"},"title":{"type":"string"},"space":{"type":"array","items":{"$ref":"#/definitions/space"}},"history":{"type":"array","items":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"title":"Container","type":"object"}},"body":{"type":"object","patternProperties":{".+":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"content-representation":{"title":"Content Representation","type":"object"},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"space":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}}}

        • Status 404
          Returned if there is no space with the given key, or if the calling user does not have permission to view the space.

      Creates a new space property.

      Request

      Example
      {"key":"example-property-key","value":{"anything":"goes"}}

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/json-space-property#","title":"Json Space Property","type":"object","properties":{"key":{"type":"string"},"value":{"title":"Json String","type":"object"},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"space":{"type":"array","items":{"$ref":"#/definitions/space"}}},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"content":{"title":"Content","type":"object","properties":{"id":{"title":"Content Id","type":"object"},"type":{"title":"Content Type","type":"object"},"status":{"title":"Content Status","type":"object"},"title":{"type":"string"},"space":{"type":"array","items":{"$ref":"#/definitions/space"}},"history":{"type":"array","items":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"title":"Container","type":"object"}},"body":{"type":"object","patternProperties":{".+":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"content-representation":{"title":"Content Representation","type":"object"},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"space":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}

      Responses
        • Status 200 - application/json

          Example
          {"space":{"key":"TST","name":"Example space","description":{"plain":{"value":"This is an example space","representation":"plain","embeddedContent":[]}},"metadata":{},"permissions":[{"subjects":{"group":{"results":[{"type":"group","name":"confluence-users","_links":{"self":"http://myhost:8080/confluence/rest/experimental/group/confluence-users"}}],"size":1},"_expandable":{"user":""}},"operation":{"operation":"delete","targetType":"blogpost"},"anonymousAccess":false,"unlicensedAccess":false}],"_expandable":{"operations":""},"_links":{"self":"http://myhost:8080/confluence/rest/api/space/TST"}},"key":"example-property-key","value":{"anything":"goes"},"version":{"number":2,"minorEdit":false},"_links":{"base":"http://myhost:8080/confluence","context":"/confluence"}}

          Returns a full JSON representation of the space property

          Schema
          {"id":"https://docs.atlassian.com/jira/REST/schema/json-space-property#","title":"Json Space Property","type":"object","properties":{"key":{"type":"string"},"value":{"title":"Json String","type":"object"},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"space":{"type":"array","items":{"$ref":"#/definitions/space"}}},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"content":{"title":"Content","type":"object","properties":{"id":{"title":"Content Id","type":"object"},"type":{"title":"Content Type","type":"object"},"status":{"title":"Content Status","type":"object"},"title":{"type":"string"},"space":{"type":"array","items":{"$ref":"#/definitions/space"}},"history":{"type":"array","items":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"title":"Container","type":"object"}},"body":{"type":"object","patternProperties":{".+":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"content-representation":{"title":"Content Representation","type":"object"},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"space":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}

        • Status 400
          Returned if the space already has a value with the given key, or no property value was provided, or the value is too long.
        • Status 403
          Returned if the user does not have permission to edit the space with the given key
        • Status 413
          Returned if the value is too long.

      Returns a paginated list of space properties.

      Example request URI:

      • http://example.com/rest/experimental/space/TST/property?expand=space,version

      Request
      query parameters
      parameter type description
      expand string

      Default: version

      a comma separated list of properties to expand on the space properties. Default value: version.

      Responses
        • Status 200 - application/json

          Example
          {"results":[{"space":{"key":"TST","name":"Example space","description":{"plain":{"value":"This is an example space","representation":"plain","embeddedContent":[]}},"metadata":{},"permissions":[{"subjects":{"group":{"results":[{"type":"group","name":"confluence-users","_links":{"self":"http://myhost:8080/confluence/rest/experimental/group/confluence-users"}}],"size":1},"_expandable":{"user":""}},"operation":{"operation":"delete","targetType":"blogpost"},"anonymousAccess":false,"unlicensedAccess":false}],"_expandable":{"operations":""},"_links":{"self":"http://myhost:8080/confluence/rest/api/space/TST"}},"key":"example-property-key","value":{"anything":"goes"},"version":{"number":2,"minorEdit":false}}],"size":1,"_links":{"base":"http://myhost:8080/confluence","context":"/confluence"}}

          Returns a full JSON representation of the space property list

          Schema
          {"id":"https://docs.atlassian.com/jira/REST/schema/json-space-property#","title":"Json Space Property","type":"object","properties":{"key":{"type":"string"},"value":{"title":"Json String","type":"object"},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"space":{"type":"array","items":{"$ref":"#/definitions/space"}}},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"content":{"title":"Content","type":"object","properties":{"id":{"title":"Content Id","type":"object"},"type":{"title":"Content Type","type":"object"},"status":{"title":"Content Status","type":"object"},"title":{"type":"string"},"space":{"type":"array","items":{"$ref":"#/definitions/space"}},"history":{"type":"array","items":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"title":"Container","type":"object"}},"body":{"type":"object","patternProperties":{".+":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"content-representation":{"title":"Content Representation","type":"object"},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"space":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}

        • Status 404
          Returned if there is no space with the given key, or if the calling user does not have permission to view the space.

      Updates a space property.

      The body contains the representation of the space property. Must include new version number. If the given version number is 1, attempts to create a new space property, just like {@link #create(String, com.atlassian.confluence.api.model.content.JsonSpaceProperty)}.

      Request

      Example
      {"key":"example-property-key","value":{"anything":"goes"},"version":{"number":2,"minorEdit":false}}

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/json-space-property#","title":"Json Space Property","type":"object","properties":{"key":{"type":"string"},"value":{"title":"Json String","type":"object"},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"space":{"type":"array","items":{"$ref":"#/definitions/space"}}},"definitions":{"anonymous":{"title":"Anonymous","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"type":{"type":"string"}},"additionalProperties":false},"content":{"title":"Content","type":"object","properties":{"id":{"title":"Content Id","type":"object"},"type":{"title":"Content Type","type":"object"},"status":{"title":"Content Status","type":"object"},"title":{"type":"string"},"space":{"type":"array","items":{"$ref":"#/definitions/space"}},"history":{"type":"array","items":{"title":"History","type":"object","properties":{"previousVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"nextVersion":{"type":"array","items":{"$ref":"#/definitions/version"}},"lastUpdated":{"type":"array","items":{"$ref":"#/definitions/version"}},"latest":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/person"},"createdDate":{"type":"string"},"contributors":{"type":"array","items":{"title":"Contributors","type":"object","properties":{"publishers":{"type":"array","items":{"title":"Contributor Users","type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/person"}},"userKeys":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false,"required":["latest"]}},"version":{"type":"array","items":{"$ref":"#/definitions/version"}},"ancestors":{"type":"array","items":{"$ref":"#/definitions/content"}},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"children":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"childTypes":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false},"descendants":{"type":"object","patternProperties":{".+":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false},"container":{"type":"array","items":{"title":"Container","type":"object"}},"body":{"type":"object","patternProperties":{".+":{"title":"Content Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false}},"additionalProperties":false},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"extensions":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"restrictions":{"type":"object","patternProperties":{".+":{"title":"Content Restriction","type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/content"}},"operation":{"$ref":"#/definitions/operation-key"},"restrictions":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"content-representation":{"title":"Content Representation","type":"object"},"embedded-content":{"title":"Embedded Content","type":"object","properties":{"entityId":{"type":"integer"}},"additionalProperties":false,"required":["entityId"]},"html-string":{"title":"Html String","type":"object"},"icon":{"title":"Icon","type":"object","properties":{"path":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"isDefault":{"type":"boolean"}},"additionalProperties":false,"required":["width","height","isDefault"]},"known-user":{"title":"Known User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"},"details":{"type":"array","items":{"title":"User Details","type":"object","properties":{"personal":{"type":"array","items":{"title":"Personal Details","type":"object","properties":{"phone":{"type":"array","items":{"type":"string"}},"im":{"type":"array","items":{"type":"string"}},"website":{"type":"array","items":{"type":"string"}},"email":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"business":{"type":"array","items":{"title":"Business Details","type":"object","properties":{"position":{"type":"array","items":{"type":"string"}},"department":{"type":"array","items":{"type":"string"}},"location":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false}}},"additionalProperties":false},"operation-check-result":{"title":"Operation Check Result","type":"object","properties":{"operation":{"$ref":"#/definitions/operation-key"}},"additionalProperties":false},"operation-key":{"title":"Operation Key","type":"object"},"person":{"title":"Person","type":"object","anyOf":[{"$ref":"#/definitions/anonymous"},{"$ref":"#/definitions/known-user"},{"$ref":"#/definitions/unknown-user"},{"$ref":"#/definitions/user"}]},"space":{"title":"Space","type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"name":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/definitions/icon"}},"description":{"type":"object","patternProperties":{".+":{"title":"Formatted Body","type":"object","properties":{"value":{"type":"string"},"webresource":{"type":"array","items":{"$ref":"#/definitions/web-resource-dependencies"}},"representation":{"$ref":"#/definitions/content-representation"},"embeddedContent":{"type":"array","items":{"$ref":"#/definitions/embedded-content"}}},"additionalProperties":false}},"additionalProperties":false},"homepage":{"type":"array","items":{"$ref":"#/definitions/content"}},"type":{"title":"Space Type","type":"object"},"metadata":{"type":"object","patternProperties":{".+":{}},"additionalProperties":false},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"permissions":{"type":"array","items":{"title":"Space Permission","type":"object","properties":{"subjects":{"type":"array","items":{"$ref":"#/definitions/subjects-by-type"}},"operation":{"$ref":"#/definitions/operation-check-result"},"anonymousAccess":{"type":"array","items":{"type":"boolean"}},"unlicensedAccess":{"type":"array","items":{"type":"boolean"}}},"additionalProperties":false}}},"additionalProperties":false},"subjects-by-type":{"title":"Subjects By Type","type":"object","properties":{"user":{"type":"array","items":{"$ref":"#/definitions/user"}},"group":{"type":"array","items":{"title":"Group","type":"object","properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},"unknown-user":{"title":"Unknown User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"user":{"title":"User","type":"object","properties":{"profilePicture":{"$ref":"#/definitions/icon"},"displayName":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/definitions/operation-check-result"}},"username":{"type":"string"},"accountId":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version","type":"object","properties":{"by":{"$ref":"#/definitions/person"},"when":{"type":"string"},"friendlyWhen":{"type":"string"},"message":{"type":"string"},"number":{"type":"integer"},"minorEdit":{"type":"boolean"},"syncRev":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/definitions/content"}}},"additionalProperties":false,"required":["number","minorEdit"]},"web-resource-dependencies":{"title":"Web Resource Dependencies","type":"object","properties":{"keys":{"type":"array","items":{"type":"string"}},"contexts":{"type":"array","items":{"type":"string"}},"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"superbatch":{"type":"array","items":{"title":"Super Batch Web Resources","type":"object","properties":{"uris":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"string","format":"uri"}}},"additionalProperties":false},"tags":{"type":"object","patternProperties":{".+":{"$ref":"#/definitions/html-string"}},"additionalProperties":false},"metatags":{"type":"array","items":{"$ref":"#/definitions/html-string"}}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}

      Resp