ReportFieldSchema

The schema for a report field that describes how to display and interact with the field in the report UI.

canDefaultSubtotalboolean

Indicates if the field can be the default subtotal field for the report.

Example: true

canSubtotalboolean

Indicates if the field can be used to subtotal the chart.

Example: true

canSubtotalMinorboolean

Indicates if the field can be used for the "minor" subtotal within Charts only.

Example: true

canSubtotalReportboolean

Indicates if the field can be used to subtotal the report rows.

Example: true

extraSpecialboolean

Internal use; indicates special display logic in the report UI.

Example: false

hasURLboolean

Indicates if report field contains URLs (links), such as attachments.

Example: false

idstring

The internal ID of the report field; same as the key field.

Example: codes_tasks

indexinteger

The index of the field in the report; the left-most column is index 0 and increases to the right.

Example: 2

integerboolean

Indicates if the field is an integer field.

Example: false

isAttachmentFieldboolean

Indicates if the field is an attachment field.

Example: false

isDateFieldboolean

Indicates if the field is a date field.

Example: false

isPercentFieldboolean

Indicates if the field is a percentage field.

Example: false

isTotalColumnboolean

Indicates if the field is totals column.

Example: false

keystring

The internal ID of the report field; same as the id field.

Example: codes_tasks

labelstring

The display name of the report field.

Example: Task

nonPositiveboolean

Indicates if the field is a expected to hold negative values, which needs special treatment especially in charts.

Example: false

numericboolean

Indicates if the field is a numeric field.

Example: false

searchableboolean

Indicates if the field is searchable.

Example: false

shownboolean

Indicates if the field is currently enabled to be shown in the report.

Example: false

sortableboolean

Indicates if the field is sortable in the report.

Example: false

truncateTextboolean

Indicates if the text in the field should be truncated with a tooltip to see the rest, or always displayed in full.

Example: false

ReportFieldSchema

{
  "canDefaultSubtotal": true,
  "canSubtotal": true,
  "canSubtotalMinor": true,
  "canSubtotalReport": true,
  "extraSpecial": false,
  "hasURL": false,
  "id": "codes_tasks",
  "index": 2,
  "integer": false,
  "isAttachmentField": false,
  "isDateField": false,
  "isPercentField": false,
  "isTotalColumn": false,
  "key": "codes_tasks",
  "label": "Task",
  "nonPositive": false,
  "numeric": false,
  "searchable": false,
  "shown": false,
  "sortable": false,
  "truncateText": false
}