Jump to

• Request
• Response
• Examples

Modify Purge Schedule.

put

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

Modify purge schedule. Note that this API works on the default schedule only.

Request

Supported Media Types

• application/json

Path Parameters

• scheduleName: string
  Name of the Purge Schedule

Query Parameters

• action(optional): string
  Action to modify Purge Schedule

Body ()

Root Schema : mftPurgeScheduleDO

Type: object

Show Source

• comment(optional): string
• endDate(optional): string
  End date of the purge schedule.
• frequency(optional): string
  Frequency of the purge schedule.
• include(optional): boolean
• instanceStatuses(optional): object instanceStatuses
• retentionPeriod(optional): string
  Retention period in days.
• scheduleTime(optional): string
  Scheduled time for the purge.
• startDate(optional): string
  Start date of the purge schedule.
• 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."
        }
    }
}

Nested Schema : instanceStatuses

Type: object

Show Source

• instanceStatus(optional): array instanceStatus

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

Nested Schema : transfers

Type: object

Show Source

• transfer(optional): array transfer

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

Nested Schema : instanceStatus

Type: array

Show Source

• Array of: string

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

Nested Schema : transfer

Type: array

Show Source

• Array of: string

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

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Purge Schedule modification succeeded.

Headers

• location: string
  Relative URL of the Purge Schedule.

500 Response

Something went wrong

Body ()

Root Schema : Error information.

Type: object

Title: Error information.

Show Source

• errorCode(optional): string
  The error code that Oracle Managed File Transfer returns.
• errorKey(optional): string
  The error key that Oracle Managed File Transfer returns.
• errorMessage(optional): string
  A message describing the error that Oracle Managed File Transfer returns.

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

Example Response (application/json)

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

Back to Top

Examples

The following example shows how to modify the default purge schedule by submitting a PUT request on the REST resource using cURL.

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

Back to Top