Table of Contents

Search

  1. Preface
  2. Introduction to Services Integration Framework
  3. Setting Up the SIF SDK
  4. Request and Response Objects
  5. Transactions and Exception Handling
  6. ORS-Specific SIF API
  7. Asynchronous SIF Requests
  8. ORS-Specific JMS Event Messages
  9. Using Security Access Manager
  10. Using Dynamic Data Masking
  11. SIF API Reference
  12. Troubleshooting
  13. Appendix A: Identifiers
  14. Appendix B: Frequently Asked Questions

Services Integration Framework Guide

Services Integration Framework Guide

Functional SIF API Listing

Functional SIF API Listing

The following table describes SIF API requests organized by function:
SIF Functional Group/Class
Description
Batch Group APIs
Batch Group API requests enable developers to run batch groups directly without using the MDM Hub Console or stored procedures.
Runs a set of batch jobs, some sequentially, and some in parallel according to the configuration.
Get status of most recent execution; polls for status after executing asynchronously.
Finds the status of the last run of a batch group, and if the status is failed, sets it to incomplete.
Data Steward APIs
Data Steward API requests facilitates developers to write applications with a custom user interface. You can use any SIF API request that your application requires.
Retrieves the lookup display name, lookup code description, for the specific lookup values, lookup codes, for the specified lookup columns.
Retrieves the list of valid lookup values (lookup codes) and lookup display names (lookup code descriptions) for the specified lookup columns.
Retrieves the match candidates for the specified record.
Retrieves a tree that represents the history of merges for a specified base object record.
Retrieves the system-specific trust settings for the specified columns.
Retrieves the data to plot the trust decay curve for the specified trust setting.
Retrieves the current trust score for the specified column in a base object record.
Retrieves multiple XREF records for the specified effective date.
Provides a preview for a base object record if a specified set of records are merged or pending updates are applied.
Searches for lookup values that match a lookup display name, lookup code description.
Sets the record state of base object records identified by the specified keys.
Data APIs
Data API requests enable developers to run the MDM Hub Cleanse, Link, MultiMerge, and Unlink base object requests.
Uses cleanse functions to transform an input record provided in the request to the output format specified by the cleanse function selected.
Links two or more base object records using the specified groupRecordKey as the group ID.
Merges multiple base object records that are identified as representing the same object and you can specify the field level overrides for the merged record.
Unlinks two or more base object records with the group ID specified in the groupRecordKey field.
Data Update / Insert APIs
Data update or insert API requests enable developers to run data updates and inserts on base object records.
Adds a relationship between two entities.
Inserts or updates a single record identified by a key into a base object.
Deletes a relationship between two entities by changing the Hub state to deleted. DeleteRelationship does not remove the record from the relationship table. If the relationship is a foreign key relationship, the request sets the foreign key value to null.
Merges two base object records that are identified as representing the same object.
Put
Inserts or updates a single record identified by a key into a base object.
Generates match tokens for a base object record that is updated or inserted.
Unmerges base object (BO) records.
Hierarchy Manager request for changing some characteristics of an existing relationship.
Data Retrieval APIs
Data Retrieval API requests enable developers to retrieve data, including BVT, a single record or sets of records, as well as to perform searches based on match columns.
Retrieves the best version of truth (BVT) from the specified package using a known key.
Get
Retrieves a single record from the specified package using a known key.
Hierarchy Manager request for fetching a graph of entities and relationships related to a specified set of entities.
Hierarchy Manager request for fetching information about the entities directly related to a specified group of entities in a specified HM configuration.
Retrieves additional data when the number of records found by the SIF API search queries, SearchMatch and SearchQuery, exceeds the number of records to return specified in the search API request.
Provides search capabilities for Hierarchy Manager.
Searches for records in a package based on match columns and rule definitions.
Retrieves a set of records from an MDM package satisfying the specified criteria.
Merge Workflow APIs
Merge Workflow API requests enable developers to run post-match batch processes, such as search for unmatched or unmerged records.
Once the match batch process is run and records are placed into match groups, there are often records that did not match any other records in the Hub. Sets the unmatched records to unique (that is, sets CONSOLIDATION_IND=1)
After the match batch process has been run and records are placed into match groups, the records that were processed and not automatically merged are placed into the UNMERGED state. This is to assign the unmerged records to specified user.
Determines whether the specified cross reference (XREF) record can be unmerged from the consolidated base object.
Clears the list of unmerged records that are currently assigned to this user.
Get a set of records requiring manual merge decisions that are assigned to the user.
Get the number of unmerged records.
Reassigns the specified records assigned for manual merge evaluation to another user.
Metadata APIs
Metadata API requests enable developers to return metadata for specified objects.
Request to describe Informatica objects by fetching their metadata.
Retrieves a list of operational record stores (ORS) registered in the master database.
Returns metadata of Informatica MDM Hub objects.
Returns metadata of Informatica MDM Hub objects.
Metadata Management APIs
Metadata Management API requests enable developers to manage ORS change lists.
Applies a change list to the current repository.
Creates a change list in XML format for the current repository.
Validates a change list against the current repository.
Validates the metadata for the current repository.
Repository Manager
APIs
Repository Manager
API requests enable developers to export metadata.
Export metadata to a change list XML file.
State Management APIs
State Management API requests enable developers to delete and restore state-enabled records with the state set to DELETE, additionally promotes pending cross-reference records.
Deletes the specified records from the MDM Hub.
Promotes or flags for promotion the XREF records specified in the request.
Restores the specified XREF records in the MDM Hub.
Task APIs
Task APIs are used for task administration.
Creates a task.
Retrieves lists of tasks and task details.
Retrieves the lineage of the specified task.
Retrieves a list of users whom you can assign a list of specified tasks.
Updates a task.
Checks each merge task specified in the request to verify there is a match table record
User Management APIs
User Management API requests enable developers to manage user security.
Authenticates a user against the specified ORS.
Changes a user password to a new password.
Miscellaneous APIs
These miscellaneous API requests enable developers to run audit requests, register and unregister users, and perform other compatibility requests.
Add a custom entry to the Hub Audit trail.
Request to get a checksum that represents the definition of the specified object in Informatica MDM Hub.
Allows for automated provisioning of users that are authenticated externally using one of the registered JAAS login modules.
Allows for previously provisioned users (see RegisterUsers) to be unregistered.

0 COMMENTS

We’d like to hear from you!