移動

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

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

patch

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

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

リクエスト

パス・パラメータ

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

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

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

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

ルート・スキーマ: schema

型: object

ソースの表示

• requestParameters: array requestParameters

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

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

型: array

ソースの表示

• 配列: object RequestParameter
  リクエスト・パラメータ

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

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

型: object

リクエスト・パラメータ

ソースの表示

• name(required): string
  パラメータの名前
• paramType(required): string
  指定できる値: [ "BOOLEAN", "LONG", "INTEGER", "DATETIME", "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"
            ]
        }
    },
    "description":"a request parameter"
}

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

ルート・スキーマ: schema

型: object

ソースの表示

• requestParameters: array requestParameters

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

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

型: array

ソースの表示

• 配列: object RequestParameter
  リクエスト・パラメータ

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

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

型: object

リクエスト・パラメータ

ソースの表示

• name(required): string
  パラメータの名前
• paramType(required): string
  指定できる値: [ "BOOLEAN", "LONG", "INTEGER", "DATETIME", "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"
            ]
        }
    },
    "description":"a request parameter"
}

先頭に戻る

レスポンス

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

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

200レスポンス

OK

本文()

ルート・スキーマ: Links

型: array

ソースの表示

• 配列: object Link

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

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

型: object

ソースの表示

• 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

ソースの表示

• 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

ソースの表示

• 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

ソースの表示

• 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

ソースの表示

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

先頭に戻る