機械翻訳について

ジャンプ先

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

スケジューラ・リクエストの更新

patch

ess/rest/scheduler/v1/requests/{requestId}

リクエストを作成または更新します。 更新可能なアイテムには、1つ以上のリクエスト・パラメータ、スケジュール情報またはコールバックURLが含まれます。 リクエスト・パラメータの場合、パラメータが存在しない場合、この操作によってリクエストが作成されます。 パラメータが存在する場合は、リクエストが更新されます。 スケジュールが置換されると、このリクエストの実行が開始されていない、以前にスケジュールされたすべてのインスタンスが取り消されます。 新しいスケジュールは、新しいインスタンスのスケジュールに対して即時に有効になります。

リクエスト

パス・パラメータ

• requestId(required): integer(int64)
  ジョブ・リクエストID

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

• application/json
• application/vnd.oracle.resource+json

リクエスト本文 - application/json ()

ルート・スキーマ : schema

タイプ: object

Show Source

• requestParameters: array requestParameters

{
    "type":"object",
    "properties":{
        "requestParameters":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RequestParameter"
            }
        }
    }
}

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

タイプ: array

Show Source

• Array of: object RequestParameter
  リクエスト・パラメータ。

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RequestParameter"
    }
}

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

タイプ: object

リクエスト・パラメータ。

Show Source

• name(required): string
  パラメータ名。
• paramType(required): string
  許可された値: [ "BOOLEAN", "LONG", "INTEGER", "DATETIME", "STRING" ]
• scope: string
• value: string

{
    "required":[
        "name",
        "paramType"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The parameter name."
        },
        "value":{
            "type":"string"
        },
        "paramType":{
            "type":"string",
            "enum":[
                "BOOLEAN",
                "LONG",
                "INTEGER",
                "DATETIME",
                "STRING"
            ]
        },
        "scope":{
            "type":"string"
        }
    },
    "description":"A request parameter."
}

リクエスト本文 - application/vnd.oracle.resource +json ()

ルート・スキーマ : schema

タイプ: object

Show Source

• requestParameters: array requestParameters

{
    "type":"object",
    "properties":{
        "requestParameters":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RequestParameter"
            }
        }
    }
}

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

タイプ: array

Show Source

• Array of: object RequestParameter
  リクエスト・パラメータ。

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RequestParameter"
    }
}

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

タイプ: object

リクエスト・パラメータ。

Show Source

• name(required): string
  パラメータ名。
• paramType(required): string
  許可された値: [ "BOOLEAN", "LONG", "INTEGER", "DATETIME", "STRING" ]
• scope: string
• value: string

{
    "required":[
        "name",
        "paramType"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The parameter name."
        },
        "value":{
            "type":"string"
        },
        "paramType":{
            "type":"string",
            "enum":[
                "BOOLEAN",
                "LONG",
                "INTEGER",
                "DATETIME",
                "STRING"
            ]
        },
        "scope":{
            "type":"string"
        }
    },
    "description":"A request parameter."
}

トップに戻る

レスポンス

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

• application/json
• application/vnd.oracle.resource+json

200 レスポンス

OK

本文 ()

ルート・スキーマ : リンク

タイプ: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

ネストされたスキーマ : リンク

タイプ: object

Show Source

• href(required): string
• rel(required): string
  許可された値: [ "self", "cancel", "forceCancel", "hold", "release", "subscribe", "permissions", "executionStatus" ]

{
    "required":[
        "href",
        "rel"
    ],
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "enum":[
                "self",
                "cancel",
                "forceCancel",
                "hold",
                "release",
                "subscribe",
                "permissions",
                "executionStatus"
            ]
        },
        "href":{
            "type":"string"
        }
    }
}

400 レスポンス

入力が無効です

本文 ()

ルート・スキーマ : SimpleExceptionDetail

タイプ: object

Show Source

• detail: string
  詳細エラー・メッセージ
• errorCode: string
  ESS固有のエラー・コード。 たとえば、ESS-00500です。
• status: integer
  HTTPステータス・コード
• title(required): string
  要約エラー・メッセージ
• type(required): string
  URI チームがアプリケーション固有の問題タイプを提供できる場合に役立ちます。 そうでない場合は、少なくともHTTPエラー・コード・ページにリンクする必要があります。

{
    "required":[
        "title",
        "type"
    ],
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"URI. It will be beneficial if teams can provide application specific problem types. If not, at least we should link to HTTP error code page."
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "status":{
            "type":"integer",
            "description":"HTTP status code"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "errorCode":{
            "type":"string",
            "description":"ESS-specific error code. For example ESS-00500."
        }
    }
}

403 レスポンス

この操作には使用できません

本文 ()

ルート・スキーマ : SimpleExceptionDetail

タイプ: object

Show Source

• detail: string
  詳細エラー・メッセージ
• errorCode: string
  ESS固有のエラー・コード。 たとえば、ESS-00500です。
• status: integer
  HTTPステータス・コード
• title(required): string
  要約エラー・メッセージ
• type(required): string
  URI チームがアプリケーション固有の問題タイプを提供できる場合に役立ちます。 そうでない場合は、少なくともHTTPエラー・コード・ページにリンクする必要があります。

{
    "required":[
        "title",
        "type"
    ],
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"URI. It will be beneficial if teams can provide application specific problem types. If not, at least we should link to HTTP error code page."
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "status":{
            "type":"integer",
            "description":"HTTP status code"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "errorCode":{
            "type":"string",
            "description":"ESS-specific error code. For example ESS-00500."
        }
    }
}

404 レスポンス

リクエストIDが見つかりません

本文 ()

ルート・スキーマ : SimpleExceptionDetail

タイプ: object

Show Source

• detail: string
  詳細エラー・メッセージ
• errorCode: string
  ESS固有のエラー・コード。 たとえば、ESS-00500です。
• status: integer
  HTTPステータス・コード
• title(required): string
  要約エラー・メッセージ
• type(required): string
  URI チームがアプリケーション固有の問題タイプを提供できる場合に役立ちます。 そうでない場合は、少なくともHTTPエラー・コード・ページにリンクする必要があります。

{
    "required":[
        "title",
        "type"
    ],
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"URI. It will be beneficial if teams can provide application specific problem types. If not, at least we should link to HTTP error code page."
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "status":{
            "type":"integer",
            "description":"HTTP status code"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "errorCode":{
            "type":"string",
            "description":"ESS-specific error code. For example ESS-00500."
        }
    }
}

500 レスポンス

スケジューリング・サブシステム・エラーが発生しました。

本文 ()

ルート・スキーマ : SimpleExceptionDetail

タイプ: object

Show Source

• detail: string
  詳細エラー・メッセージ
• errorCode: string
  ESS固有のエラー・コード。 たとえば、ESS-00500です。
• status: integer
  HTTPステータス・コード
• title(required): string
  要約エラー・メッセージ
• type(required): string
  URI チームがアプリケーション固有の問題タイプを提供できる場合に役立ちます。 そうでない場合は、少なくともHTTPエラー・コード・ページにリンクする必要があります。

{
    "required":[
        "title",
        "type"
    ],
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"URI. It will be beneficial if teams can provide application specific problem types. If not, at least we should link to HTTP error code page."
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "status":{
            "type":"integer",
            "description":"HTTP status code"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "errorCode":{
            "type":"string",
            "description":"ESS-specific error code. For example ESS-00500."
        }
    }
}

「トップに戻る」