Bulk Import Files
A bulk import file is a spreadsheet used to create or update many records at once. The API lets you submit files and track them through validation and processing. See the Bulk Import Files guide for the formats and import types, and the API file upload section for how to send file content.
Methods
Section titled “Methods”Retrieve Single Bulk Import File
Section titled “Retrieve Single Bulk Import File”/backend/api/v1/bulkImportFiles/ID - fetch the bulk import file with the specified ID.
List Bulk Import Files
Section titled “List Bulk Import Files”/backend/api/v1/bulkImportFiles/ - list all bulk import files.
Additional Query Parameters
Section titled “Additional Query Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
idAfter | integer | No | Only include files with a higher ID |
createdSince | datetime | No | Only include files created since the given time |
updatedSince | datetime | No | Only include files updated since the given time |
/backend/api/v1/bulkImportFiles/ - submit a new bulk import file. The newly-added file record will be returned.
Fields
Section titled “Fields”| Field | Name | Type | Description |
|---|---|---|---|
| fileName | Filename | Text | Name of the uploaded bulk import file |
| uploadedDate | Date Uploaded | Date | Date when the bulk import file was uploaded |
| status | File Status | Preset Value | Current processing status of the bulk import file |
| fileType | File Type | Preset Value | Type of data contained in the bulk import file |
| fileMode | File Mode | Preset Value | Processing mode for the bulk import file (insert or update) |
| importRules | Import Rules | Text (Multiline) | Specific rules and configuration for processing this bulk import file |
| notes | Notes | Text (Multiline) | Additional notes about this bulk import file |
| log | Log | Text (Multiline) | Processing log and status information for this bulk import file |
| id | Bulk Import File ID | Text | The unique identifier for this bulk import file |
| storedFileID | Stored File | Preset Value |