API Data Provider - Online Help

Routes

Get the list of routes.

Columns

Name Type ReadOnly References Description
Id [KEY] Xs:string True

Unique identifier for the route.

Priority Xs:integer False

Priority level for the route. Smaller numbers indicate higher priority. Higher priority routes are handled first. Defaults to 0.

Description Xs:string False

Human-readable description of the route for identification purposes.

Expression Xs:string False

Filter expression that determines when the route is triggered.

Actions Xs:string False

Array of actions to execute when the expression evaluates to true.

CreatedAt Xs:dateTime True

Date and time when the route was created.

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 26.0.9770.0