Jump to

• Request
• Response
• Examples

Run an R Function on Grouped Data with Script Owner Specified

post

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

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

Request

Supported Media Types

• application/json

Path Parameters

• ownerName(required): string
  The owner of the R script
• scriptName(required): string
  The name of the R script

Body ()

A JSON str of (name - value) pairs specifying arguments of the request and additional arguments

Root Schema : EmbedScriptComputeGrp

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.
• groupBy(required): string
  Columns to group by. To set a list of columns, provide a comma-separated list.
• input(required): string
  Query statement specifying input data.
• orderBy: string
  Columns to order by. To set a list of columns, provide a comma-separated list.
• parallel: integer(int32)
  Degree of parallel.
• parallelFlag: boolean
  Whether to execute job in parallelism.
• 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",
    "required":[
        "groupBy",
        "input"
    ],
    "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."
        },
        "input":{
            "type":"string",
            "description":"Query statement specifying input data."
        },
        "groupBy":{
            "type":"string",
            "description":"Columns to group by. To set a list of columns, provide a comma-separated list."
        },
        "orderBy":{
            "type":"string",
            "description":"Columns to order by. To set a list of columns, provide a comma-separated list."
        },
        "parallelFlag":{
            "type":"boolean",
            "description":"Whether to execute job in parallelism."
        },
        "parallel":{
            "type":"integer",
            "format":"int32",
            "description":"Degree of parallel."
        }
    }
}

Example Request (application/json)

{"input":"GRADE", "groupBy":"GENDER", "orderBy":"GENDER, STATUS", "parameters":"{\"ore.na.omit\":true}", "parallelFlag":true, "asyncFlag":true, "timeout":3600}

Back to Top

Response

Supported Media Types

• application/json

200 Response

By default, returns the job result.

Body ()

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: string(uri)

400 Response

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

Body ()

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.

Body ()

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"
        }
    }
}

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