移動

• リクエスト
• レスポンス
• 例

バージョン2のメタデータの取得

get

/py-scripts/v2

Script Execution APIのバージョン2を記述するメタデータを返します。

リクエスト

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

この操作にはリクエスト本文はありません。

先頭に戻る

レスポンス

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

• application/json

200レスポンス

APIのバージョン2を記述するメタデータ。

本文()

ルート・スキーマ: 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":"#/components/schemas/EmbedScriptResourceLink"
            }
        }
    }
}

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

型: array

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

ソースの表示

• 配列: object EmbedScriptResourceLink
  関連リソース・リンクのリスト。

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

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

型: object

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

ソースの表示

• href(必須): string
  リソースのURL。
• rel(必須): string
  現在のリソースへのリンクの関係。

{
    "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."
}

先頭に戻る

例

次の例では、Embedded Python ExecutionのREST APIのバージョン1に関する情報を取得します。

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

レスポンス・ヘッダー

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

HTTP/1.1 200 OK
Date: Thu, 20 Aug 2020 14:52:38 GMT
Content-Type: application/json
Content-Length: 1556
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

レスポンス本文

JSON形式のレスポンス本文は次のとおりです。

{
    "version": "v2",
    "isLatest": true,
    "lifecycle": "ACTIVE",
    "links": [
        {
            "rel": "self",
            "href": "<oml-cloud-service-location-url>/oml/api/py-scripts/v2"
        },
        {
            "rel": "child",
            "href": "<oml-cloud-service-location-url>/oml/api/py-scripts/v2/envs"
        },
        {
            "rel": "child",
            "href": "<oml-cloud-service-location-url>/oml/api/py-scripts/v2/jobs/{jobId}"
        },
        {
            "rel": "child",
            "href": "<oml-cloud-service-location-url>/oml/api/py-scripts/v2/jobs/{jobId}/result"
        },
        {
            "rel": "child",
            "href": "<oml-cloud-service-location-url>/oml/api/py-scripts/v2/jobs"
        },
        {
            "rel": "child",
            "href": "<oml-cloud-service-location-url>/oml/api/py-scripts/v2/scripts/{scriptType}"
        },
        {
            "rel": "child",
            "href": "<oml-cloud-service-location-url>/oml/api/py-scripts/v2/scripts"
        },
        {
            "rel": "child",
            "href": "<oml-cloud-service-location-url>/oml/api/py-scripts/v2/do-eval/{scriptName}"
        },
        {
            "rel": "child",
            "href": "<oml-cloud-service-location-url>/oml/api/py-scripts/v2/do-eval/{scriptName}/{ownerName}"
        },
        {
            "rel": "child",
            "href": "<oml-cloud-service-location-url>/oml/api/py-scripts/v2/table-apply/{scriptName}"
        },
        {
            "rel": "child",
            "href": "<oml-cloud-service-location-url>/oml/api/py-scripts/v2/table-apply/{scriptName}/{ownerName}"
        },
        {
            "rel": "child",
            "href": "<oml-cloud-service-location-url>/oml/api/py-scripts/v2/row-apply/{scriptName}"
        },
        {
            "rel": "child",
            "href": "<oml-cloud-service-location-url>/oml/api/py-scripts/v2/row-apply/{scriptName}/{ownerName}"
        },
        {
            "rel": "child",
            "href": "<oml-cloud-service-location-url>/oml/api/py-scripts/v2/index-apply/{scriptName}"
        },
        {
            "rel": "child",
            "href": "<oml-cloud-service-location-url>/oml/api/py-scripts/v2/index-apply/{scriptName}/{ownerName}"
        },
        {
            "rel": "child",
            "href": "<oml-cloud-service-location-url>/oml/api/py-scripts/v2/group-apply/{scriptName}"
        },
        {
            "rel": "child",
            "href": "<oml-cloud-service-location-url>/oml/api/py-scripts/v2/group-apply/{scriptName}/{ownerName}"
        }
    ]
}

先頭に戻る