Versions Compared

Old Version 10

changes.mady.by.user Marcus Jennings

Saved on

compared with

New Version Current

changes.mady.by.user Heather Smith

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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 below were developed by Regent utilizing the REST architecture to help support clients' needs for process automation that begins or ends outside of Regent software.

...

Clients must reach out to their Account Manager for assistance with initial API setup.

APIs for Import/Export Processes

API

Description

Parameters

Response

POST /api/v1/ioProcesses/files

Uploads a file with the given friendly name and creates a new IO process associated with that file.

image-20241121-212626.png

  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

GET /api/v1/ioProcesses/files

Retrieves a list of files from IO process records based on the provided IO process type code and optional creation date range or ioProcessId.

image-20241121-212707.png

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

GET /api/v1/ioProcesses/files/{ioProcessId}

Downloads a file associated with a given IO process identifier, validated by the IO process type code and exact file name.

image-20241121-211719.png

Returns the specified file

List of Import/Export Processes

Csv
script^List of Import Export Processes.csv
Change Log
 Expand
titleView a list of changes to this page
Date
Description of Change
Editor
11/21/2024 
Page creation.
Marcus Jennings
Attachments
 Expand
titleView Related Attachments
 View file
nameList of Import Export Processes.csv
...