Run a Python Function on Specified Data with Script Owner Specified

post

/api/py-scripts/v1/table-apply/{scriptName}/{ownerName}

Run a Python function on the specified data with script owner specified.

Request

Supported Media Types
Path Parameters
Body ()
A JSON str of (name - value) pairs specifying arguments of the request and additional arguments to the script
Root Schema : EmbedScriptComputeTab
Type: object
Show Source
Example Request (application/json)
{"input":"select name, back from SWIM where gender='F'", "asyncFlag":true, "timeout":7200}
Back to Top

Response

Supported Media Types

200 Response

By default, returns the job result.
Body ()
Root Schema : JSONObject
Type: object
Show Source

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.
Body ()
Root Schema : InvalidParameterValueException
Type: object
Show Source

500 Response

Problem connecting to Broker, executing job or other unexpected error.
Body ()
Root Schema : ComputeContainerException
Type: object
Show Source
Back to Top

Examples

The following example runs the script named my_predict and specifies the script owner.

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\"}", "parallelFlag":true}' \
"<oml-cloud-service-location-url>/oml/api/py-scripts/v1/table-apply/my_predict/<owner_name>"

Response Headers

The response headers are the following:

HTTP/1.1 200 OK
Date: Thu, 27 Aug 2020 14:43:24 GMT
Content-Type: application/json
Transfer-Encoding: chunked
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=node01ryqe8rco0mt1chwfb54k25z4699.node0; Path=/oml; Secure; HttpOnly
Expires: Thu, 01 Jan 1970 00:00:00 GMT

Response Body

The a portion of the response body in JSON format is the following:

{"result":[{"Pred_Petal_Width":6.8462408185,"Species":"setosa","Petal_Width":0.2},
{"Pred_Petal_Width":5.2786489228,"Species":"versicolor","Petal_Width":1.1},
{"Pred_Petal_Width":5.0951801182,"Species":"versicolor","Petal_Width":1},
{"Pred_Petal_Width":5.24866547,"Species":"versicolor","Petal_Width":1.2},...]}
Back to Top