Import a CSV file that contains data for multiple stream records.

Each line of the file becomes a new submission that launches the processes associated with the stream.

 

Prerequisites

• Your unique Tenant ID, obtained from support.
• Your unique apiKey, as generated in Company Info.
• The stream ID​, taken from the stream Summary page.
• A CSV file containing stream data
  • One record per row
  • The first row should contain column headings.
     (That row is ignored during import.)
• Use the File Upload API to upload the CSV file to Pulpstream.
  That process gives you a file reference to use in this API
  

Details

​

Method: POST

URL: https://us.pulpstream.com/vfr/api/imports/{streamID}

Headers:

tenantId: {tenantId}

apiKey: {apiKey}

apiUserName: Optional. Specify internal username from the User definition to submit the data on behalf of that user.

Content-Type: application/json

​

PayLoad:

{"file":"67234123123235234_CSVfileReference.csv",    // The reference obtained from the File Upload API

 "fieldMapList":[{"column":"0","objectField":"dataComponent.field1"},
                 {"column":"1","objectField":"dataComponent.field2"},
                 ...
                ]
}

 

Notes:

• The field map list is an array of pairs, where each item in the pair is itself a name/value pair.
  • The first pair is the literal "column", with a column-number value.
  • The second pair is the literal "objectField", with a value specifying the
    data component and field that will receive the data in that column.
• When the import finishes, an email is sent to the user specified in the apiUserName parameter.
  If that parameter is not present, the email goes to the designated administrators in the
  general Company Information settings.
• Field data formats are the same as those used when submitting stream data.
  ​