You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 6
Next »
Overview
An application programming interface, or API, is a mechanism that allows two applications to extract and share data within and across organizations. The APIs described below were developed by Regent utilizing the REST architecture to help support clients' needs for automation that begins or ends outside of Regent software.
APIs for Import/Export Processes
API Common Name | URI | Parameters | Response |
---|
Upload | | ioProcessTypeCode (required) dataPipelineName (optional) dataPipelineName is required when ioProcessTypeCode = ImportDataPipeline
File Contents (required) Friendly File Name (required)
| Initiates the ioProcess indicated by the ioProcessTypeCode After the ioProcess has completed, returns a .txt file that details the call parameters and summarizes the ioProcess results: Process Id Total Records Processed Records Unprocessed Records Process Status
|
List Files | | ioProcessId (optional) ioProcessTypeCode (required) dataPipelineName (optional) dataPipelineName is required if ioProcessTypeCode = ExportDataPipeline
File Created Date From MM/DD/YYYY (optional) Required if File Created Date To is provided
File Created Date To MM/DD/YYYY (optional) Required if File Created Date From is provided
| Returns a list of files available for download and provides the following details: Process Id ioProcessTypeCode dataPipelineName (if present) Friendly File Name
|
Download | | ProcessId (required) ioProcessTypeCode (required) dataPipelineName (optional) dataPipelineName is required when ioProcessTypeCode = ExportDataPipeline
Friendly File Name (required)
| Returns the specified file |
Import/Export Processes
Change Log
View a list of changes to this page
Date | Description of Change | Editor |
---|
11/21/2024 | Page creation. | Marcus Jennings |
| | |
| | |
| | |
| | |
Attachments