Embedded R ExecutionのREST API

使用可能なバージョンのメタデータの取得

GET

/api/r-scripts

Script Execution APIの使用可能なすべてのバージョンを記述するメタデータを返します。

リクエスト

この操作にはリクエスト・パラメータはありません。

先頭に戻る

レスポンス

サポートされているメディア・タイプ

application/json

200レスポンス

使用可能なすべてのバージョンのリスト。

ルート・スキーマ: EmbedScriptApiMetadata

型: object

ソースの表示

items: array items

バージョン・リソースのコレクション。
links: array links

関連リソース・リンクのリスト。

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"Collection of version resources.",
            "items":{
                "$ref":"#/definitions/EmbedScriptApiVersion"
            }
        },
        "links":{
            "type":"array",
            "description":"List of related resource links.",
            "items":{
                "$ref":"#/definitions/EmbedScriptResourceLink"
            }
        }
    }
}

ネストされたスキーマ: items

型: array

バージョン・リソースのコレクション。

ソースの表示

配列: object EmbedScriptApiVersion

{
    "type":"array",
    "description":"Collection of version resources.",
    "items":{
        "$ref":"#/definitions/EmbedScriptApiVersion"
    }
}

ネストされたスキーマ: links

型: array

関連リソース・リンクのリスト。

ソースの表示

配列: object EmbedScriptResourceLink

{
    "type":"array",
    "description":"List of related resource links.",
    "items":{
        "$ref":"#/definitions/EmbedScriptResourceLink"
    }
}

ネストされたスキーマ: EmbedScriptApiVersion

型: object

ソースの表示

isLatest: boolean

これがAPIの最新バージョンである場合はtrue。
lifecycle: string

指定可能な値: [ "ACTIVE", "DEPRECATED" ]

バージョンのライフサイクル。
links: array links

関連リソース・リンクのリスト。
version: string

このAPIのバージョン。

{
    "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":"#/definitions/EmbedScriptResourceLink"
            }
        }
    }
}

ネストされたスキーマ: links

型: array

関連リソース・リンクのリスト。

ソースの表示

配列: object EmbedScriptResourceLink

{
    "type":"array",
    "description":"List of related resource links.",
    "items":{
        "$ref":"#/definitions/EmbedScriptResourceLink"
    }
}

ネストされたスキーマ: EmbedScriptResourceLink

型: object

ソースの表示

href(必須): string

リソースのURL。
rel(必須): string

現在のリソースへのリンクの関係。

{
    "type":"object",
    "required":[
        "href",
        "rel"
    ],
    "properties":{
        "rel":{
            "type":"string",
            "description":"Relationship of the link to the current resource."
        },
        "href":{
            "type":"string",
            "description":"URL of the resource."
        }
    }
}

先頭に戻る

例

次の例では、Embedded R ExecutionのREST APIについて使用可能なバージョンの情報を取得します。

curl -i -X GET --header "Authorization: Bearer ${token}" \
--header 'Accept: application/json' \
"<oml-cloud-service-location-url>/oml/api/r-scripts"

レスポンス・ヘッダー

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

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形式のレスポンス本文は次のとおりです。

{"items":[
{"isLatest":true,
"lifecycle":"ACTIVE",
"links":[
  {"href":"https://<oml-cloud-service-location-url>/oml/api/r-scripts/v1","rel":"self"},
  {"href":"https://<oml-cloud-service-location-url>/oml/api/r-scripts/v1/scripts","rel":"child"},
  {"href":"https://<oml-cloud-service-location-url>/oml/api/r-scripts/v1/do-eval/{scriptName}","rel":"child"},
  {"href":"https://<oml-cloud-service-location-url>/oml/api/r-scripts/v1/do-eval/{scriptName}/{ownerName}","rel":"child"},
  {"href":"https://<oml-cloud-service-location-url>/oml/api/r-scripts/v1/table-apply/{scriptName}","rel":"child"},
  {"href":"https://<oml-cloud-service-location-url>/oml/api/r-scripts/v1/table-apply/{scriptName}/{ownerName}","rel":"child"},
  {"href":"https://<oml-cloud-service-location-url>/oml/api/r-scripts/v1/row-apply/{scriptName}","rel":"child"},
  {"href":"https://<oml-cloud-service-location-url>/oml/api/r-scripts/v1/row-apply/{scriptName}/{ownerName}","rel":"child"},
  {"href":"https://<oml-cloud-service-location-url>/oml/api/r-scripts/v1/index-apply/{scriptName}","rel":"child"},
  {"href":"https://<oml-cloud-service-location-url>/oml/api/r-scripts/v1/index-apply/{scriptName}/{ownerName}","rel":"child"},
  {"href":"https://<oml-cloud-service-location-url>/oml/api/r-scripts/v1/group-apply/{scriptName}","rel":"child"},
  {"href":"https://<oml-cloud-service-location-url>/oml/api/r-scripts/v1/group-apply/{scriptName}/{ownerName}","rel":"child"}],
"version":"v1"}],
"links":[
  {"href":"https://<oml-cloud-service-location-url>/oml/api/r-scripts","rel":"self"},
  {"href":"https://<oml-cloud-service-location-url>/oml/api/r-scripts/v1","rel":"current"}]}

先頭に戻る