Can I export and/or import annotation (callout) and measurement data? Can I export and/or import annotation (callout) and measurement data?

Can I export and/or import annotation (callout) and measurement data?

Nira can export and import the 3D annotations on an asset, both callouts and measurements, as a CSV, TSV, or JSON file.

Plan availability: Import and export of annotation and measurement data is available on the Growth and Enterprise plans.

Exporting

  1. Open the asset and switch to Edit mode.
  2. Open the menu at the top right of the viewer and choose Export Annotations...
  3. Choose the file format you want: CSV, TSV, or JSON.
  4. If the asset has a coordinate system, choose whether positions will be written as latitude/longitude or in the asset's own coordinate system.
  5. Tick what you want included: 3D annotations, 3D polyline and measurement annotations, 2D photo annotations, and PDF report screenshot IDs.
  6. Click Export.

The viewer menu with Import Annotations and Export Annotations

The Export Annotations dialog with format, coordinate system, and include options

The file has an External ID column, which is empty unless you have given the annotation an identifier from your own system through an import or the API.

Importing

  1. Open the menu at the top right of the viewer and choose Import Annotations...
  2. Click Browse and pick the CSV, TSV, or JSON file from your computer.
  3. Choose a mode. Add adds every annotation in the file as a new annotation and keeps the ones already on the asset. Replace removes every annotation on the asset, photo annotations included, before the ones in the file are added. Update changes annotations already on the asset, matched by the uuid or External ID in each row, and skips rows that match nothing. When Update is selected, choose under Match rows by which of the two is used.
  4. Click Import.

The Import Annotations dialog with a file chosen and the Add, Replace and Update modes

The Import Annotations dialog with Update selected and the Match rows by choice of uuid or External ID

The file will either be applied in full or not at all. If a row is rejected, an error will name the row and the field, and nothing on the asset will change.

The import error dialog naming the invalid value and row

The result dialog reports how many annotations were removed, added, updated, or skipped. Download import results gives you a JSON, CSV, or TSV file listing the outcome and uuid of each row in your file. Click Reload to see the changes in the viewer.

The import result dialog showing 3 annotations added and the download import results buttons

Importing an exported file

In Add mode, importing an export back onto its own asset gives you a second copy of every annotation, since the uuids in the file are not reused. To fully replace the asset's annotations with the ones in the file, choose Replace. To change the existing annotations from the file, matched by their uuid or External ID, choose Update.

The Import Annotations dialog with Replace selected and its warning in red

The same three modes are available through the HTTP API, documented at https://developers.nira.app/api/.

Add comment

Please sign in to leave a comment.