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 process automation that begins or ends outside of Regent software.
Clients are responsible for developing any code that interacts with these APIs. Regent is not implementing any type of middleware that will reside in a client’s environment that would upload files to or download files from a Regent repository folder or blob storage container. Also, Regent is not implementing any process that would upload files to or download files from any state government system.
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. |
|
|
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. |
| Returns a list of files available for download and provides the following details:
|
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. |
| Returns the specified file |
List of Import/Export Processes
| Csv | ||
|---|---|---|
| ||
Change Log
| Expand | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
|
Attachments
| Expand | ||||
|---|---|---|---|---|
| ||||
|
...