REST API for Oracle Managed File Transfer

Update existing artifacts

put

/mftapp/rest/v1/artifacts

Updates the specified artifact.

Request

Supported Media Types

multipart/form-data

Query Parameters

previewModeFlag: boolean

Value depicts if preview mode is true or false.

Form Parameters

artifacts: file

File with the required artifacts as per the XSD.
json(required): object

Response

Supported Media Types

application/json

200 Response

Root Schema : MFT Artifacts result

Type: object

Title: MFT Artifacts result

Show Source

failureResults: array failureResults
successResults: array successResults

{
    "title":"MFT Artifacts result",
    "type":"object",
    "properties":{
        "successResults":{
            "description":"",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "artifactName":{
                        "description":"",
                        "type":"string"
                    },
                    "id":{
                        "description":"",
                        "type":"string"
                    },
                    "artifactCategory":{
                        "description":"",
                        "type":"string"
                    },
                    "errorMessage":{
                        "description":"",
                        "type":"string"
                    }
                }
            }
        },
        "failureResults":{
            "description":"",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "artifactName":{
                        "description":"Name of the artifact.",
                        "type":"string"
                    },
                    "artifactCategory":{
                        "description":"",
                        "type":"string"
                    },
                    "errorMessage":{
                        "description":"Error message, if any.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : failureResults

Type: array

Show Source

Array of: object items

{
    "description":"",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "artifactName":{
                "description":"Name of the artifact.",
                "type":"string"
            },
            "artifactCategory":{
                "description":"",
                "type":"string"
            },
            "errorMessage":{
                "description":"Error message, if any.",
                "type":"string"
            }
        }
    }
}

Nested Schema : successResults

Type: array

Show Source

Array of: object items

{
    "description":"",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "artifactName":{
                "description":"",
                "type":"string"
            },
            "id":{
                "description":"",
                "type":"string"
            },
            "artifactCategory":{
                "description":"",
                "type":"string"
            },
            "errorMessage":{
                "description":"",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

artifactCategory: string
artifactName: string

Name of the artifact.
errorMessage: string

Error message, if any.

{
    "type":"object",
    "properties":{
        "artifactName":{
            "description":"Name of the artifact.",
            "type":"string"
        },
        "artifactCategory":{
            "description":"",
            "type":"string"
        },
        "errorMessage":{
            "description":"Error message, if any.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

artifactCategory: string
artifactName: string
errorMessage: string
id: string

{
    "type":"object",
    "properties":{
        "artifactName":{
            "description":"",
            "type":"string"
        },
        "id":{
            "description":"",
            "type":"string"
        },
        "artifactCategory":{
            "description":"",
            "type":"string"
        },
        "errorMessage":{
            "description":"",
            "type":"string"
        }
    }
}

500 Response

Root Schema : schema

Type: object

Show Source

errorCode: string

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

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

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

{
    "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-7439",
    "errorKey":"MFT_UTILITY_COULD_NOT_QUERY_MDS_ARTIFACT_ID_BY_NAME",
    "errorMessage":"Unable to find artifact by artifact name src1"
}

Examples

Example of Response Body

The following example shows how to update an existing artifact by submitting a PUT request on the REST resource using cURL.

curl -i -X PUT -H "Content-Type: multipart/form-data" -F "artifacts=@artifact.xml" http://host:port/mftapp/rest/v1/artifacts?previewModeFlag=false

The following example shows the contents of the response body for a successful request in xml format:

<mft-artifacts version="12.2.x.x"> 
	<source> 
		<ftp-embedded name="ES"> 
			<generalProperties contentFolder="/scratch/filein" includeContentInSubfolder="false"/> 
			<advancedProperties includeExcludePatternType="Wildcard"/> 
		</ftp-embedded> 
	</source>
 	<target> 
		<file name="File"> 
			<generalProperties contentFolder="/scratch/fileout" retryInterval="30" retryCount="1" alwaysSaveModifiedFiles="false" propagateSourceSubfolders="false"/> 
			<advancedProperties overwrite="true" concurrentThreshold="20" renameOnCompletion="false"> 
			</advancedProperties> 
		</file> 
	</target> 
	<transfer name="ES to File" priority="medium"> 
		<source name="ES"> 
		</source> 
		<targets> 
			<target name="File"> 
				<postProcessingActions> 
					<TransferNotification order="1" minFileSize="0" fileNamePattern="*" patternType="Wildcard" templateFile="/tmp/notifytestothervariables.eml"> 
					<ContactsToNotify contactType="External" contactDetails="test@oracle.com"> 
					</ContactsToNotify> 
					</TransferNotification> 
				</postProcessingActions> 
			</target> 
		</targets> 
		</security> 
		</security> 
	</transfer> 
</mft-artifacts>