REST API for Embedded R Execution

Run an R Function

post

/r-scripts/v1/do-eval/{scriptName}

Run the user-owned R Function.

Request

Path Parameters

scriptName(required): string

The name of the R script

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

asyncFlag: boolean

Whether to execute the job asynchronously.
envName: string

Name of the conda environment.
graphicsFlag: boolean

Whether to capture images rendered in the script to the result.
parameters: string

A JSON str of (name - value) pairs specifying keyword arguments to be passed into the script.
service: string

Allowed Values: [ "LOW, MEDIUM, HIGH" ]

LEVEL of the service. Default is LOW.
timeout: integer (int32)

Minimum Value: 1800

Maximum Value: 43200

The timeout limit (in seconds, default 1800s) of asynchronous job. Must be used together with `asyncFlag`=true.

{
    "type":"object",
    "properties":{
        "parameters":{
            "type":"string",
            "description":"A JSON str of (name - value) pairs specifying keyword arguments to be passed into the script."
        },
        "graphicsFlag":{
            "type":"boolean",
            "description":"Whether to capture images rendered in the script to the result."
        },
        "asyncFlag":{
            "type":"boolean",
            "description":"Whether to execute the job asynchronously."
        },
        "timeout":{
            "type":"integer",
            "format":"int32",
            "description":"The timeout limit (in seconds, default 1800s) of asynchronous job. Must be used together with `asyncFlag`=true.",
            "minimum":1800,
            "maximum":43200
        },
        "service":{
            "type":"string",
            "description":"LEVEL of the service. Default is LOW.",
            "enum":[
                "LOW, MEDIUM, HIGH"
            ]
        },
        "envName":{
            "type":"string",
            "description":"Name of the conda environment."
        }
    }
}

Response

Supported Media Types

application/json

200 Response

By default, returns the job result.

Root Schema : JSONObject

Type: object

Show Source

empty: boolean

{
    "type":"object",
    "properties":{
        "empty":{
            "type":"boolean"
        }
    }
}

201 Response

If asyncFlag=true, returns the location header where the status of the job can be fetched.

Headers

Location:

400 Response

Invalid parameters specified, output exceeding size limit or other script execution error.

Root Schema : InvalidParameterValueException

Type: object

Show Source

errorCode(required): integer (int64)
errorMessage: string
parameterName: string
parameterValue: string

{
    "type":"object",
    "required":[
        "debug",
        "errorCode"
    ],
    "properties":{
        "errorMessage":{
            "type":"string"
        },
        "errorCode":{
            "type":"integer",
            "format":"int64"
        },
        "parameterName":{
            "type":"string"
        },
        "parameterValue":{
            "type":"string"
        }
    }
}

500 Response

Problem connecting to Broker, executing job or other unexpected error.

Root Schema : ComputeContainerException

Type: object

Show Source

errorCode(required): integer (int64)
errorMessage: string

{
    "type":"object",
    "required":[
        "debug",
        "errorCode"
    ],
    "properties":{
        "errorMessage":{
            "type":"string"
        },
        "errorCode":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Examples

Example 1

The following example runs the script named RandomRedDots. The graphicsFlag parameter is set to true to return the PNG image and the data from the function in JSON format.

curl -i -X POST --header "Authorization: Bearer ${token}" \
--header 'Content-Type: application/json' --header 'Accept: application/json' \
-d '{"graphicsFlag":true, "service":"LOW"}' \
"<oml-cloud-service-location-url>/oml/api/r-scripts/v1/do-eval/RandomRedDots"

Response Headers

The response headers are the following:

HTTP/1.1 200 OK
Date: Thu, 28 Jul 2022 21:04:18 GMT
Content-Type: application/json
Content-Length: 1820
Connection: keep-alive
Cache-Control: no-cache, no-store, must-revalidate                                                                          
Pragma: no-cache
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1;mode=block                                                                                                                                                                 
Strict-Transport-Security: max-age=31536000; includeSubDomains
X-Content-Type-Options: nosniff
Content-Security-Policy: frame-ancestors 'none'

Response Body

The result of the REST endpoint is a JSON representation of the value returned from the R script, which includes the image and the data. Image bytes are returned in PNG format. A portion of the returned value is:


{"result":[{"IMAGE":"iVBORw0KGgoAAAANSUhEUg......Fug8AAAAASUVORK5CYII=","DATA":[{
"val":0.01,"id":1},{"val":0.02,"id":2},{"val":0.03,"id":3},{"val":0.04,"id":4
},{"val":0.05,"id":5},{"val":0.06,"id":6},{"val":0.07,"id":7},{"val":0.08,"id
":8},{"val":0.09,"id":9},{"val":0.1,"id":10}],"ID":1}]}

Example 2

The following example runs the script named test_ggplot2_noinp. The graphicsFlag parameter is set to true to return the PNG image and the data from the function in JSON format.

curl -i -k -X POST --header "Authorization: Bearer ${token}" --header
'Content-Type: application/json' --header 'Accept: application/json' -d
'{"envName": "myrenv", "graphicsFlag": true}' 
"<oml-cloud-service-locationurl>/oml/api/r-scripts/v1/do-eval/test_ggplot2_noinp"

Response Body

The result of the REST endpoint is a JSON representation of the value returned from the R script, which includes the image and the data. Image bytes are returned in PNG format.

{
  "result": [
    {
      "IMAGE": "iVBORw0KGgoAAAANSUhE......AAAABJRU5ErkJggg==",
      "DATA": "\"hello world\"",
      "ID": 1
    }
  ]
}