Novant

Documentation

Sign in

Import

The import endpoints provide a consistent way to add or update large sets of data in bulk. They accept structured CSV payloads and apply changes to existing records or create new ones, depending on the provided identifiers.

Unlike other API endpoints, import endpoints require CSV data in the request body, and all parameters must be provided as URL query parameters. See the links below for details on each specific action.

Endpoint Description
Zones Add or update zone records
Spaces Add or update space records
Assets Add or update asset records
Sources Add or update source records
Source Map Add or update a source map
Trends Append, prepend, or merge trend data

Request Format

All import endpoints take CSV in the request body and require the Content-Type: text/csv header. Any parameters are passed as URL query parameters rather than form fields.

The first CSV row is a header naming the columns. Rows without an id add a new record; rows with one update the record it names. See the linked Import & Export guide for each entity for its column definitions.

Errors

Imports are all-or-nothing. If any row fails validation the whole request is rejected with a 400 and nothing is committed. The error identifies the line that failed.