Our Report web services consist of some legacy functions that are not essential to Yellowfin reports, but are still active. Below is brief information on these. If you would like further details on any of these services, then please contact Yellowfin support team.
The EXPIRESESSION request will cause a specified Yellowfin session to expire. The following code will accomplish this:
|
This function retrieves all comments of a particular report, provided it has any.
Request ElementsThe following elements will be passed with this request:
Request ExampleThe following SOAP example shows the parameters that you can pass to this call:
Response ElementsThe response will contain the following main parameter:
Response ExampleThe service will return the below response, according to our SOAP example:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete ExampleBelow is a full example of this function. To use it for yourself, carry out the following the steps:
|
The LEAVECOMMENT request will create a comment/response to a comment in a particular report. The following code will accomplish this:
|
The DELETECOMMENT request will delete the particular comment from a report. The following code with accomplish this:
|
This function is used to set the status of a report comment. The status options include: OPEN, EDITED, RESOLVED and DELETED.
Request ElementsThe following elements will be passed with this request:
These are the mandatory parameters that you need to set in the ReportComment object for this function:
Request ExampleThe following SOAP example shows the parameters that you can pass to this call:
Response ElementsThe response will contain the following main parameter:
Response ExampleThe service will return the below response, according to our SOAP example:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete ExampleBelow is a full example of this function. To use it for yourself, carry out the following the steps:
|
The DISTRIBUTEINBOX request will distribute a report to the inboxes of a list of recipients. The following code will accomplish this:
|
The GETDISPLAYEDREPORTID request will return the report ID of the currently displayed report. The following code will accomplish this:
The returned ReportServiceResponse object consists of:
|
The GETKPI request will return you the KPI object for a particular KPI report. This function request is usually utilised within the mobile application. The following code will accomplish this:
The returned ReportServiceResponse object consists of:
|
The GETDRILLANYWHEREMENU request will return you the Drill Anywhere menu that is available for the selected report column. This function request is usually utilized within the mobile application. The following code will accomplish this:
The returned ReportServiceResponse object consists of:
|
The SUBSCRIBEDETAILS request will return the schedule record for a particular report. The following code will accomplish this:
The returned ReportServiceResponse object consists of:
|
The SUBSCRIBE request will create/modify a subscription to a specified report for a specified user. This function request is usually called after SUBSCRIBEDETAILS to retrieve a current subscription first, otherwise a ScheduleRecord object must be created and populated appropriately (refer to ScheduleRecord) for this function call. The following code will accomplish this:
|
The UNSUBSCRIBE request will unsubscribe a specified user from a specified report. The following code will accomplish this:
|
The LOADDASHBOARDTAB request will load a specified dashboard tab and its metadata. The following code will accomplish this:
The returned ReportServiceResponse object consists of:
|
This function retrieves a specific dashboard's parent tab's definition or metadata.
Request ElementsThe following elements will be passed with this request:
Request ExampleThe following SOAP example shows the parameters that you can pass to this call:
Response ElementsThe response returned will contain these parameters:
Response ExampleThe service will return the below response, according to our SOAP example:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete ExampleBelow is a full example of this function. To use it for yourself, carry out the following the steps:
|
The following code will accomplish this:
|
The GETDASHBOARDREPORTFILTERVALUES request will return filter metadata for a particular report on a dashboard tab. The following code will accomplish this:
The returned ReportServiceResponse object consists of:
|
The RUNDASHBOARDREPORT request will run and export a specified report on a dashboard tab. The response will include Base64 encoded generated html, including charts, GIS maps, and CSS styles. The following code will accomplish this:
The returned ReportServiceResponse object consists of:
|