Get Object Collections and Filters

API-Result

Result Resulting object, if any, of the call

Result.IsAggregate boolean
Indicates if the result is aggregated.

Result.Count integer
The number of results.

Result.Columns. array of objects
Contains information about each column.

Result.Columns.Name string
The name of the column.

Result.Columns.IsHidden boolean
Indicates if the column is hidden.

Result.Columns.DDName string

Result.Columns.Title string
An alternative name for the column.

Result.Columns.Description string
A description of of the column.

Result.Columns.Type integer
An enumerator indicating the type of the column.

Result.Columns.Format string

Result.Columns.Width integer
The width of the column.

Result.Columns.TableKey string
They unique identifier for the column.

Result.Columns.ForeignKey string
The foreign key of the column.

Result.Columns.TableName string
The name of the table in which the column exists.

Result.FullCount integer
The number of items returned.

Result.Results array of objects
The number of items returned.

Result.Results.Entities array of objects
Contains filter information for each object.

Result.Results.Entities.Type string
The type of entity.

Result.Results.Entities.Key string
They key for the filter.

Result.Results.Entities.IsForeignKey boolean

Result.Results.Entities.Row object
Provides information about the database row that describes the object filter.

Result.Results.Entities.Row.Description string
A description of the type of object that the row describes.

Result.Results.Entities.Row.ObjectType string
The type of object described by the row.

Result.Results.Entities.Row.CollectionType string
Indicates the type of filter.

Result.Results.Entities.Row.Filters string
Provides the filter text (e.g. an SQL query).

Result.Results.Entities.Row.Name string
The name of the filter.

Result.Results.Entities.Row.Rank string
The rank of the filter.

Result.Results.Entities.Row.Builtin boolean
Indicates if the filter is builtin.

Result.Results.Entities.Row.ID string
The unique ID of the row.

Result.Results.ReturnID string

Message string
Error message text on failure, may be null

ErrorID string
Unique support identifier for this occurrence of an error

success boolean
Indicates API success or failure