移動先

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

パージ・スケジュールの変更

put

/mftapp/rest/v1/purges/schedules/{scheduleName}

パージ・スケジュールを変更します。このAPIは、デフォルトのスケジュールでのみ機能することに注意してください。

リクエスト

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

• application/json

パス・パラメータ

• scheduleName: string
  パージ・スケジュールの名前

問合せのパラメータ

• action(optional): string
  パージ・スケジュールを変更するアクション

本文 ()

ルート・スキーマ : mftPurgeScheduleDO

型: object

ソースを表示

• comment(optional): string
• endDate(optional): string
  パージ・スケジュールの終了日。
• frequency(optional): string
  パージ・スケジュールの頻度。
• include(optional): boolean
• instanceStatuses(optional): object instanceStatuses
• retentionPeriod(optional): string
  保存期間(日)。
• scheduleTime(optional): string
  パージのスケジュール時間。
• startDate(optional): string
  パージ・スケジュールの開始日。
• transfers(optional): object transfers

{
    "type":"object",
    "properties":{
        "retentionPeriod":{
            "type":"string",
            "description":"Retention period in days."
        },
        "startDate":{
            "type":"string",
            "description":"Start date of the purge schedule."
        },
        "instanceStatuses":{
            "type":"object",
            "description":"",
            "properties":{
                "instanceStatus":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        },
        "include":{
            "type":"boolean",
            "description":""
        },
        "scheduleTime":{
            "type":"string",
            "description":"Scheduled time for the purge."
        },
        "comment":{
            "type":"string",
            "description":""
        },
        "transfers":{
            "type":"object",
            "description":"",
            "properties":{
                "transfer":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        },
        "endDate":{
            "type":"string",
            "description":"End date of the purge schedule."
        },
        "frequency":{
            "type":"string",
            "description":"Frequency of the purge schedule."
        }
    }
}

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

型: object

ソースを表示

• instanceStatus(optional): array instanceStatus

{
    "type":"object",
    "description":"",
    "properties":{
        "instanceStatus":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

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

型: object

ソースを表示

• transfer(optional): array transfer

{
    "type":"object",
    "description":"",
    "properties":{
        "transfer":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

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

型: array

ソースを表示

• Array of: string

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

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

型: array

ソースを表示

• Array of: string

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

トップに戻る

レスポンス

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

• application/json

200レスポンス

パージ・スケジュールの変更は成功しました。

ヘッダー

• location: string
  パージ・スケジュールの相対URLです。

500レスポンス

問題が発生

本文 ()

ルート・スキーマ: Error information.

型: object

タイトル: Error information。

ソースを表示

• errorCode(optional): string
  Oracle Managed File Transferから返されるエラー・コード。
• errorKey(optional): string
  Oracle Managed File Transferから返されるエラー・キー。
• errorMessage(optional): string
  Oracle Managed File Transferから返されるエラーを説明するメッセージ。

{
    "title":"Error information.",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"The error code that Oracle Managed File Transfer returns."
        },
        "errorKey":{
            "type":"string",
            "description":"The error key that Oracle Managed File Transfer returns."
        },
        "errorMessage":{
            "type":"string",
            "description":"A message describing the error that Oracle Managed File Transfer returns."
        }
    }
}

レスポンスの例(application/json)

{
    "errorCode":"MFT-5835",
    "errorKey":"MFT_ESS_PURGE_SCHEDULE_DEACTIVATE_EXCEPTION",
    "errorMessage":"Trying to deactivate a non-active Schedule Purge [Default_Purge_Schedule]."
}

トップに戻る

例

次の例は、cURLを使用してRESTリソースにPUTリクエストを発行して、デフォルトのパージ・スケジュールを変更する方法を示しています。

curl -i -X PUT -u <username>:<password> -H "Content-Type: application/json" -d '{"retentionPeriod":"45","startDate":"10-05-2019", "instanceStatuses":{"instanceStatus":[ "F", "C" ]}, "include":true,"scheduleTime":"04:32:10", "comment":"Test Comment", "transfers":{"transfer":["transfer_test1" ]}, "endDate":"10-07-2019", "frequency":"Daily"}, http://host:port/mftapp/rest/v1/purges/schedules/DefaultSchedule

トップに戻る