Services Integration Framework Guide

10.3

Back Next

ORS-Specific SIF API Field Parameters

The following table lists the field parameters that the ORS-specific SIF classes use:

The list of field parameters might vary based on your ORS.

Field Name	Type	Description
username	String	Optional. Name of the user who executes the request.
password	String	Optional. Password for the user name.
encrypted	Boolean	Optional. Indicates whether the password is encrypted. Specify true if the password is encrypted, or specify false if the password is not encrypted.
securityPayload	Byte	A security token or binary data used with a third-party authentication provider.
orsID	String	Optional. Identifier for the ORS.
interactionId	String	Optional. A unique identifier for the request.
isAsynchronous	Boolean	Optional. Indicates whether to place the request on a JMS queue. Specify true to place the request on a JMS queue, or specify false to disable asynchronous processing.
jmsReplyTo	Boolean	Optional. Indicates whether to post the response on the specified JMS queue. Specify true to post the response on the specified JMS queue, or specify false if you perform synchronous processing.
jmsCorrelationId	Boolean	Optional. Indicates whether to set the JMS correlation ID to the specified value. Specify true to set the JMS correlation ID to the specified value, or specify false if you do not want to set the JMS correlation ID.
sortCriteria	String	List of column names, separated by commas, to order the results. The sortCriteria field is equivalent to the ORDER BY clause of an SQL query.
recordsToReturn	Int	Maximum number of relationship records to return.
returnTotal	Boolean	Indicates whether to return the total number of records that satisfy the search criteria. Specify true to return the total number of records that satisfy the search criteria, or specify false if you do not want to return the total number of records that satisfy the search criteria.
removeDuplicates	Boolean	Indicates whether to remove the duplicate records from the results. Specify true to remove the duplicate records, or specify false to retain the records.
matchType	MatchType object	Indicates the type of match rules that you want to apply from the match rule set. You can specify one of the following match types: BOTH . Applies the automatic and the manual merge match rules. AUTO . Applies the automatic merge match rules. NONE . Applies the automatic and the manual merge match rules. If you selected exact-match columns in the Selected Match Columns list, and a selected record contains a value for that exact-match column, the match process identifies duplicate records based on the exact-match column plus the match rules.
matchRuleSetUid	String	Optional. ID of the match rule set that you want to use. Use null if you want to use the default match rule set.
disablePaging	Boolean	Indicates whether to disable paging. Specify true to disable paging to increase performance, and specify false to return a search token that is valid for 15 minutes.
systemName	String	Optional. Name of the source system.
sourceKey	String	Optional. The value of the PKEY_SRC_OBJECT column of the XREF record.
columnUid	String	UID of the Global Business Identifier (GBID) column.
package	Boolean	Optional.
xref	Boolean	Optional.
pendingXref	Boolean	Optional. Indicates whether to return the pending XREF records. Specify true to return the pending XREF records, or specify false if you do not want to return the pending XREF records.
deletedXref	Boolean	Optional. Indicates whether to return the deleted XREF records. Specify true to return the deleted XREF records, or specify false if you do not want to return the deleted XREF records.
history	Boolean	Optional.
xrefHistory	Boolean	Optional. Indicates whether to return XREF history records. Specify true to return the XREF history records, or specify false if you do not want to return the XREF history records.
raw	Boolean	Optional.
returnTrustScores	Boolean	Optional. Indicates whether to return trust scores for the trust-enabled columns in the package and XREF records. Specify true to return the trust scores, or specify false if you do not want to return the trust scores.
returnLineage	Boolean	Optional. Indicates whether to return the lineage of the records. Specify true to return the lineage of the records, or specify false if you do not want to return the lineage of the records.
generateSourceKey	Boolean	Indicates whether to generate a source key if you do not specify the key in the record key. Specify true to generate a source key, or specify false if you specify the key in the record key.
lastUpdateDate	Date time	Optional. The date when you last updated the relationship record.

Rename Saved Search

Table of Contents

Services Integration Framework Guide

Services Integration Framework Guide

ORS-Specific SIF API Field Parameters

ORS-Specific SIF API Field Parameters