Description
Import entities into the Address Manager database.
Note:
- You must be an Address Manager administrator to use this method.
- Ensure that the formatting of your import files matches the examples exactly, as the importEntities method is case sensitive.
- UDFs are supported but must exist in Address Manager first. Ensure that you have created necessary UDFs in Address Manager before uploading files with UDF values.
Parameters
| Name | Description |
|---|---|
| data |
Location: formData Type: file The CSV or NDJSON file containing entities to be
imported. For information on how to structure the import
file, refer to Importing entities.
Tip: To bring up CSV and NDJSON examples
for a data type, supply a value of ? (or empty) for
data and specify the type with
dataType.
|
| commit |
Location: query Type: boolean Indicates if the Address Manager database will be
updated after processing the input file. Set to false
for validation purposes to view importEntities
processing results without updating the database. The
parameter is optional and if omitted, the default value
is true.
Warning: If maxFailures is greater
than 0, this parameter is ignored (implied value of
true), and processed entities will be persisted into
the database. To view processing results without
updating the database, ensure that commit is set to
false and maxFailures is set to 0.
|
| configuration | Location: query Type: string The name of the configuration that the entities will be imported into. A single importEntities call can only be performed on one configuration. |
| dataType |
Location: query Type: string The type of data that is being imported. Supported data
types are IP4Address, IP4Block, IP4DHCPRange,
IP4Network, and MACAddress.
|
| ignoreFields |
Location: query Type: string The fields that will be skipped during validation of
entities. This parameter is useful when an input entity
contains fields that are not supported for processing.
When importing content that was exported using Export entities, ensure that extra fields such as id, parentid, type,
and state are ignored. This parameter is optional.
Attention: Unique UDF values are supported for
processing but the UDFs must be created before
calling importEntities.
|
| maxFailures |
Location: query Type: integer (int32) The number of failures allowed before importEntities
stops processing. When the value is 0, all entities will
be processed in one transaction and any failure will
stop the process and rollback any updates made to the
database. When the value is greater than 0, each entity
will be processed individually in a separate transaction
until the maximum number of failures is reached
(therefore entities processed before reaching the max
failure limit will remain in database). This parameter
is optional and if omitted, the default value is 0.
Warning: If maxFailures is greater than 0, the
commit parameter is ignored (implied value of true),
and processed entities will be persisted into the
database. To view processing results without
updating the database, ensure that commit is set to
false and maxFailures is set to 0.
|
| maxSize |
Location: query Type: integer (int32) The maximum number of entities allowed in a single
importEntities call. This parameter is optional and if
omitted, the default value is 1000.
|
| userComment |
Location: query Type: string The user control comment that will be added to the
transaction history. This parameter is optional.
|
Responses
| Code | Description |
|---|---|
| 200 |
Type: NDJSON Newline delimited JSON objects that detail the raw
entity input, whether the entities were processed
successfully, object IDs if processed successfully, the
transaction history ID if processed in one transaction
(maxFailures = 0), and the total number of entities
input, accepted, rejected, and skipped.
|