- Created by Seibert Media employee, last modified by Administrator on Jun 05, 2024
Documentation's navigation
On this page
Disclaimer
The documentation refers to the latest version of the Microblog!
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.
If you also have Space Privacy installed, the request PUT /microposts/{id}
should also contain the parameter spaceKey
. The spaceKey
should match the given topicId
.
{"openapi": "3.0.1","paths": {"/links/resolve": {"get": {"operationId": "resolveConfluenceLink","parameters": [{"name": "url","in": "query","schema": {"type": "string"}}],"responses": {"default": {"description": "default response","content": {"application/json": {"schema": {"$ref": "#/components/schemas/ResolvedConfluenceInternalLink"}}}}}}},"/digest": {"get": {"operationId": "sendDigest","parameters": [{"name": "userName","in": "query","schema": {"type": "string"}},{"name": "limit","in": "query","schema": {"type": "integer","format": "int32","default": 5}},{"name": "dryRun","in": "query","schema": {"type": "boolean","default": false}}],"responses": {"default": {"description": "default response","content": {"text/html;charset=UTF-8": {}}}}}},"/subscription": {"get": {"operationId": "getSubscription","responses": {"default": {"description": "default response","content": {"application/json": {"schema": {"$ref": "#/components/schemas/SubscriptionDto"}}}}}},"post": {"operationId": "createSubscription","responses": {"default": {"description": "default response","content": {"application/json": {"schema": {"$ref": "#/components/schemas/SubscriptionDto"}}}}}},"delete": {"operationId": "unsubscribe","responses": {"default": {"description": "default response","content": {"application/json": {"schema": {"$ref": "#/components/schemas/SubscriptionDto"}}}}}}},"/subscription/type": {"put": {"operationId": "setSubscriptionType","requestBody": {"content": {"application/json": {"schema": {"type": "string","enum": ["daily","immediate"]}}}},"responses": {"default": {"description": "default response","content": {"application/json": {"schema": {"$ref": "#/components/schemas/SubscriptionDto"}}}}}}},"/subscription/time": {"put": {"operationId": "setTime","requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/DigestTime"}}}},"responses": {"default": {"description": "default response","content": {"application/json": {"schema": {"$ref": "#/components/schemas/SubscriptionDto"}}}}}}},"/subscription/myselection": {"put": {"operationId": "subscribeMySelection","responses": {"default": {"description": "default response","content": {"application/json": {"schema": {"$ref": "#/components/schemas/SubscriptionDto"}}}}}}},"/subscription/selection": {"put": {"operationId": "updateSelection","requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/UserSelectionDto"}}}},"responses": {"default": {"description": "default response","content": {"application/json": {"schema": {"$ref": "#/components/schemas/SubscriptionDto"}}}}}}},"/my-spaces-and-topics": {"get": {"operationId": "getSelection","responses": {"default": {"description": "default response","content": {"application/json": {"schema": {"$ref": "#/components/schemas/UserSelectionDto"}}}}}},"put": {"operationId": "save","requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/UserSelectionDto"}}}},"responses": {"default": {"description": "default response","content": {"application/json": {}}}}}},"/postinstall/post-install-info-confirmation": {"post": {"operationId": "setPostInstallInfoConfirmation","requestBody": {"content": {"application/json": {"schema": {"type": "string","enum": ["CONFIRMED","UNCONFIRMED"]}}}},"responses": {"default": {"description": "default response","content": {"application/json": {}}}}}},"/microposts/count": {"get": {"operationId": "countByLuceneQueryByGetRequest","parameters": [{"name": "query","in": "query","schema": {"type": "string"}}],"responses": {"default": {"description": "default response","content": {"application/json;charset=UTF-8": {"schema": {"type": "integer","format": "int64"}}}}}},"post": {"operationId": "countByLuceneQueryByPostRequest","requestBody": {"content": {"*/*": {"schema": {"type": "string"}}}},"responses": {"default": {"description": "default response","content": {"application/json;charset=UTF-8": {"schema": {"type": "integer","format": "int64"}}}}}}},"/microposts/{id}/likes": {"get": {"operationId": "getLikesOfPost","parameters": [{"name": "id","in": "path","required": true,"schema": {"type": "string"}}],"responses": {"default": {"description": "default response","content": {"application/json;charset=UTF-8": {}}}}}},"/microposts/{id}/oldversions": {"get": {"operationId": "getOldPostVersions","parameters": [{"name": "id","in": "path","required": true,"schema": {"type": "string"}}],"responses": {"default": {"description": "default response","content": {"application/json;charset=UTF-8": {}}}}}},"/microposts/{id}": {"get": {"operationId": "getPost","parameters": [{"name": "id","in": "path","required": true,"schema": {"type": "string"}}],"responses": {"default": {"description": "default response","content": {"application/json;charset=UTF-8": {}}}}},"put": {"operationId": "save_1","parameters": [{"name": "id","in": "path","required": true,"schema": {"type": "string"}}],"requestBody": {"content": {"*/*": {"schema": {"type": "object","properties": {"html": {"type": "string","default": ""},"topicId": {"type": "string"},"parentId": {"type": "string"},"edit": {"type": "boolean","default": false}}}}}},"responses": {"default": {"description": "default response","content": {"application/json;charset=UTF-8": {}}}}},"delete": {"operationId": "remove","parameters": [{"name": "id","in": "path","required": true,"schema": {"type": "string"}}],"responses": {"default": {"description": "default response","content": {"application/json;charset=UTF-8": {}}}}}},"/microposts/{id}/editorformat": {"get": {"operationId": "getPostEditorFormat","parameters": [{"name": "id","in": "path","required": true,"schema": {"type": "string"}}],"responses": {"default": {"description": "default response","content": {"text/html; charset=UTF-8": {}}}}}},"/microposts/{id}/like": {"post": {"operationId": "likePost","parameters": [{"name": "id","in": "path","required": true,"schema": {"type": "string"}}],"responses": {"default": {"description": "default response","content": {"application/json;charset=UTF-8": {}}}}}},"/microposts/search": {"get": {"operationId": "searchByLuceneQueryByGetRequest","parameters": [{"name": "query","in": "query","schema": {"type": "string"}},{"name": "replyLimit","in": "query","schema": {"$ref": "#/components/schemas/ReplyLimit"}},{"name": "offset","in": "query","schema": {"type": "integer","format": "int32"}},{"name": "limit","in": "query","schema": {"type": "integer","format": "int32"}}],"responses": {"default": {"description": "default response","content": {"application/json;charset=UTF-8": {}}}}},"post": {"operationId": "searchByLuceneQueryByPostRequest","parameters": [{"name": "replyLimit","in": "query","schema": {"$ref": "#/components/schemas/ReplyLimit"}},{"name": "offset","in": "query","schema": {"type": "integer","format": "int32"}},{"name": "limit","in": "query","schema": {"type": "integer","format": "int32"}}],"requestBody": {"content": {"*/*": {"schema": {"type": "string"}}}},"responses": {"default": {"description": "default response","content": {"application/json;charset=UTF-8": {}}}}}},"/sketch": {"post": {"operationId": "sketch","requestBody": {"content": {"*/*": {"schema": {"type": "object","properties": {"topicId": {"type": "string"}}}}}},"responses": {"default": {"description": "default response","content": {"application/json;charset=UTF-8": {}}}}}},"/microposts/{id}/watch": {"put": {"operationId": "watchPost","parameters": [{"name": "id","in": "path","required": true,"schema": {"type": "string"}}],"requestBody": {"content": {"*/*": {"schema": {"type": "boolean"}}}},"responses": {"default": {"description": "default response","content": {"application/json;charset=UTF-8": {}}}}}},"/topics/{topicId}/microposts/count": {"get": {"operationId": "countMicropostsInTopic","parameters": [{"name": "topicId","in": "path","required": true,"schema": {"type": "integer","format": "int64"}}],"responses": {"default": {"description": "default response","content": {"application/json;charset=UTF-8": {}}}}}},"/topics": {"get": {"operationId": "getTopics","responses": {"default": {"description": "default response","content": {"application/json;charset=UTF-8": {}}}}},"post": {"operationId": "createTopic","requestBody": {"content": {"*/*": {"schema": {"$ref": "#/components/schemas/TopicDto"}}}},"responses": {"default": {"description": "default response","content": {"application/json;charset=UTF-8": {}}}}}},"/topics/{topicId}": {"post": {"operationId": "updateTopic","parameters": [{"name": "topicId","in": "path","required": true,"schema": {"$ref": "#/components/schemas/TopicId"}}],"requestBody": {"content": {"*/*": {"schema": {"$ref": "#/components/schemas/TopicDto"}}}},"responses": {"default": {"description": "default response","content": {"application/json;charset=UTF-8": {}}}}},"delete": {"operationId": "deleteTopic","parameters": [{"name": "topicId","in": "path","required": true,"schema": {"$ref": "#/components/schemas/TopicId"}}],"responses": {"default": {"description": "default response","content": {"application/json;charset=UTF-8": {}}}}}},"/topics/permission/administerable": {"get": {"operationId": "getAdministerable","responses": {"default": {"description": "default response","content": {"application/json;charset=UTF-8": {}}}}}},"/topics/space/{spaceKey}": {"get": {"operationId": "getTopics_1","parameters": [{"name": "spaceKey","in": "path","required": true,"schema": {"type": "string"}}],"responses": {"default": {"description": "default response","content": {"application/json;charset=UTF-8": {}}}}}},"/topics/user": {"get": {"operationId": "getUserSelectedSpacesAndTopics","responses": {"default": {"description": "default response","content": {"application/json;charset=UTF-8": {"schema": {"type": "array","items": {"$ref": "#/components/schemas/TopicsInSpaceDto"}}}}}}}},"/topics/permission/writable": {"get": {"operationId": "getWritable","responses": {"default": {"description": "default response","content": {"application/json;charset=UTF-8": {"schema": {"type": "array","items": {"$ref": "#/components/schemas/TopicsInSpaceDto"}}}}}}}},"/topics/space/{spaceKey}/permission/writable": {"get": {"operationId": "getWritable_1","parameters": [{"name": "spaceKey","in": "path","required": true,"schema": {"type": "string"}}],"responses": {"default": {"description": "default response","content": {"application/json;charset=UTF-8": {"schema": {"type": "array","items": {"$ref": "#/components/schemas/TopicsInSpaceDto"}}}}}}}},"/topics/{topicId}/move/topic/{newTopicId}": {"put": {"operationId": "moveMicropostToTopic","parameters": [{"name": "topicId","in": "path","required": true,"schema": {"type": "integer","format": "int64"}},{"name": "newTopicId","in": "path","required": true,"schema": {"type": "integer","format": "int64"}}],"responses": {"default": {"description": "default response","content": {"application/json;charset=UTF-8": {}}}}}},"/topics/{topicId}/move/space/{newSpaceKey}": {"put": {"operationId": "moveTopicToSpace","parameters": [{"name": "topicId","in": "path","required": true,"schema": {"type": "integer","format": "int64"}},{"name": "newSpaceKey","in": "path","required": true,"schema": {"type": "string"}}],"responses": {"default": {"description": "default response","content": {"application/json;charset=UTF-8": {}}}}}},"/topics/space/{spaceKey}/topicorder": {"put": {"operationId": "saveTopicOrder","parameters": [{"name": "spaceKey","in": "path","required": true,"schema": {"type": "string"}}],"requestBody": {"content": {"application/json": {"schema": {"type": "array","items": {"type": "integer","format": "int64"}}}}},"responses": {"default": {"description": "default response","content": {"application/json;charset=UTF-8": {}}}}}},"/users/reply": {"get": {"operationId": "getUserForReply","parameters": [{"name": "username","in": "query","schema": {"type": "string"}}],"responses": {"default": {"description": "default response","content": {"application/json;charset=UTF-8": {}}}}}}},"components": {"schemas": {"ResolvedConfluenceInternalLink": {"type": "object","properties": {"href": {"type": "string"},"id": {"type": "integer","format": "int64"},"version": {"type": "integer","format": "int32"},"type": {"type": "string"},"title": {"type": "string"}}},"SubscriptionDto": {"type": "object","properties": {"hasSubscribed": {"type": "boolean"},"userKey": {"type": "string"},"rawTime": {"type": "integer","format": "int32"},"time": {"type": "string"},"mySelection": {"type": "boolean"},"type": {"type": "string","enum": ["daily","immediate"]},"selection": {"$ref": "#/components/schemas/UserSelectionDto"}}},"UserSelectionDto": {"type": "object","properties": {"global": {"type": "boolean"},"spaceIds": {"type": "array","items": {"type": "integer","format": "int64"}},"topicIds": {"type": "array","items": {"type": "integer","format": "int64"}}}},"DigestTime": {"type": "object","properties": {"time": {"type": "integer","format": "int32"},"valid": {"type": "boolean"},"formattedTime": {"type": "string"}}},"ReplyLimit": {"type": "object","properties": {"value": {"type": "integer","format": "int32"},"all": {"type": "boolean"}}},"TopicDto": {"type": "object","properties": {"id": {"type": "integer","format": "int64"},"name": {"type": "string"},"spaceName": {"type": "string"},"spaceId": {"type": "integer","format": "int64"},"spaceKey": {"type": "string"},"creationDate": {"type": "string","format": "date-time"},"lastModificationDate": {"type": "string","format": "date-time"},"position": {"type": "integer","format": "int32"},"unknown": {"type": "boolean"}}},"TopicId": {"type": "object"},"TopicsInSpaceDto": {"type": "object","properties": {"spaceId": {"type": "integer","format": "int64"},"spaceKey": {"type": "string"},"spaceName": {"type": "string"},"defaultTopicId": {"type": "integer","format": "int64"},"topics": {"type": "array","items": {"$ref": "#/components/schemas/TopicDto"}}}}}}}
Looking for an alternative in the Cloud?
Besides offering apps like Linchpin Intranet Suite, that is available for Atlassian Data Center, we also have apps for Confluence Cloud in our portfolio.
Like Mantra, the intranet for Confluence Cloud, developed by our joint-venture AppAnvil (known for hits like Aura & Karma).
Test the intranet for Confluence Cloud now for free:
Link to this page: https://seibert.biz/microblog-api
This page was last edited on 06/05/2024.