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
English
  • Multidomain MDM 10.5 HotFix 3
  • All Products

Table of Contents

Search

  1. Preface
  2. Introduction to Business Entity Services
  3. EJB Business Entity Service Calls
  4. REST Business Entity Service Calls
  5. REST APIs for Data Director
  6. SOAP Business Entity Service Calls
  7. Cross-reference Records and BVT Calculations Services
  8. Supporting Corporate Linkage Service
  9. External Calls to Cleanse, Analyze, and Transform Data
  10. Appendix A: Using REST APIs to Add Records
  11. Appendix B: Using REST APIs to Upload Files
  12. Appendix C: Using REST APIs to Manage Reports

Business Entity Services Guide

Business Entity Services Guide

Back Next

Parameters

Parameters

Specify the source system you want to return in the response.
The following table describes the parameters in the request body:
Parameter
Type
Description
orsId
Path
Operational Reference Store ID of the database to retrieve the source system.
entityId
Path
ID of the business entity.
entityName
Path
Name of the business entity.
action
Query
The action you want API to perform. The following is the default value:
getSourceSystems
aggregate
Query
Optional. Aggregate data across multiple XREFs. Use the following values:
  • RECORD
  • NODE
  • ENTITY
children
Query
Optional. List of child node names. If specified, the response contains the child node names.
compact
Query
Optional. specify to return a compact result.
contentMetadata
Query
Optional. Metadata of the list of history events. Use the following values:
XREF
PENDING_XREF
DELETED_XREF
HISTORY
MATCH
BVT
TRUST
contributorsOnly
Query
Optional. Counts all the XREFs or those XREFs that contribute to the best version of the truth (BVT).
depth
Query
Optional. Number of child levels to return.
describe
Query
Optional. Adds the source system description.
fields
Query
Optional. Comma-separated list of business entity fields. If specified, the response only contains listed fields.
filter
Query
Optional. Filter expression.
firstRecord
Query
Optional. Specifies the first row in the result.
order
Query
Optional.
Comma-separated list of field names with an optional prefix of
+
 or
-
. The prefix
+
 indicates to sort the results in ascending order, and the prefix
-
 indicates to sort the results in descending order. Default is
+
. When you specify more than one parameter, the result set is ordered by the parameter that is first in the list, followed by the next.
recordStates
Query
Optional. Record states returned in the list of history events. Provide a comma-separated list.
You can use the following values:
  • ACTIVE
  • PENDING
  • DELETED
recordstoReturn
Query
Optional. Specifies the number of rows to return.
recordsTotal
Query
Optional. If set to
true
, returns the number of records in the result. Default is
false
0 COMMENTS
We’d like to hear from you!