Import a CSV file that contains data for multiple smart object records.

 

Prerequisites

• Your unique Tenant ID, obtained from support.
• Your unique apiKey, as generated in Company Info.
• The Smart Object ID, obtained from the Smart Object page.
• A CSV file containing smart object 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/{smartObjectID}

Headers:

tenantId: {tenantId}

apiKey: {apiKey}

Content-Type: application/json

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

 

PayLoad:

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

 "fieldMapList":[{"column":"0","objectField":"field1"},
                 {"column":"1","objectField":"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".
    The value is the name of the field to receive the data in that column.
     
• If the type of the record key for the smart object is Unique Random Key, then
  every row in the CSV file becomes a new record.
   
  
• If the type of the record key is anything else, then:
  • There must be a mapping from the CSV file to the key field
  • If a record with that key already exists, the target record is updated:

    • Fields contained in the payload replace fields in the target record.

    • Fields that are not present in the payload do not affect the target record.

• Field data formats are the same as those used when creating a smart object record.
   
• 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.