Versions Compared

Old Version 6

changes.mady.by.user Marcus Jennings

Saved on

compared with

New Version 7

changes.mady.by.user Marcus Jennings

Saved on

Key

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

...

APIs for Import/Export Processes

API Common NameURI

Description

Parameters

Response

Upload

  • ioProcessTypeCode (required)

  • dataPipelineName (optional)

    1. dataPipelineName is required when ioProcessTypeCode = ImportDataPipeline

  • File Contents (required)

    • Friendly File Name (required)

    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.pngImage Added

    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

  • ioProcessId (optional)

  • ioProcessTypeCode (required)

  • dataPipelineName (optional)

    1. dataPipelineName is required if ioProcessTypeCode = ExportDataPipeline

  • File Created Date From MM/DD/YYYY (optional)

    1. Required if File Created Date To is provided

    • File Created Date To MM/DD/YYYY (optional)

    Required if File Created Date From is provided

    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.pngImage Added

    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

  • ProcessId (required)

  • ioProcessTypeCode (required)

  • dataPipelineName (optional)

    1. dataPipelineName is required when ioProcessTypeCode = ExportDataPipeline

    • Friendly File Name (required)

    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.pngImage Added

    Returns the specified file

    ...