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

URL Parameters

URL Parameters

The name of the source system is a required parameter in the request URL.
The following table lists the parameters that you can use in the URL:
Parameter
Description
systemName
Name of the source system.
interactionId
ID of the interaction. You can group multiple requests into a single interaction. All changes are done with the interaction ID.
ignoreWarnings
Indicates whether the warning-level validation messages are ignored. Default is false. Set to true to ignore the warning messages.
startDate and endDate
Specifies the period of time for which the record is effective. Provide these parameters for a timeline-enabled base object.
validateOnly
Indicates whether the write business entity service validates incoming data. Default is false.
recordState
State of the record. Use the parameter to specify the initial state of the record. Use ACTIVE or PENDING. Default is ACTIVE.
taskComment
Add a comment to the workflow task triggered by the API.
taskAttachments
If task attachments are enabled, attach a file to the workflow task triggered by the API.

0 COMMENTS

We’d like to hear from you!