Objects belonging to a user in a Primary or Client Organization can be retrieved by using the web service calls defined in this section. These are used to retrieve report or dashboard metadata (such as their name, description, ID, etc.). Then links can be provided to access a selected report/dashboard via Yellowfin application (SSO and Session Options).
Note that if you require the actual data of a report (such as its HTML, or PDF), then you should use Yellowfin's Report web services.
The following web service calls are related to obtaining or managing user reports.
Retrieves report metadata for a specified report ID, and a user who requires it. The user can be identified using the AdministrationPerson object. Keep in mind that each time when you edit a report, Yellowfin changes the report ID whereas the report UUID is always the same for the report. You can use the GETIDFORUUID call to find out what ID corresponds to the report UUID at that moment.
Request ParametersThe following parameters should be passed with this request:
These are the main parameters that you must set in the AdministrationPerson object for this web service call:
Request ExampleBelow is a SOAP XML example for this request:
Response ParametersThe returned response 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 web service call. To use it for yourself, carry out the following the steps:
|
This function retrieves the metadata of all the reports of a specified user. The user can be identified using the AdministrationPerson object. If a client organization is specifed, then all the reports from there will be retrieved, otherwise all the reports from the default organization will be obtained.
Request ParametersThe following parameters should be passed with this request:
These are the main parameters that you must set in the AdministrationPerson object for this web service call:
Request ExampleBelow is a SOAP XML example for this request:
Response ParametersThe returned response 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 web service call. To use it for yourself, carry out the following the steps:
|
This function returns all reports with comments, that are accessible to a specified user. Use the AdministrationPerson object to specify the user. If a client organization is specifed, then all the commented reports from there will be retrieved, otherwise reports from the default organization will be obtained.
Request ParametersThe following parameters should be passed with this request:
These are the main parameters that you must set in the AdministrationPerson object for this web service call:
Request ExampleBelow is a SOAP XML example for this request:
Response ParametersThe returned response 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 web service call. To use it for yourself, carry out the following the steps:
|
This function returns draft report (thta is, reports that were modified and not saved or activated) that are accessible to a specified user. Use the AdministrationPerson object to specify the user.
Request ParametersThe following parameters should be passed with this request:
These are the main parameters that you must set in the AdministrationPerson object for this web service call:
Request ExampleBelow is a SOAP XML example for this request:
Response ParametersThe returned response 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 web service call. To use it for yourself, carry out the following the steps:
|
This function deletes a specified user report. The report can be identified with either the report ID or the report UUID. Use the AdministrationPerson object to specify the user.
Request ParametersThe following parameters should be passed with this request:
These are the main parameters that you must set in the AdministrationPerson object for this web service call:
Request ExampleBelow is a SOAP XML example for this request:
Response ParametersThe returned response 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 web service call. To use it for yourself, carry out the following the steps:
|
The following web service calls are related to obtaining or managing user dashboards.
This web service call will return the metadata of all the published dashboards for a specified user. It also treats each sub tab within a dashboard as separate tabs so that if there is a dashboard with 2 sub tabs, GETUSERTABS call retrieves 2 AdministrationReportGroup objects for the dashboard. To get the parent dashboard metadata, do GETUSERPARENTTABS call. You can provide a dashboard tab/subtab Id to retrieve a specific dashboard tab/subtab data via request.setDashboardTabId(<Integer>). Requires user Id. User Id should be passed via AdministrationPerson object. The dashboard reports metadata will not be retrieved. If you need reports metadata, do GETUSERTABSWITHREPORTS call.
Request ParametersThe following parameters should be passed with this request:
These are the main parameters that you must set in the AdministrationPerson object for this web service call:
Request ExampleBelow is a SOAP XML example for this request:
Response ParametersThe returned response 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 web service call. To use it for yourself, carry out the following the steps:
|