ReportField¶
| Field | NULL | Description | Note |
|---|---|---|---|
| fieldId string (GUID) |
The id of the field | ||
| fieldUniqueName string |
Unique name for the field | ||
| originalName string |
The original name of the field | ||
| fieldName string |
The name of the field | ||
| fieldNameAlias string |
The alias of the field | ||
| dataFieldType string |
The data type | ||
| querySourceId string (GUID) |
Y | The id of the query source | |
| querySourceUniqueName string |
Unique name for the query source | ||
| querySourceType string |
Either “Table”, “View”, “Stored Procedure” or “Function” | ||
| sourceAlias string |
The source alias | ||
| querySourceAlias string |
The alias of the query source | ||
| relationshipId string (GUID) |
The id of the relationship if applicable | ||
| visible boolean |
Is the field visible | ||
| filterable boolean |
Is the field filterable | ||
| reportId string (GUID) |
Y | The id of the report of applicable | |
| fieldFunctionExpression string |
The expression for field function | ||
| expression string |
The calculated expression | ||
| grandTotalExpression string |
The grand total expression | ||
| grandTotalFormat string |
Format for the grand total | ||
| subTotalExpression string |
The sub total expression | ||
| subtotalFormat string |
Format for the sub total | ||
| sort string |
Either “Unsorted”, “Ascending” or “Descending” | ||
| autoSort boolean |
Internal use: whether the field is automatically sorted | ||
| function string |
The function | ||
| formatting object |
A DataFormating object | ||
| functionDataType string |
The result data type of the function | ||
| isCalculated boolean |
Is this a calculated field | ||
| hasAggregatedFunction boolean |
Whether this field uses aggregated function | ||
| invalidField integer |
Invalid field setting | ||
| isCrossFilter boolean |
Whether this instance is cross filter |
ReportField Sample:
{
"fieldId" : "76139896-c2c3-432e-898a-2c2205bb2e35",
"fieldName" : "Country",
"fieldNameAlias" : "Country",
"dataFieldType" : "Text",
"querySourceId" : "1641cb37-b60c-42bc-b986-c51667e8037d",
"querySourceType" : "Table",
"sourceAlias" : "Suppliers",
"relationshipId" : null,
"visible" : true,
"calculatedTree" : null,
"schemaName" : "dbo",
"querySourceName" : "Suppliers",
"databaseName" : "Northwind",
"isCalculated" : false
}