Page History
...
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||
The following code will call the Yellowfin web service to create a user:
This code will return This function will create a user in Yellowfin. The details in the AdministrationPerson object will be used in the user creation process.
These are the parameters that you need to set in the AdministrationPerson object:
The response returned will contain these parameters:
|
Expand | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||
The following code will call the Yellowfin web service to create a user:
This code will return This function will delete a user from Yellowfin. The details in the AdministrationPerson object will be used in the user deletion process.
These are the parameters that you need to set in the AdministrationPerson object:
The response returned will contain these parameters:
|
...
Expand | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||
The following code will call the Yellowfin web service to retrieve a user's details:
This code will return an AdministrationPerson object with the user's details and This function will retrieve the details of a particular user in Yellowfin. The details in the AdministrationPerson object will be used in the retrieval process.
These are the parameters that you need to set in the AdministrationPerson object:
The response returned will contain these parameters:
|
Expand | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||
The following code will call the Yellowfin web service to retrieve a user's details via their internal IpId:
This code will return an AdministrationPerson object with the user's details and This function will retrieve the details of a particular user in Yellowfin by looking up their IP ID. The details in the AdministrationPerson object will be used in the retrieval process.
These are the parameters that you need to set in the AdministrationPerson object:
IpId|Integer|IP ID of the Yellowfin User| The response returned will contain these parameters:
|
Expand | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||
This function will retrieve users from Yellowfin based on a specific search string. This string is compared against the user's first name, last name, and email address.
The response returned will contain these parameters:
|
Expand | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||
The following code will call the Yellowfin web service to validate a user:
This code will return an AdministrationPerson object of the particular user if successful; otherwise it will return an error message explaining why the user validation process failed. This function will validate a specified Yellowfin user, checking if the user currently exists within the application. The details in the AdministrationPerson object will be used in the user validation process.
These are the parameters that you need to set in the AdministrationPerson object:
The response returned will contain these parameters:
|
Expand | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||
The following code will call the Yellowfin web service to validate a user's password:
This code will check if the password is expired and will return This function will validate a Yellowfin user's password. The details in the AdministrationPerson object will be used in the password validation process.
These are the parameters that you need to set in the AdministrationPerson object:
The response returned will contain these parameters:
|
...
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
The following code will call the Yellowfin web service to edit a user's details:
This code will return an AdministrationPerson object with the user's details and This function will update a specified Yellowfin user's details. The details in the AdministrationPerson object will be used in the update process.
These are the parameters that you can set in the AdministrationPerson object:
The response returned will contain these parameters:
|
Expand | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||
The following code will call the Yellowfin web service and change the password for the specified Yellowfin user:
The code will return This function will change a specified Yellowfin user's password.
These are the parameters that you need to set in the AdministrationPerson object:
The response returned will contain these parameters:
|
...
Expand | ||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||
The following code will call the Yellowfin web service and return all reports with a Web Services Name that are accessible for the particular user:
This code will return an Array of AdministrationReport objects in This function will return all reports with a webservice name that are accessible for the specified Yellowfin user.
These are the parameters that you need to set in the AdministrationPerson object:
The response returned will contain these parameters:
|
Expand | ||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||
The following code will call the Yellowfin web service and return all reports that are accessible for the particular user:
This code will return an Array of AdministrationReport objects in
These are the parameters that you need to set in the AdministrationPerson object:
The response returned will contain these parameters:
|
Expand | ||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||
The following code will call the Yellowfin web service and return all commented reports that are accessible for the particular user:
This code will return an Array of AdministrationReport objects in This function will return all commented reports in Yellowfin that are accessible by the specified Yellowfin user.
These are the parameters that you need to set in the AdministrationPerson object:
The response returned will contain these parameters:
|
Expand | |||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||
The following code will call the Yellowfin web service and return all report favourites that are accessible for the particular user:
This code will return an Array of AdministrationReport objects in This function will return all the favourite reports of a specified Yellowfin user.
These are the parameters that you need to set in the AdministrationPerson object:
The response returned will contain these parameters:
|
Expand | |||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||
The following code will call the Yellowfin web service and return all reports that are in the particular user's inbox:
This code will return an Array of AdministrationReport objects in This function will return the reports that are in the inbox of a specified Yellowfin user.
These are the parameters that you need to set in the AdministrationPerson object:
The response returned will contain these parameters:
|
Expand | |||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||
The following code will call the Yellowfin web service and return all dashboard tabs without reports that are accessible for that particular user:
This code will return an Array of AdministrationReportGroup objects in This function will return a list of dashboard tabs that are accessible by the specified Yellowfin user.
These are the parameters that you need to set in the AdministrationPerson object:
The response returned will contain these parameters:
|
Expand | |||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||
The following code will call the Yellowfin web service and return all dashboard tabs with reports that are accessible for that particular user:
This code will return an Array of AdministrationReportGroup objects in This function will return a list of dashboard tabs that are accessible by the specified Yellowfin user, with the reports' metadata loaded as well. The metadata for every report in the dashboard tab is contained within the AdministrationReportGroup object.
These are the parameters that you need to set in the AdministrationPerson object:
The response returned will contain these parameters:
|
Expand | |||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||
This function will return a list of reports contained within a specified dashboard tab, that is accessible by a specified user in Yellowfin.
These are the parameters that you need to set in the AdministrationPerson and AdministrationReportGroup object:
The response returned will contain these parameters:
|
...
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and return all available roles within Yellowfin:
The code will return an Array of AdministrationRole objects in |
...
title | LISTGROUPS |
---|
...
This function will return all the available |
...
roles within Yellowfin |
...
.
The response returned will contain these parameters:
|
Expand | ||
---|---|---|
|
Code Block |
---|
AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if you wish to get groups in a client organization
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("LISTGROUPS");
rs = AdministrationService.remoteAdministrationCall(rsr);
|
The code will return an Array of AdministrationGroup objects in rs.getGroups()
and SUCCESS
in rs.getStatusCode()
, otherwise it will return an error explaining why the process failed.
...
The following code will call the Yellowfin web service and return |
...
all available groups within Yellowfin:
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
The code will return an |
...
Array of |
...
AdministrationGroup objects in |
...
|
...
and |
...
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and create the specified group in Yellowfin:
The code will return Note: you can also put existing Yellowfin users into this newly created group at the same time by populating an AdministrationGroupMember array of AdministrationPerson objects. Each AdministrationPerson object only needs the |
...
title | INCLUDEUSERINGROUP |
---|
...
. This function will return all the available user groups within Yellowfin.
The response returned will contain these parameters:
|
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and return the specified group with its members in Yellowfin:
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
The code will return an AdministrationGroup object in |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and exclude a specified user from a specified group in Yellowfin. Note: this user is not deleted from the group but merely excluded from the group definition. An example of why this would be useful is when:
The code will return |
...
This function will return a specified Yellowfin group with a list of its members.
These are the parameters that you need to set in the AdministrationGroup object:
The response returned will contain these parameters:
|
Expand | |||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||
The following code will call the Yellowfin web service and create the specified group in Yellowfin:
The code will return Note: you can also put existing Yellowfin users into this newly created group at the same time by populating an AdministrationGroupMember array of AdministrationPerson objects. Each AdministrationPerson object only needs the This function will create a Yellowfin group. Note that you are able to save existing Yellowfin users into the new group in this function as well.
These are the parameters that you need to set in the AdministrationGroup object:
The response returned will contain these parameters:
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||
The following code will call the Yellowfin web service and include a specified user into a specified group in Yellowfin:
The code will return This function will include a specified Yellowfin user into a specified group.
These are the parameters that you need to set in the AdministrationGroup and AdministrationPerson objects:
The response returned will contain these parameters:
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||
The following code will call the Yellowfin web service and exclude a specified user from a specified group in Yellowfin. Note: this user is not deleted from the group but merely excluded from the group definition. An example of why this would be useful is when:
The code will return This function will exclude a specified Yellowfin user from a specified group. Note that this user is not deleted from the group but merely excluded from the group definition. An example of why this would be useful is when:
These are the parameters that you need to set in the AdministrationGroup and AdministrationPerson objects:
The response returned will contain these parameters:
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||
The following code will call the Yellowfin web service and delete a specified user from a specified group in Yellowfin:
The code will return This function will delete a specified Yellowfin user from a specified group. Note that this scenario is different from the one in EXCLUDEUSERINGROUP - in this function a user will be permanently removed from the group.
These are the parameters that you need to set in the AdministrationGroup and AdministrationPerson objects:
The response returned will contain these parameters:
|
Expand | ||
---|---|---|
|
...
The following code will call the Yellowfin web service and |
...
modify the specified group in Yellowfin:
|
...
|
...
|
...
|
...
|
...
|
...
The code will return Note: you can also put existing Yellowfin users into this modified group at the same time by populating an AdministrationGroupMember array of AdministrationPerson objects. Each AdministrationPerson object only needs the This function will modify the details for a specified group in Yellowfin. Note that you are able to save existing Yellowfin users into the new group in this function as well.
| ||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||
The following code will call the Yellowfin web service and modify the specified group in Yellowfin:
The code will return Note: you can also put existing Yellowfin users into this modified group at the same time by populating an AdministrationGroupMember array of AdministrationPerson objects. Each AdministrationPerson object only needs the | ||||||||||||||||||||||||||||||||
These are the parameters that you need to set in the AdministrationGroup object:
The response returned will contain these parameters:
|
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and delete the specified group in Yellowfin:
The code will return |
...
The code will return This function will delete a specified group from Yellowfin.
These are the parameters that you need to set in the AdministrationGroup object:
The response returned will contain these parameters:
|
Client Organisation Functionality
...
Client Organisation functionality can be managed with the available web service calls listed below.
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and list all client |
...
organisations within Yellowfin:
|
...
The code will return an Array of AdministrationClientOrg objects and |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and get the specified client |
...
organisation within Yellowfin:
|
...
The code will return an AdministrationClientOrg object in |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and create the specified client |
...
organisation within Yellowfin:
|
...
The code will return |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and delete the specified client |
...
organisation within Yellowfin:
|
...
The code will return |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and update the specified client |
...
organisation within Yellowfin:
|
...
The code will return |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and list all users belonging to the specified client |
...
organisation within Yellowfin:
|
...
The code will return an Array of AdministrationPerson objects in |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and list all client |
...
organisations accessible by a specified user within Yellowfin:
|
...
The code will return an Array of AdministrationClientOrg objects in |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and add access to a specified client |
...
organisation for a specified user within Yellowfin:
|
...
The code will return |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and remove access to a specified client |
...
organisation for a specified user within Yellowfin:
|
...
The code will return |
Expand | ||
---|---|---|
| ||
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and add a specified report to a specified user's favourites list:
The code will return |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and remove a specified report to a specified user's favourites list:
The code will return |
...
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and clear the geometry cache in Yellowfin:
The code will return |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and remove a view's cache in Yellowfin:
The code will return |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and remove a report's cached definitions in Yellowfin:
The code will return |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and remove a dashboard's cached definitions in Yellowfin:
The code will return |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and delete a report in Yellowfin:
The code will return |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and delete a view in Yellowfin:
The code will return |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and delete a data source in Yellowfin:
The code will return { |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and delete a dashboard tab in Yellowfin:
The code will return |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and reload the licence definitions in Yellowfin:
The code will return |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and close the specified data source's connection pool in Yellowfin:
The code will return |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and flush the specified filter's filter cache in Yellowfin:
The code will return |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and approve a report in Yellowfin via the expert approval process:
The code will return |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and obtain all exportable content within Yellowfin:
The code will return an Array of ContentResource objects in |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and obtain dependencies for a specific Yellowfin artifact:
The code will return an Array of ContentResource objects in |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and export the specified artifacts within Yellowfin:
The code will return an Array of ReportBinaryObjects objects in |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and read a Yellowfin import file, returning the objects to be imported:
The code will return an Array of ContentResource objects in Refer to |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and validate the Yellowfin import objects. This function usually follows after the GETIMPORTCONTENT web services call:
The code will return an Array of ImportIssue objects in Refer to |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and import the specified Yellowfin import objects into the application:
The code will return Refer to |
...