Page tree
Skip to end of metadata
Go to start of metadata

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

NameLocated inDescriptionRequiredSchema
topicIdformData Yesstring

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
htmlformData Yesstring
topicIdformData Yesstring

Responses

CodeDescriptionSchema
200OKMicroPostContent

/microposts (Deprecated)


use GET microposts/search?query=micropostType:parent

GET

Parameters

NameLocated inDescriptionRequiredSchema
limitquery Yesinteger
offsetquery Yesinteger
plaintextquery Yesboolean

Responses

CodeDescriptionSchema
200OKMicroblogResponseDto

/microposts/count


GET

Parameters

NameLocated inDescriptionRequiredSchema
limitquery Yesinteger
offsetquery Yesinteger
queryquery Yesstring

Responses

CodeDescriptionSchema
200OKinteger

/microposts/search


GET

Parameters

NameLocated inDescriptionRequiredSchema
limitquery Yesinteger
offsetquery Yesinteger
queryquery Yesstring

Responses

CodeDescriptionSchema
200OKMicroblogResponseDto

/microposts/since/{id} (Deprecated)


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

GET

Parameters

NameLocated inDescriptionRequiredSchema
idpath Yesstring
limitquery Yesinteger
offsetquery Yesinteger
plaintextquery Yesboolean

Responses

CodeDescriptionSchema
200OKMicroblogResponseDto

/microposts/{id}


GET

Parameters

NameLocated inDescriptionRequiredSchema
idpath Yesstring

Responses

CodeDescriptionSchema
200OKMicroPostContent
PUT

Parameters

NameLocated inDescriptionRequiredSchema
idpath Yesstring
htmlformData Yesstring
parentIdformData Yesstring
topicIdformData Yesstring

Responses

CodeDescriptionSchema
200OK
DELETE

Parameters

NameLocated inDescriptionRequiredSchema
idpath Yesstring

Responses

CodeDescriptionSchema
200OK

/microposts/{id}/editorformat


GET

Parameters

NameLocated inDescriptionRequiredSchema
idpath Yesstring

Responses

CodeDescriptionSchema
200OKstring

/microposts/{id}/like


POST

Parameters

NameLocated inDescriptionRequiredSchema
idpath Yesstring

Responses

CodeDescriptionSchema
200OK

/microposts/{id}/likes


GET

Parameters

NameLocated inDescriptionRequiredSchema
idpath Yesstring

Responses

CodeDescriptionSchema
200OK[like]

/microposts/{id}/oldversions


GET

Parameters

NameLocated inDescriptionRequiredSchema
idpath Yesstring

Responses

CodeDescriptionSchema
200OK[ MicroPostContent ]

/my-spaces-and-topics


GET

Parameters

NameLocated inDescriptionRequiredSchema

Responses

CodeDescriptionSchema
200OKUserSelectionDto
PUT

Parameters

NameLocated inDescriptionRequiredSchema
bodybody YesUserSelectionDto

Responses

CodeDescription
204No Content

/space/{spaceKey} (Deprecated)


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

GET

Parameters

NameLocated inDescriptionRequiredSchema
spaceKeypath Yesstring
limitquery Yesinteger
offsetquery Yesinteger
plaintextquery Yesboolean

Responses

CodeDescriptionSchema
200OKMicroblogResponseDto

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


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

GET

Parameters

NameLocated inDescriptionRequiredSchema
spaceKeypath Yesstring
usernamepath Yesstring
limitquery Yesinteger
offsetquery Yesinteger
plaintextquery Yesboolean

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
bodybody YesUserSelectionDto

Responses

CodeDescriptionSchema
200OKSubscriptionDto

/subscription/time


PUT

Parameters

NameLocated inDescriptionRequiredSchema
bodybody YesDigestTime

Responses

CodeDescriptionSchema
200OKSubscriptionDto

/subscription/type


PUT

Parameters

NameLocated inDescriptionRequiredSchema
bodybody Yesstring

Responses

CodeDescriptionSchema
200OKSubscriptionDto

/topics


GET

Parameters

NameLocated inDescriptionRequiredSchema

Responses

CodeDescriptionSchema
200OK[topic]
POST

Parameters

NameLocated inDescriptionRequiredSchema
spaceKeyformData Yesstring
topicNameformData Yesstring

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
spaceKeypath Yesstring

Responses

CodeDescriptionSchema
200OK[topic]

/topics/space/{spaceKey}/topicorder


PUT

Parameters

NameLocated inDescriptionRequiredSchema
spaceKeypath Yesstring
bodybody Yesinteger

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
spaceKeypath Yesstring

Responses

CodeDescriptionSchema
200OK[topic]

/topics/{topicId}


POST

Parameters

NameLocated inDescriptionRequiredSchema
topicIdpath Yesstring
spaceKeyformData Yesstring
topicNameformData Yesstring

Responses

CodeDescriptionSchema
200OK
DELETE

Parameters

NameLocated inDescriptionRequiredSchema
topicIdpath Yesstring

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
topicIdpath Yesstring
limitquery Yesinteger
offsetquery Yesinteger
plaintextquery Yesboolean

Responses

CodeDescriptionSchema
200OKMicroblogResponseDto

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


PUT

Parameters

NameLocated inDescriptionRequiredSchema
newSpaceKeypath Yesstring
topicIdpath Yesinteger

Responses

CodeDescriptionSchema
200OK

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


PUT

Parameters

NameLocated inDescriptionRequiredSchema
newTopicIdpath Yesinteger
topicIdpath Yesinteger

Responses

CodeDescriptionSchema
200OK

/users/reply


GET

Parameters

NameLocated inDescriptionRequiredSchema
usernamequery Yesstring

Responses

CodeDescriptionSchema
200OKReplyUserInformationDto

Models


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

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

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

NameTypeDescriptionRequired
microposts[ MicroPostContent ] No
hasMoreboolean No
lastRefreshIdnumber No

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

NameTypeDescriptionRequired
timenumber No
formattedTimestring No
validboolean No

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

NameTypeDescriptionRequired
idnumber No
creationDatestring No
authorFullNamestring No
authorNamestring No
contentstring No
replies[MicroPostContent] No
canRemoveMicropostboolean No
spaceKeystring No
parentIdstring No
canReplyMicropostboolean No
canEditMicropostboolean No
canLikeMicropostboolean No
topictopic No
...

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

NameTypeDescriptionRequired
hasSubscribedboolean No
userKeystring No
timestring No
mySelectionboolean No
typestring No
selectionselection No

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

NameTypeDescriptionRequired
usernamestring No
userFullnamestring No
contentIdnumber No