Asset Vision

Aggregates data across a supported pre-approved join in Asset Vision Data Services. Join selection is limited to the connector's supported join definitions. Field naming:

• Left.<Field> refers to a field from the left side of the join.
• Right.<Field> refers to a field from the right side of the join.

Supported operators:

• eq, ne, gt, gte, lt, lte, contains, startswith, endswith, in, isnull, isnotnull.

Notes:

• Null foreign-key relationships can be excluded with op 'isnotnull'.

Special values:

• '@me' (or 'me') may be used on supported user-related fields to refer to the current authenticated user.

Examples:

• groupBy: ["Right.AssetName", "Right.CurrentStatus"]
• aggregates: [{ func: "count", field: "Left.ID", as: "JobCount" }]

Request format:

• Provide arguments inside a top-level object named "req".
• Example: { "req": { "field": "value" } }
• Requests without the "req" wrapper are invalid.

Assigns each source row to its nearest target row and returns target groups aggregated by count. This endpoint supports nearest-neighbour style spatial aggregation, optionally constrained by maximum distance. Notes:

• Requires spatial column mapping for both tables.
• Rows with null spatial values are excluded automatically.
• Invalid geography values are repaired where possible and skipped if they cannot be converted.

Request format:

• Provide arguments inside a top-level object named "req".
• Example: { "req": { "field": "value" } }
• Requests without the "req" wrapper are invalid.

Aggregates data from a single allowed table in Asset Vision Data Services using functions such as count, sum, avg, min, and max. Table selection is limited to the allowlisted tables exposed by the connector. Field naming:

• Plain column names such as Region or InspectionID are supported.
• Table-prefixed field names are not supported by this endpoint.

Supported operators:

• eq, ne, gt, gte, lt, lte, contains, startswith, endswith, in, isnull, isnotnull.

Special values:

• '@me' (or 'me') may be used on supported user-related fields to refer to the current authenticated user.

Examples:

• groupBy: ["Region"]
• aggregates: [{ func: "count", field: "ID", as: "JobCount" }]
• where: { field: "InspectionID", op: "isnotnull" }

Request format:

• Provide arguments inside a top-level object named "req".
• Example: { "req": { "field": "value" } }
• Requests without the "req" wrapper are invalid.

Tests SQL connectivity and reports the active database name. Intended for diagnostics when database connectivity is unavailable or failing. Returns the current database name on success.

Returns background reference information for Asset Vision Data Services, including common tables, domain terminology, and data interpretation notes. Request format:

• Provide arguments inside a top-level object named "req".
• Example: { "req": { "field": "value" } }
• Requests without the "req" wrapper are invalid.

Returns information about the currently authenticated user in Asset Vision. User field mapping convention:

• String-based user fields store DisplayName.
• Ref_*UserID fields store UserId.

Example:

• Job.AssignedUser stores DisplayName.
• Job.Ref_AssignedUserID stores UserId.

UserId values are typically used for foreign-key filters, while DisplayName values appear in legacy string fields.

Request format:

• Provide arguments inside a top-level object named "req".
• Example: { "req": { "field": "value" } }
• Requests without the "req" wrapper are invalid.

Return a single dashboard payload for the in-chat UI. Filters:

• Contract (exact match)
• Period: today | week | month

Notes:

• Excludes Deleted = true by default where present.
• CompletedStatus values 'Completed' and 'No Action Required' are treated as complete.

Request format:

• Provide arguments inside a top-level object named "req".
• Example: { "req": { "field": "value" } }
• Requests without the "req" wrapper are invalid.

Returns column metadata for an allowed table in Asset Vision Data Services, including column name, type, and nullability. This endpoint is useful for discovering valid field names for filters, groupBy, and joins. Table selection is limited to the allowlisted tables exposed by the connector.

Request format:

• Provide arguments inside a top-level object named "req".
• Example: { "req": { "field": "value" } }
• Requests without the "req" wrapper are invalid.

Returns turn-by-turn driving directions between an origin and destination, with optional waypoints. This endpoint provides route summary information, distance, duration, and step-by-step driving directions. Required inputs:

• Origin
• Destination

Optional inputs:

• Waypoints

Returns:

• Route summary
• Distance
• Duration
• Step-by-step directions

Returns the tables in Asset Vision Data Services that are allowed to be queried. Request format:

• Provide arguments inside a top-level object named "req".
• Example: { "req": { "field": "value" } }
• Requests without the "req" wrapper are invalid.

Returns the supported join definitions and their relationships. Each result includes the join name, left table, right table, join condition, and join type.

Returns the most common Module.ModuleName values, also referred to as module types. This endpoint is useful for understanding the module names present in Asset Vision data. Optional filters:

• Contract (exact match)
• Region (exact match)

Returns:

• ModuleName + Count

Request format:

• Provide arguments inside a top-level object named "req".
• Example: { "req": { "field": "value" } }
• Requests without the "req" wrapper are invalid.

Returns the most common sub-register types. In Asset Vision, sub registers are Module records attached under another record via Module.ParentSourceTableName and Module.ParentSourceTableID. This endpoint returns the most common Module.ModuleName values for those sub-register modules. Optional filters:

• ParentTable (Job/Inspection/CapitalWork/CapitalWorkTask/Module)
• IncludeDeleted (default false)

Returns:

• ModuleName + Count

Request format:

• Provide arguments inside a top-level object named "req".
• Example: { "req": { "field": "value" } }
• Requests without the "req" wrapper are invalid.

Optimizes the driving order for a list of stops. Returns ordered stop IDs, per-leg distance and duration, and an overview polyline. This endpoint does not provide step-by-step driving directions. The ordered stops can be used as input to a separate directions endpoint when navigation steps are needed. Input fields:

• origin: optional starting point
• destination: optional ending point
• returnToOrigin: if true, the route ends at the origin
• stops: list of stops to visit, up to 20

Queries data across a supported pre-approved join in Asset Vision Data Services. Join selection is limited to the connector's supported join definitions. Field naming:

• Left.<Field> refers to a field from the left side of the join.
• Right.<Field> refers to a field from the right side of the join.
• Raw SQL and table-name-prefixed field syntax are not supported by this endpoint.

Special values:

• '@me' (or 'me') may be used on supported user-related fields to refer to the current authenticated user.

Examples:

• where: { field: "Left.InspectionID", op: "isnotnull" }
• selectRight: ["Name", "Code"]

Request format:

• Provide arguments inside a top-level object named "req".
• Example: { "req": { "field": "value" } }
• Requests without the "req" wrapper are invalid.

Queries a single allowed table using spatial filtering over SQL Server geography data. Spatial request shape:

• Spatial.Near: returns rows within a radius in metres of a point
• Spatial.WithinBbox: returns rows intersecting a bounding box
• Spatial.Nearest: optional integer used with Spatial.Near to return the nearest N rows ordered by distance

Important:

• Nearest is not a standalone mode. Use Spatial.Near + Spatial.Nearest together.
• DistanceMetres is available when Spatial.Near is supplied.

Examples:

• Near: { "spatial": { "near": { "lat": -38.0, "lon": 145.0, "metres": 500 } } }
• Nearest: { "spatial": { "near": { "lat": -38.0, "lon": 145.0, "metres": 50000 }, "nearest": 25 } }
• Bbox: { "spatial": { "withinBbox": { "minLat": ..., "minLon": ..., "maxLat": ..., "maxLon": ... } } }

Virtual select fields:

• SpatialWkt, Lat, Lon, Srid, DistanceMetres
• Direct selection of the underlying spatial column is not supported.

Request format:

• Provide arguments inside a top-level object named "req".
• Example: { "req": { "field": "value" } }
• Requests without the "req" wrapper are invalid.

Queries a single allowed table in Asset Vision Data Services using structured filters, sorting, and paging. Table selection is limited to the allowlisted tables exposed by the connector. Field naming:

• Plain column names such as AssetName or InspectionID are supported.
• Table-prefixed field names are not supported by this endpoint.

Supported operators:

• eq, ne, gt, gte, lt, lte, contains, startswith, endswith, in, isnull, isnotnull.

Special values:

• '@me' (or 'me') may be used on supported user-related fields to refer to the current authenticated user.

Examples:

• where: { field: "InspectionID", op: "isnotnull" }
• orderBy: { field: "CreatedDate", dir: "desc" }

Request format:

• Provide arguments inside a top-level object named "req".
• Example: { "req": { "field": "value" } }
• Requests without the "req" wrapper are invalid.

Creates a chart specification from aggregated data for bar, line, or pie charts. This endpoint returns a ChartSpec and does not produce a visible image. It is intended for use with aggregated results such as grouped counts or summaries. Field requirements:

• xField must match a group-by field present in the aggregate result.
• yField must match an aggregate alias present in the aggregate result (for example, JobCount).

Chart types:

• bar: compares values across categories
• line: shows values across an ordered sequence such as time
• pie: shows proportional breakdowns

Request format:

• Provide arguments inside a top-level object named "req".
• Example: { "req": { "field": "value" } }
• Requests without the "req" wrapper are invalid.

Renders a PNG chart image from a ChartSpec and returns its URL. This endpoint produces a user-visible chart image from a valid chart specification. ChartSpec values are typically produced by the chart specification endpoint or another compatible source. Input requirements:

• chart must contain a valid ChartSpec with title, type, xField, yField, and points.
• width and height control the output image size.

Request format:

• Provide arguments inside a top-level object named "req".
• Example: { "req": { "field": "value" } }
• Requests without the "req" wrapper are invalid.

Renders aggregated data as formatted text charts such as ASCII bars, sparklines, or emoji bars. This endpoint returns a text-based chart representation suitable for chat display. It is intended for aggregated results such as grouped counts or summaries. Styles:

• ascii: wide bars using █ characters
• sparkline: compact bars using block characters
• emoji: friendly bars using coloured blocks such as 🟦🟥🟩🟨

Request format:

• Provide arguments inside a top-level object named "req".
• Example: { "req": { "field": "value" } }
• Requests without the "req" wrapper are invalid.

Resolves a user phrase such as 'work order', 'CRM', or 'customer request' to the best matching Module.ModuleName values. This endpoint searches existing ModuleName values and returns ranked suggestions. The returned candidates can be used in Module queries or filters on ModuleName. Optional filters:

• Contract (exact match)
• Region (exact match)

Returns:

• candidates [{moduleName, score, count, reason}]

Request format:

• Provide arguments inside a top-level object named "req".
• Example: { "req": { "field": "value" } }
• Requests without the "req" wrapper are invalid.

Resolves a user phrase to the best matching sub-register types. In Asset Vision, sub registers are Module records attached under another record via Module.ParentSourceTableName and Module.ParentSourceTableID. Example phrases may include 'sub register', 'activity notes', 'CRM tab', or 'safety checklist'. Returns ranked Module.ModuleName candidates for matching sub-register modules. Matched results can be used with compatible child-module joins and ModuleName filters.

Request format:

• Provide arguments inside a top-level object named "req".
• Example: { "req": { "field": "value" } }
• Requests without the "req" wrapper are invalid.

Opens the connected Asset Vision dashboard UI.