Zeige mehr…

Microblog REST API

Base path: /microblog/1.0

e.g.: {domain}/rest/microblog/1.0/space/{spacekey}

URL Method Parameter Description
/micropost POST
  • html
    (string) 
  • spaceKey
    (string) 

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

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

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

/microposts GET
  • 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 as the given post id.

/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.

/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 username.

/microposts/{id}/like POST  

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} 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}/likes GET  

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 given space key.

Base path: /microblog/1.0

e.g.: {domain}/rest/microblog/1.0/space/{spacekey}

URL Method Parameter Description
/micropost POST
  • html
    (string) 
  • spaceKey
    (string) 

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

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

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

/microposts GET
  • 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 as the given post id.

/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.

/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 username.

/microposts/{id}/like POST  

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} 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}/likes GET  

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 given space key.

Zeige mehr…
Zeige mehr…