Microblog APIs

Documentation's navigation

Disclaimer

Please be aware that all APIs might be subject to change without prior announcement.

There is no guarantee and no support.

Usage at your own risk.

/sketch

POST

Parameters

Name	Located in	Description	Required	Schema
topicId	formData		Yes	string

Responses

Code	Description	Schema

/hashtag/{hashtag} (Deprecated)

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

Responses

Code	Description	Schema
200	OK	MicroblogResponseDto

/micropost (Deprecated)

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

POST

Parameters

Name	Located in	Description	Required	Schema
html	formData		Yes	string
topicId	formData		Yes	string

Responses

Code	Description	Schema
200	OK	MicroPostContent

/microposts (Deprecated)

use GET microposts/search?query=micropostType:parent

GET

Parameters

Name	Located in	Required	Schema
limit	query	Yes	integer
offset	query	Yes	integer
plaintext	query	Yes	boolean

Responses

Code	Description	Schema
200	OK	MicroblogResponseDto

/microposts/count

GET

Parameters

Name	Located in	Required	Schema
limit	query	Yes	integer
offset	query	Yes	integer
query	query	Yes	string

Responses

Code	Description	Schema
200	OK	integer

/microposts/search

GET

Parameters

Name	Located in	Required	Schema
limit	query	Yes	integer
offset	query	Yes	integer
query	query	Yes	string

Responses

Code	Description	Schema
200	OK	MicroblogResponseDto

/microposts/since/{id} (Deprecated)

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

GET

Parameters

Name	Located in	Required	Schema
id	path	Yes	string
limit	query	Yes	integer
offset	query	Yes	integer
plaintext	query	Yes	boolean

Responses

Code	Description	Schema
200	OK	MicroblogResponseDto

/microposts/{id}

GET

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	string

Responses

Code	Description	Schema
200	OK	MicroPostContent

PUT

Parameters

Name	Located in	Required	Schema
id	path	Yes	string
html	formData	Yes	string
parentId	formData	Yes	string
topicId	formData	Yes	string

Responses

Code	Description	Schema
200	OK

DELETE

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	string

Responses

Code	Description	Schema
200	OK

/microposts/{id}/editorformat

GET

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	string

Responses

Code	Description	Schema
200	OK	string

/microposts/{id}/like

POST

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	string

Responses

Code	Description	Schema
200	OK

/microposts/{id}/likes

GET

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	string

Responses

Code	Description	Schema
200	OK	[like]

/microposts/{id}/oldversions

GET

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	string

Responses

Code	Description	Schema
200	OK	[ MicroPostContent ]

/my-spaces-and-topics

GET

Parameters

Name	Located in	Description	Required	Schema

Responses

Code	Description	Schema
200	OK	UserSelectionDto

PUT

Parameters

Name	Located in	Description	Required	Schema
body	body		Yes	UserSelectionDto

Responses

Code	Description
204	No Content

/space/{spaceKey} (Deprecated)

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

GET

Parameters

Name	Located in	Required	Schema
spaceKey	path	Yes	string
limit	query	Yes	integer
offset	query	Yes	integer
plaintext	query	Yes	boolean

Responses

Code	Description	Schema
200	OK	MicroblogResponseDto

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

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

GET

Parameters

Name	Located in	Required	Schema
spaceKey	path	Yes	string
username	path	Yes	string
limit	query	Yes	integer
offset	query	Yes	integer
plaintext	query	Yes	boolean

Responses

Code	Description	Schema
200	OK	MicroblogResponseDto

/subscription

GET

Parameters

Name	Located in	Description	Required	Schema

Responses

Code	Description	Schema
200	OK	SubscriptionDto

POST

Parameters

Name	Located in	Description	Required	Schema

Responses

Code	Description	Schema
200	OK	SubscriptionDto

DELETE

Parameters

Name	Located in	Description	Required	Schema

Responses

Code	Description	Schema
200	OK	SubscriptionDto

/subscription/global (Deprecated)

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

PUT

Parameters

Name	Located in	Description	Required	Schema

Responses

Code	Description	Schema
200	OK	SubscriptionDto

/subscription/myselection

PUT

Parameters

Name	Located in	Description	Required	Schema

Responses

Code	Description	Schema
200	OK	SubscriptionDto

/subscription/selection

PUT

Parameters

Name	Located in	Description	Required	Schema
body	body		Yes	UserSelectionDto

Responses

Code	Description	Schema
200	OK	SubscriptionDto

/subscription/time

PUT

Parameters

Name	Located in	Description	Required	Schema
body	body		Yes	DigestTime

Responses

Code	Description	Schema
200	OK	SubscriptionDto

/subscription/type

PUT

Parameters

Name	Located in	Description	Required	Schema
body	body		Yes	string

Responses

Code	Description	Schema
200	OK	SubscriptionDto

/topics

GET

Parameters

Name	Located in	Description	Required	Schema

Responses

Code	Description	Schema
200	OK	[topic]

POST

Parameters

Name	Located in	Description	Required	Schema
spaceKey	formData		Yes	string
topicName	formData		Yes	string

Responses

Code	Description	Schema
200	OK

/topics/permission/administerable

GET

Parameters

Name	Located in	Description	Required	Schema

Responses

Code	Description	Schema
200	OK	[topic]

/topics/permission/writable

GET

Parameters

Name	Located in	Description	Required	Schema

Responses

Code	Description	Schema
200	OK	[topic]

/topics/space/{spaceKey}

GET

Parameters

Name	Located in	Description	Required	Schema
spaceKey	path		Yes	string

Responses

Code	Description	Schema
200	OK	[topic]

/topics/space/{spaceKey}/topicorder

PUT

Parameters

Name	Located in	Description	Required	Schema
spaceKey	path		Yes	string
body	body		Yes	integer

Responses

Code	Description	Schema
200	OK

/topics/user

GET

Parameters

Name	Located in	Description	Required	Schema

Responses

Code	Description	Schema
200	OK	[ user ]

/topics/user/writable (Deprecated)

use /microposts/permission/writable instead

GET

Parameters

Name	Located in	Description	Required	Schema

Responses

Code	Description	Schema
200	OK	[topic]

/topics/{spaceKey}

GET

Parameters

Name	Located in	Description	Required	Schema
spaceKey	path		Yes	string

Responses

Code	Description	Schema
200	OK	[topic]

/topics/{topicId}

POST

Parameters

Name	Located in	Required	Schema
topicId	path	Yes	string
spaceKey	formData	Yes	string
topicName	formData	Yes	string

Responses

Code	Description	Schema
200	OK

DELETE

Parameters

Name	Located in	Description	Required	Schema
topicId	path		Yes	string

Responses

Code	Description	Schema
200	OK

/topics/{topicId}/microposts (Deprecated)

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

GET

Parameters

Name	Located in	Required	Schema
topicId	path	Yes	string
limit	query	Yes	integer
offset	query	Yes	integer
plaintext	query	Yes	boolean

Responses

Code	Description	Schema
200	OK	MicroblogResponseDto

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

PUT

Parameters

Name	Located in	Description	Required	Schema
newSpaceKey	path		Yes	string
topicId	path		Yes	integer

Responses

Code	Description	Schema
200	OK

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

PUT

Parameters

Name	Located in	Description	Required	Schema
newTopicId	path		Yes	integer
topicId	path		Yes	integer

Responses

Code	Description	Schema
200	OK

/users/reply

GET

Parameters

Name	Located in	Description	Required	Schema
username	query		Yes	string

Responses

Code	Description	Schema
200	OK	ReplyUserInformationDto

Page:

Microblog Release Notes

Page:

Edit a micropost

Page:

Microblog Timeline macro

Page:

Microblog permissions

Page:

Create a micropost

Page:

Manage topics

Page:

General configuration

Page:

FAQ about the new editor

Page:

Linchpin User Profiles - First Steps

Page:

Microblogging for Confluence - Documentation

Page:

Drafts and draft clean-up

Page:

Microblog Placeholder macro

Page:

Embed media into the editor

Page:

Space administration privileges

Page:

General configuration (Release 4.4)

Page:

Personalize your timeline, use the search and filter topics (Release 4.4)

Page:

Microblog permissions (Release 4.4)

Page:

Microblog Timeline macro (Release 4.4)

Page:

Microblog APIs (Release 4.4)

Page:

Microblog Release Notes (Release 4.4)

Page:

Space administration privileges (Release 4.4)

Page:

Microblog APIs

Page:

Older releases of Microblogging for Confluence (Release 4.4)

Page:

Microblog Placeholder macro (Release 4.4)

Page:

Microblog - First Steps (Release 4.4)

Page:

Microblog - Known issues (Release 4.4)

Page:

E-mail notifications (Release 4.4)

Page:

"New posts" notifications & shortened microposts (Release 4.4)

Page:

Delete microposts & copy direct links (Release 4.4)

Page:

Create a micropost (Release 4.4)

Name	Type	Required
microposts	[ MicroPostContent ]	No
hasMore	boolean	No
lastRefreshId	number	No

Name	Type	Required
id	number	No
creationDate	string	No
authorFullName	string	No
authorName	string	No
content	string	No
replies	[MicroPostContent]	No
canRemoveMicropost	boolean	No
spaceKey	string	No
parentId	string	No
canReplyMicropost	boolean	No
canEditMicropost	boolean	No
canLikeMicropost	boolean	No
topic	topic	No
...

Name	Type	Required
hasSubscribed	boolean	No
userKey	string	No
time	string	No
mySelection	boolean	No
type	string	No
selection	selection	No

Page tree