FOfountain
dataPipelines

Execute data pipeline import

Triggers a data pipeline import. Accepts a file or raw JSON text, or uses the stored sample file if no input is provided.

post/api/serviceintegrations/processes/dataPipelines/import

Request

  • Base URL
    https://services.fountain.com
  • URL
    https://services.fountain.com/api/serviceintegrations/processes/dataPipelines/import
  • Auth
    HTTP bearer

Request body multipart/form-data

dataPipelineUuidstring uuid required

UUID of the data pipeline to execute.

filestring binary

File (CSV or JSON) to import.

jsonTextstring

Raw JSON text to import.

s3Keystring

S3 key of the file to import (one-time import flow).

fileFormat'CSV' | 'JSON'

Format of the file or s3Key, when it differs from the pipeline's: any pipeline imports a CSV or a JSON file. Defaults to the pipeline's format.

tempS3KeysToCleanupstring

JSON array of S3 keys to delete when import reaches a terminal state. Backend performs cleanup; do not call cleanupTempFiles from the client.

consentConfirmedboolean

Required true for prospects-type pipelines: confirms the uploader holds consent or another lawful basis to contact the individuals in the file. Ignored for other data types.

optionBankDatasetUuidstring uuid

Option Bank pipelines with no target of their own (the standard one): the existing Option Bank to fill. Ignored when the pipeline names its own target.

csvSeparatorstring
optionBankNamestring

Option Bank pipelines with no target of their own: the name of a new Option Bank to create and fill, used when optionBankDatasetUuid is absent.

datasetUuidstring uuid

Dataset pipelines: an existing dataset of the company, Option Banks included, to fill in place of the pipeline's own target.

datasetNamestring

Dataset pipelines: the name of a new dataset to create, with the pipeline's key column, and fill. Used when datasetUuid is absent.

Response

Import initiated successfully

eventUuidstring uuid
status'pending' | 'started' | 'succeeded' | 'completed_with_issues' | 'failed' | 'skipped'
totalRowsnumber
totalRowsUnknownboolean

True when totalRows is a placeholder rather than a read count.

processedRowsnumber
errorsstring[]
durationnumber
errorMessagestring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.