Run an R Function on Grouped Data with Script Owner Specified

post

/r-scripts/v1/group-apply/{scriptName}/{ownerName}

Runs an R function on data grouped by column values with script owner specified.

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

The following example runs the script named group.count and specifies the script owner.

curl -i -X POST --header "Authorization: Bearer ${token}" \
--header 'Content-Type: application/json' --header 'Accept: application/json' \
-d '{"input":"IRIS", "groupBy":"Species", "parallelFlag":true}' \
"<oml-cloud-service-location-url>/oml/api/r-scripts/v1/group-apply/group.count/<owner_name>"

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

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

{"result":[{"Count":50,"Species":"setosa"},{"Count":50,"Species":"versicolor"},{"Count":50,"Species":"virginica"}]}
Back to Top