Microblogging for Confluence

Share information, have conversations, write messages and updates

See the documentation for your Release

REST APIs

Base path: /microblog/1.0

e.g.: {domain}/rest/microblog/1.0/topic/{topicId}

URLMethodParameterDescription
/hashtag/{hashtag}GET
  • offset
    (number) 
  • limit
    (number) 
  • plaintext
    (boolean) 
  • space
    (string)

Returns all micro posts which are attached to the given space key and hashtag. Searches globally if no space key is given.

    
/micropostPOST
  • html
    (string) 
  • topicId
    (string) 

Creates a micro post with the given content (html) within the given topicId.

    
/micropostsGET
  • offset
    (number) 
  • limit
    (number) 
  • plaintext
    (boolean) 

Returns all micro posts.

/microposts/since/{id}GET
  • offset
    (number)
  • limit
    (number)
  • plaintext
    (boolean) 

Returns all micro posts with a newer modification date than the given post id.

/microposts/{id}DELETE 

Deletes a micro post referenced by the given id.

/microposts/{id}GET 

Returns a single micro post referenced by the given id.

/microposts/{id}/likePOST 

Creates a like or remove it for the given micro post id. If a like exists for the post it will be removed.

/microposts/{id}/likesGET 

Returns the user names of users that liked the micro post referenced by the given id.

/microposts/{parentId}

 

POST

  • html
    (string)
  • spaceKey
    (string) 
Creates a micro post with the given content (html) as a reply to the given parent post id. The post will be attached to the topic of the parent micropost.
    
/space/{spaceKey}GET
  • offset
    (number) 
  • limit
    (number) 
  • plaintext
    (boolean) 

Returns all micro posts which are attached to the given space key.

/space/{spaceKey}/users/{username}GET
  • offset
    (number) 
  • limit
    (number) 
  • plaintext
    (boolean) 

Returns all micro posts which are attached to the given space key and created by the given username.

    
/subscriptionGET Returns the subscription status of the current user.
/subscriptionPOST
  • ddTime
    (String) 
Sets the subscription of the current user. ddTime should be send in 24h notation formatted like "hh:mm" (example: "14:00").
/subscriptionDELETE Deletes the subscription status of the current user.
    
/topicsGET

 

Returns all topics grouped by space.
/topics/permission/writableGET Returns all topics grouped by space, on which the current user has permission to write.
/topicsPOST
  • topicName
    (String)
  • SpaceKey
    (String) 
Creates a new topic in the given space.
/topics/{topicId}POST
  • topicId
    (String) 
  • topicName
    (String)
  • SpaceKey
    (String)
Updates the given topic with a new name or space.
/topics/{topicId}DELETE Deletes the given topic and all microposts contained inside.
/topics/{topicId}/micropostsGET
  • offset
    (number) 
  • limit
    (number) 
  • plaintext
    (boolean) 

Returns all micro posts which are attached to the given topic.

 

  • No labels