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

DescribeSiperianObject

DescribeSiperianObject

The
DescribeSiperianObject
API returns the metadata for the Informatica MDM Hub objects specified in the request.

Required Parameter

The following table describes the parameter required for the
DescribeSiperianObject
request.
Parameter
Description
objectUid
Each object defined in Informatica MDM Hub has a unique identifier of the form
<
objectType
>.<
objectName
>
, for example,
PACKAGE.CUSTOMER_READ
. ObjectUid specifies which object's metadata is returned in the
DescribeSiperianObjects
response.
Use the objectUid MATCH_KEY.
<base_object_name>
to request the match key of a base object.
For a list of valid object types, see SiperianObjectUID.

Response Parameters

The following table describes the information contained in the
DescribeSiperianObject
response.
Field
Type
Description
objects
List
A list of returned metadata for the objects specified in the request.
If you request a match key for a base object,
DescribeSiperianObject
returns the match column that represents the base object, in addition to the following fields:
Field
Type
Description
fuzzyColumn
Boolean
The value is
true
if the match column is a fuzzy column.
columns
List
The list of UIDs for the columns that make up this match column. UIDs are formed as COLUMN.<
base_object_name
>|<
column_name
>.

Use Case

The following scenario is a common use for the
DescribeSiperianObject
request:
  • Obtaining metadata about an object before manipulating it. You can use the
    DescribeSiperianObject
    request to gather information about an object before you perform any operations on it.

Usage Example

The following example shows how metadata is retrieved for the base objects C_PARTY and C_ADDRESS:
DescribeSiperianObjectRequest request = new DescribeSiperianObjectRequest(); request.setOrsId("orcl-VER_IDD"); ArrayList objectUids = new ArrayList(); objectUids.add(SiperianObjectType.BASE_OBJECT.makeUid("C_PARTY")); objectUids.add(SiperianObjectType.BASE_OBJECT.makeUid("C_ADDRESS")); request.setUids(objectUids); DescribeSiperianObjectResponse response = (DescribeSiperianObjectResponse)sipClient.process(request);

0 COMMENTS

We’d like to hear from you!