Skip to content

Latest commit

 

History

History
152 lines (110 loc) · 3.01 KB

README.md

File metadata and controls

152 lines (110 loc) · 3.01 KB
Raw

API

This repository gives information about the API to openCPU.

With this connection the endpoint to openCPU is provided. The platform can get access to the openCPU library and will be able to run R scripts. Additional Information can be found here at the site with HTTP API of openCPU.

Run script

POST /api/v1/ocpu/library/:id/R/:functionName*

Request parameter

  • id - id of the ERC
  • functionName - name of R package function that shall be calculated

This request will pass the URL localhost/api/v1/ocpu/* to the openCPU endpoint localhost/ocpu/*. The id of the ERC has to be provided by the user. Then openCPU will run the R script of the package (that has the same name), to calculate the result of the R function with the provided parameter. The original data, used in the paper will be saved to the metadata of the given ERC.

Example:

Request (for timeseries)

POST /api/v1/ocpu/library/t5UH3/R/tsfunction

Request body parameters for executing R script

{
 "x": 2.7
}
  • x parameter that has been changed (with value)

Response

Response after running openCPU

{
 ...
 "data": "/ocpu/tmp/x07acffa77a/R/run
 /ocpu/tmp/x07acffa77a/R/.val
 /ocpu/tmp/x07acffa77a/graphics/1
 /ocpu/tmp/x07acffa77a/stdout
 /ocpu/tmp/x07acffa77a/source
 /ocpu/tmp/x07acffa77a/console
 /ocpu/tmp/x07acffa77a/info
 /ocpu/tmp/x07acffa77a/files/DESCRIPTION"
 ...
}
  • data - String containing URLs to retrieve information of the calculation from openCPU

Request (for maps)

POST /api/v1/ocpu/library/z5jF9/R/mapfunction

Request body parameters for executing R script

{
 "y": 2001
}
  • y parameter that has been changed (with value)

Response

Response after running openCPU

{
 ...
 "data": "/ocpu/tmp/x05b16d5b4d/R/run2
 /ocpu/tmp/x05b16d5b4d/R/.val
 /ocpu/tmp/x05b16d5b4d/graphics/1
 /ocpu/tmp/x05b16d5b4d/stdout
 /ocpu/tmp/x05b16d5b4d/source
 /ocpu/tmp/x05b16d5b4d/console
 /ocpu/tmp/x05b16d5b4d/info
 /ocpu/tmp/x05b16d5b4d/files/DESCRIPTION
 /ocpu/tmp/x05b16d5b4d/files/figure1.Rdata"
 ...
}
  • data - String containing URLs to retrieve information of the calculation from openCPU

Get result

Request (for timeseries)

/ocpu/tmp/ + tempId + /R/.val/json

Request parameters

  • tempId - id of the openCPU calculation (which is retrieved by the run script POST request)

Response

{
 ...
 "data": [
  [
    {
    	"PANEL": 1,
	"colour": "black",
	"group": 1,
	"linetype": "solid",
	"size": 1,
	"x": 1,
	"y": 0.8631,
    },
    ...
  ]
 ]
 ...
}
  • data - an array containing at first place (data[0]) an array with timeseries plot data

Request (for maps)

/ocpu/tmp/ + tempId + /graphics/1/png

Request parameters

  • tempId - id of the openCPU calculation (which is retrieved by the run script POST request)

Response

{
 ...
 "config": {
  ...
  "url": "http://localhost/api/v1/ocpu/tmp/x05b16d5b4d/graphics/1/png"
  ...
 }
 ...
}
  • config
  • url - url to retrieve the calculated map as png