- Created by //SEIBERT/MEDIA employee, last modified by Administrator on Jan 09, 2020
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 |
|---|
/draft (Deprecated)
Use POST /sketch instead
/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 | Description | 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 | Description | 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 | Description | 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 | Description | 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 | Description | 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 | Description | 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 | Description | 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 | Description | 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 | Description | 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 |
Models
<a name="userSelectionDto"></a>UserSelectionDto
| Name | Type | Description | Required |
|---|---|---|---|
| global | boolean | No | |
| spaceIds | [ number ] | No | |
| topicIds | [ topic ] | No |
<a name="microblogResponseDto"></a>MicroblogResponseDto
| Name | Type | Description | Required |
|---|---|---|---|
| microposts | [ MicroPostContent ] | No | |
| hasMore | boolean | No | |
| lastRefreshId | number | No |
<a name="digestTime"></a>DigestTime
| Name | Type | Description | Required |
|---|---|---|---|
| time | number | No | |
| formattedTime | string | No | |
| valid | boolean | No |
<a name="microPostContent"></a>MicroPostContent
| Name | Type | Description | 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 | |
| ... |
<a name="subscriptionDto"></a>SubscriptionDto
| Name | Type | Description | Required |
|---|---|---|---|
| hasSubscribed | boolean | No | |
| userKey | string | No | |
| time | string | No | |
| mySelection | boolean | No | |
| type | string | No | |
| selection | selection | No |
<a name="replyUserInformationDto"></a>ReplyUserInformationDto
| Name | Type | Description | Required |
|---|---|---|---|
| username | string | No | |
| userFullname | string | No | |
| contentId | number | No |
On this page
Related content
This content was last updated on 01/09/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. Please click this link if you want us to update this page. 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-media.net if you are in doubt, have a question, suggestion, or want changes from us.