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. SOAP Business Entity Service Calls
  6. Cross-reference Records and BVT Calculations Services
  7. Supporting Corporate Linkage Service
  8. External Calls to Cleanse, Analyze, and Transform Data
  9. Appendix A: Using REST APIs to Add Records
  10. Appendix B: Using REST APIs to Upload Files
  11. Appendix C: Using REST APIs to Manage Reports

Query Parameters

Query Parameters

The name of the source system is a required parameter.
The following table lists the parameters that you can use in the request:
Parameter
Description
systemName
Required. Name of the source system which performs the data change.
interactionId
Optional. Interaction ID to assign to all the changes. Usually, the Hub generates the ID when it creates a pending change as the result of a call.
effectivePeriod
Optional. Contains the start date and end date. Specifies the period of time for which the record is effective. Provide these parameters for a timeline-enabled record.
validateOnly
Optional. If set to TRUE, only validation rules are applied to the modified record and the changes are not persisted.
recordState
Optional. Hub state for the created or the updated records. The supported record states are ACTIVE and PENDING.
processId
Optional. ID of the workflow process that contains the task. When a workflow is started as result of the service call, the parameter contains the identifier of the started workflow process.

0 COMMENTS

We’d like to hear from you!