Reports: QBL v0.15

ColorCoding

False

-

See nested properties

    ColorBy

False

-

-

    ColorFormula

False

-

-

Filters

False

-

See nested properties

    Criteria

False

Default

Any string

    DynamicFields

False

Default

One of: Default, None
Array of items of type: Reference to Field

    AllowQuickSearch

False

False

true or false

RolePermissions

False

-

Keyed reference with properties: References: QB::Application::Role, Scope: Root, Definition: RolePermissions (type: boolean), Required: False

Name

True

-

Any string

Description

False

""

Any string

ShowDescription

False

False

true or false

CalendarEvents

Daily events to appear on the calendar

False

-

See nested properties

    StartDate

False

-

-

    EndDate

False

-

-

    DisplayFields

False

-

-

    AllowRecordCreationFromCalendar

False

-

-

    DisplayCalendarEventsAs

False

-

-

    MaxEventsPerDay

False

-

-

    FirstDayOfTheWeek

False

-

-

    InitialMonthToDisplay

False

CurrentMonth

One of: CurrentMonth, NextMonth, PreviousMonth, SpecificMonth
See nested properties

        SpecificMonthToDisplay

False

-

See nested properties

            Month

False

January

One of: January, February, March, April, May, June, July, August, September, October, November, December

            Year

False

-

Any integer

ColorCoding

False

-

See nested properties

    ColorBy

False

-

-

    ColorFormula

False

-

-

    Appearance

False

-

-

SortAndGroup

False

Default

Array of items of type: See nested properties
One of: Default, ManualOrder

    Field

False

-

-

    SortOrder

False

-

-

    GroupBy

False

-

-

SortGroupsByStartField

False

-

-

Timeline

False

-

See nested properties

    Display

True

-

See nested properties

        Bars

False

[]

Array of items of type: Reference to Field, ReportFormula

        Resolution

Tells Quickbase how to break down your timeline. Always measures time in two increments and Quickbase always expands the duration your timeline shows to include a full instance of the highest level time increment

False

Week-Day

One of: Week-Day, Month-Week, Quarter-Month, FiscalQuarter-Month, Year-Month, Year-Quarter, FiscalYear-Quarter

        FiscalYearFirstMonth

Fiscal year for each app by specifying the first month of the fiscal year

False

UseAppSettings

One of: UseAppSettings, Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec

        ShowWeekends

Effective only when Resolution is set to 'Week-Day'

False

True

true or false

    StartField

True

-

References: QB::Field::Lookup (Scope: QB::Table), QB::Field::Summary (Scope: QB::Table), QB::Field::Date (Scope: QB::Table), QB::Field::Date::Formula (Scope: QB::Table), QB::Field::DateTime (Scope: QB::Table), QB::Field::DateTime::Formula (Scope: QB::Table), QB::Field::WorkDate (Scope: QB::Table), QB::Field::WorkDate::Formula (Scope: QB::Table), QB::Field::DateCreated (Scope: QB::Table), QB::Field::DateModified (Scope: QB::Table)

    EndField

True

-

References: QB::Field::Lookup (Scope: QB::Table), QB::Field::Summary (Scope: QB::Table), QB::Field::Date (Scope: QB::Table), QB::Field::Date::Formula (Scope: QB::Table), QB::Field::DateTime (Scope: QB::Table), QB::Field::DateTime::Formula (Scope: QB::Table), QB::Field::WorkDate (Scope: QB::Table), QB::Field::WorkDate::Formula (Scope: QB::Table), QB::Field::DateCreated (Scope: QB::Table), QB::Field::DateModified (Scope: QB::Table)

    Milestone

When specific task is a milestone, Quickbase displays it with a special diamond-shaped graphic

False

Default

References: QB::Field::Lookup (Scope: QB::Table), QB::Field::Checkbox (Scope: QB::Table), QB::Field::Checkbox::Formula (Scope: QB::Table)
Any string

Columns

List of fields or report formulas to be displayed on the report

False

Default

Array of items of type: Reference to Field, ReportFormula
One of: Default

Label

False

""

Any string

Formula

False

""

Any string

Label

False

""

Any string

Formula

False

""

Any string

Label

False

""

Any string

Formula

False

""

Any string

Label

False

""

Any string

Formula

False

""

Any string

DecimalPlaces

False

0

Any integer

Label

False

""

Any string

Formula

False

""

Any string

Label

False

""

Any string

Formula

False

""

Any string

Label

False

""

Any string

Formula

False

""

Any string

Label

False

""

Any string

Formula

False

""

Any string

DecimalPlaces

False

0

Any integer

Label

False

""

Any string

Formula

False

""

Any string

DecimalPlaces

False

0

Any integer

Label

False

""

Any string

Formula

False

""

Any string

DecimalPlaces

False

0

Any integer

Label

False

""

Any string

Formula

False

""

Any string

DecimalPlaces

False

0

Any integer

Label

False

""

Any string

Formula

False

""

Any string

Label

False

""

Any string

Formula

False

""

Any string

Label

False

""

Any string

Formula

False

""

Any string

Label

False

""

Any string

Formula

False

""

Any string

Label

False

""

Any string

Formula

False

""

Any string

Label

False

""

Any string

Formula

False

""

Any string

Sort

False

Default

Array of items of type: See nested properties
One of: Default, ManualOrder

    Field

False

-

-

    SortOrder

False

-

-

AllowEditingRecords

False

True

true or false

AllowViewingRecords

False

True

true or false

HideTotals

False

False

true or false

Columns

List of fields or report formulas to be displayed on the report

False

Default

Array of items of type: Reference to Field, ReportFormula
One of: Default

RolePermissions

False

-

Keyed reference with properties: References: QB::Application::Role, Scope: Root, Definition: RolePermissions (type: boolean), Required: False

Name

True

-

Any string

Description

False

""

Any string

ShowDescription

False

False

true or false

Filters

False

-

See nested properties

    Criteria

False

Default

Any string

Sort

False

Default

Array of items of type: See nested properties
One of: Default, ManualOrder

    Field

False

-

-

    SortOrder

False

-

-

ColorCoding

False

-

See nested properties

    ColorBy

False

-

-

    ColorFormula

False

-

-

Filters

False

-

See nested properties

    Criteria

False

Default

Any string

    DynamicFields

False

Default

One of: Default, None
Array of items of type: Reference to Field

    AllowQuickSearch

False

False

true or false

RolePermissions

False

-

Keyed reference with properties: References: QB::Application::Role, Scope: Root, Definition: RolePermissions (type: boolean), Required: False

Name

True

-

Any string

Description

False

""

Any string

ShowDescription

False

False

true or false

CardGroups

False

-

See nested properties

    GroupBy

True

-

References: QB::Field::TextMultipleChoice (Scope: parent), QB::Field::User (Scope: parent), QB::Field::AddressCountry (Scope: parent), QB::Field::AddressState (Scope: parent)

    Values

False

All

One of: All
Array of items of type: Any string

DisplayFields

False

Default

One of: Default
Array of items of type: Reference to Field, ReportFormula

ColorCoding

False

-

See nested properties

    ColorBy

False

-

-

    ColorFormula

False

-

-

Sort

False

Default

Array of items of type: See nested properties
One of: Default, ManualOrder

    Field

False

-

-

    SortOrder

False

-

-

Columns

List of fields or report formulas to be displayed on the report

False

Default

Array of items of type: Reference to Field, ReportFormula
One of: Default

Filters

False

-

See nested properties

    Criteria

False

Default

Any string

    DynamicFields

False

Default

One of: Default, None
Array of items of type: Reference to Field

    AllowQuickSearch

False

False

true or false

RolePermissions

False

-

Keyed reference with properties: References: QB::Application::Role, Scope: Root, Definition: RolePermissions (type: boolean), Required: False

Name

True

-

Any string

Description

False

""

Any string

ShowDescription

False

False

true or false

AddressField

False

Default

One of: Default
References: QB::Field::Address (Scope: parent), QB::Field::Lookup (Scope: parent)

MapType

False

Road

One of: Road, Satellite, Hybrid, Terrain

Icons

False

NoIcons

One of: NoIcons
Any string

Source

True

-

One of: CountOfRecords
References: Field (Scope: QB::Table), ReportFormula (Scope: parent), SummaryFormula (Scope: parent)

SummarizeBy

False

None

One of: CountOfRecords, Total, Average, Minimum, Maximum, StdDeviation, DistinctCount, Median, None

DisplayAs

False

NormalValue

One of: NormalValue, PercentOfColumnTotal, PercentOfCrosstabTotal, RunningTotalForColumn, RunningTotalForCrosstab

HideTotals

False

False

true or false

DrilldownReport

False

Default

One of: Default, None
References: Report (Scope: parent), Chart (Scope: parent)

Filters

False

-

See nested properties

    Criteria

False

Default

Any string

    DynamicFields

False

Default

One of: Default, None
Array of items of type: Reference to Field

    AllowQuickSearch

False

False

true or false

RolePermissions

False

-

Keyed reference with properties: References: QB::Application::Role, Scope: Root, Definition: RolePermissions (type: boolean), Required: False

Name

True

-

Any string

Description

False

""

Any string

ShowDescription

False

False

true or false

GroupingAndCrosstabs

False

-

See nested properties

    Rows

False

-

Array of items of type: See nested properties

        Source

False

-

-

        GroupBy

False

-

-

    Crosstabs

False

None

One of: None
See nested properties

        Source

False

-

-

        GroupBy

False

-

-

Sort

False

Default

Array of items of type: See nested properties
One of: Default

    Source

False

-

-

    SortOrder

False

-

-

Label

False

""

Any string

Formula

False

""

Any string

Label

False

""

Any string

Formula

False

""

Any string

Label

False

""

Any string

Formula

False

""

Any string

Label

False

""

Any string

Formula

False

""

Any string

DecimalPlaces

False

0

Any integer

Label

False

""

Any string

Formula

False

""

Any string

Label

False

""

Any string

Formula

False

""

Any string

Label

False

""

Any string

Formula

False

""

Any string

Label

False

""

Any string

Formula

False

""

Any string

DecimalPlaces

False

0

Any integer

Label

False

""

Any string

Formula

False

""

Any string

DecimalPlaces

False

0

Any integer

Label

False

""

Any string

Formula

False

""

Any string

DecimalPlaces

False

0

Any integer

Label

False

""

Any string

Formula

False

""

Any string

DecimalPlaces

False

0

Any integer

Label

False

""

Any string

Formula

False

""

Any string

Label

False

""

Any string

Formula

False

""

Any string

Label

False

""

Any string

Formula

False

""

Any string

Label

False

""

Any string

Formula

False

""

Any string

Label

False

""

Any string

Formula

False

""

Any string

Label

False

""

Any string

Formula

False

""

Any string

Source

A Summary Variable is a calculated column available in reports and charts that runs an aggregation function over a target Field (in the same Table) or Report Formula (in the same Report). It can be used by any Summary Formula in the Report or Chart it belongs to.

True

-

One of: CountOfRecords
References: Field (Scope: QB::Table), ReportFormula (Scope: parent)

SummarizeBy

The actual set of possible summary functions depends on the field type being referenced in Field.

False

None

One of: CountOfRecords, Total, Average, Minimum, Maximum, StdDeviation, DistinctCount, Median, None

ColumnsUI

Defines how the column will be displayed in the UI, what will be the column alignment and the header

False

Default

Array of items of type: See nested properties
One of: Default

    Field

The field or report formula, for which the column UI is defined

True

-

References: Field (Scope: parent), ReportFormula (Scope: child)

    Label

The header or label of the column

False

""

Any string

    Alignment

The alignment of the data in the column. Can be Left, Center, Right or Auto

False

Auto

One of: Auto, Left, Right, Center

    Pinned

False

Default

One of: Default, Left, Right

SortAndGroup

False

Default

Array of items of type: See nested properties
One of: Default, ManualOrder

    Field

False

-

-

    SortOrder

False

-

-

    GroupBy

False

-

-

ColorCoding

False

-

See nested properties

    ColorBy

False

-

-

    ColorFormula

False

-

-

    Appearance

False

-

-

AllowEditingRecords

False

True

true or false

AllowViewingRecords

False

True

true or false

HideTotals

False

False

true or false

Columns

List of fields or report formulas to be displayed on the report

False

Default

Array of items of type: Reference to Field, ReportFormula
One of: Default

Filters

False

-

See nested properties

    Criteria

False

Default

Any string

    DynamicFields

False

Default

One of: Default, None
Array of items of type: Reference to Field

    AllowQuickSearch

False

False

true or false

RolePermissions

False

-

Keyed reference with properties: References: QB::Application::Role, Scope: Root, Definition: RolePermissions (type: boolean), Required: False

Name

True

-

Any string

Description

False

""

Any string

ShowDescription

False

False

true or false

DisplayOnlyNewOrChangedRecords

False

False

true or false

ShowSummaryTable

False

-

-

HideMainTable

False

-

-

DefaultRowHeight

False

Default

One of: Default, Short, Medium, Tall, ExtraTall, Max

ColumnHeaderText

False

Default

One of: Default, Truncate, Wrap

InlineEditing

False

Default

One of: Default, No, Yes

GroupDisplay

False

Default

One of: Default, Expanded, Collapsed

DisableDeleteCheckbox

False

False

true or false

Format

False

Normal

One of: Normal, PlainText, CSV, TSV, XMLFlat, XMLStructured, JSON

XmlStylesheet

It's only exported when the Format is set to XMLStructured or XMLFlat

False

""

Any string

RowNumberVisibility

False

Default

One of: Default, Visible, Hidden

SortAndGroup

False

Default

Array of items of type: See nested properties
One of: Default, ManualOrder

    Field

False

-

-

    SortOrder

False

-

-

    GroupBy

False

-

-

SortGroupsByStartField

False

-

-

Filters

False

-

See nested properties

    Criteria

False

Default

Any string

    DynamicFields

False

Default

One of: Default, None
Array of items of type: Reference to Field

    AllowQuickSearch

False

False

true or false

ColorCoding

False

-

See nested properties

    ColorBy

False

-

-

    ColorFormula

False

-

-

    Appearance

False

-

-

ColumnsUI

Defines how the column will be displayed in the UI, what will be the column alignment and the header

False

Default

Array of items of type: See nested properties
One of: Default

    Field

The field or report formula, for which the column UI is defined

True

-

References: Field (Scope: parent), ReportFormula (Scope: child)

    Label

The header or label of the column

False

""

Any string

    Alignment

The alignment of the data in the column. Can be Left, Center, Right or Auto

False

Auto

One of: Auto, Left, Right, Center

Columns

List of fields or report formulas to be displayed on the report

False

Default

Array of items of type: Reference to Field, ReportFormula
One of: Default

Timeline

False

-

See nested properties

    Display

True

-

See nested properties

        Bars

False

[]

Array of items of type: Reference to Field, ReportFormula

        Resolution

Tells Quickbase how to break down your timeline. Always measures time in two increments and Quickbase always expands the duration your timeline shows to include a full instance of the highest level time increment

False

Week-Day

One of: Week-Day, Month-Week, Quarter-Month, FiscalQuarter-Month, Year-Month, Year-Quarter, FiscalYear-Quarter

        FiscalYearFirstMonth

Fiscal year for each app by specifying the first month of the fiscal year

False

UseAppSettings

One of: UseAppSettings, Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec

        ShowWeekends

Effective only when Resolution is set to 'Week-Day'

False

True

true or false

    StartField

True

-

References: QB::Field::Lookup (Scope: QB::Table), QB::Field::Summary (Scope: QB::Table), QB::Field::Date (Scope: QB::Table), QB::Field::Date::Formula (Scope: QB::Table), QB::Field::DateTime (Scope: QB::Table), QB::Field::DateTime::Formula (Scope: QB::Table), QB::Field::WorkDate (Scope: QB::Table), QB::Field::WorkDate::Formula (Scope: QB::Table), QB::Field::DateCreated (Scope: QB::Table), QB::Field::DateModified (Scope: QB::Table)

    EndField

True

-

References: QB::Field::Lookup (Scope: QB::Table), QB::Field::Summary (Scope: QB::Table), QB::Field::Date (Scope: QB::Table), QB::Field::Date::Formula (Scope: QB::Table), QB::Field::DateTime (Scope: QB::Table), QB::Field::DateTime::Formula (Scope: QB::Table), QB::Field::WorkDate (Scope: QB::Table), QB::Field::WorkDate::Formula (Scope: QB::Table), QB::Field::DateCreated (Scope: QB::Table), QB::Field::DateModified (Scope: QB::Table)

    Milestone

When specific task is a milestone, Quickbase displays it with a special diamond-shaped graphic

False

Default

References: QB::Field::Lookup (Scope: QB::Table), QB::Field::Checkbox (Scope: QB::Table), QB::Field::Checkbox::Formula (Scope: QB::Table)
Any string

    StartDate

Start of the period of time you want to examine

False

""

Any string

    EndDate

End of the period of time you want to examine

False

""

Any string

RolePermissions

False

-

Keyed reference with properties: References: QB::Application::Role, Scope: Root, Definition: RolePermissions (type: boolean), Required: False

Name

True

-

Any string

Description

False

""

Any string

ShowDescription

False

False

true or false

Name

True

-

Any string

Reports

True

-

Array of items of type: Reference to Report, Chart