1. REST API for Embedded Python Execution
  2. Tasks
  3. Run Scripts

Run a Python Function on Grouped Data

post

/py-scripts/v1/group-apply/{scriptName}

Runs a user-owned Python function on data grouped by column values.

Request

Path Parameters
Back to Top

Response

200 Response

By default, returns the job result.

201 Response

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

400 Response

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

500 Response

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

Examples

Example 1: Synchronous Example

The following example runs the script named group_count. In the example, the parallelFlag is set to true to leverage database parallelism. 

curl -i -X POST --header "Authorization: Bearer ${token}" \
--header 'Content-Type: application/json' --header 'Accept: application/json' \
-d '{"input":"select * from IRIS", "parameters":"{\"oml_input_type\":\"pandas.DataFrame\"}", "groupBy":"Species", "orderBy":"Sepal_Length", "parallelFlag":true}' \
"<oml-cloud-service-location-url>/oml/api/py-scripts/v1/group-apply/group_count"

Response Headers

The response headers are the following:

HTTP/1.1 200 OK
Date: Mon, 17 Aug 2020 21:06:54 GMT
Content-Type: application/json
Content-Length: 5045
Connection: keep-alive
Cache-Control: no-cache, no-store, private
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1;mode=block
Strict-Transport-Security: max-age=31536000; includeSubDomains
X-Content-Type-Options: nosniff
Set-Cookie: JSESSIONID=node0bucgs4gt7hci1gxvgtqc1hjdv647.node0; Path=/oml; Secure; HttpOnly
Expires: Thu, 01 Jan 1970 00:00:00 GMT

Response Body

A portion of the response body in JSON format is the following.

{"result":{"versicolor_8":{"SEPAL_LENGTH":{"0":5.7},"SPECIES":{"0":"versicolor"},"COUNT":{"0":5}},
"versicolor_7":{"SEPAL_LENGTH":{"0":5.6},"SPECIES":{"0":"versicolor"},"COUNT":{"0":2}},...}

Example 2

The following example runs the script named test_seaborn_inp. 

curl -i -k -X POST --header "Authorization: Bearer ${token}" --header
'Content-Type: application/json' --header 'Accept: application/json' -d
'{"input": "select * from IRIS", "groupBy": "Species", "envName": "seaborn","graphicsFlag": true}' 
"<oml-cloud-service-location-url>/oml/api/py-scripts/v1/group-apply/test_seaborn_inp"

Response Body

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

{
  "result": {
    "0": {
      "GROUP": "setosa",
      "IMAGE": "iVBORw0KGgoAAAAN......AAAAASUVORK5CYII=",
      "DATA": "\"hello world\"",
      "TITLE": "Iris plot",
      "ID": 1
    },
      "1": {
      "GROUP": "versicolor",
      "IMAGE": "iVBORw0KGgoAAAAN......AAAAASUVORK5CYII=",
      "DATA": "\"hello world\"",
      "TITLE": "Iris plot",
      "ID": 1
    },
      "2": {
      "GROUP": "virginica",
      "IMAGE": "iVBORw0KGgoAAAAN......AAAAASUVORK5CYII=",
      "DATA": "\"hello world\"",
      "TITLE": "Iris plot",
      "ID": 1
      }
    }
}
Back to Top