com.citrix.sharefile.api.entities

Class SFReportsEntity

java.lang.Object

com.citrix.sharefile.api.entities.SFEntitiesBase

com.citrix.sharefile.api.entities.SFReportsEntity

public class SFReportsEntity
extends SFEntitiesBase

Field Summary

Fields inherited from class com.citrix.sharefile.api.entities.SFEntitiesBase

client

Constructor Summary

Constructors

Constructor and Description
SFReportsEntity(ISFApiClient client)

Method Summary

Methods

Modifier and Type	Method and Description
ISFQuery<SFReport>	create(SFReport report, java.lang.Boolean runOnCreate) Create Report { "Id": "rs24f83e-b147-437e-9f28-e7d03634af42" "Title": "Usage Report", "ReportType": "Activity", "ObjectType": "Account", "ObjectId": "a024f83e-b147-437e-9f28-e7d0ef634af42", "DateOption": "Last30Days", "SaveFormat": "Excel" } Creates a new Report.
ISFQuery	delete(java.net.URI url) Delete Report Removes a report from the system
ISFQuery	downloadData(java.lang.String id) Get spreadsheet data Get the spreadsheet data for a report
ISFQuery<SFODataFeed<SFReport>>	get() Get Reports for Current Account Returns all the reports configured for the current account.
ISFQuery<SFReport>	get(java.net.URI url) Get Report by ID Returns a single report specified by id.
ISFQuery	getJsonData(java.lang.String id) Get JSON Data Get the JSON data for a report
ISFQuery<SFODataFeed<SFReport>>	getRecent() Get recent reports Returns the most recent reports run for the current account.
ISFQuery<SFODataFeed<SFReport>>	getRecent(java.lang.Integer maxReports) Get recent reports Returns the last 10 reports run for the current account.
ISFQuery<SFReportRecord>	getRecord(java.lang.String id) Get Report Record by ID Returns a single record.
ISFQuery<SFODataFeed<SFReportRecord>>	getRecords(java.net.URI url) Get all Records by Report ID Returns all records for a single report.
ISFQuery<SFODataFeed<SFReport>>	getRecurring() Get recurring reports Returns all recurring reports for the current account.
ISFQuery<SFReportRecord>	getRun(java.net.URI url) Run Report Run a report and get the run id.
ISFQuery	move(java.net.URI reportUrl, java.lang.String folderId) Save a folder to a folder location
ISFQuery<SFItemProtocolLink>	preview(java.net.URI reportUrl) Get a preview location for the report
ISFQuery<SFReport>	update(SFReport report) Update Report { "Title": "Usage Report", "ReportType": "Activity", "ObjectType": "Account", "ObjectId": "a024f83e-b147-437e-9f28-e7d03634af42", "DateOption": "Last30Days", "Frequency": "Once" } Updates an existing report

Methods inherited from class com.citrix.sharefile.api.entities.SFEntitiesBase

getEntity

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SFReportsEntity

public SFReportsEntity(ISFApiClient client)

Method Detail

get

public ISFQuery<SFODataFeed<SFReport>> get()

Get Reports for Current Account Returns all the reports configured for the current account. By expanding the Records property, a list of all ReportRecords can be accessed as well.

Returns:

Reports for current account

get

public ISFQuery<SFReport> get(java.net.URI url)
                       throws InvalidOrMissingParameterException

Get Report by ID Returns a single report specified by id. The Records property is expandable.

Parameters:

url -

Returns:

Single Report

Throws:

InvalidOrMissingParameterException

getRecent

public ISFQuery<SFODataFeed<SFReport>> getRecent(java.lang.Integer maxReports)
                                          throws InvalidOrMissingParameterException

Get recent reports Returns the last 10 reports run for the current account.

Parameters:

maxReports - (default: 10)

Returns:

List of reports

Throws:

InvalidOrMissingParameterException

getRecent

public ISFQuery<SFODataFeed<SFReport>> getRecent()

Get recent reports Returns the most recent reports run for the current account. 10 reports are returned unless otherwise specified.

Returns:

List of reports

getRecurring

public ISFQuery<SFODataFeed<SFReport>> getRecurring()

Get recurring reports Returns all recurring reports for the current account.

Returns:

List of reports

getRecord

public ISFQuery<SFReportRecord> getRecord(java.lang.String id)
                                   throws InvalidOrMissingParameterException

Get Report Record by ID Returns a single record.

Parameters:

id -

Returns:

Single Record

Throws:

InvalidOrMissingParameterException

getRecords

public ISFQuery<SFODataFeed<SFReportRecord>> getRecords(java.net.URI url)
                                                 throws InvalidOrMissingParameterException

Get all Records by Report ID Returns all records for a single report.

Parameters:

url -

Returns:

Records for a Report

Throws:

InvalidOrMissingParameterException

create

public ISFQuery<SFReport> create(SFReport report,
                        java.lang.Boolean runOnCreate)
                          throws InvalidOrMissingParameterException

Create Report { "Id": "rs24f83e-b147-437e-9f28-e7d03634af42" "Title": "Usage Report", "ReportType": "Activity", "ObjectType": "Account", "ObjectId": "a024f83e-b147-437e-9f28-e7d0ef634af42", "DateOption": "Last30Days", "SaveFormat": "Excel" } Creates a new Report.

Parameters:

report -

runOnCreate -

Returns:

the created report

Throws:

InvalidOrMissingParameterException

update

public ISFQuery<SFReport> update(SFReport report)
                          throws InvalidOrMissingParameterException

Update Report { "Title": "Usage Report", "ReportType": "Activity", "ObjectType": "Account", "ObjectId": "a024f83e-b147-437e-9f28-e7d03634af42", "DateOption": "Last30Days", "Frequency": "Once" } Updates an existing report

Parameters:

report -

Returns:

the updated report

Throws:

InvalidOrMissingParameterException

delete

public ISFQuery delete(java.net.URI url)
                throws InvalidOrMissingParameterException

Delete Report Removes a report from the system

Parameters:

url -

Throws:

InvalidOrMissingParameterException

getRun

public ISFQuery<SFReportRecord> getRun(java.net.URI url)
                                throws InvalidOrMissingParameterException

Run Report Run a report and get the run id.

Returns:

ReportRecord

Throws:

InvalidOrMissingParameterException

preview

public ISFQuery<SFItemProtocolLink> preview(java.net.URI reportUrl)
                                     throws InvalidOrMissingParameterException

Get a preview location for the report

Parameters:

reportUrl -

Throws:

InvalidOrMissingParameterException

getJsonData

public ISFQuery getJsonData(java.lang.String id)
                     throws InvalidOrMissingParameterException

Get JSON Data Get the JSON data for a report

Returns:

JSON Formatted Report Results

Throws:

InvalidOrMissingParameterException

move

public ISFQuery move(java.net.URI reportUrl,
            java.lang.String folderId)
              throws InvalidOrMissingParameterException

Save a folder to a folder location

Parameters:

reportUrl -

folderId -

Throws:

InvalidOrMissingParameterException

downloadData

public ISFQuery downloadData(java.lang.String id)
                      throws InvalidOrMissingParameterException

Get spreadsheet data Get the spreadsheet data for a report

Returns:

Excel Formatted Report Results

Throws:

InvalidOrMissingParameterException