1. BibSonomy
  2. General
  3. BibSonomy

Wiki

Clone wiki

BibSonomy / documentation / api / REST API

BibSonomy provides a webservice using Representational State Transfer (REST), a software architectural style for distributed hypermedia systems. The term originated in a 2000 doctoral dissertation about the web written by Roy Fielding, one of the principal authors of the HTTP protocol specification. This site is intended for developers who want to develop applications which interact with BibSonomy.

You can use the provided client library, written in Java, to access the API or you can directly interact with the webservice if you would like to write a client in a language other than Java. Furthermore, there is a customized JabRef-Client available:

Methods

For the uniform addressing and identification a URL pattern was specified. The individual inquiries can be partly supplemented with attributes of the form key=value .

An overview of the currently available methods is outlined in the following table:

Description Method Path Status
Users
List of all users GET /users ok
Create a user POST /users x
Details for a user GET /users/[username] ok
Change user details PUT /users/[username] x
Delete user DELETE /users/[username] x
List of posts for a user GET /users/[username]/posts ?tags=[t1+t2+...+tn] ?resourcetype=(bibtexǀbookmark) ok
Create post POST /users/[username]/posts ok
Details for a post GET /users/[username]/posts/[resourceHash] ok
Change post PUT /users/[username]/posts/[resourceHash] ok
Delete post DELETE /users/[username]/posts/[resourceHash] ok
Add document of a post POST /users/[username]/posts/[resourcehash]/documents/ ok
Document of a post GET /users/[username]/posts/[resourcehash]/documents/[fileName] ok
Rename document of a post PUT /users/[username]/posts/[resourcehash]/documents/[fileName] ok
Delete document of a post DELETE /users/[username]/posts/[resourcehash]/documents/[fileName] ok
List of concepts for a user GET /users/[username]/concepts ?status=(allǀpicked) ok
Details for a concept for a user GET /users/[username]/concepts/[conceptname] ok
Create concept POST /users/[username]/concepts/[conceptname] ok
Update concept PUT /users/[username]/concepts/[conceptname] ok
Delete concept DELETE /users/[username]/concepts/[conceptname] ok
Posts in clipboard GET /users/[username]/clipboard ok
Friends
List of friends for a user GET /users/[username]/friends ?relation=(incomingǀoutgoing) ok
Add users as friends POST /users/[username]/friends ok
Groups
List of all groups GET /groups ok
Create a group POST /groups x
Details for a group GET /groups/[groupname] ok
Change group PUT /groups/[groupname] x
Delete group DELETE /groups/[groupname] x
List of users for a group GET /groups/[groupname]/users ok
Add user to a group POST /groups/[groupname]/users x
Remove user from a group DELETE /groups/[groupname]/users/[username] x
Global - Tags
List of all tags GET /tags ?filter=[regex] ?(userǀgroupǀviewable)=[usernameǀgroupname] ?order=(frequencyǀalph) ok
Details for a tag; details for a list of sub-/super-/correlated-tags GET /tags/[tag] ok
Correlated tags for specific tag(s) GET /tags/[tag1+tag2+...] ?relation=(relatedǀsimilar) ?(userǀgroupǀviewable)=([username]ǀ[groupname]) ?order=(frequencyǀalph) ok
Substitute the shared appearance of t1,t2,... with T1,T2,... PUT /substitutetags?from=[t1+t2+..]&to=[T1+T2+..] x
Global - Concepts
List of popular concepts GET /concepts ok
Details for a concept GET /concepts/[conceptname] ok
Global - Posts
List of all posts GET /posts ?tags=[t1+t2+...+tn] ?resourcetype=(bibtexǀbookmark) ?(userǀgroupǀviewable)=[username/groupname] ?resource=[hash] ?search=[search_string] ok
List of recent posts GET /posts/added ?resourcetype=(bibtexǀbookmark) ok
List of popular posts GET /posts/popular ?resourcetype=(bibtexǀbookmark) ok

Format-Parameters

All URLs can be supplemented by these attributes (use start and end only with lists):

  • ?format=(xml|json|csl|bibtex|endnote) (only xml and json are supported for input, the remaining formats only for output of publications)
  • ?start=[int], starting at 0, default 0 **)
  • ?end=[int], starting at 0, default 20 **)

E.g., ?start=0&end=20 returns a list of the first 20 entities (exclusively the 'end'-value).

Tags can be customized in the following way:

  • ->[tag] tag and its direct children
  • -->[tag] tag and its children (transitive)
  • [tag]-> tag and its direct parents
  • [tag]--> tag and its parents (transitive)
  • <->[tag] tag and its correlated tags

Fulltext search on publications or bookmarks can be done via /posts?search=[search_string]&resourcetype=(bibtex|bookmark), see above. The search covers all available metadata for a post (e.g. title, authors, ISBN, DOI, ...) as well as associated tags. The standard behaviour when you supply more than one search term (separated by + or spaces) is that matches will be returned which contain both terms, i.e. /posts?resourcetype=bibtex&search=folksonomy+folksonomies will return publications which contain both folksonomy and folksonomies in any metadata field. Apart from this, you can enhance your search in the following ways:

  • exclude terms: /posts/?search=folksonomy -ontology will return matches that contain folksonomy, but not ontology
  • phrase search /posts/?search="folksonomies are cool" will return matches that contain the whole phrase "folksonomies are cool", but not matches that contain e.g. "folksonomies are not cool".
  • wildcards: /posts/?search=folksonom\* will return matches that contain "folksonomy, folksonomies, ...".

Special characters in search terms: Please note that all special (i.e. non-alphanumeric) characters occuring in search terms apart from "_" and "'" are treated as search term separators - if you search e.g. for an ISBN like /posts?search=isbn:978-0-387-71000-6, then you also an entry with ISBN 387-0-978-71000-6 will be matched, because the number blocks are treated as distinct search terms, which is not what you want. In such a case, phrase search will yield the expected result:

  • /posts?search="isbn:978-0-387-71000-6"

Errors

In case of an error the API sends the appropriate HTTP status code (please see the details of each request) and a XML document including a description of the error that occurred. In addition to that, the XML root element contains an attribute stat, whose value will be "fail" in case of an error, and "ok" otherwise.

<bibsonomy stat="fail">
    <error>some error message</error>
</bibsonomy>

Updated