Services Integration Framework Guide

10.5

Back Next

Get

Get uses a record key to retrieve a single row of data from the specified package. The row can include data from base objects and from child records (that is, content metadata such as History, Xref, Xref History, and Raw) associated with the base object. You can use this request against the regular MDM packages (“PACKAGE.” SiperianObjectUid prefix).

You can also get lineage and trust information. The trust scores are returned for the package record and the cross reference records. The lineage information returned as indicator on the trust enabled fields indicating whether the specific field of the cross-reference record has won over other cross-references and is used on the base object.

When performing a

Get

request using a ROWID_OBJECT for a base object record that has been merged into another base object record,

Get

returns the surviving base object record. For example, if two base object records are merged, one with a ROWID_OBJECT value of ROWID_A and the other with a value of ROWID_B, the ROWID_OBJECT of the surviving base object could be ROWID_A. In this scenario, if you perform a

Get

request for ROWID_B, the

Get

response returns ROWID_A.

For MDM packages, you can use this request to retrieve the following types of the content metadata for underlying primary base object of the package and the trust score and the lineage information for the trust enabled columns:

SiperianObjectType	Description
XREF	Cross-reference data. If state management is enabled for the parent of the package, then this option will return only the cross reference records that are in the ACTIVE state.
PENDING_XREF	Cross-reference data that is in the PENDING state. This option is only valid when state management is enabled for the parent of the package. Otherwise, an exception is thrown.
DELETED_XREF	Cross-reference data that is in the DELETED state. This option is only valid when state management is enabled for the parent of the package. Otherwise, an exception is thrown.
XREF_HISTORY	Previous values for each of the underlying cross references of the specified base object. Base object history has to be enabled
HISTORY	Previous values for the specified base object record. Base object history has to be enabled.
RAW	Raw records associated with the specific base object record. Raw retention needs to be enabled on at least one staging table belonging to the specified base object.

If the package is based on a query that joins multiple base objects, content metadata is returned only for the primary base object.

Required Parameters

The following table lists and describes the parameters that are required by the Get API:

Parameter	Description
SiperianObjectUid	Name and type of the package or base object to be queried.
RecordKey	Key to uniquely identify the record to be fetched.
SystemName	Name of the system for which XREF and XREF history must be retrieved.
RecordTypes	Types of records to retrieve.

Optional Parameters

The following table lists and describes the optional parameters that are used by the Get API:

Parameter	Description
EffectiveDate	The date for which you must retrieve values of the base object. EffectiveDate must be used only for timeline-enabled base objects.
HistoryDate	The date for which you retrieve base object data that is effective at the specified point in time. The Get API does not return any record with a HIST_CREATE_DATE value that is equal to, or preceded by, the HistoryDate value. The Get API truncates milliseconds for HistoryDate. If you run the request on Oracle, the value of HistoryDate is adjusted for Daylight Saving Time (DST) when DST is enabled for the operating system. If the HistoryDate value is later than a record's HIST_CREATE_DATE value by less than one hour during DST, the API call does not return the record. Use HistoryDate for timeline-enabled base objects only.
DataFilter	The SQL condition to be applied to the result set.

Use Case

The following is a common scenario for using the Get request:

Get

used to retrieve a row and its associated child records. The most common use of get is to retrieve a single row of data, with any associated child records.

Usage Example

The following example gets a record with ROWID_OBJECT key 782 from the package PARTY_ADDRESS_READ_PKG.

GetRequest request = new GetRequest();
RecordKey recordKey = new RecordKey();
recordKey.setRowid("782");
request.setRecordKey(recordKey); //Required
request.setSiperianObjectUID("PACKAGE.PARTY_ADDRESS_READ_PKG"); //Required
GetResponse response = sipClient.process(request);