{ "openapi":"3.0.1", "info":{ "title":"REST API for Embedded Python Execution", "description":"

Use the REST API for Embedded Python Execution to execute user-defined Python functions in Python engines spawned by an Autonomous AI Database environment.

\n\n

Note: The /api/py-scripts/v1 endpoints are deprecated and will be retired on March 31, 2026. Migrate to the /api/py-scripts/v2 endpoints during the deprecation period. While v1 endpoints remain accessible during this time, deprecation warnings and the sunset date are returned in the response headers. The final retirement date for v1 is March 31, 2026.

", "version":"2026.02.10", "x-summary":"Use the REST API for Embedded Python Execution to execute user-defined Python functions in Python engines spawned by an Autonomous AI Database environment." }, "paths":{ "/py-scripts/v2/jobs/{jobId}":{ "get":{ "tags":[ "Run Scripts" ], "summary":"Retrieve Asynchronous Job Status", "description":"Retrieves the status of the asynchronous job.", "operationId":"getPyScriptsAsyncJobStatusTable", "parameters":[ { "name":"jobId", "in":"path", "description":"The id of the asynchronous job", "required":true, "schema":{ "type":"string" } } ], "responses":{ "302":{ "description":"Returns the Content-Location header where the result of the job can be fetched.", "headers":{ "Content-Location":{ "style":"simple", "schema":{ "type":"string", "format":"uri" } } } }, "202":{ "description":"Job is still pending.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/JSONObject" } } } }, "401":{ "description":"When the user doesn't have privileges to perform the action.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UnauthorizedException" } } } }, "500":{ "description":"Problem connecting to Broker, finding the job id or other unexpected error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ComputeContainerException" } } } } }, "x-internal-id":"py-scripts-v2-jobs-{jobId}-get", "x-filename-id":"py-scripts-v2-jobs-jobid-get" }, "delete":{ "tags":[ "Run Scripts" ], "summary":"Delete an Asynchronous Job", "description":"Delete an asynchronous job specified by *jobId* from the Database.", "operationId":"deleteByJobId", "parameters":[ { "name":"jobId", "in":"path", "description":"The id of the asynchronous job", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Job is deleted.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/JSONObject" } } } }, "401":{ "description":"When the user doesn't have privileges to perform the action.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UnauthorizedException" } } } }, "500":{ "description":"Problem connecting to Broker, finding the job id or other unexpected error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ComputeContainerException" } } } } }, "x-internal-id":"py-scripts-v2-jobs-{jobId}-delete", "x-filename-id":"py-scripts-v2-jobs-jobid-delete" } }, "/py-scripts/v1/jobs/{jobId}":{ "get":{ "tags":[ "Run Scripts V1" ], "summary":"Retrieve Asynchronous Job Status", "description":"Retrieves the status of the asynchronous job.", "operationId":"getPyScriptsAsyncJobStatus", "parameters":[ { "name":"jobId", "in":"path", "description":"The id of the asynchronous job", "required":true, "schema":{ "type":"string" } } ], "responses":{ "302":{ "description":"Returns the Content-Location header where the result of the job can be fetched.", "headers":{ "Content-Location":{ "style":"simple", "schema":{ "type":"string", "format":"uri" } } } }, "202":{ "description":"Job is still pending.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/JSONObject" } } } }, "401":{ "description":"When the user doesn't have privileges to perform the action.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UnauthorizedException" } } } }, "500":{ "description":"Problem connecting to Broker, finding the job id or other unexpected error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ComputeContainerException" } } } } }, "deprecated":true, "x-internal-id":"py-scripts-v1-jobs-{jobId}-get", "x-filename-id":"py-scripts-v1-jobs-jobid-get" }, "delete":{ "tags":[ "Run Scripts V1" ], "summary":"Delete Asynchronous Job", "description":"Delete an asynchronous job from database", "operationId":"deleteByJobIdV1", "parameters":[ { "name":"jobId", "in":"path", "description":"The id of the asynchronous job", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Job deleted successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/JSONObject" } } } }, "401":{ "description":"When the user doesn't have privileges to perform the action.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UnauthorizedException" } } } }, "500":{ "description":"Problem connecting to Broker, finding the job id or other unexpected error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ComputeContainerException" } } } } }, "deprecated":true, "x-internal-id":"py-scripts-v1-jobs-{jobId}-delete", "x-filename-id":"py-scripts-v1-jobs-jobid-delete" } }, "/py-scripts/v1/do-eval/{scriptName}/{ownerName}":{ "post":{ "tags":[ "Run Scripts V1" ], "summary":"Run a Python Function with Script Owner Specified", "description":"Runs the Python function with script owner specified.", "operationId":"executeOwnerPyScriptDoEval", "parameters":[ { "name":"ownerName", "in":"path", "description":"The owner of the Python script", "required":true, "schema":{ "type":"string" } }, { "name":"scriptName", "in":"path", "description":"The name of the Python script", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"A JSON str of (name - value) pairs specifying arguments of the request and additional arguments to the script", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EmbedScriptCompute" }, "example":{ "parameters":"{\"ds_name\":\"ds_pydata\"}", "asyncFlag":false, "service":"LOW" } } }, "required":true }, "responses":{ "200":{ "description":"By default, returns the job result.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/JSONObject" } } } }, "201":{ "description":"If asyncFlag=true, returns the location header where the status of the job can be fetched.", "headers":{ "Location":{ "style":"simple", "schema":{ "type":"string", "format":"uri" } } } }, "400":{ "description":"Invalid parameters specified, output exceeding size limit or other script execution error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/InvalidParameterValueException" } } } }, "500":{ "description":"Problem connecting to Broker, executing job or other unexpected error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ComputeContainerException" } } } } }, "deprecated":true, "x-internal-id":"py-scripts-v1-do-eval-{scriptName}-{ownerName}-post", "x-filename-id":"py-scripts-v1-do-eval-scriptname-ownername-post" } }, "/py-scripts/v2/do-eval/{scriptName}/{ownerName}":{ "post":{ "tags":[ "Run Scripts" ], "summary":"Run a Python Function with Script Owner Specified", "description":"Run the Python Function with script owner specified.", "operationId":"executeOwnerPyScriptDoEvalwithConda", "parameters":[ { "name":"ownerName", "in":"path", "description":"The owner of the Python script", "required":true, "schema":{ "type":"string" } }, { "name":"scriptName", "in":"path", "description":"The name of the Python script", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"A JSON str of (name - value) pairs specifying arguments of the request and additional arguments to the script", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EmbedScriptCompute" }, "example":{ "parameters":"{\"ds_name\":\"ds_pydata\"}", "asyncFlag":true, "graphicsFlag":true } } }, "required":true }, "responses":{ "200":{ "description":"By default, returns the job result.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/JSONObject" } } } }, "201":{ "description":"If asyncFlag=true, returns the location header where the status of the job can be fetched.", "headers":{ "Location":{ "style":"simple", "schema":{ "type":"string", "format":"uri" } } } }, "400":{ "description":"Invalid parameters specified, output exceeding size limit or other script execution error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/InvalidParameterValueException" } } } }, "500":{ "description":"Problem connecting to Broker, executing job or other unexpected error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ComputeContainerException" } } } } }, "x-internal-id":"py-scripts-v2-do-eval-{scriptName}-{ownerName}-post", "x-filename-id":"py-scripts-v2-do-eval-scriptname-ownername-post" } }, "/py-scripts/v1/group-apply/{scriptName}/{ownerName}":{ "post":{ "tags":[ "Run Scripts V1" ], "summary":"Run a Python Function on Grouped Data with Script Owner Specified", "description":"Runs a Python function on data grouped by column values with script owner specified.", "operationId":"executeOwnerPyScriptGrpApply", "parameters":[ { "name":"ownerName", "in":"path", "description":"The owner of the Python script", "required":true, "schema":{ "type":"string" } }, { "name":"scriptName", "in":"path", "description":"The name of the Python script", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"A JSON str of (name - value) pairs specifying arguments of the request and additional arguments", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EmbedScriptComputeGrp" }, "example":{ "input":"select * from GRADE", "groupBy":"GENDER", "orderBy":"GENDER,STATUS", "parameters":"{\"oml_input_type\":\"default\"}", "parallelFlag":true, "asyncFlag":true, "timeout":3600 } } }, "required":true }, "responses":{ "200":{ "description":"By default, returns the job result.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/JSONObject" } } } }, "201":{ "description":"If asyncFlag=true, returns the location header where the status of the job can be fetched.", "headers":{ "Location":{ "style":"simple", "schema":{ "type":"string", "format":"uri" } } } }, "400":{ "description":"Invalid parameters specified, output exceeding size limit or other script execution error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/InvalidParameterValueException" } } } }, "500":{ "description":"Problem connecting to Broker, executing job or other unexpected error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ComputeContainerException" } } } } }, "deprecated":true, "x-internal-id":"py-scripts-v1-group-apply-{scriptName}-{ownerName}-post", "x-filename-id":"py-scripts-v1-group-apply-scriptname-ownername-post" } }, "/py-scripts/v2/group-apply/{scriptName}/{ownerName}":{ "post":{ "tags":[ "Run Scripts" ], "summary":"Run a Python Function on Grouped Data with Script Owner Specified", "description":"Runs a Python function on data grouped by column values with script owner specified.", "operationId":"executeOwnerPyScriptGrpApplywithConda", "parameters":[ { "name":"ownerName", "in":"path", "description":"The owner of the Python script", "required":true, "schema":{ "type":"string" } }, { "name":"scriptName", "in":"path", "description":"The name of the Python script", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"A JSON str of (name - value) pairs specifying arguments of the request and additional arguments", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EmbedScriptComputeGrp" }, "example":{ "input":"select * from GRADE", "groupBy":"GENDER,YEAR", "orderBy":"GENDER", "parameters":"{\"oml_input_type\":\"default\"}", "parallelFlag":true } } }, "required":true }, "responses":{ "200":{ "description":"By default, returns the job result.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/JSONObject" } } } }, "201":{ "description":"If asyncFlag=true, returns the location header where the status of the job can be fetched.", "headers":{ "Location":{ "style":"simple", "schema":{ "type":"string", "format":"uri" } } } }, "400":{ "description":"Invalid parameters specified, output exceeding size limit or other script execution error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/InvalidParameterValueException" } } } }, "500":{ "description":"Problem connecting to Broker, executing job or other unexpected error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ComputeContainerException" } } } } }, "x-internal-id":"py-scripts-v2-group-apply-{scriptName}-{ownerName}-post", "x-filename-id":"py-scripts-v2-group-apply-scriptname-ownername-post" } }, "/py-scripts/v1/index-apply/{scriptName}/{ownerName}":{ "post":{ "tags":[ "Run Scripts V1" ], "summary":"Run a Python Function multiple times with Script Owner Specified", "description":"Runs a Python Function \"times\" times with script owner specified.", "operationId":"executeOwnerPyScriptIdxApply", "parameters":[ { "name":"ownerName", "in":"path", "description":"The owner of the Python script", "required":true, "schema":{ "type":"string" } }, { "name":"scriptName", "in":"path", "description":"The name of the Python script", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"A JSON str of (name - value) pairs specifying arguments of the request and additional arguments to the script", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EmbedScriptComputeIdx" }, "example":{ "times":3, "parallelFlag":true, "service":"MEDIUM", "asyncFlag":true } } }, "required":true }, "responses":{ "200":{ "description":"By default, returns the job result.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/JSONObject" } } } }, "201":{ "description":"If asyncFlag=true, returns the location header where the status of the job can be fetched.", "headers":{ "Location":{ "style":"simple", "schema":{ "type":"string", "format":"uri" } } } }, "400":{ "description":"Invalid parameters specified, output exceeding size limit or other script execution error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/InvalidParameterValueException" } } } }, "500":{ "description":"Problem connecting to Broker, executing job or other unexpected error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ComputeContainerException" } } } } }, "deprecated":true, "x-internal-id":"py-scripts-v1-index-apply-{scriptName}-{ownerName}-post", "x-filename-id":"py-scripts-v1-index-apply-scriptname-ownername-post" } }, "/py-scripts/v2/index-apply/{scriptName}/{ownerName}":{ "post":{ "tags":[ "Run Scripts" ], "summary":"Run a Python Function multiple times with Script Owner Specified", "description":"Runs a Python Function \"times\" times with script owner specified.", "operationId":"executeOwnerPyScriptIdxApplywithConda", "parameters":[ { "name":"ownerName", "in":"path", "description":"The owner of the Python script", "required":true, "schema":{ "type":"string" } }, { "name":"scriptName", "in":"path", "description":"The name of the Python script", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"A JSON str of (name - value) pairs specifying arguments of the request and additional arguments to the script", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EmbedScriptComputeIdx" }, "example":{ "times":3, "parallelFlag":true, "graphicsFlag":true, "service":"MEDIUM" } } }, "required":true }, "responses":{ "200":{ "description":"By default, returns the job result.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/JSONObject" } } } }, "201":{ "description":"If asyncFlag=true, returns the location header where the status of the job can be fetched.", "headers":{ "Location":{ "style":"simple", "schema":{ "type":"string", "format":"uri" } } } }, "400":{ "description":"Invalid parameters specified, output exceeding size limit or other script execution error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/InvalidParameterValueException" } } } }, "500":{ "description":"Problem connecting to Broker, executing job or other unexpected error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ComputeContainerException" } } } } }, "x-internal-id":"py-scripts-v2-index-apply-{scriptName}-{ownerName}-post", "x-filename-id":"py-scripts-v2-index-apply-scriptname-ownername-post" } }, "/py-scripts/v1/row-apply/{scriptName}/{ownerName}":{ "post":{ "tags":[ "Run Scripts V1" ], "summary":"Run a Python Function on Chunks of Rows with Script Owner Specified", "description":"Runs a Python function on data chunked in sets of rows with script owner specified.", "operationId":"executeOwnerPyScriptRowApply", "parameters":[ { "name":"ownerName", "in":"path", "description":"The owner of the Python script", "required":true, "schema":{ "type":"string" } }, { "name":"scriptName", "in":"path", "description":"The name of the Python script", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"A JSON str of (name - value) pairs specifying arguments of the request and additional arguments to the script", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EmbedScriptComputeRow" }, "example":{ "input":"select name, finalgrade from GRADE where score > 90", "rows":5, "parameters":"{\"oml_input_type\":\"numpy.recarray\"}", "asyncFlag":true } } }, "required":true }, "responses":{ "200":{ "description":"By default, returns the job result.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/JSONObject" } } } }, "201":{ "description":"If asyncFlag=true, returns the location header where the status of the job can be fetched.", "headers":{ "Location":{ "style":"simple", "schema":{ "type":"string", "format":"uri" } } } }, "400":{ "description":"Invalid parameters specified, output exceeding size limit or other script execution error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/InvalidParameterValueException" } } } }, "500":{ "description":"Problem connecting to Broker, executing job or other unexpected error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ComputeContainerException" } } } } }, "deprecated":true, "x-internal-id":"py-scripts-v1-row-apply-{scriptName}-{ownerName}-post", "x-filename-id":"py-scripts-v1-row-apply-scriptname-ownername-post" } }, "/py-scripts/v2/row-apply/{scriptName}/{ownerName}":{ "post":{ "tags":[ "Run Scripts" ], "summary":"Run a Python Function on Chunks of Rows with Script Owner Specified", "description":"Runs a Python function on data chunked in sets of rows with script owner specified.", "operationId":"executeOwnerPyScriptRowApplywithConda", "parameters":[ { "name":"ownerName", "in":"path", "description":"The owner of the Python script", "required":true, "schema":{ "type":"string" } }, { "name":"scriptName", "in":"path", "description":"The name of the Python script", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"A JSON str of (name - value) pairs specifying arguments of the request and additional arguments to the script", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EmbedScriptComputeRow" }, "example":{ "input":"select name, finalgrade from GRADE where score > 90", "rows":5, "parameters":"{\"oml_input_type\":\"pandas.DataFrame\"}", "parallelFlag":true } } }, "required":true }, "responses":{ "200":{ "description":"By default, returns the job result.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/JSONObject" } } } }, "201":{ "description":"If asyncFlag=true, returns the location header where the status of the job can be fetched.", "headers":{ "Location":{ "style":"simple", "schema":{ "type":"string", "format":"uri" } } } }, "400":{ "description":"Invalid parameters specified, output exceeding size limit or other script execution error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/InvalidParameterValueException" } } } }, "500":{ "description":"Problem connecting to Broker, executing job or other unexpected error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ComputeContainerException" } } } } }, "x-internal-id":"py-scripts-v2-row-apply-{scriptName}-{ownerName}-post", "x-filename-id":"py-scripts-v2-row-apply-scriptname-ownername-post" } }, "/py-scripts/v1/table-apply/{scriptName}/{ownerName}":{ "post":{ "tags":[ "Run Scripts V1" ], "summary":"Run a Python Function on Specified Data with Script Owner Specified", "description":"Runs a Python function on the specified data with script owner specified.", "operationId":"executeOwnerPyScriptTabApply", "parameters":[ { "name":"ownerName", "in":"path", "description":"The owner of the Python script", "required":true, "schema":{ "type":"string" } }, { "name":"scriptName", "in":"path", "description":"The name of the Python script", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"A JSON str of (name - value) pairs specifying arguments of the request and additional arguments to the script", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EmbedScriptComputeTab" }, "example":{ "input":"select name, back from SWIM where gender='F'", "asyncFlag":true, "timeout":7200 } } }, "required":true }, "responses":{ "200":{ "description":"By default, returns the job result.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/JSONObject" } } } }, "201":{ "description":"If asyncFlag=true, returns the location header where the status of the job can be fetched.", "headers":{ "Location":{ "style":"simple", "schema":{ "type":"string", "format":"uri" } } } }, "400":{ "description":"Invalid parameters specified, output exceeding size limit or other script execution error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/InvalidParameterValueException" } } } }, "500":{ "description":"Problem connecting to Broker, executing job or other unexpected error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ComputeContainerException" } } } } }, "deprecated":true, "x-internal-id":"py-scripts-v1-table-apply-{scriptName}-{ownerName}-post", "x-filename-id":"py-scripts-v1-table-apply-scriptname-ownername-post" } }, "/py-scripts/v2/table-apply/{scriptName}/{ownerName}":{ "post":{ "tags":[ "Run Scripts" ], "summary":"Run a Python Function on Specified Data with Script Owner Specified", "description":"Runs a Python function on the specified data with script owner specified.", "operationId":"executeOwnerPyScriptTabApplywithConda", "parameters":[ { "name":"ownerName", "in":"path", "description":"The owner of the Python script", "required":true, "schema":{ "type":"string" } }, { "name":"scriptName", "in":"path", "description":"The name of the Python script", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"A JSON str of (name - value) pairs specifying arguments of the request and additional arguments to the script", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EmbedScriptComputeTab" }, "example":{ "input":"SWIM", "parameters":"{\"oml_na_omit\":true}", "service":"LOW" } } }, "required":true }, "responses":{ "200":{ "description":"By default, returns the job result.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/JSONObject" } } } }, "201":{ "description":"If asyncFlag=true, returns the location header where the status of the job can be fetched.", "headers":{ "Location":{ "style":"simple", "schema":{ "type":"string", "format":"uri" } } } }, "400":{ "description":"Invalid parameters specified, output exceeding size limit or other script execution error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/InvalidParameterValueException" } } } }, "500":{ "description":"Problem connecting to Broker, executing job or other unexpected error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ComputeContainerException" } } } } }, "x-internal-id":"py-scripts-v2-table-apply-{scriptName}-{ownerName}-post", "x-filename-id":"py-scripts-v2-table-apply-scriptname-ownername-post" } }, "/py-scripts/v1/do-eval/{scriptName}":{ "post":{ "tags":[ "Run Scripts V1" ], "summary":"Run a Python Function", "description":"Run the user-owned Python Function.", "operationId":"executePyScriptDoEval", "parameters":[ { "name":"scriptName", "in":"path", "description":"The name of the Python script", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"A JSON str of (name - value) pairs specifying arguments of the request and additional arguments to the script", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EmbedScriptCompute" }, "example":{ "parameters":"{\"ds_name\":\"ds_pydata\"}", "asyncFlag":true, "graphicsFlag":true } } }, "required":true }, "responses":{ "200":{ "description":"By default, returns the job result.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/JSONObject" } } } }, "201":{ "description":"If asyncFlag=true, returns the location header where the status of the job can be fetched.", "headers":{ "Location":{ "style":"simple", "schema":{ "type":"string", "format":"uri" } } } }, "400":{ "description":"Invalid parameters specified, output exceeding size limit or other script execution error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/InvalidParameterValueException" } } } }, "500":{ "description":"Problem connecting to Broker, executing job or other unexpected error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ComputeContainerException" } } } } }, "deprecated":true, "x-internal-id":"py-scripts-v1-do-eval-{scriptName}-post", "x-filename-id":"py-scripts-v1-do-eval-scriptname-post" } }, "/py-scripts/v2/do-eval/{scriptName}":{ "post":{ "tags":[ "Run Scripts" ], "summary":"Run a Python Function", "description":"Run the user-owned Python Function.", "operationId":"executePyScriptDoEvalwithConda", "parameters":[ { "name":"scriptName", "in":"path", "description":"The name of the Python script", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"A JSON str of (name - value) pairs specifying arguments of the request and additional arguments to the script", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EmbedScriptCompute" }, "example":{ "parameters":"{\"ds_name\":\"ds_pydata\"}", "asyncFlag":true, "graphicsFlag":true } } }, "required":true }, "responses":{ "200":{ "description":"By default, returns the job result.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/JSONObject" } } } }, "201":{ "description":"If asyncFlag=true, returns the location header where the status of the job can be fetched.", "headers":{ "Location":{ "style":"simple", "schema":{ "type":"string", "format":"uri" } } } }, "400":{ "description":"Invalid parameters specified, output exceeding size limit or other script execution error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/InvalidParameterValueException" } } } }, "500":{ "description":"Problem connecting to Broker, executing job or other unexpected error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ComputeContainerException" } } } } }, "x-internal-id":"py-scripts-v2-do-eval-{scriptName}-post", "x-filename-id":"py-scripts-v2-do-eval-scriptname-post" } }, "/py-scripts/v1/group-apply/{scriptName}":{ "post":{ "tags":[ "Run Scripts V1" ], "summary":"Run a Python Function on Grouped Data", "description":"Runs a user-owned Python function on data grouped by column values.", "operationId":"executePyScriptGrpApply", "parameters":[ { "name":"scriptName", "in":"path", "description":"The name of the Python script", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"A JSON str of (name - value) pairs specifying arguments of the request and additional arguments", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EmbedScriptComputeGrp" }, "example":{ "input":"select * from GRADE", "groupBy":"GENDER,YEAR", "orderBy":"GENDER", "parameters":"{\"oml_input_type\":\"default\"}", "parallelFlag":true } } }, "required":true }, "responses":{ "200":{ "description":"By default, returns the job result.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/JSONObject" } } } }, "201":{ "description":"If asyncFlag=true, returns the location header where the status of the job can be fetched.", "headers":{ "Location":{ "style":"simple", "schema":{ "type":"string", "format":"uri" } } } }, "400":{ "description":"Invalid parameters specified, output exceeding size limit or other script execution error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/InvalidParameterValueException" } } } }, "500":{ "description":"Problem connecting to Broker, executing job or other unexpected error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ComputeContainerException" } } } } }, "deprecated":true, "x-internal-id":"py-scripts-v1-group-apply-{scriptName}-post", "x-filename-id":"py-scripts-v1-group-apply-scriptname-post" } }, "/py-scripts/v2/group-apply/{scriptName}":{ "post":{ "tags":[ "Run Scripts" ], "summary":"Run a Python Function on Grouped Data", "description":"Runs a user-owned Python function on data grouped by column values.", "operationId":"executePyScriptGrpApplywithConda", "parameters":[ { "name":"scriptName", "in":"path", "description":"The name of the Python script", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"A JSON str of (name - value) pairs specifying arguments of the request and additional arguments", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EmbedScriptComputeGrp" }, "example":{ "input":"select * from GRADE", "groupBy":"GENDER,YEAR", "orderBy":"GENDER", "parameters":"{\"oml_input_type\":\"default\"}", "parallelFlag":true } } }, "required":true }, "responses":{ "200":{ "description":"By default, returns the job result.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/JSONObject" } } } }, "201":{ "description":"If asyncFlag=true, returns the location header where the status of the job can be fetched.", "headers":{ "Location":{ "style":"simple", "schema":{ "type":"string", "format":"uri" } } } }, "400":{ "description":"Invalid parameters specified, output exceeding size limit or other script execution error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/InvalidParameterValueException" } } } }, "500":{ "description":"Problem connecting to Broker, executing job or other unexpected error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ComputeContainerException" } } } } }, "x-internal-id":"py-scripts-v2-group-apply-{scriptName}-post", "x-filename-id":"py-scripts-v2-group-apply-scriptname-post" } }, "/py-scripts/v1/index-apply/{scriptName}":{ "post":{ "tags":[ "Run Scripts V1" ], "summary":"Run a Python Function multiple times", "description":"Runs a user-owned Python Function \"times\" times.", "operationId":"executePyScriptIdxApply", "parameters":[ { "name":"scriptName", "in":"path", "description":"The name of the Python script", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"A JSON str of (name - value) pairs specifying arguments of the request and additional arguments to the script", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EmbedScriptComputeIdx" }, "example":{ "times":3, "parallelFlag":true, "graphicsFlag":true, "service":"MEDIUM" } } }, "required":true }, "responses":{ "200":{ "description":"By default, returns the job result.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/JSONObject" } } } }, "201":{ "description":"If asyncFlag=true, returns the location header where the status of the job can be fetched.", "headers":{ "Location":{ "style":"simple", "schema":{ "type":"string", "format":"uri" } } } }, "400":{ "description":"Invalid parameters specified, output exceeding size limit or other script execution error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/InvalidParameterValueException" } } } }, "500":{ "description":"Problem connecting to Broker, executing job or other unexpected error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ComputeContainerException" } } } } }, "deprecated":true, "x-internal-id":"py-scripts-v1-index-apply-{scriptName}-post", "x-filename-id":"py-scripts-v1-index-apply-scriptname-post" } }, "/py-scripts/v2/index-apply/{scriptName}":{ "post":{ "tags":[ "Run Scripts" ], "summary":"Run a Python Function multiple times", "description":"Runs a user-owned Python Function \"times\" times.", "operationId":"executePyScriptIdxApplywithConda", "parameters":[ { "name":"scriptName", "in":"path", "description":"The name of the Python script", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"A JSON str of (name - value) pairs specifying arguments of the request and additional arguments to the script", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EmbedScriptComputeIdx" }, "example":{ "times":3, "parallelFlag":true, "graphicsFlag":true, "service":"MEDIUM" } } }, "required":true }, "responses":{ "200":{ "description":"By default, returns the job result.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/JSONObject" } } } }, "201":{ "description":"If asyncFlag=true, returns the location header where the status of the job can be fetched.", "headers":{ "Location":{ "style":"simple", "schema":{ "type":"string", "format":"uri" } } } }, "400":{ "description":"Invalid parameters specified, output exceeding size limit or other script execution error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/InvalidParameterValueException" } } } }, "500":{ "description":"Problem connecting to Broker, executing job or other unexpected error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ComputeContainerException" } } } } }, "x-internal-id":"py-scripts-v2-index-apply-{scriptName}-post", "x-filename-id":"py-scripts-v2-index-apply-scriptname-post" } }, "/py-scripts/v1/row-apply/{scriptName}":{ "post":{ "tags":[ "Run Scripts V1" ], "summary":"Run a Python Function on Chunks of Rows", "description":"Runs a user-owned Python function on data chunked in sets of rows.", "operationId":"executePyScriptRowApply", "parameters":[ { "name":"scriptName", "in":"path", "description":"The name of the Python script", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"A JSON str of (name - value) pairs specifying arguments of the request and additional arguments to the script", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EmbedScriptComputeRow" }, "example":{ "input":"select name, finalgrade from GRADE where score > 90", "rows":5, "parameters":"{\"oml_input_type\":\"pandas.DataFrame\"}", "parallelFlag":true } } }, "required":true }, "responses":{ "200":{ "description":"By default, returns the job result.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/JSONObject" } } } }, "201":{ "description":"If asyncFlag=true, returns the location header where the status of the job can be fetched.", "headers":{ "Location":{ "style":"simple", "schema":{ "type":"string", "format":"uri" } } } }, "400":{ "description":"Invalid parameters specified, output exceeding size limit or other script execution error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/InvalidParameterValueException" } } } }, "500":{ "description":"Problem connecting to Broker, executing job or other unexpected error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ComputeContainerException" } } } } }, "deprecated":true, "x-internal-id":"py-scripts-v1-row-apply-{scriptName}-post", "x-filename-id":"py-scripts-v1-row-apply-scriptname-post" } }, "/py-scripts/v2/row-apply/{scriptName}":{ "post":{ "tags":[ "Run Scripts" ], "summary":"Run a Python Function on Chunks of Rows", "description":"Runs a user-owned Python function on data chunked in sets of rows.", "operationId":"executePyScriptRowApplywithConda", "parameters":[ { "name":"scriptName", "in":"path", "description":"The name of the Python script", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"A JSON str of (name - value) pairs specifying arguments of the request and additional arguments to the script", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EmbedScriptComputeRow" }, "example":{ "input":"select name, finalgrade from GRADE where score > 90", "rows":5, "parameters":"{\"oml_input_type\":\"pandas.DataFrame\"}", "parallelFlag":true } } }, "required":true }, "responses":{ "200":{ "description":"By default, returns the job result.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/JSONObject" } } } }, "201":{ "description":"If asyncFlag=true, returns the location header where the status of the job can be fetched.", "headers":{ "Location":{ "style":"simple", "schema":{ "type":"string", "format":"uri" } } } }, "400":{ "description":"Invalid parameters specified, output exceeding size limit or other script execution error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/InvalidParameterValueException" } } } }, "500":{ "description":"Problem connecting to Broker, executing job or other unexpected error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ComputeContainerException" } } } } }, "x-internal-id":"py-scripts-v2-row-apply-{scriptName}-post", "x-filename-id":"py-scripts-v2-row-apply-scriptname-post" } }, "/py-scripts/v1/table-apply/{scriptName}":{ "post":{ "tags":[ "Run Scripts V1" ], "summary":"Run a Python Function on Specified Data", "description":"Runs a user-owned Python function on the specified data.", "operationId":"executePyScriptTabApply", "parameters":[ { "name":"scriptName", "in":"path", "description":"The name of the Python script", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"A JSON str of (name - value) pairs specifying arguments of the request and additional arguments to the script", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EmbedScriptComputeTab" }, "example":{ "input":"select * from SWIM", "parameters":"{\"oml_na_omit\":true}", "service":"LOW" } } }, "required":true }, "responses":{ "200":{ "description":"By default, returns the job result.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/JSONObject" } } } }, "201":{ "description":"If asyncFlag=true, returns the location header where the status of the job can be fetched.", "headers":{ "Location":{ "style":"simple", "schema":{ "type":"string", "format":"uri" } } } }, "400":{ "description":"Invalid parameters specified, output exceeding size limit or other script execution error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/InvalidParameterValueException" } } } }, "500":{ "description":"Problem connecting to Broker, executing job or other unexpected error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ComputeContainerException" } } } } }, "deprecated":true, "x-internal-id":"py-scripts-v1-table-apply-{scriptName}-post", "x-filename-id":"py-scripts-v1-table-apply-scriptname-post" } }, "/py-scripts/v2/table-apply/{scriptName}":{ "post":{ "tags":[ "Run Scripts" ], "summary":"Run a Python Function on Specified Data", "description":"Runs a user-owned Python function on the specified data.", "operationId":"executePyScriptTabApplywithConda", "parameters":[ { "name":"scriptName", "in":"path", "description":"The name of the Python script", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"A JSON str of (name - value) pairs specifying arguments of the request and additional arguments to the script", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EmbedScriptComputeTab" }, "example":{ "input":"SWIM", "parameters":"{\"oml_na_omit\":true}", "service":"LOW" } } }, "required":true }, "responses":{ "200":{ "description":"By default, returns the job result.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/JSONObject" } } } }, "201":{ "description":"If asyncFlag=true, returns the location header where the status of the job can be fetched.", "headers":{ "Location":{ "style":"simple", "schema":{ "type":"string", "format":"uri" } } } }, "400":{ "description":"Invalid parameters specified, output exceeding size limit or other script execution error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/InvalidParameterValueException" } } } }, "500":{ "description":"Problem connecting to Broker, executing job or other unexpected error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ComputeContainerException" } } } } }, "x-internal-id":"py-scripts-v2-table-apply-{scriptName}-post", "x-filename-id":"py-scripts-v2-table-apply-scriptname-post" } }, "/py-scripts":{ "get":{ "tags":[ "Get Version Metadata" ], "summary":"Retrieve Metadata of Available Versions", "description":"Returns metadata describing all available versions of the Script Execution APIs.", "operationId":"getAllVersionMetadata", "responses":{ "200":{ "description":"A list of all available versions.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EmbedScriptApiMetadata" } } } } }, "x-internal-id":"py-scripts-get", "x-filename-id":"py-scripts-get" } }, "/py-scripts/v1/envs":{ "get":{ "tags":[ "List Environments" ], "summary":"List OML4Py Conda Environments V1", "description":"Returns all the available conda environments.", "operationId":"getCondaEnvs", "responses":{ "200":{ "description":"List of conda environments", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/JSONObject" } } } } }, "deprecated":true, "x-internal-id":"py-scripts-v1-envs-get", "x-filename-id":"py-scripts-v1-envs-get" } }, "/py-scripts/v2/envs":{ "get":{ "tags":[ "List Environments" ], "summary":"List OML4Py Conda Environments", "description":"Returns all the available conda environments.", "operationId":"getCondaEnvsV2", "responses":{ "200":{ "description":"List of conda environments", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/JSONObject" } } } } }, "x-internal-id":"py-scripts-v2-envs-get", "x-filename-id":"py-scripts-v2-envs-get" } }, "/py-scripts/v2/jobs":{ "get":{ "tags":[ "Run Scripts" ], "summary":"Retrieve All Asynchronous Jobs", "description":"Retrieves the status, job id, elapsed time of the asynchronous jobs.", "operationId":"getJobs", "responses":{ "200":{ "description":"List of asynchronous jobs.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/JSONObject" } } } }, "401":{ "description":"When the user doesn't have privileges to perform the action.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UnauthorizedException" } } } }, "500":{ "description":"Problem connecting to Broker, finding the job id or other unexpected error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ComputeContainerException" } } } } }, "x-internal-id":"py-scripts-v2-jobs-get", "x-filename-id":"py-scripts-v2-jobs-get" } }, "/py-scripts/v1/jobs/{jobId}/result":{ "get":{ "tags":[ "Run Scripts V1" ], "summary":"Retrieve Asynchronous Job Result", "description":"Retrieves the result of the asynchronous job.", "operationId":"getPyScriptsAsyncJobResult", "parameters":[ { "name":"jobId", "in":"path", "description":"The id of the asynchronous job", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Job result.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/JSONObject" } } } }, "401":{ "description":"When the user doesn't have privileges to perform the action.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UnauthorizedException" } } } }, "404":{ "description":"Resource not found, when the result is not ready.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/AbstractOmlException" } } } }, "500":{ "description":"Problem connecting to Broker, finding the job id or other unexpected error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ComputeContainerException" } } } } }, "deprecated":true, "x-internal-id":"py-scripts-v1-jobs-{jobId}-result-get", "x-filename-id":"py-scripts-v1-jobs-jobid-result-get" } }, "/py-scripts/v2/jobs/{jobId}/result":{ "get":{ "tags":[ "Run Scripts" ], "summary":"Retrieve Asynchronous Job Result", "description":"Retrieves the result of the asynchronous job.", "operationId":"getPyScriptsAsyncJobResultTable", "parameters":[ { "name":"jobId", "in":"path", "description":"The id of the asynchronous job", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Job result.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/JSONObject" } } } }, "401":{ "description":"When the user doesn't have privileges to perform the action.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UnauthorizedException" } } } }, "404":{ "description":"Resource not found, when the result is not ready.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/AbstractOmlException" } } } }, "500":{ "description":"Problem connecting to Broker, finding the job id or other unexpected error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ComputeContainerException" } } } } }, "x-internal-id":"py-scripts-v2-jobs-{jobId}-result-get", "x-filename-id":"py-scripts-v2-jobs-jobid-result-get" } }, "/py-scripts/v2":{ "get":{ "tags":[ "Get Version Metadata" ], "summary":"Retrieve Metadata of Version 2", "description":"Returns metadata describing version 2 of the Script Execution APIs.", "operationId":"getVersion2Metadata", "responses":{ "200":{ "description":"Metadata describing version 2 of the API.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EmbedScriptApiVersion" } } } } }, "x-internal-id":"py-scripts-v2-get", "x-filename-id":"py-scripts-v2-get" } }, "/py-scripts/v1":{ "get":{ "tags":[ "Get Version Metadata" ], "summary":"Retrieve Metadata of Version 1", "description":"Returns metadata describing version 1 of the Script Execution APIs.", "operationId":"getVersionOneMetadata", "responses":{ "200":{ "description":"Metadata describing version 1 of the API.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EmbedScriptApiVersion" } } } } }, "deprecated":true, "x-internal-id":"py-scripts-v1-get", "x-filename-id":"py-scripts-v1-get" } }, "/py-scripts/v2/scripts":{ "get":{ "tags":[ "List Scripts" ], "summary":"List Scripts", "description":"Lists the scripts to which the current user has access.", "operationId":"listAllPyScriptsV2", "responses":{ "200":{ "description":"List of accessible python scripts.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EmbedScript" } } } }, "500":{ "description":"Problem connecting to Broker, executing job or other unexpected error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ComputeContainerException" } } } } }, "x-internal-id":"py-scripts-v2-scripts-get", "x-filename-id":"py-scripts-v2-scripts-get" } }, "/py-scripts/v1/scripts":{ "get":{ "tags":[ "List Scripts" ], "summary":"List Scripts V1", "description":"Lists the scripts to which the current user has access.", "operationId":"listPyScripts", "responses":{ "200":{ "description":"List of accessible python scripts.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EmbedScript" } } } }, "500":{ "description":"Problem connecting to Broker, executing job or other unexpected error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ComputeContainerException" } } } } }, "deprecated":true, "x-internal-id":"py-scripts-v1-scripts-get", "x-filename-id":"py-scripts-v1-scripts-get" } }, "/py-scripts/v2/scripts/{scriptType}":{ "get":{ "tags":[ "List Scripts" ], "summary":"List Scripts with Specific Type", "description":"Lists OML4Py scripts matching the specified type from the script repository.", "operationId":"listPyScriptsV2", "parameters":[ { "name":"scriptType", "in":"path", "description":"The type of the Python script:\n* __user__ : Lists Python scripts created by current user.\n* __all__ : Lists all Python scripts to which the current user has\n read access.\n* __global__ : Lists all user-created global Python scripts.\n* __grant__ : Lists Python scripts the read privilege for which has been\n granted by the current user to other users.\n* __granted__ : Lists Python scripts the read privilege for which has been\n granted by other users to the current user.", "required":true, "schema":{ "type":"string", "enum":[ "user", "all", "global", "grant", "granted" ] } } ], "responses":{ "200":{ "description":"List of Python scripts.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EmbedScript" } } } }, "500":{ "description":"Problem connecting to Broker, executing job or other unexpected error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ComputeContainerException" } } } } }, "x-internal-id":"py-scripts-v2-scripts-{scriptType}-get", "x-filename-id":"py-scripts-v2-scripts-scripttype-get" } } }, "components":{ "schemas":{ "JSONObject":{ "type":"object", "properties":{ "empty":{ "type":"boolean" } } }, "UnauthorizedException":{ "type":"object", "required":[ "debug", "errorCode" ], "properties":{ "errorMessage":{ "type":"string" }, "errorCode":{ "type":"integer", "format":"int64" } } }, "ComputeContainerException":{ "type":"object", "required":[ "debug", "errorCode" ], "properties":{ "errorMessage":{ "type":"string" }, "errorCode":{ "type":"integer", "format":"int64" } } }, "InvalidParameterValueException":{ "type":"object", "required":[ "debug", "errorCode" ], "properties":{ "errorMessage":{ "type":"string" }, "errorCode":{ "type":"integer", "format":"int64" }, "parameterName":{ "type":"string" }, "parameterValue":{ "type":"string" } } }, "EmbedScriptCompute":{ "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, TP, TPURGENT" ] }, "envName":{ "type":"string", "description":"Name of the conda environment." } } }, "EmbedScriptComputeGrp":{ "required":[ "groupBy", "input" ], "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, TP, TPURGENT" ] }, "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", "description":"Degree of parallel.", "format":"int32" } } }, "EmbedScriptComputeIdx":{ "required":[ "times" ], "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, TP, TPURGENT" ] }, "envName":{ "type":"string", "description":"Name of the conda environment." }, "times":{ "type":"integer", "description":"Number of times to execute the script.", "format":"int32" }, "parallelFlag":{ "type":"boolean", "description":"Whether to execute job in parallel." }, "parallel":{ "type":"integer", "description":"Degree of parallelism.", "format":"int32" } } }, "EmbedScriptComputeRow":{ "required":[ "input", "rows" ], "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, TP, TPURGENT" ] }, "envName":{ "type":"string", "description":"Name of the conda environment." }, "input":{ "type":"string", "description":"Query statement specifying input data." }, "rows":{ "type":"integer", "description":"Number of rows to chunk by.", "format":"int32" }, "parallelFlag":{ "type":"boolean", "description":"Whether to execute job in parallel." }, "parallel":{ "type":"integer", "description":"Degree of parallelism.", "format":"int32" } } }, "EmbedScriptComputeTab":{ "required":[ "input" ], "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, TP, TPURGENT" ] }, "envName":{ "type":"string", "description":"Name of the conda environment." }, "input":{ "type":"string", "description":"Query statement specifying input data." } } }, "EmbedScriptApiMetadata":{ "type":"object", "properties":{ "items":{ "type":"array", "description":"Collection of version resources.", "items":{ "$ref":"#/components/schemas/EmbedScriptApiVersion" } }, "links":{ "type":"array", "description":"List of related resource links.", "items":{ "$ref":"#/components/schemas/EmbedScriptResourceLink" } } } }, "EmbedScriptApiVersion":{ "type":"object", "properties":{ "version":{ "type":"string", "description":"Version of this API." }, "isLatest":{ "type":"boolean", "description":"True if this is the latest version of the API." }, "lifecycle":{ "type":"string", "description":"Lifecycle of the version.", "enum":[ "ACTIVE,DEPRECATED" ] }, "links":{ "type":"array", "description":"List of related resource links.", "items":{ "$ref":"#/components/schemas/EmbedScriptResourceLink" } } } }, "EmbedScriptResourceLink":{ "required":[ "href", "rel" ], "type":"object", "properties":{ "rel":{ "type":"string", "description":"Relationship of the link to the current resource." }, "href":{ "type":"string", "description":"URL of the resource." } }, "description":"List of related resource links." }, "AbstractOmlException":{ "type":"object", "required":[ "debug", "errorCode" ], "properties":{ "errorMessage":{ "type":"string" }, "errorCode":{ "type":"integer", "format":"int64" } } }, "EmbedScript":{ "type":"object", "properties":{ "owner":{ "type":"string" }, "name":{ "type":"string" }, "script":{ "type":"string" }, "description":{ "type":"string" }, "date":{ "type":"string", "format":"date-time" } } } } }, "tags":[ { "name":"Get Version Metadata", "description":"The operations from the Get Version Metadata category." }, { "name":"List Environments", "description":"The operations from the List Environments category." }, { "name":"List Scripts", "description":"The operations from the List Scripts category." }, { "name":"Run Scripts", "description":"The operations from the Run Scripts category." }, { "name":"Run Scripts V1", "description":"The operations from the Run Scripts V1 category." } ] }