Nira HTTP API

Unique identifier for the callout.

When importing callouts:

• If the specified uuid matches an existing callout on the asset, the matching callout will be updated with the specified data.
• If the uuid does not match a callout for the asset, a new callout will be created. The specified uuid will be used for the new callout as long as the uuid isn't already being used by a callout on a different asset. If the uuid is already being used by a callout on a different asset, a new uuid will be used for the new callout.

Specifies the type of callout. Measurement callouts are also referred to as Polyline Callouts. These values correspond to the Callout Type labels shown in the Nira app as follows: CameraBookmark = "Basic Text", Annotation = "Rich Text Window", Defect = "Defect Window", Measurement = "Measurement / Defect Window". In the app, these labels are prefixed with "3D Callout - " for point callouts and "Polyline - " for polyline/measurement callouts (e.g. a CameraBookmark appears as "3D Callout - Basic Text").

The version of the callout data format. Always specify 2. Version 2 expresses measurement points in the same coordinate system as the other positional fields (the system named by coordsys). Version 1, or omitting this field, is a legacy format and should not be used.

The coordinate system used for the callout's 3D positional data (posX/Y/Z, camPosX/Y/Z, camTarX/Y/Z, and points), in EPSG format or 'local' for local coordinates. 'local' can only be used with non-georeferenced assets. For latitude/longitude coordinates, EPSG:4326 should be specified.

On export, the value is set from the export request's coordsys query parameter and is local, the asset's EPSG code, or EPSG:4326. On import, if omitted, the coordinates are assumed to be in the asset's internal/local coordinate space and no validation or transformation is performed — this is how legacy exports produced before schemaVersion 2 behave.

Axis order for EPSG:4326: X values (posX, camPosX, camTarX, and the first component of each points entry) are longitude, and Y values are latitude. Z values are elevation in the asset's source-file units and are passed through unconverted.

Title for Annotation and Camera Bookmarks. Also see defectTitle parameter.

Description text for CameraBookmark callouts — the text box that gets shown in the 3D view next to the callout. Whether the box is displayed is controlled by showDescriptionInView. Has no effect on other callout types.

Rich-text body content for Annotation callouts, produced by Nira's Slate-based editor. It is an array of block nodes, each of the form { "type": "p", "children": [ { "text": "..." } ] }. If provided, it must be non-empty. In CSV/TSV it is encoded as a JSON string.

X coordinate for point callouts. When coordsys is EPSG:4326, this is the longitude.

Y coordinate for point callouts. When coordsys is EPSG:4326, this is the latitude.

Z coordinate for point callouts. Elevation is always expressed in the coordinate system of the asset's source geometry files (e.g. meters if the source files use meters); it is not converted between vertical datums.

Camera position X coordinate.

Camera position Y coordinate.

Camera position Z coordinate.

Camera target X coordinate.

Camera target Y coordinate.

Camera target Z coordinate.

Title used when the callout's type is 'Defect'.

Defect description

Numeric value indicating the severity of the defect. One of 1–5, or null when unclassified. The values correspond to the labels shown in the app: null = Unclassified, 1 = Low, 2 = Normal, 3 = Medium, 4 = High, 5 = Critical.

The callout's list of tags, shown as "Observation Tags" in the app. Despite the field name, tags are supported on all callout types, not just Defects. In the app's Layers panel, callouts can be grouped and filtered by these tags, and each tag becomes an autocomplete suggestion for future tagging across the organization.

Indicates whether the polyline forms a closed shape. Measurement / polyline callouts only.

The sum of the lengths of all segments of the polyline. Measurement / polyline callouts only. Calculated at export time. On import the value is stored exactly as provided — it is never recalculated from points — and is used for display in the application, such as measurement labels in the orthophoto viewer and the defect dialog. Hand-authored import data should compute this consistently with points.

The area enclosed by the polyline. Closed measurement / polyline callouts only. Calculated at export time. On import the value is stored exactly as provided — it is never recalculated from points — and is used for display in the application. Hand-authored import data should compute this consistently with points.

An array of ordered 3D points comprising the polyline. Measurement / polyline callouts only. When schemaVersion is 2 or greater, point coordinates follow the declared coordsys. For closed polylines the export omits the duplicate closing point. In CSV/TSV, points are encoded as zero-indexed column triplets point0X, point0Y, point0Z, point1X, ….

The red component of the callout's display color, in the range 0-255 (not 0.0-1.0).

The green component of the callout's display color, in the range 0-255.

The blue component of the callout's display color, in the range 0-255.

For CameraBookmark callouts, controls whether the callout's poiDescription text box is displayed next to its marker — pinned open in the 2D orthophoto view, and shown when the callout is selected or highlighted in the 3D view. When false, only the marker and title are shown. Corresponds to the "Show Description in View" checkbox in the app. Has no effect on other callout types.

A list of photo callouts associated with this callout. Currently, only one photo callout per callout is supported, and they are only applicable to callouts of type Defect. The filename of each photo callout must refer to an image that has already been uploaded to the asset. In CSV/TSV, photo callouts are encoded using the photoCalloutFilename, photoCalloutTop, photoCalloutLeft, photoCalloutWidth, and photoCalloutHeight columns.