REST API for Oracle Managed File Transfer

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

put

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

リクエスト

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

application/json

パス・パラメータ

scheduleName: タイプ: string

必須: true

パージ・スケジュールの名前

問合せパラメータ

action: タイプ: string

パージ・スケジュールを変更するアクション

本文パラメータ

ルート・スキーマ: mftPurgeScheduleDO

タイプ: object

プロパティ

comment: タイプ: string
endDate: タイプ: string
frequency: タイプ: string
include: タイプ: boolean
instanceStatuses: タイプ: object instanceStatuses
retentionPeriod: タイプ: string
scheduleTime: タイプ: string
startDate: タイプ: string
transfers: タイプ: object transfers

ネスト・スキーマ: instanceStatuses

タイプ: object

プロパティ

instanceStatus: タイプ: array instanceStatus

ネスト・スキーマ: transfers

タイプ: object

プロパティ

transfer: タイプ: array transfer

ネスト・スキーマ: instanceStatus

タイプ: array

項目

タイプ: string

ネスト・スキーマ: transfer

タイプ: array

項目

タイプ: string

application/jsonの例


{
    "retentionPeriod":"7",
    "startDate":"10-05-2016",
    "instanceStatuses":{
        "instanceStatus":[
            "F",
            "C"
        ]
    },
    "include":true,
    "scheduleTime":"04:32:10",
    "comment":"No Comment",
    "transfers":{
        "transfer":[
            "T1",
            "T2"
        ]
    },
    "endDate":"10-07-2016",
    "frequency":"DAILY"
}

レスポンス

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

application/json

200レスポンス

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

ヘッダー

location: タイプ: string

パージ・スケジュールの相対URL。

500レスポンス

なんらかの問題があります。

本文

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

タイプ: object

タイトル: Error information.

プロパティ

errorCode: タイプ: string

Oracle Managed File Transferが返すエラー・コード。
errorKey: タイプ: string

Oracle Managed File Transferが返すエラー・キー。
errorMessage: タイプ: string

Oracle Managed File Transferが返すエラーを説明するメッセージ。

application/jsonの例


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