ジャンプ先

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

トップ・レベルURL

GET

/grid/cmd/v1/cmd

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

リクエスト

問合せパラメータ

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

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

  • [0]: string

  {
      "collectionFormat":"csv",
      "description":"Fetch only specific fields",
      "in":"query",
      "items":{
          "type":"string"
      },
      "name":"fields",
      "type":"array"
  }

先頭に戻る

レスポンス

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

• 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(optional): exec
• homes(optional): object homes
• jobs(optional): jobs
• name(optional): string

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

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

タイプ: object

タイトル: Singular Resource

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

ソースの表示

• links(optional): 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(optional): string
• path(optional): 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(optional): string
  URI [RFC3986]またはURIテンプレート[RFC6570].値がURIテンプレートに設定されている場合、"templated"プロパティをtrueに設定する必要があります。
• mediaType(optional): string
  メディア・タイプ。RFC 2046で定義され、リンク・ターゲットを記述します。
• rel(optional): 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(optional): array items

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

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

タイプ: object

タイトル: Collection Resource

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

ソースの表示

• items(optional): 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
                },
                "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(optional): array flags
• homeName(optional): string
• jobExpiry(optional): integer
• nodeName(optional): 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
  Read Only: true
• output(optional): array output
  Read Only: true
• processId(optional): integer
  Read Only: true
• processStatus(optional): integer
  Read Only: true
• status(optional): string
  Read Only: true

  指定できる値: [ "Scheduled", "Running", "Completed", "Failed", "Unknown" ]
• timeFinish(optional): string
  Read Only: true
• timeStart(optional): string
  Read Only: 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
        },
        "processId":{
            "type":"integer",
            "readOnly":true
        },
        "processStatus":{
            "type":"integer",
            "readOnly":true
        },
        "timeStart":{
            "type":"string",
            "readOnly":true
        },
        "timeFinish":{
            "type":"string",
            "readOnly":true
        }
    },
    "required":[
        "jobId"
    ]
}

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

タイプ: array

ソースの表示

• 配列: 文字列

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

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

タイプ: array

ソースの表示

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

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

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

タイプ: array

Read Only: true

ソースの表示

• 配列: 文字列

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

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

タイプ: array

ソースの表示

• 配列: オブジェクト 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"

先頭に戻る