Rest API (version 11)

Introduction

Rest API is located in /api/ path of the deployed application. For instance, Rest API of pdmap project that can be browsed using http://pdmap.uni.lu/minerva/ will be located here: http://pdmap.uni.lu/minerva/api/

Rest API tries to follow API Design Guide by Google.

Specification

Projects

• Project data:
  • URL: /projects/{projectId}/
  • Method: GET
  • Example: /projects/pdmap_feb17/
• Elements:
  • URL: /projects/{projectId}/bioEntities/elements/
  • Method: GET
  • Parameters:
    • columns - set of columns. Possible values are: id, modelId, name, type, description, symbol, complexId, compartmentId, fullName, abbreviation, formula, name, synonyms, formerSymbols, references, bounds, hierarchyVisibilityLevel,
    • ids - set of database ids
  • Example: /projects/pdmap_feb17/bioEntities/elements/?columns=id,name,type
• Reactions:
  • URL: /projects/{projectId}/bioEntities/reactions/
  • Method: GET
  • Parameters:
    • columns - set of columns. Possible values are:
    • ids - set of database ids
  • Example: /projects/pdmap_feb17/bioEntities/reactions/?columns=id,name,type

Users

Configuration