Oracle Managed File Transfer REST API -既存のアーティファクトの更新

既存のアーティファクトの更新

put

/mftapp/rest/v1/artifacts

指定したアーティファクトを更新します。

リクエスト

サポートされるメディア・タイプ

multipart/form-data

問合せのパラメータ

previewModeFlag(optional): boolean

値は、プレビュー・モードがtrueであるかfalseであるかを示します

フォーム・パラメータ

artifacts: file

XSDに準拠した必須アーティファクトのファイル。
json: object

トップに戻る

レスポンス

サポートされるメディア・タイプ

application/json

200レスポンス

ルート・スキーマ : MFT Artifacts result

型: object

タイトル: MFT Artifacts result

ソースを表示

failureResults(optional): array failureResults
successResults(optional): 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"
                    }
                }
            }
        }
    }
}

ネストされたスキーマ: failureResults

型: array

ソースを表示

Array of: object アイテム

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

ネストされたスキーマ: successResults

型: array

ソースを表示

Array of: object アイテム

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

ネストされたスキーマ: items

型: object

ソースを表示

artifactCategory(optional): string
artifactName(optional): string

アーティファクトの名前
errorMessage(optional): string

エラー・メッセージ(存在する場合)。

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

ネストされたスキーマ: items

型: object

ソースを表示

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

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

500レスポンス

ルート・スキーマ : schema

型: object

ソースを表示

errorCode(optional): string

Oracle Managed File Transferから返されるエラー・コード。
errorKey(optional): string

Oracle Managed File Transferから返されるエラー・キー。
errorMessage(optional): string

Oracle Managed File Transferから返されるエラーを説明するメッセージ。

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

レスポンスの例(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"
}

トップに戻る

例

レスポンス本文の例

次の例は、cURLを使用してRESTリソースにPUTリクエストを発行して、既存のアーティファクトを更新する方法を示しています。

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

次の例では、正常終了したリクエストのレスポンス本文のコンテンツを示しています(XML形式):

<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>

トップに戻る