Fetch report | Zoho Creator Help

Fetch report

ZCReportAPIUtil

This utility lets you make use of the reports of your Zoho Creator applications in your Android apps.

Note: Zoho Creator's Mobile SDK is currently a Beta feature. We do not recommend using it for apps in the production stage.
getReport(String appOwnerName, String appLinkName, String reportLinkName, ZCComponentType reportType, int noOfRecordsToFetch, String queryString)

Returns the metadata and the records that the specified list, calendar, timeline, kanban, or map report displays.

Parameters:

appOwnerNameThe Zoho username of the specified Creator application's owner.
appLinkNameThe link name of the required Zoho Creator application.
reportLinkNameThe link name of the required report, which is present in the specified Creator application.
reportTypeThe target report's type:
  • ZCComponentType.REPORT for list reports
  • ZCComponentType.CALENDAR for calendar reports
  • ZCComponentType.MAP for map reports
  • ZCComponentType.KANBAN for kanban reports
noOfRecordsToFetchSpecifies the number of records that are to be fetched; ranges from 1 to 200; 50 is the recommended value.
queryStringThe criteria to filter the records, which is to be passed in the format:
field1=value1&field2=value2
getReport(ZCComponent zcComponent, int noOfRecordsToFetch)

Returns the metadata and the records that the specified list, calendar, timeline, kanban, or map report displays.

Parameters:

zcComponentAn object that holds the details of the specified report component.
noOfRecordsToFetchSpecifies the number of records that are to be fetched; can range from 1 to 200; and 50 is the recommended value.
loadMoreRecords(ZCReport zcReport, ZCComponent component, int pageSize)

Loads more records from the specified list, calendar, timeline, kanban, or map report. The number of records that will be loaded is based on the value of the pageSize parameter.

Parameters:

zcReportAn object that holds the details of the required reports.
zcComponentAn object that holds the details of the required report component
pageSizeSpecifies the number of records that you want to load.
getUpdatedRecordsAfterActionPerformed(ZCReport zcReport, ZCComponent zcComponent)

Returns the list of records after executing the specified report actions.

Parameters:

zcReportAn object that holds the details of the required reports.
zcComponentAn object that holds the details of the required report component
updateRecordInReport(ZCReport zcReport)

Updates the records that the specified report displays.

Parameters:

zcReportAn object that holds the details of the required reports.

 getRecordsCount(ZCReport zcReport, boolean isWithCriteria)

Returns the total number of records that the specified report displays.

Parameters:

zcReportAn object that holds the details of the required reports.
isWithCriteriaSpecifies whether the count is to be returned with or without the criteria. Set it as true to return the count after applying the criteria; else set as false.

 getReportForSubformRecord(ZCReport zcReport,SubformRecordParams subformRecordParams)

Returns the metadata and the record of the report for the subform summary.

Parameters:

zcReportAn object that holds the details of the required reports.
subformRecordParamsThe subformRecordParams object.
getPivotReportURL(ZCComponent zcComponent)

Returns the public URL of the specified pivot table or pivot chart.

Parameters:

zcComponentAn object that holds the details of the required report component