Plugins (beta)#

List registered plugins on the server#

• URL: /plugins/
• Method: GET
• Parameters: NONE
• Output: List of all minerva plugins that were registered on the server.
• Example:

curl -X GET https://minerva-dev.lcsb.uni.lu/minerva/api/plugins/

Register new plugin on the server#

• URL: /plugins/
• Method: POST
• Parameters:
  • hash - hash (md5) id of the plugin
  • url
  • name
  • version
  • isPublic - should the plugin be visible in list of plugins for every user
• Output: Information about registered plugin.
• Example:

curl -X POST --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" --data \ 'hash=aaafd8f11572b0b2eb065de7b4b4cedd&url=https%3A%2F%2Fminerva-dev.lcsb.uni.lu%2Fplugins%2Fdisease-associations%2Fplugin.js&name=Disease-variant%20associations&version=1.0.0&isPublic=false' \
 https://minerva-dev.lcsb.uni.lu/minerva/api/plugins/

Access information about plugin#

• URL: /plugins/{hash}
• Method: GET
• Parameters:
  • hash - hash id of the plugin
• Output: Information about registered plugin.
• Example:

curl -X GET  https://minerva-dev.lcsb.uni.lu/minerva/api/plugins/aaafd8f11572b0b2eb065de7b4b4cedd

Set global plugin parameter#

• URL: /plugins/{hash}/data/global/{key}
• Method: POST
• Parameters:
  • hash - hash id of the plugin
  • key - property name
  • value - value to set
• Output: value that was set.
• Example:

curl -X POST --data 'value=y' \
--cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" \
 https://minerva-dev.lcsb.uni.lu/minerva/api/plugins/aaafd8f11572b0b2eb065de7b4b4cedd/data/global/some_key

Get global plugin parameter#

• URL: /plugins/{hash}/data/global/{key}
• Method: GET
• Parameters:
  • hash - hash id of the plugin
  • key - property name
• Output: value of the parameter.
• Example:

curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" \
 https://minerva-dev.lcsb.uni.lu/minerva/api/plugins/aaafd8f11572b0b2eb065de7b4b4cedd/data/global/some_key

Set user plugin parameter#

• URL: /plugins/{hash}/data/users/{key}
• Method: POST
• Parameters:
  • hash - hash id of the plugin
  • key - property name
  • login - user for which this value is going to be set
  • value - value to set
• Output: value that was set.
• Example:

curl -X POST --data 'value=y' \
--cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" \
 https://minerva-dev.lcsb.uni.lu/minerva/api/plugins/aaafd8f11572b0b2eb065de7b4b4cedd/data/users/some_key

Get user plugin parameter#

• URL: /plugins/{hash}/data/users/{key}
• Method: GET
• Parameters:
  • hash - hash id of the plugin
  • key - property name
  • login - user for which this value is going to be set
• Output: value that was set.
• Example:

curl -X GET --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx" \
 https://minerva-dev.lcsb.uni.lu/minerva/api/plugins/aaafd8f11572b0b2eb065de7b4b4cedd/data/users/some_key

Back to top