REST APIリファレンス

前へ次へ

customFunc

このリソースを使用して、PowerCenterマップレットの詳細や、組織内のすべてのPowerCenterマップレットのリストを要求します。また、このリソースを使用して、PowerCenterマップレットをアップロードまたは削除することもできます。

組織内のすべてのマップレットのリストを要求するには、objectsリソースを使用します。詳細については、アセットの検索を参照してください。

GET要求

組織内のすべてのPowerCenterマップレットのリストを要求するには、次のURIを使用します。

/api/v2/customFunc

単一のマップレットの詳細を要求するには、要求でマップレットIDまたはマップレット名を使用できます。次のいずれかのURIを使用します。

/api/v2/customFunc/<id>

/api/v2/customFunc/name/<name>

マップレット名を使用し、そのマップレット名にスペースが含まれる場合は、スペースを

%20

で置き換えます。以下に例を示します。

/api/v2/customFunc/name/my%20mapplet

GET応答

マップレットのリストに関する要求が正常に実行されると、組織内のすべてのPowerCenterマップレットにcustomFuncオブジェクトが返されますが、入出力や接続の詳細は含まれません。

単一のマップレットの詳細に関する要求が正常に実行されると、customFuncオブジェクトが返されます。

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

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

フィールド	タイプ	説明
id	String	マップレットID。
orgId	String	組織ID。
name	String	マップレット名。
description	String	マップレットの説明。
createTime	Date/Time	マップレットが作成された時刻。
updateTime	Date/Time	マップレットが最後に更新された時刻。
createdBy	String	マップレットを作成したユーザー。
updatedBy	String	マップレットを最後に更新したユーザー。
mappletName	String	マップレットで使用されるマップレットトランスフォーメーションの名前。
active	Boolean	マップレットがアクティブかどうかを示します。trueまたはfalseを返します。
mappletXmlFile	String	マップレットのXMLファイル。
入力	String	マップレットの入力フィールド。フィールドオブジェクトの各フィールドに関する次の情報が含まれます。 id name type label parentObject precision pcType scale columnIndex isKey isExternalId isNullable isUnique isCreateable isCalculated isUpdateable isFilterable linkedFields relatedInfos。fieldRelatedInfoオブジェクトには次の情報が含まれています。 id referenceObject relationshipName javaType showLabel naturalOrder customProperties
outputs	String	マップレットの出力フィールド。フィールドオブジェクトの各フィールドに関する次の情報が含まれます。 id name type label parentObject precision pcType scale columnIndex isKey isExternalId isNullable isUnique isCreateable isCalculated isUpdateable isFilterable linkedFields relatedInfos。fieldRelatedInfoオブジェクトには次の情報が含まれています。 id referenceObject relationshipName javaType showLabel naturalOrder customProperties
connections		マップレットの接続情報。各接続のpcsConnectionオブジェクトを含みます。
id	Long	pcsConnectionオブジェクトに含まれています。
name	String	pcsConnectionオブジェクトに含まれています。接続名。
type	String	pcsConnectionオブジェクトに含まれています。接続タイプ。
subtype	String	pcsConnectionオブジェクトに含まれています。接続のサブタイプ。
description	String	pcsConnectionオブジェクトに含まれています。接続の説明。
connectionId	String	pcsConnectionオブジェクトに含まれています。接続ID。

POST要求

新しいPowerCenterマップレットをアップロードするには、次のURIを使用します。

/api/v2/customFunc

マップレットの場所を指定する場合、要求にコンテナIDを含めます。コンテナIDが要求に含まれていない場合、マップレットはDefaultフォルダに作成されます。

データ統合

ユーザーインタフェースでプロジェクトまたはフォルダのコンテナIDを検索できます。

［エクスプローラ］

ページで、フォルダを選択します。URLの最後の文字列がコンテナIDです。

例えば、次のURLのコンテナIDはdH2DuGJYda7ijgW4Sm32sRです。

https://na1.dm-us.informaticacloud.com/diUI/products/integrationDesign/main/Explore/dH2DuGJYda7ijgW4Sm32sR

既存のPowerCenterマップレットを更新するには、次のURIにマップレットIDを含めます。

/api/v2/customFunc/<id>

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

このURIでは、要求本文に次の属性を使用できます。

フィールド	タイプ	必須	説明
file	String	○	Informatica PowerCenterからエクスポートされたマップレットのXMLファイル。ファイルのコンテンツはUTF-8エンコードされたバイナリ形式にする必要があります。
name	String	○	マップレット名。
description	String	-	マップレットの説明。
containerId	String	-	マップレットを含めるためのプロジェクトまたはフォルダのID。要求に含まれていない場合、マップレットはDefaultフォルダに作成されます。

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

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

ファイル名。マップレットのXMLファイル名。

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

Informatica Intelligent Cloud Services

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

customFunc POST要求で次のテンプレートを使用します。

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

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

<content of the mapplet XML file encoded as UTF-8>

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

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

<description of the mapplet>
--<boundary value>
Content-Disposition: form-data; name="icSessionId"

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

POST応答

正常に完了すると、作成または更新されたPowerCenterマップレットにcustomFunc応答オブジェクトを返します。

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

DELETE要求

PowerCenterマップレットを削除するには、次のURIでマップレットIDを使用します。

/api/v2/customFunc/<id>

DELETE応答

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

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

POSTの例

IV4wOrJmd6YUtmKa8tのicSessionIdでID3を使用してPowerCenterマップレットを更新するには、次の要求を使用します。更新されたマップレットには「Lookup Mapplet（ルックアップマップレット）」という名前が付き、lookup_mapplet.xmlファイルを使用します。XMLデータはUTF-8でエンコードする必要があります。

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

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

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE POWERMART SYSTEM "powrmart.dtd">
<POWERMART CREATION_DATE="05/14/2012 12:17:26" REPOSITORY_VERSION="181.90">
<REPOSITORY NAME="pc91hf1" VERSION="181" CODEPAGE="UTF-8" DATABASETYPE="Oracle">
<FOLDER NAME="test" GROUP="" OWNER="Administrator" SHARED="SHARED" DESCRIPTION="" PERMISSIONS="rwx---r--" UUID="96f9d03b-c2c5-4034-8e3a-838026bbf6e8">
  <SOURCE BUSINESSNAME ="" DATABASETYPE ="Oracle" DBDNAME ="ddicst" DESCRIPTION ="" NAME ="CUSTOMERMASTER" OBJECTVERSION ="1" OWNERNAME ="C01" VERSIONNUMBER ="1">
    <SOURCEFIELD BUSINESSNAME ="" DATATYPE ="nvarchar2" DESCRIPTION ="" FIELDNUMBER ="1" FIELDPROPERTY ="0" FIELDTYPE ="ELEMITEM" HIDDEN ="NO" KEYTYPE ="PRIMARY KEY" LENGTH ="0" LEVEL ="0" NAME ="CUSTOMERID" NULLABLE ="NOTNULL" OCCURS ="0" OFFSET ="0" PHYSICALLENGTH ="30" PHYSICALOFFSET ="0" PICTURETEXT ="" PRECISION ="30" SCALE ="0" USAGE_FLAGS =""/>
.
.
.
 <ATTRIBUTE NAME ="Parameter Filename" VALUE =""/>
        <ATTRIBUTE NAME ="Write Backward Compatible Workflow Log File" VALUE ="NO"/>
        <ATTRIBUTE NAME ="Workflow Log File Name" VALUE ="wf_plugin_lookup.log"/>
        <ATTRIBUTE NAME ="Workflow Log File Directory" VALUE ="$PMWorkflowLogDir&#x5c;"/>
        <ATTRIBUTE NAME ="Save Workflow log by" VALUE ="By runs"/>
        <ATTRIBUTE NAME ="Save workflow log for these runs" VALUE ="0"/>
        <ATTRIBUTE NAME ="Service Name" VALUE =""/>
        <ATTRIBUTE NAME ="Service Timeout" VALUE ="0"/>
        <ATTRIBUTE NAME ="Is Service Visible" VALUE ="NO"/>
        <ATTRIBUTE NAME ="Is Service Protected" VALUE ="NO"/>
        <ATTRIBUTE NAME ="Fail task after wait time" VALUE ="0"/>
        <ATTRIBUTE NAME ="Enable HA recovery" VALUE ="NO"/>
        <ATTRIBUTE NAME ="Automatically recover terminated tasks" VALUE ="NO"/>
        <ATTRIBUTE NAME ="Service Level Name" VALUE ="Default"/>
        <ATTRIBUTE NAME ="Allow concurrent run with unique run instance name" VALUE ="NO"/>
        <ATTRIBUTE NAME ="Allow concurrent run with same run instance name" VALUE ="NO"/>
        <ATTRIBUTE NAME ="Maximum number of concurrent runs" VALUE ="0"/>
        <ATTRIBUTE NAME ="Assigned Web Services Hubs" VALUE =""/>
        <ATTRIBUTE NAME ="Maximum number of concurrent runs per Hub" VALUE ="1000"/>
        <ATTRIBUTE NAME ="Expected Service Time" VALUE ="1"/>
    </WORKFLOW>
</FOLDER>
</REPOSITORY>
</POWERMART>

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

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

IV4wOrJmd6YUtmKa8t
--243553118520053--

要求が正常に完了すると、更新されたマップレットにcustomFunc応答オブジェクトを返します。

データ統合 REST API

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal