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

グループ化データに対するR関数の実行

POST

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

列値でグループ化されたデータに対してユーザー所有のR関数を実行します。

リクエスト

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

レスポンス

200レスポンス

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

201レスポンス

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

400レスポンス

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

500レスポンス

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

例

例1: 同期の例

次の例では、group.countというスクリプトを実行します。この例では、parallelFlagをtrueに設定してデータベースの並列性を利用します。 

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"

レスポンス・ヘッダー

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

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":[{"Count":50,"Species":"setosa"},{"Count":50,"Species":"versicolor"},{"Count":50,"Species":"virginica"}]}

例2

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

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

レスポンス本文

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

{
  "result": [
    [
      {
        "GROUP": "setosa",
        "IMAGE": "iVBORw0KGgoAAAANSUhEU......jAAAAABJRU5ErkJggg==",
        "DATA": "\"hello world\"",
        "ID": 1
      }
    ],
    [
      {
        "GROUP": "versicolor",
        "IMAGE": "iVBORw0KGgoAAAANSUhEU......LsAAAAASUVORK5CYII=",
        "DATA": "\"hello world\"",
        "ID": 1
      }
    ],
    [
      {
        "GROUP": "virginica",
        "IMAGE": "iVBORw0KGgoAAAANSUhEU......gwAAAABJRU5ErkJggg==",
        "DATA": "\"hello world\"",
        "ID": 1
      }
    ]
  ]
}
先頭に戻る