REST APIリファレンス

前へ次へ

fileRecord

このリソースを使用して、VisioテンプレートのXMLファイルまたはイメージファイルを組織にアップロードします。また、VisioテンプレートのXMLファイルまたはイメージファイルを組織から削除することもできます。

POST要求

VisioテンプレートのXMLファイルまたはイメージファイルをアップロードするには、次のURIを使用します。

/api/v2/fileRecord

最大5MBのファイルをアップロードできます。

要求本文をmultipart/form-dataとしてエンコードします。

要求本文で、次の属性を使用します。

フィールド	タイプ	必須	説明
file		はい	アップロードするファイルのコンテンツ。ファイルのコンテンツはUTF-8エンコードされたバイナリ形式にする必要があります。
type	String	○	アップロードするファイルのタイプ。以下のいずれかの値を使用します。 MAPPING。VisioテンプレートのXMLファイルをアップロードします。XMLファイルのみに使用されます。 IMAGE。Visioテンプレートのイメージファイルを更新します。JPEGファイルまたはPNGファイルのみが対象となります。

POST属性に加え、要求本文で次の情報を渡します。

バウンダリ値。要求本文の異なる部分を定義する際に使用されます。

ファイル名。アップロードするコンテンツのファイル名。

icSessionId。ログインリソースによって返される

Informatica Intelligent Cloud Services

セッションID。この情報は、カスタムヘッダーが許可されていないクライアントの要求本文で渡すことができます。要求本文の一部としてicSessionIdを渡せる場合は、この情報を省略できます。

fileRecord POST要求には、次のテンプレートを使用します。

URL: <serverUrl>/api/v2/fileRecord/ 
HTTP method: POST

Content-Type:multipart/form-data;boundary=<boundary value>
--<boundary value>
Content-Disposition:form-data; name="file";filename="<filename.ext>";Content-Type:text/<xml|json>

<content of the file you want to upload encoded as UTF-8>

--<boundary value>
Content-Disposition: form-data; name="type" 

<MAPPING | IMAGE>
--<boundary value>
Content-Disposition: form-data; name="icSessionId"

<icSessionID returned from login resource>
--<boundary value>--

POST応答

アップロードに成功すると、fileRecordオブジェクトを返します。エラーが発生した場合にエラーオブジェクトを返します。

fileRecordオブジェクトには次の属性が含まれます。

フィールド	タイプ	説明
id	String	アップロードされたファイルのID。このIDを使用して、masterTemplateリソースを使用したVisioテンプレートの作成または更新時にファイルを識別します。
orgId	String	組織ID
name	String	ファイル名。
description	String	ファイルの説明。
createTime	Date/Time	ファイルが組織にアップロードされた時刻。
updateTime	Date/Time	ファイルの最終更新時刻。
createdBy	String	ファイルを最初にアップロードしたユーザー。
updatedBy	String	ファイルを最後に更新したユーザー。
type	String	ファイル種別。
size	Int	ファイルサイズ
attachTime	String	ファイルがVisioテンプレートに関連付けられた時刻。

DELETE要求

VisioテンプレートがVisioテンプレートによって使用されていない場合は、VisioテンプレートのXMLまたはイメージファイルを削除できます。

ファイルを削除するには、次のURIにファイルIDを使用します。

/api/v2/fileRecord/<id>

DELETE応答

要求に成功した場合に200の応答コードを返します。

エラーが発生した場合にエラーオブジェクトを返します。

POSTの例

IV4wOrJmd6YUtmKa8tのicSessionIdを使用してVisioTemplate.xmlファイルをアップロードするには、次の要求を使用できます。XMLデータはUTF-8でエンコードする必要があります。

URL: https://example.informatica.com/saas/api/v2/fileRecord/ 
HTTP method: POST

Content-Type:multipart/form-data;boundary=243553118520053
--243553118520053
Content-Disposition:form-data; name="file";filename="<VisioTemplate.xml>";Content-Type:text/xml

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE Graph SYSTEM "graph.dtd">
<Graph Name="" Description="" UItype="" DlgSize="">
  <Groups />
  <Parameters>
    <Parameter Name="$EXTERNALID__C$" Label="" LabelWidth="" IsMandatory="True" DefaultValue="" Control="" Data="" Description="" />
    <Parameter Name="$TGT$" Label="" LabelWidth="" IsMandatory="True" DefaultValue="" Control="Combo_Ctrl" Data="Targets" Description="" />
    <Parameter Name="$GroupBy$" Label="" LabelWidth="" IsMandatory="True" DefaultValue="" Control="" Data="" Description="" />
    <Parameter Name="$o_PERCENT_FLD__C$" Label="" LabelWidth="" IsMandatory="True" DefaultValue="" Control="" Data="" Description="" />
    <Parameter Name="$SRC$" Label="" LabelWidth="" IsMandatory="True" DefaultValue="" Control="Combo_Ctrl" Data="Sources" Description="" />
  </Parameters>
  <Node NameID="Source Definition" Name="$SRC$" Reusable="" Type="Source Definition" InstanceName="$SRC$" Description="" isParameterized="True">
    <CustomProperty Name="Source Table" Value="$SRC$" isParameterized="True" />
    <CustomProperty Name="Database Name" Value="" isParameterized="False" />
    <CustomProperty Name="Owner Name" Value="" isParameterized="False" />
    <CustomProperty Name="Business Name" Value="" isParameterized="False" />
    <CustomProperty Name="Database Type" Value="" isParameterized="False" />
    <CustomProperty Name="Is ShortCut" Value="False" isParameterized="False" />
  </Node>
.
.
.
  <Link Name="Sheet.7" FromNameID="Aggregator" ToNameID="Target Definition" MasterInputSet="False" isParameterized="False">
    <Rule Text="Datatype:string" isParameterized="False" />
    <Rule Text="EXCLUDE Named:AUTO__C (TO) AUTO__C" isParameterized="False" />
    <Rule Text="Datatype:date/time" isParameterized="False" />
    <Rule Text="Pattern:_o$" isParameterized="False" />
    <Rule Text="Datatype:nstring" isParameterized="False" />
    <Rule Text="Datatype:ntext" isParameterized="False" />
    <Rule Text="Datatype:text" isParameterized="False" />
  </Link>
</Graph>

--243553118520053
Content-Disposition: form-data; name="type" 

MAPPING
--243553118520053
Content-Disposition: form-data; name="icSessionId"

IV4wOrJmd6YUtmKa8t
--243553118520053--

アップロードに成功したら、fileRecord応答オブジェクトを返します。

データ統合 REST API

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal