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

  1. ioProcessTypeCode (required)

  2. dataPipelineName (optional)

    1. dataPipelineName is required when ioProcessTypeCode = ImportDataPipeline

  3. File Contents (required)

  4. Friendly File Name (required)

  1. Initiates the ioProcess indicated by the ioProcessTypeCode

  2. After the ioProcess has completed, returns a .txt file that details
    the call parameters and summarizes the ioProcess results:

    1. Process Id

    2. Total Records

    3. Processed Records

    4. Unprocessed Records

    5. Process Status

List Files

  1. ioProcessId (optional)

  2. ioProcessTypeCode (required)

  3. dataPipelineName (optional)

    1. dataPipelineName is required if ioProcessTypeCode = ExportDataPipeline

  4. File Created Date From MM/DD/YYYY (optional)

    1. Required if File Created Date To is provided

  5. File Created Date To MM/DD/YYYY (optional)

    1. Required if File Created Date From is provided

Returns a list of files available for download and provides the following details:

  1. Process Id

  2. ioProcessTypeCode

  3. dataPipelineName (if present)

  4. Friendly File Name

Download

  1. ProcessId (required)

  2. ioProcessTypeCode (required)

  3. dataPipelineName (optional)

    1. dataPipelineName is required when ioProcessTypeCode = ExportDataPipeline

  4. Friendly File Name (required)

Returns the specified file

Import/Export Processes

Change Log
Date
Description of Change
Editor
11/21/2024 
Page creation.
Marcus Jennings
Attachments