This web service is used to retrieve users' avatar images. If an avatar image is not set up for a user in Yellowfin, then no image will be retrieved for that user. This service requires the users' internal IDs (that is, their IP ID).
Request ParametersThe following parameters should be passed with this request:
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 web service is used to upload an avatar image for a specified user. The image should be an array of bytes in UTF-8 which you could convert to a String value.
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 the following 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 web service call. To use it for yourself, carry out the following the steps:
|
Favourting Items
This web service call returns all reports marked as favourite by a specific 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 the following 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 web service call. To use it for yourself, carry out the following the steps:
|
This returns a specified user's inbox reports. These are reports which have been distributed to 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 the following 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 web service call. To use it for yourself, carry out the following the steps:
|
This web service checks whether or not a particular report is marked as a specific user's favourite. Both the user and the report would need to be specified here, the latter by providing the Report ID. This ID can be retrieved from Yellowfin database's Report Header table. You can even use the GETIDFORUUID web service call to retrieve the Report ID.
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 the following 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 web service call. To use it for yourself, carry out the following the steps:
|
Also, ADDTOFAVORITES. This web service call marks a particular report as the specified user's favourite. Both the user and the report would need to be specified here, the latter by providing the report ID. Use the GETIDFORUUID web service call to retrieve the report ID, or fetch it from the database (this value is stored in the Report Header table).
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 the following 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 web service call. To use it for yourself, carry out the following the steps:
|
Also, REMOVEFAVORITE. This web service call removes a particular report from the specified user's favourite list. Both the user and the report would need to be specified here, the latter by providing the report ID. Use the GETIDFORUUID web service call to retrieve the report ID, or fetch it from the database (this value is stored in the Report Header table).
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 the following 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 web service call. To use it for yourself, carry out the following the steps:
|
This web service call returns a specific user's favourite items, including reports, storyboards, views, dashboards, distributed content, discussions or comments flagged by them.
Request ParametersThe following parameters should be passed with this request:
These are the main parameters that you must set in the PersonFavourite object for this web service call:
Request ExampleBelow is a SOAP XML example for this request:
Response ParametersThe returned response will contain the following 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 web service call. To use it for yourself, carry out the following the steps:
|
This web service call adds an item to a user's favourite list, such as a report, storyboard, view, etc. It also allows a dashboard tab to be added to a user's dashboard, and even flag a comment for a user.
Request ParametersThe following parameters should be passed with this request:
These are the main parameters that you must set in the PersonFavourite object for this web service call:
Request ExampleBelow is a SOAP XML example for this request:
Response ParametersThe returned response will contain the following 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 web service call. To use it for yourself, carry out the following the steps:
|
This web service call removes an item or object from a specific user's favourite list, such as a report, storyboard, view, etc. It also allows a dashboard tab to be removed from a user's dashboard, and even unflag a comment flagged by a user.
Request ParametersThe following parameters should be passed with this request:
These are the main parameters that you must set in the PersonFavourite object for this web service call:
Request ExampleBelow is a SOAP XML example for this request:
Response ParametersThe returned response will contain the following 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 web service call. To use it for yourself, carry out the following the steps:
|