Jump to

• Request
• Response
• Examples

Create a MFT Artifact

post

/mftapp/rest/v1/artifacts

Request

Supported Media Types

• multipart/form-data

Query Parameters

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

Body ()

A body of type:

• multipart/form-data

Root Schema : schema

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":"",
                        "type":"string"
                    },
                    "artifactCategory":{
                        "description":"",
                        "type":"string"
                    },
                    "errorMessage":{
                        "description":"",
                        "type":"string"
                    }
                }
            }
        },
        "failureResults":{
            "description":"",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "artifactName":{
                        "description":"",
                        "type":"string"
                    },
                    "artifactCategory":{
                        "description":"",
                        "type":"string"
                    },
                    "errorMessage":{
                        "description":"",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : failureResults

Type: array

Show Source

• [0]: object items

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

Nested Schema : successResults

Type: array

Show Source

• [0]: object items

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

Nested Schema : items

Type: object

Show Source

• artifactCategory(optional): string
• artifactName(optional): string
• errorMessage(optional): string

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

Nested Schema : items

Type: object

Show Source

• artifactCategory(optional): string
• artifactName(optional): string
• errorMessage(optional): string

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

500 Response

Body ()

Root Schema : schema

Type: object

Show Source

• errorCode(optional): string
• errorKey(optional): string
• errorMessage(optional): string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorKey":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "errorCode":"MFT-7441",
    "errorKey":"MFT_UTILITY_COULD_NOT_SAVE_MDS_ARTIFACT",
    "errorMessage":"Unable to create artifact."
}

Examples

The following example shows the contents of the response body for a successful request in JSON 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>