Microblogging for Confluence

Share information, have conversations, write messages and updates

See the documentation for your Release

REST APIs

Confluence Microblog

/sketch


POST

Parameters

NameLocated inDescriptionRequiredSchema
topicIdformDataYesstring

Responses

CodeDescriptionSchema

/draft (Deprecated)


Use POST /sketch instead

/hashtag/{hashtag} (Deprecated)


use GET microposts/search?query=thread.hashtag:{hashtag}

Responses

CodeDescriptionSchema
200OKMicroblogResponseDto

/micropost (Deprecated)


Use "POST /draft" you will get an id then "PUT /microposts/{id}" with that id)

POST

Parameters

NameLocated inDescriptionRequiredSchema
htmlformDataYesstring
topicIdformDataYesstring

Responses

CodeDescriptionSchema
200OKMicroPostContent

/microposts (Deprecated)


use GET microposts/search?query=micropostType:parent

GET

Parameters

NameLocated inDescriptionRequiredSchema
limitqueryYesinteger
offsetqueryYesinteger
plaintextqueryYesboolean

Responses

CodeDescriptionSchema
200OKMicroblogResponseDto

/microposts/count


GET

Parameters

NameLocated inDescriptionRequiredSchema
limitqueryYesinteger
offsetqueryYesinteger
queryqueryYesstring

Responses

CodeDescriptionSchema
200OKinteger

/microposts/search


GET

Parameters

NameLocated inDescriptionRequiredSchema
limitqueryYesinteger
offsetqueryYesinteger
queryqueryYesstring

Responses

CodeDescriptionSchema
200OKMicroblogResponseDto

/microposts/since/{id} (Deprecated)


use GET microposts/search?query=thread.micropostId:[{id+1}+TO+*]

GET

Parameters

NameLocated inDescriptionRequiredSchema
idpathYesstring
limitqueryYesinteger
offsetqueryYesinteger
plaintextqueryYesboolean

Responses

CodeDescriptionSchema
200OKMicroblogResponseDto

/microposts/{id}


GET

Parameters

NameLocated inDescriptionRequiredSchema
idpathYesstring

Responses

CodeDescriptionSchema
200OKMicroPostContent
PUT

Parameters

NameLocated inDescriptionRequiredSchema
idpathYesstring
htmlformDataYesstring
parentIdformDataYesstring
topicIdformDataYesstring

Responses

CodeDescriptionSchema
200OK
DELETE

Parameters

NameLocated inDescriptionRequiredSchema
idpathYesstring

Responses

CodeDescriptionSchema
200OK

/microposts/{id}/editorformat


GET

Parameters

NameLocated inDescriptionRequiredSchema
idpathYesstring

Responses

CodeDescriptionSchema
200OKstring

/microposts/{id}/like


POST

Parameters

NameLocated inDescriptionRequiredSchema
idpathYesstring

Responses

CodeDescriptionSchema
200OK

/microposts/{id}/likes


GET

Parameters

NameLocated inDescriptionRequiredSchema
idpathYesstring

Responses

CodeDescriptionSchema
200OK[like]

/microposts/{id}/oldversions


GET

Parameters

NameLocated inDescriptionRequiredSchema
idpathYesstring

Responses

CodeDescriptionSchema
200OK[ MicroPostContent ]

/my-spaces-and-topics


GET

Parameters

NameLocated inDescriptionRequiredSchema

Responses

CodeDescriptionSchema
200OKUserSelectionDto
PUT

Parameters

NameLocated inDescriptionRequiredSchema
bodybodyYesUserSelectionDto

Responses

CodeDescription
204No Content

/space/{spaceKey} (Deprecated)


use GET /microposts/search?query=thread.spaceKey:{spaceKey}

GET

Parameters

NameLocated inDescriptionRequiredSchema
spaceKeypathYesstring
limitqueryYesinteger
offsetqueryYesinteger
plaintextqueryYesboolean

Responses

CodeDescriptionSchema
200OKMicroblogResponseDto

/space/{spaceKey}/users/{username} (Deprecated)


use GET microposts/search?query=thread.spaceKey:{spaceKey}+AND+thread.author:{username}

GET

Parameters

NameLocated inDescriptionRequiredSchema
spaceKeypathYesstring
usernamepathYesstring
limitqueryYesinteger
offsetqueryYesinteger
plaintextqueryYesboolean

Responses

CodeDescriptionSchema
200OKMicroblogResponseDto

/subscription


GET

Parameters

NameLocated inDescriptionRequiredSchema

Responses

CodeDescriptionSchema
200OKSubscriptionDto
POST

Parameters

NameLocated inDescriptionRequiredSchema

Responses

CodeDescriptionSchema
200OKSubscriptionDto
DELETE

Parameters

NameLocated inDescriptionRequiredSchema

Responses

CodeDescriptionSchema
200OKSubscriptionDto

/subscription/global (Deprecated)


use /selection with body '{"global": true}' instead

PUT

Parameters

NameLocated inDescriptionRequiredSchema

Responses

CodeDescriptionSchema
200OKSubscriptionDto

/subscription/myselection


PUT

Parameters

NameLocated inDescriptionRequiredSchema

Responses

CodeDescriptionSchema
200OKSubscriptionDto

/subscription/selection


PUT

Parameters

NameLocated inDescriptionRequiredSchema
bodybodyYesUserSelectionDto

Responses

CodeDescriptionSchema
200OKSubscriptionDto

/subscription/time


PUT

Parameters

NameLocated inDescriptionRequiredSchema
bodybodyYesDigestTime

Responses

CodeDescriptionSchema
200OKSubscriptionDto

/subscription/type


PUT

Parameters

NameLocated inDescriptionRequiredSchema
bodybodyYesstring

Responses

CodeDescriptionSchema
200OKSubscriptionDto

/topics


GET

Parameters

NameLocated inDescriptionRequiredSchema

Responses

CodeDescriptionSchema
200OK[topic]
POST

Parameters

NameLocated inDescriptionRequiredSchema
spaceKeyformDataYesstring
topicNameformDataYesstring

Responses

CodeDescriptionSchema
200OK

/topics/permission/administerable


GET

Parameters

NameLocated inDescriptionRequiredSchema

Responses

CodeDescriptionSchema
200OK[topic]

/topics/permission/writable


GET

Parameters

NameLocated inDescriptionRequiredSchema

Responses

CodeDescriptionSchema
200OK[topic]

/topics/space/{spaceKey}


GET

Parameters

NameLocated inDescriptionRequiredSchema
spaceKeypathYesstring

Responses

CodeDescriptionSchema
200OK[topic]

/topics/space/{spaceKey}/topicorder


PUT

Parameters

NameLocated inDescriptionRequiredSchema
spaceKeypathYesstring
bodybodyYesinteger

Responses

CodeDescriptionSchema
200OK

/topics/user


GET

Parameters

NameLocated inDescriptionRequiredSchema

Responses

CodeDescriptionSchema
200OK[ user ]

/topics/user/writable (Deprecated)


use /microposts/permission/writable instead

GET

Parameters

NameLocated inDescriptionRequiredSchema

Responses

CodeDescriptionSchema
200OK[topic]

/topics/{spaceKey}


GET

Parameters

NameLocated inDescriptionRequiredSchema
spaceKeypathYesstring

Responses

CodeDescriptionSchema
200OK[topic]

/topics/{topicId}


POST

Parameters

NameLocated inDescriptionRequiredSchema
topicIdpathYesstring
spaceKeyformDataYesstring
topicNameformDataYesstring

Responses

CodeDescriptionSchema
200OK
DELETE

Parameters

NameLocated inDescriptionRequiredSchema
topicIdpathYesstring

Responses

CodeDescriptionSchema
200OK

/topics/{topicId}/microposts (Deprecated)


use /microposts/search with the topic in the query body instead "thread.topicId:{topicId}"

GET

Parameters

NameLocated inDescriptionRequiredSchema
topicIdpathYesstring
limitqueryYesinteger
offsetqueryYesinteger
plaintextqueryYesboolean

Responses

CodeDescriptionSchema
200OKMicroblogResponseDto

/topics/{topicId}/move/space/{newSpaceKey}


PUT

Parameters

NameLocated inDescriptionRequiredSchema
newSpaceKeypathYesstring
topicIdpathYesinteger

Responses

CodeDescriptionSchema
200OK

/topics/{topicId}/move/topic/{newTopicId}


PUT

Parameters

NameLocated inDescriptionRequiredSchema
newTopicIdpathYesinteger
topicIdpathYesinteger

Responses

CodeDescriptionSchema
200OK

/users/reply


GET

Parameters

NameLocated inDescriptionRequiredSchema
usernamequeryYesstring

Responses

CodeDescriptionSchema
200OKReplyUserInformationDto

Models


<a name="userSelectionDto"></a>UserSelectionDto

NameTypeDescriptionRequired
globalbooleanNo
spaceIds[ number ]No
topicIds[ topic ]No

<a name="microblogResponseDto"></a>MicroblogResponseDto

NameTypeDescriptionRequired
microposts[ MicroPostContent ]No
hasMorebooleanNo
lastRefreshIdnumberNo

<a name="digestTime"></a>DigestTime

NameTypeDescriptionRequired
timenumberNo
formattedTimestringNo
validbooleanNo

<a name="microPostContent"></a>MicroPostContent

NameTypeDescriptionRequired
idnumberNo
creationDatestringNo
authorFullNamestringNo
authorNamestringNo
contentstringNo
replies[MicroPostContent]No
canRemoveMicropostbooleanNo
spaceKeystringNo
parentIdstringNo
canReplyMicropostbooleanNo
canEditMicropostbooleanNo
canLikeMicropostbooleanNo
topictopicNo
...

<a name="subscriptionDto"></a>SubscriptionDto

NameTypeDescriptionRequired
hasSubscribedbooleanNo
userKeystringNo
timestringNo
mySelectionbooleanNo
typestringNo
selectionselectionNo

<a name="replyUserInformationDto"></a>ReplyUserInformationDto

NameTypeDescriptionRequired
usernamestringNo
userFullnamestringNo
contentIdnumberNo

 

  • No labels

This content was last updated on 01/14/2020.

This content hasn't been updated in a while. That doesn't have to be a problem. Some of our pages live for years without becoming obsolete.

Old content can be incorrect, misleading or outdated. Please get in contact with us via a form on this page, our live chat or via email with content@seibert.group if you are in doubt, have a question, suggestion, or want changes from us.