FilterField¶
| Field | NULL | Description | Note |
|---|---|---|---|
| filterId string (GUID) |
The id of the filter | ||
| reportFieldAlias string |
The alias of the field | ||
| reportPartTitle string |
The report part title | ||
| querySourceFieldId string (GUID) |
The id of the query source field | ||
| querySourceType string |
Either “Table”, “View”, “Stored Procedure” or “Function” | ||
| querySourceId string (GUID) |
Y | The id of the query source | |
| relationshipId string (GUID) |
Y | The id of the relationship if this field is in a relationship | |
| alias string |
The alias of the field | ||
| position integer |
The position in the list of filters | ||
| visible boolean |
Is the filter field visible | ||
| required boolean |
Is the filter field required | ||
| cascading boolean |
Whether common filter field will be cascaded | ||
| operatorId string (GUID) |
Y | The id of the operator | |
| operatorSetting string |
The operator setting | ||
| value string |
The value for the filter field and the selected operator | ||
| dataFormatId string (GUID) |
Y | The id of the display format for the filter field | |
| sortType string |
Either “Unsorted”, “Ascending” or “Descending” | ||
| fontFamily string |
The font family | ||
| fontSize integer |
The font size | ||
| textColor string |
The text color | ||
| backgroundColor string |
The background color | ||
| fontBold boolean |
Is the text in bold | ||
| fontItalic boolean |
Is the text in italic | ||
| fontUnderline boolean |
Is the text underlined | ||
| querySourceUniqueName string |
A unique name for query source | ||
| querySourceFieldName string |
The name of query source field | ||
| comparisonFieldUniqueName string |
The unique name for comparison field | ||
| isNegative boolean |
Whether this filter field is indeterminate |
Inherited fields:
Entity¶
| Field | NULL | Description | Note |
|---|---|---|---|
| id string (GUID) |
The id of this object Example: 572bd576-8c92-4901-ab2a-b16e38144813 |
Allow null incase insert a new entity | |
| state integer |
The entity state of this object
|
||
| deleted boolean |
Is this object deleted | ||
| inserted boolean |
Is this object inserted | ||
| version string |
Y | The version | |
| created datetime in ISO 8601 format |
Y | The created datetime | |
| createdBy string |
The creator | ||
| modified datetime in ISO 8601 format |
Y | The modification datetime | |
| modifiedBy string |
The user who last modified this object |