Hi, I'm Ask INFA!
What would you like to know?
ASK INFAPreview
Please to access Ask INFA.
Communities
A collaborative platform to connect and grow with like-minded Informaticans across the globe
Product Communities
Connect and collaborate with Informatica experts and champions
Discussions
Have a question? Start a Discussion and get immediate answers you are looking for
User Groups
Customer-organized groups that meet online and in-person. Join today to network, share ideas, and get tips on how to get the most out of Informatica
Get Started
Community Guidelines
Knowledge Center
Troubleshooting documents, product guides, how to videos, best practices, and more
Knowledge Base
One-stop self-service portal for solutions, FAQs, Whitepapers, How Tos, Videos, and more
Support TV
Video channel for step-by-step instructions to use our products, best practices, troubleshooting tips, and much more
Documentation
Information library of the latest product documents
Velocity (Best Practices)
Best practices and use cases from the Implementation team
Learn
Rich resources to help you leverage full capabilities of our products
Trainings
Role-based training programs for the best ROI
Certifications
Get certified on Informatica products. Free, Foundation, or Professional
Product Learning Paths
Free and unlimited modules based on your expertise level and journey
Resources
Library of content to help you leverage the best of Informatica products
Tech Tuesdays Webinars
Most popular webinars on product architecture, best practices, and more
Product Availability Matrix
Product Availability Matrix statements of Informatica products
SupportFlash
Monthly support newsletter
Support Documents
Informatica Support Guide and Statements, Quick Start Guides, and Cloud Product Description Schedule
Product Lifecycle
End of Life statements of Informatica products
Ideas
Events
Change Request Tracking
Marketplace
日本語
  • B2B Gateway
  • 所有产品

目次

Search

  1. はじめに
  2. Informatica Intelligent Cloud Services REST API
  3. プラットフォームREST APIバージョン2リソース
  4. プラットフォームREST APIバージョン3リソース
  5. データ統合 REST API
  6. ファイル取り込みとレプリケーションREST API
  7. ストリーミング取り込みとレプリケーションREST API
  8. モデルサーバー REST API
  9. RunAJobユーティリティ
  10. ParamSetCliユーティリティ
  11. REST APIコード
  12. REST APIリソースクイックリファレンス

REST APIリファレンス

REST APIリファレンス

前へ 次へ

フィールドの詳細の取得

フィールドの詳細の取得

フィールドリソースを使用して、ソースオブジェクトまたはターゲットオブジェクトのフィールド詳細を取得します。

GET要求

ソースオブジェクトのフィールドの詳細を取得するには、次のいずれかのURIを使用します。
  • ソース接続IDを指定する場合は、
    /api/v2/connection/source/<id>/field/<オブジェクト名>
    を使用します。
  • ソース接続名とソースオブジェクト名を指定する場合は、
    /api/v2/connection/source/name/<name>/field/<オブジェクト名>
    を使用します。
ターゲットオブジェクトのフィールドの詳細を取得するには、次のいずれかのURIを使用します。
  • ターゲット接続IDを指定する場合は、
    /api/v2/connection/target/<id>/field/<オブジェクト名>
    を使用します。
  • ターゲット接続名とターゲットオブジェクト名を指定する場合は、
    /api/v2/connection/target/name/<name>/field/<オブジェクト名>
    を使用します。
オブジェクト名にスラッシュ（/）が含まれている場合は、次のURIを使用します。 
/api/v2/connection/<source or target>/<id>/fields?objectName=<objectName>
URIに接続名を使用し、その接続名にスペースが含まれる場合は、スペースを
%20
で置き換えます。以下に例を示します。 
/api/v2/connection/source/name/my%20connection/field/customer
オブジェクト名は大文字と小文字が区別されます。

GET応答

応答は、ソースオブジェクトまたはターゲットオブジェクトの各フィールドのフィールドオブジェクトと、エラーが発生した場合はエラーオブジェクトを返します。
次の表に、接続タイプに基づいて返される可能性のあるフィールドオブジェクトの属性とその説明を示します。
フィールド
タイプ
説明
id
Long
フィールドID。
name
String
フィールド名。
type
String
フィールドの種類
label
String
フィールドのラベル。
parentObject
String
親オブジェクト（該当する場合）。
precision
Int
フィールドの長さ（バイト）。
pcType
String
PowerCenterのデータ型。
scale
Int
数値の小数点以下の桁数。
columnIndex
Int
カラムのインデックス。
isKey
Boolean
フィールドがキーとして使用されるかどうかを示します。
isExternalId
Boolean
フィールドが外部IDとして使用されるかどうかを示します。
isSfldLookup
Boolean
フィールドがSalesforce IDのルックアップフィールドとして使用されるかどうかを示します。
isNullible
Boolean
フィールドにNULL値を含めることができるかどうかを示します。
isUnique
Boolean
フィールドに一意の値が必要かどうかを示します。
isCreateable
Boolean
フィールドが新しい値を承認するかどうかを示します。
isCalculated
Boolean
フィールドが計算されるかどうかを示します。
isUpdateable
Boolean
フィールドで更新が許可されるかどうかを示します。
isFilterable
Boolean
フィールドをフィルタできるかどうかを示します。
linkedFields
String
マスキング
タスクの場合は、マップレットの入力フィールドにマップされるソースフィールド。
relatedInfos
各関連フィールドのfieldRelatedInfoオブジェクトに含まれる、関連するフィールドの情報。
fieldId
Long
fieldRelatedInfoオブジェクトに含まれています。
フィールドID。
referenceObject
String
fieldRelatedInfoオブジェクトに含まれています。フィールドに含まれるオブジェクト。
relationshipName
String
fieldRelatedInfoオブジェクトに含まれています。オブジェクトとのリレーション。
references
各関連フィールドのfieldRelatedInfoオブジェクトに含まれる参照情報。
fieldId
Long
fieldRelatedInfoオブジェクトに含まれています。
フィールドID。
referenceObject
String
fieldRelatedInfoオブジェクトに含まれています。
フィールドに含まれるオブジェクト。
relationshipName
String
fieldRelatedInfoオブジェクトに含まれています。
オブジェクトとのリレーション。
javaType
String
Javaデータ型。
showLabel
Boolean
フィールドのラベルを表示するかどうかを示します。
naturalOrder
Int
ソース内のフィールドの位置番号。
customProperties
フィールドのカスタムプロパティ。

GETの例

IDが0002D420000000Jというソース接続から使用できるCustomerソースオブジェクトのフィールドの詳細を取得するには、次の要求を使用します。 
GET <serverUrl>/api/v2/connection/source/0002D420000000J/field/Customer
Content-Type: application/xml
Accept: application/xml
icSessionId: <icSessionId>
要求に成功すると、Customerソースオブジェクトの各フィールドに対するフィールドオブジェクトを返します。