1. Embedded R ExecutionのREST API
  2. タスク
  3. スクリプトの実行

指定したデータに対するR関数の実行

POST

/r-scripts/v1/table-apply/{scriptName}

指定したデータに対してユーザー所有のR関数を実行します。

リクエスト

パス・パラメータ
先頭に戻る

レスポンス

200レスポンス

デフォルトでは、ジョブの結果を返します。

201レスポンス

asyncFlag=trueの場合、ジョブのステータスをフェッチできるロケーション・ヘッダーを返します。
ヘッダー

400レスポンス

無効なパラメータが指定され、出力がサイズ制限を超えているか、他のスクリプト実行エラーが発生しました。

500レスポンス

ブローカへの接続中、ジョブの実行中に問題が発生したか、または他の予期しないエラーが発生しました。
先頭に戻る

例

例1

次の例では、my.predictというスクリプトを実行します。 

curl -i -X POST --header "Authorization: Bearer ${token}" \
--header 'Content-Type: application/json' --header 'Accept: application/json' \
-d '{"input":"IRIS"}' \
"<oml-cloud-service-location-url>}/oml/api/r-scripts/v1/table-apply/my.predict"

レスポンス・ヘッダー

レスポンス・ヘッダーは次のとおりです。

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'

レスポンス本文

JSON形式のレスポンス本文の一部を次に示します。

{"result":[{"PRED":4.7227,"Sepal.Length":4.6},{"PRED":4.5396,"Sepal.Length":4.3},{"PRED":4.6902,"Sepal.Length":5},{"PRED":5.0869,"Sepal.Length":5.8},{"PRED":4.6739,"Sepal.Length":4.4},{"PRED":4.7731,"Sepal.Length":4.4},...

例2

次の例では、test_ggplot2_inpというスクリプトを実行します。 

curl -i -X POST --header "Authorization: Bearer ${token}" --header
'Content-Type: application/json' --header 'Accept: application/json' -d
'{"input": "IRIS", "envName": "myrenv", "graphicsFlag": true}' 
"<oml-cloudservice-location-url>/oml/api/r-scripts/v1/table-apply/test_ggplot2_inp"

レスポンス本文

RESTエンドポイントの結果は、イメージおよびデータを含むRスクリプトから返される値のJSON表現です。イメージ・バイトはPNG形式で返されます。

{
  "result": [
    {
      "IMAGE": "iVBORw0KGgoAAAANSUhEU......AAAABJRU5ErkJggg==",
      "DATA": "\"hello world\"",
      "ID": 1
    }
  ]
}
先頭に戻る