REST API for Oracle Managed File Transfer

Modify Purge Schedule

put

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

Request

Supported Media Types

application/json

Path Parameters

scheduleName: Type: string

Required: true

name of the Purge Schedule

Query Parameters

action: Type: string

Action to modify Purge Schedule

Body Parameter

Root Schema : mftPurgeScheduleDO

Type: object

Properties

comment: Type: string
endDate: Type: string
frequency: Type: string
include: Type: boolean
instanceStatuses: Type: object instanceStatuses
retentionPeriod: Type: string
scheduleTime: Type: string
startDate: Type: string
transfers: Type: object transfers

Nested Schema : instanceStatuses

Type: object

Properties

instanceStatus: Type: array instanceStatus

Nested Schema : transfers

Type: object

Properties

transfer: Type: array transfer

Nested Schema : instanceStatus

Type: array

Items

Type: string

Nested Schema : transfer

Type: array

Items

Type: string

Example 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"
}

Response

Supported Media Types

application/json

200 Response

Purge Schedule modification succeeded.

Headers

location: Type: string

Relative URL of the Purge Schedule.

500 Response

Something went wrong

Body

Root Schema : Error information.

Type: object

Title: Error information.

Properties

errorCode: Type: string

The error code that Oracle Managed File Transfer returns.
errorKey: Type: string

The error key that Oracle Managed File Transfer returns.
errorMessage: Type: string

A message describing the error that Oracle Managed File Transfer returns.

Example application/json


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