ジャンプ先

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

トップレベルURL

get

/grid/cmd/v1/cmd

コマンド・リソースを返します

リクエスト

問合せパラメータ

• expand: string
  子リソースの展開
• fields: array[string]
  コレクション形式: csv

  特定のフィールドのみのフェッチ

先頭に戻る

レスポンス

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

• application/vnd.oracle.resource+json;type=singular
• text/plain

200レスポンス

成功

ヘッダー

• Content-Type: string
  Content-type "application/vnd.oracle.resource+json;type=singular"

本文()

ルート・スキーマ: cmd

すべてに一致

ソースの表示

• オブジェクト cmd-allOf[0]
• オブジェクト Singular Resource
  タイトル: Singular Resource

  Oracleベース単一リソースのスキーマ定義。

{
    "allOf":[
        {
            "properties":{
                "exec":{
                    "$ref":"#/definitions/exec"
                },
                "homes":{
                    "$ref":"#/definitions/homes"
                },
                "jobs":{
                    "$ref":"#/definitions/jobs"
                },
                "name":{
                    "type":"string"
                }
            }
        },
        {
            "$ref":"#/definitions/singularResource"
        }
    ]
}

ネストされたスキーマ: cmd-allOf[0]

型: object

ソースの表示

• exec: exec
• homes: object homes
• jobs: jobs
• name: string

{
    "properties":{
        "exec":{
            "$ref":"#/definitions/exec"
        },
        "homes":{
            "$ref":"#/definitions/homes"
        },
        "jobs":{
            "$ref":"#/definitions/jobs"
        },
        "name":{
            "type":"string"
        }
    }
}

ネストされたスキーマ: Singular Resource

型: object

タイトル: Singular Resource

Oracleベース単一リソースのスキーマ定義。

ソースの表示

• links: array links

{
    "description":"Oracle base singular resource schema definition.",
    "properties":{
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        }
    },
    "title":"Singular Resource",
    "type":"object"
}

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

すべてに一致

ソースの表示

• オブジェクト Singular Resource
  タイトル: Singular Resource

  Oracleベース単一リソースのスキーマ定義。

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        }
    ]
}

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

型: object

ソースの表示

• homeName: string
• path: string

{
    "properties":{
        "homeName":{
            "type":"string"
        },
        "path":{
            "type":"string"
        }
    }
}

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

すべてに一致

ソースの表示

• オブジェクト jobs-allOf[0]
• allOf collectionBaseResource

{
    "allOf":[
        {
            "properties":{
                "items":{
                    "items":{
                        "$ref":"#/definitions/job"
                    },
                    "type":"array"
                }
            }
        },
        {
            "$ref":"#/definitions/collectionBaseResource"
        }
    ]
}

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

型: array

ソースの表示

• 配列: オブジェクト instanceLink
  JSONインスタンス表現に表示される場合があるリンクの説明オブジェクトを記述するメタデータ。

{
    "items":{
        "$ref":"#/definitions/instanceLink"
    },
    "type":"array"
}

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

型: object

JSONインスタンス表現に表示される場合があるリンクの説明オブジェクトを記述するメタデータ。

ソースの表示

• href: string
  URI [RFC3986]またはURIテンプレート[RFC6570].値がURIテンプレートに設定されている場合、"templated"プロパティをtrueに設定する必要があります。
• mediaType: string
  メディア・タイプ。RFC 2046で定義され、リンク・ターゲットを記述します。
• rel: string
  リンクの詳細を取得するために、タイプ・プロパティに加えて使用できるリンク・リレーションの名前。たとえば、hrefまたはプロファイル

{
    "description":"Metadata describing link description objects that MAY appear in the JSON instance representation.",
    "properties":{
        "href":{
            "description":"URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the \"templated\" property must be set to true.",
            "type":"string"
        },
        "mediaType":{
            "description":"Media type, as defined by RFC 2046, describing the link target.",
            "type":"string"
        },
        "rel":{
            "description":"Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile ",
            "type":"string"
        }
    }
}

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

すべてに一致

ソースの表示

• オブジェクト Singular Resource
  タイトル: Singular Resource

  Oracleベース単一リソースのスキーマ定義。
• オブジェクト Collection Resource
  タイトル: Collection Resource

  Oracleベース・コレクション・リソースのスキーマ定義。

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "description":"Oracle base collection resource schema definition. ",
            "properties":{
                "items":{
                    "items":{
                        "type":"object"
                    },
                    "type":"array"
                }
            },
            "title":" Collection Resource"
        }
    ]
}

ネストされたスキーマ: jobs-allOf[0]

型: object

ソースの表示

• items: array items

{
    "properties":{
        "items":{
            "items":{
                "$ref":"#/definitions/job"
            },
            "type":"array"
        }
    }
}

ネストされたスキーマ: Collection Resource

型: object

タイトル: Collection Resource

Oracleベース・コレクション・リソースのスキーマ定義。

ソースの表示

• items: array items

{
    "description":"Oracle base collection resource schema definition. ",
    "properties":{
        "items":{
            "items":{
                "type":"object"
            },
            "type":"array"
        }
    },
    "title":" Collection Resource"
}

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

型: array

ソースの表示

• 配列: job

{
    "items":{
        "$ref":"#/definitions/job"
    },
    "type":"array"
}

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

すべてに一致

ソースの表示

• オブジェクト jobCommon
• オブジェクト job-allOf[1]
• オブジェクト Singular Resource
  タイトル: Singular Resource

  Oracleベース単一リソースのスキーマ定義。

{
    "allOf":[
        {
            "$ref":"#/definitions/jobCommon"
        },
        {
            "properties":{
                "jobId":{
                    "type":"string",
                    "readOnly":true
                },
                "status":{
                    "type":"string",
                    "enum":[
                        "Scheduled",
                        "Running",
                        "Completed",
                        "Failed",
                        "Unknown"
                    ],
                    "readOnly":true
                },
                "output":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    },
                    "readOnly":true
                },
                "outputFile":{
                    "allOf":[
                        {
                            "$ref":"#/definitions/singularResource"
                        }
                    ],
                    "readOnly":true
                },
                "processId":{
                    "type":"integer",
                    "readOnly":true
                },
                "processStatus":{
                    "type":"integer",
                    "readOnly":true
                },
                "timeStart":{
                    "type":"string",
                    "readOnly":true
                },
                "timeFinish":{
                    "type":"string",
                    "readOnly":true
                }
            },
            "required":[
                "jobId"
            ]
        },
        {
            "$ref":"#/definitions/singularResource"
        }
    ]
}

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

型: object

ソースの表示

• command(必須): array command
• flags: array flags
• homeName: string
• jobExpiry: integer
• nodeName: string
• runAsUser(必須): string

{
    "properties":{
        "command":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "flags":{
            "type":"array",
            "items":{
                "type":"string",
                "enum":[
                    "outputDiscard"
                ]
            }
        },
        "homeName":{
            "type":"string"
        },
        "jobExpiry":{
            "type":"integer"
        },
        "nodeName":{
            "type":"string"
        },
        "runAsUser":{
            "type":"string"
        }
    },
    "required":[
        "command",
        "runAsUser"
    ]
}

ネストされたスキーマ: job-allOf[1]

型: object

ソースの表示

• jobId(必須): string
  読取り専用: true
• output: array output
  読取り専用: true
• outputFile: outputFile
  読取り専用: true
• processId: integer
  読取り専用: true
• processStatus: integer
  読取り専用: true
• status: string
  読取り専用: true

  指定できる値: [ "Scheduled", "Running", "Completed", "Failed", "Unknown" ]
• timeFinish: string
  読取り専用: true
• timeStart: string
  読取り専用: true

{
    "properties":{
        "jobId":{
            "type":"string",
            "readOnly":true
        },
        "status":{
            "type":"string",
            "enum":[
                "Scheduled",
                "Running",
                "Completed",
                "Failed",
                "Unknown"
            ],
            "readOnly":true
        },
        "output":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "readOnly":true
        },
        "outputFile":{
            "allOf":[
                {
                    "$ref":"#/definitions/singularResource"
                }
            ],
            "readOnly":true
        },
        "processId":{
            "type":"integer",
            "readOnly":true
        },
        "processStatus":{
            "type":"integer",
            "readOnly":true
        },
        "timeStart":{
            "type":"string",
            "readOnly":true
        },
        "timeFinish":{
            "type":"string",
            "readOnly":true
        }
    },
    "required":[
        "jobId"
    ]
}

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

型: array

ソースの表示

• 配列: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

ソースの表示

• 配列: string
  指定できる値: [ "outputDiscard" ]

{
    "type":"array",
    "items":{
        "type":"string",
        "enum":[
            "outputDiscard"
        ]
    }
}

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

型: array

読取り専用: true

ソースの表示

• 配列: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "readOnly":true
}

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

読取り専用: true

すべてに一致

ソースの表示

• オブジェクト Singular Resource
  タイトル: Singular Resource

  Oracleベース単一リソースのスキーマ定義。

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        }
    ],
    "readOnly":true
}

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

型: array

ソースの表示

• 配列: object items

{
    "items":{
        "type":"object"
    },
    "type":"array"
}

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

型: object

400レスポンス

不正なリクエスト

ヘッダー

• Content-Type: string
  Content - type "text/plain"

401レスポンス

未認可

ヘッダー

• Content-Type: string
  Content - type "text/plain"

404レスポンス

見つかりません

ヘッダー

• Content-Type: string
  Content - type "text/plain"

500レスポンス

内部サーバー・エラー

ヘッダー

• Content-Type: string
  Content - type "text/plain"

先頭に戻る