Versions Compared

Key

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

...

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

...