Jump to

• Request
• Response
• Examples

Create a MFT Artifact

post

/mftapp/rest/v1/artifacts

Create a new MFT artifact.

Request

Supported Media Types

• multipart/form-data

Query Parameters

• previewModeFlag(optional): boolean
  Value depicts if preview mode is true or false

Form Parameters

• artifacts: file
  File with the required artifacts as per the XSD.
• json: object

Back to Top

Response

Supported Media Types

• application/json

200 Response

Body ()

Root Schema : MFT Artifacts result.

Type: object

Title: MFT Artifacts result.

Show Source

• failureResults(optional): array failureResults
• successResults(optional): array successResults

{
    "type":"object",
    "title":"MFT Artifacts result.",
    "properties":{
        "successResults":{
            "description":"",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "artifactName":{
                        "description":"Name of the artifact.",
                        "type":"string"
                    },
                    "artifactCategory":{
                        "description":"Category of the artifact.",
                        "type":"string"
                    },
                    "errorMessage":{
                        "description":"Error message, if any.",
                        "type":"string"
                    }
                }
            }
        },
        "failureResults":{
            "description":"",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "artifactName":{
                        "description":"Name of the artifact.",
                        "type":"string"
                    },
                    "artifactCategory":{
                        "description":"Category of the artifact.",
                        "type":"string"
                    },
                    "errorMessage":{
                        "description":"A message describing the error that Oracle Managed File Transfer returns.",
                        "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":"Category of the artifact.",
                "type":"string"
            },
            "errorMessage":{
                "description":"A message describing the error that Oracle Managed File Transfer returns.",
                "type":"string"
            }
        }
    }
}

Nested Schema : successResults

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":"Category of the artifact.",
                "type":"string"
            },
            "errorMessage":{
                "description":"Error message, if any.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• artifactCategory(optional): string
  Category of the artifact.
• artifactName(optional): string
  Name of the artifact.
• errorMessage(optional): string
  A message describing the error that Oracle Managed File Transfer returns.

{
    "type":"object",
    "properties":{
        "artifactName":{
            "description":"Name of the artifact.",
            "type":"string"
        },
        "artifactCategory":{
            "description":"Category of the artifact.",
            "type":"string"
        },
        "errorMessage":{
            "description":"A message describing the error that Oracle Managed File Transfer returns.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• artifactCategory(optional): string
  Category of the artifact.
• artifactName(optional): string
  Name of the artifact.
• errorMessage(optional): string
  Error message, if any.

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

500 Response

Body ()

Root Schema : schema

Type: object

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.

{
    "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-7441",
    "errorKey":"MFT_UTILITY_COULD_NOT_SAVE_MDS_ARTIFACT",
    "errorMessage":"Unable to create artifact."
}

Back to Top

Examples

Example of Response Body

The following example shows how to create an artifact by submitting a POST request on the REST resource using cURL.

curl -i -X POST -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="[e-mail]"> 
					</ContactsToNotify> 
					</TransferNotification> 
				</postProcessingActions> 
			</target> 
		</targets> 
		</security> 
		</security> 
	</transfer> 
</mft-artifacts>	  

Back to Top