ReportRunResponse

The response object for a report run.

Note that not all of these keys will be present in all responses, depending on the report type.

The core data of the report is usually under the following key:

results > data > report_desc > items

This will be an array of objects, either subtotal objects or individual data objects (rows), depending on the report type and options. The base row objects usually have keys that correspond to the fields listed in:

results > data > report_desc > fields

data object

The report data. The exact format of this object will vary depending on the report type, but the following keys are typical.

report_desc object

The description of the report.

disableActionsstring[]

The list of actions that are disabled in the report. These are internal UI action codes such as view-printable.

fields object[]

The list of fields that are shown in the report.

Array [

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

]

fields_amount object[]

The list of displayed fields that are Amount fields with special treatment.

Array [

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

]

fields_rank_by object[]

The list of fields that can be used as ranking / axis fields in the Chart associated with the report.

Array [

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

]

id_reportstring

The internal ID of the report.

Example: DB3235A3C0914C21ACEA05B37C060912

id_userstring

The internal ID of the user who owns the report.

Example: 9D9C3CD9096F422D8390352F6814A466

itemsobject[]

This contains the core data of the report. The exact format of the data objects depends on the report type. Typically the first-level objects will be subtotal objects that then contain the actual data under that subtotal.

Typically the keys in these objects correspond to the field names in the fields array.

outputOptions object

The formatting and display options of the report.

alwaysShowSubtotalLabelboolean

Indicates if the subtotal label should always be shown.

Example: false

dateFormatstring

The date format used in the report.

Example: MM/DD/YYYY

detailsExpandedboolean

Indicates if the details are expanded by default.

Example: false

htmlFooterstring

The custom HTML footer of the report.

Example: Detailed Hours by Date Report

htmlHeaderstring

The custom HTML header of the report.

Example: Detailed Hours by Date Report

reportEndDatestring

The end date of the report in YYYYMMDD format.

Example: 20210131

reportStartDatestring

The start date of the report in YYYYMMDD format.

Example: 20210101

showDetailboolean

Indicates if there is an expandable details that can be shown.

Example: false

showGrandTotalboolean

Indicates if the grand total should be shown.

Example: true

showSubReportsboolean

Indicates if sub-reports should be shown. Only applicable to certain report types such as the Accrual report.

Example: true

report_namestring

The name of the report.

Example: Detailed Hours by Date Report

report_typeinteger

The internal Report Type code.

Example: 0

supported_chart_types object[]

Array [

component

The internal name of the chart UI component.

Example: UtilizationChartCard

name

The internal name of the chart type.

Example: horizontal-bar

]

supports_chartsboolean

Indicates if the report supports charts or not.

Example: true

chart_desc object

The settings of the chart shown in the report.

componentstring

The internal name of the chart UI component.

Example: UtilizationChartCard

extrasobject

Additional properties of the chart.

namestring

The name of the chart.

attachments object[]

The list of attachments associated with the report.

Array [

labelstring

The display name of the attachment.

urluri

The URL of the attachment to access the raw data.

descriptionstring

A generated text description of the attachment which includes the uploader's name and time.

is_pdfboolean

Indicates if the attachment is a PDF file.

Example: true

is_imageboolean

Indicates if the attachment is an image file.

Example: false

]

id_sheetstring

The internal ID of the applicable User Time Sheet; only present for the "Timesheet Report" type.

oldestRecDatestring

The oldest record date in the report as a YYYYMMDD date; only included when prompting the user for free-floating report dates.

Example: 20190101

latestRecDatestring

The latest record date in the report as a YYYYMMDD date; only included when prompting the user for free-floating report dates.

Example: 20190131

flagstring

Set to prompt-free-floating if the report requires the user to select a date range.

canModReportboolean

Indicates if the user can modify the report settings.

Example: true

canCommitRecordsboolean

Indicates if the report enables a "Commit Records" button that marks all included records as read-only and committed to an external system.

Example: false

ReportRunResponse

{
  "data": {
    "report_desc": {
      "disableActions": [
        "string"
      ],
      "fields": [
        {
          "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
        }
      ],
      "fields_amount": [
        {
          "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
        }
      ],
      "fields_rank_by": [
        {
          "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
        }
      ],
      "id_report": "DB3235A3C0914C21ACEA05B37C060912",
      "id_user": "9D9C3CD9096F422D8390352F6814A466",
      "items": [
        {}
      ],
      "outputOptions": {
        "alwaysShowSubtotalLabel": false,
        "dateFormat": "MM/DD/YYYY",
        "detailsExpanded": false,
        "htmlFooter": "Detailed Hours by Date Report",
        "htmlHeader": "Detailed Hours by Date Report",
        "reportEndDate": 20210131,
        "reportStartDate": 20210101,
        "showDetail": false,
        "showGrandTotal": true,
        "showSubReports": true
      },
      "report_name": "Detailed Hours by Date Report",
      "report_type": 0,
      "supported_chart_types": [
        {
          "component": "UtilizationChartCard",
          "name": "horizontal-bar"
        }
      ],
      "supports_charts": true
    },
    "chart_desc": {
      "component": "UtilizationChartCard",
      "extras": {},
      "name": "string"
    },
    "attachments": [
      {
        "label": "string",
        "url": "string",
        "description": "string",
        "is_pdf": true,
        "is_image": false
      }
    ]
  },
  "id_sheet": "string",
  "oldestRecDate": "20190101",
  "latestRecDate": "20190131",
  "flag": "string",
  "canModReport": true,
  "canCommitRecords": false
}