Page History
...
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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: Expand | | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
<soapenv:Header/>
<soapenv:Body>
<web:remoteAdministrationCall>
<arg0>
<loginId>admin@yellowfin.com.au</loginId>
<password>test</password>
<orgId>1</orgId>
<function>GETFAVOURITES</function>
<person>
<userId>admin@yellowfin.com.au</userId>
</person>
</arg0>
</web:remoteAdministrationCall>
</soapenv:Body>
</soapenv:Envelope> |
Response Parameters
The returned response will contain the following parameter:
Response Element | Data Type | Description |
---|---|---|
StatusCode | String | Status of the web service call. Possible values include:
|
Person | Full details of the user. | |
Reports | An array of the user's favourite reports. |
Response Example
The service will return the below response, according to our SOAP example:
Code Block | ||||
---|---|---|---|---|
| ||||
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
<return>
|
Code Block | ||
---|---|---|
| ||
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
rsr.setFunction("GETFAVOURITES"); |
You can specify the user to fetch their favourite reports:
Code Block | ||
---|---|---|
| ||
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("test.user@yellowfin.com.au");
rsr.setPerson(ap); |
Once the request is configured, perform the call:
Code Block language java AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
Initialize the Administration web service. Click here to learn how to do this.
The response will contain the StatusCode, Person and Reports parameters. See the Response Parameter table above for details on these.
Complete Example
Below is a full example of this web service call. To use it for yourself, carry out the following the steps:
- Copy the code and save it as ws_ getfavourites.jsp.
- Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
- Adjust the host, port, and admin user according to your environment.
- Run http://<host>:<port>/ws_ getfavourites.jsp from your Internet browser.
Code Block | ||||
---|---|---|---|---|
| ||||
<% /* ws_getfavourites.jsp *<errorCode>0</errorCode> %> <%@ page language="java" contentType="text/html; charset=UTF-8" %> <%@ page import="com.hof.util.*, java.util.*, java.text.*" %> <%@ page import="com.hof.web.form.*" %> <%@ page import="com.hof.mi.web.service.*" %> <% AdministrationServiceService s_adm = new AdministrationServiceServiceLocator("localhost",8080, "/services/AdministrationService", false); // adjust host and port number AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService(); AdministrationServiceRequest rsr = new AdministrationServiceRequest(); rsr.setLoginId("admin@yellowfin.com.au"); <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages> <messages>Getting user information...</messages> <messages>Getting user information...</messages> // provide your Yellowfin web services admin account rsr.setPassword("test"); <messages>Web Service Request Complete</messages> <person> // set to the password of the account above rsr.setOrgId(1); rsr.setFunction("GETFAVOURITES"); AdministrationPerson ap = new AdministrationPerson(); ap.setUserId("test.user@yellowfin.com.au"); rsr.setPerson(ap); AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode()) ) { <emailAddress>admin@yellowfin.com.au</emailAddress> <firstName>System</firstName> out.write("<br>Success");<initial/> <ipId>5</ipId> <languageCode>EN</languageCode> AdministrationReport[] reports = rs.getReports(); <lastName>Administrator</lastName> <roleCode>YFADMIN</roleCode> if (reports != null) <salutationCode/> <status>ACTIVE</status> <timeZoneCode>AUSTRALIA/SYDNEY</timeZoneCode> <userId>admin@yellowfin.com.au</userId> </person> for(AdministrationReport r: reports){ <reports> <authoringMode>JAVA</authoringMode> <averageRunTime>0</averageRunTime> <birtData/> <chartTypeCode/> <dashboardEnabled>true</dashboardEnabled> out.write("<br>Report Name: " + r.getReportName()); <dataOutput>COLUMN</dataOutput> <deliveryMode/> <executionObject/> <lastModifiedDate>2016-03-29T00:00:00+11:00</lastModifiedDate> <lastModifierId>5</lastModifierId> } } else { <lastModifierName>System Administrator</lastModifierName> out.write("Failure"); <publishDate>2016-03-23T00:00:00+11:00</publishDate> <reportCategory>Audit Reports</reportCategory> out.write(" Code: " + rs.getErrorCode()); } %> |
title | GETINBOX |
---|
<reportDescription/>
<reportId>56401</reportId>
<reportName>Active Sessions</reportName>
<reportSubCategory>Admin Reports</reportSubCategory>
<reportTemplate>REPORTANDCHART</reportTemplate>
<reportUUID>594d4da4-1b58-44d3-bf4f-11456a42f68c</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>24</usage>
<viewDescription>Yellowfin Usage Audit</viewDescription>
<viewId>56169</viewId>
<viewName>NEW VIEW</viewName>
</reports>
<reports>
<authoringMode>JAVA</authoringMode>
<averageRunTime>0</averageRunTime>
<birtData/>
<chartTypeCode/>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<deliveryMode/>
<executionObject/>
<lastModifiedDate>2016-03-29T00:00:00+11:00</lastModifiedDate>
<lastModifierId>5</lastModifierId>
<lastModifierName>System Administrator</lastModifierName>
<publishDate>2016-03-23T00:00:00+11:00</publishDate>
<reportCategory>Audit Reports</reportCategory>
<reportDescription/>
<reportId>56401</reportId>
<reportName>Active Sessions</reportName>
<reportSubCategory>Admin Reports</reportSubCategory>
<reportTemplate>REPORTANDCHART</reportTemplate>
<reportUUID>594d4da4-1b58-44d3-bf4f-11456a42f68c</reportUUID>
<roleCode>OPERATIONAL</roleCode>
<sourceName/>
<usage>24</usage>
<viewDescription>Yellowfin Usage Audit</viewDescription>
<viewId>56169</viewId>
<viewName>NEW VIEW</viewName>
</reports>
<sessionId>dffb6a0f4f155d46c73d1e77dffbd81c</sessionId>
<statusCode>SUCCESS</statusCode>
</return>
</ns2:remoteAdministrationCallResponse>
</S:Body>
</S:Envelope> |
Instructions
See below for step-by-step instructions on how to perform this call, using a Java example:
Expand | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
|
Complete Example
Below is a full example of this web service call. To use it for yourself, carry out the following the steps:
- Copy the code and save it as ws_ getfavourites.jsp.
- Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
- Adjust the host, port, and admin user according to your environment.
- Run http://<host>:<port>/ws_ getfavourites.jsp from your Internet browser.
Code Block | ||||
---|---|---|---|---|
| ||||
<%
/* ws_getfavourites.jsp */
%>
<%@ page language="java" contentType="text/html; charset=UTF-8" %>
<%@ page import="com.hof.util.*, java.util.*, java.text.*" %>
<%@ page import="com.hof.web.form.*" %>
<%@ page import="com.hof.mi.web.service.*" %>
<%
AdministrationServiceService s_adm = new AdministrationServiceServiceLocator("localhost",8080, "/services/AdministrationService", false); // adjust host and port number
AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService();
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
rsr.setLoginId("admin@yellowfin.com.au"); // provide your Yellowfin web services admin account
rsr.setPassword("test"); // set to the password of the account above
rsr.setOrgId(1);
rsr.setFunction("GETFAVOURITES");
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("test.user@yellowfin.com.au");
rsr.setPerson(ap);
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
out.write("<br>Success");
AdministrationReport[] reports = rs.getReports();
if (reports != null)
for(AdministrationReport r: reports){
out.write("<br>Report Name: " + r.getReportName());
}
} else {
out.write("Failure");
out.write(" Code: " + rs.getErrorCode());
}
%>
|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
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:
Anchor | | getinboxap | getinboxap |
AdministrationPerson Element | Data Type | Description |
---|---|---|
UserId | String | ID of the user whose inbox reports are to be fetched. This value could be the user ID or user's email address, depending on the Logon ID method. |
Request Example
Below is a SOAP XML example for this request:
Code Block | ||||
---|---|---|---|---|
| ||||
|
Response Parameters
The returned response will contain the following parameter:
Response Element | Data Type | Description |
---|---|---|
StatusCode | String | Status of the web service call. Possible values include:
|
Person | Full details of the user. | |
Reports | An array of the user's inbox reports. |
Response Example
The service will return the below response, according to our SOAP example:
Code Block | ||||
---|---|---|---|---|
| ||||
|
Instructions
See below for step-by-step instructions on how to perform this call, using a Java example:
title | Step-by-step instructions |
---|
Code Block | ||
---|---|---|
| ||
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
rsr.setFunction("GETINBOX"); |
You can specify the user to fetch their favourite reports:
Code Block | ||
---|---|---|
| ||
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("test.user@yellowfin.com.au");
rsr.setPerson(ap); |
Once the request is configured, perform the call:
Code Block language java AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
Initialize the Administration web service. Click here to learn how to do this.
The response will contain the StatusCode, Person and Reports parameters. See the Response Parameter table above for details on these.
Complete Example
Below is a full example of this web service call. To use it for yourself, carry out the following the steps:
- Copy the code and save it as ws_ getinbox.jsp.
- Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
- Adjust the host, port, and admin user according to your environment.
- Run http://<host>:<port>/ws_ getinbox.jsp from your Internet browser.
Code Block | ||||
---|---|---|---|---|
| ||||
<% /* ws_getinbox.jsp */ %> <%@ page language="java" contentType="text/html; charset=UTF-8" %> <%@ page import="com.hof.util.*, java.util.*, java.text.*" %> <%@ page import="com.hof.web.form.*" %> <%@ page import="com.hof.mi.web.service.*" %> <% AdministrationServiceService s_adm = new AdministrationServiceServiceLocator("localhost",8080, "/services/AdministrationService", false); // adjust host and port number AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService(); AdministrationServiceRequest rsr = new AdministrationServiceRequest(); rsr.setLoginId("admin@yellowfin.com.au"); // provide your Yellowfin webservices admin account rsr.setPassword("test"); <password>test</password> <orgId>1</orgId> <function>ISREPORTFAVOURITE</function> // change to<reportId>56401</reportId> be the password of the account above rsr.setOrgId(1); rsr.setFunction("GETINBOX"); AdministrationPerson ap = new AdministrationPerson(); ap.setUserId("test.user@yellowfin.com.au"); rsr.setPerson(ap); AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode()) ) { <person> <userId>admin@yellowfin.com.au</userId> out.write("<br>Success"); </person> </arg0> </web:remoteAdministrationCall> AdministrationReport[] reports = rs.getReports(); </soapenv:Body> </soapenv:Envelope> |
Response Parameters
The returned response will contain the following parameter:
Response Element | Data Type | Description |
---|---|---|
StatusCode | String | Status of the web service call. Possible values include:
|
Response Example
The service will return the below response, according to our SOAP example:
Code Block | ||||
---|---|---|---|---|
| ||||
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> if (reports != null) <ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/"> <return> <errorCode>0</errorCode> <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages> for(AdministrationReport r: reports){ <messages>Web Service Request Complete</messages> <sessionId>ca75c7ebef710e4fc7c6ca6137baa784</sessionId> <statusCode>SUCCESS</statusCode> </return> </ns2:remoteAdministrationCallResponse> </S:Body> </S:Envelope> |
Instructions
See below for step-by-step instructions on how to perform this call, using a Java example:
Expand | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||
|
Complete Example
Below is a full example of this web service call. To use it for yourself, carry out the following the steps:
- Copy the code and save it as ws_ isreportfavourite.jsp.
- Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
- Adjust the host, port, and admin user according to your environment.
- Run http://<host>:<port>/ws_ isreportfavourite.jsp from your Internet browser.
Code Block | ||||
---|---|---|---|---|
| ||||
<% /* ws_isreportfavourite.jsp out.write("<br>Report Name: " + r.getReportName()); } } else { out.write("Failure"); out.write(" Code: " + rs.getErrorCode()); } %> |
title | ISREPORTFAVOURITE |
---|
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 Parameters
The following parameters should be passed with this request:
Request Element | Data Type | Description |
---|---|---|
LoginId | String | An admin account to connect to Yellowfin web services. This can be the user ID or the email address, depending on the Logon ID method. This account must have the “web services” role enabled, and must belong to the default (i.e. primary) org. |
Password | String | Password of the above account. |
OrgId | Integer | Default (i.e. primary) organization ID within Yellowfin. Always set this to 1. |
Function | String | Web service function. Set this to "ISREPORTFAVOURITE". |
Person | AdministrationPerson | This object contains details of the user. See table below. |
ReportId | Integer | The report ID to check whether the report is the user's favourite. |
These are the main parameters that you must set in the AdministrationPerson object for this web service call:
AdministrationPerson Element | Data Type | Description |
---|---|---|
UserId | String | ID of the user whose inbox reports are to be fetched. This value could be the user ID or user's email address, depending on the Logon ID method. |
Request Example
Below is a SOAP XML example for this request:
Code Block | ||||
---|---|---|---|---|
| ||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/"> <soapenv:Header/> <soapenv:Body> <web:remoteAdministrationCall> <arg0> <loginId>admin@yellowfin.com.au</loginId> <password>test</password> */ %> <%@ page language="java" contentType="text/html; charset=UTF-8" %> <%@ page import="com.hof.util.*, java.util.*, java.text.*" %> <%@ page import="com.hof.web.form.*" %> <%@ page import="com.hof.mi.web.service.*" %> <% AdministrationServiceService s_adm = new AdministrationServiceServiceLocator("localhost",8080, "/services/AdministrationService", false); // adjust host and port number AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService(); AdministrationServiceRequest rsr = new AdministrationServiceRequest(); rsr.setLoginId("admin@yellowfin.com.au"); // provide your Yellowfin web services admin account rsr.setPassword("test"); // set to the password of the account above rsr.setOrgId(1); rsr.setFunction("ISREPORTFAVOURITE"); AdministrationPerson ap = new AdministrationPerson(); ap.setUserId("test.user@yellowfin.com.au"); rsr.setPerson(ap); rsr.setReportId(61131); AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode()) ) { <orgId>1</orgId> out.write("<br>Success"); <function>ISREPORTFAVOURITE</function> <reportId>61131</reportId> } else { <person> <userId>admin@yellowfin.com.au</userId>out.write("Failure"); </person> out.write(" Code: " </arg0> </web:remoteAdministrationCall> </soapenv:Body> </soapenv:Envelope>+ rs.getErrorCode()); } %> |
Expand | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
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:
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: Expand | | |||||||||||||||
|
An admin account to connect to Yellowfin web services. This can be the user ID or the email address, depending on the Logon ID method. This account must have the “web services” role enabled, and must belong to the default (i.e. primary) org. | ||
Password | String | Password of the above account. |
OrgId | Integer | Default (i.e. primary) organization ID within Yellowfin. Always set this to 1. |
Function | String | Web service function. Set this to "ADDTOFAVOURITES" or "ADDTOFAVORITES". |
Person | AdministrationPerson | This object contains details of the user. See table below. |
ReportId | Integer | The ID of the report that is to be added as a favourite of the user's. |
Anchor | ||||
---|---|---|---|---|
|
These are the main parameters that you must set in the AdministrationPerson object for this web service call:
AdministrationPerson Element | Data Type | Description |
---|---|---|
UserId | String | ID of the user to add the report as their favourite. This value could be the user ID or user's email address, depending on the Logon ID method. |
Request Example
Below is a SOAP XML example for this request:
Code Block | ||||
---|---|---|---|---|
| ||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
<soapenv:Header/>
<soapenv:Body>
<web:remoteAdministrationCall>
<arg0>
<loginId>admin@yellowfin.com.au</loginId>
<password>test</password>
<orgId>1</orgId>
<function>ADDTOFAVOURITES</function>
<reportId>56401</reportId>
<person>
<userId>admin@yellowfin.com.au</userId>
</person>
</arg0>
</web:remoteAdministrationCall>
</soapenv:Body>
</soapenv:Envelope> |
Response Parameters
The returned response will contain the following parameter:
Response Element | Data Type | Description |
---|---|---|
StatusCode | String | Status of the web service call. Possible values include:
|
Response Example
The service will return the below response, according to our SOAP example:
Code Block | ||||
---|---|---|---|---|
| ||||
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
|
Code Block | ||
---|---|---|
| ||
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
rsr.setFunction("ISREPORTFAVOURITE"); |
You can identify the user for whom to check the report's favourite status:
Code Block | ||
---|---|---|
| ||
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("test.user@yellowfin.com.au");
rsr.setPerson(ap); |
Specify which report to check the favourite status for:
Code Block | ||
---|---|---|
| ||
rsr.setReportId(61131); |
Once the request is configured, perform the call:
Code Block language java AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
Initialize the Administration web service. Click here to learn how to do this.
The response will contain the StatusCode. See the Response Parameter table above for details on this.
Complete Example
Below is a full example of this web service call. To use it for yourself, carry out the following the steps:
- Copy the code and save it as ws_ isreportfavourite.jsp.
- Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
- Adjust the host, port, and admin user according to your environment.
- Run http://<host>:<port>/ws_ isreportfavourite.jsp from your Internet browser.
Code Block | ||||
---|---|---|---|---|
| ||||
<% /* ws_isreportfavourite.jsp <return> *<errorCode>0</errorCode> %> <%@ page language="java" contentType="text/html; charset=UTF-8" %> <%@ page import="com.hof.util.*, java.util.*, java.text.*" %> <%@ page import="com.hof.web.form.*" %> <%@ page import="com.hof.mi.web.service.*" %> <% AdministrationServiceService s_adm = new AdministrationServiceServiceLocator("localhost",8080, "/services/AdministrationService", false); // adjust host and port number AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService(); AdministrationServiceRequest rsr = new AdministrationServiceRequest(); rsr.setLoginId("admin@yellowfin.com.au"); <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages> <messages>Web Service Request Complete</messages> <sessionId>cf897244c65ceecd6c4c39e8ab8c4fcb<//sessionId> provide your Yellowfin web services admin account rsr.setPassword("test"); <statusCode>SUCCESS</statusCode> </return> // set to the password of the account above rsr.setOrgId(1); rsr.setFunction("ISREPORTFAVOURITE"); AdministrationPerson ap = new AdministrationPerson(); ap.setUserId("test.user@yellowfin.</ns2:remoteAdministrationCallResponse> </S:Body> </S:Envelope> |
Instructions
See below for step-by-step instructions on how to perform this call, using a Java example:
Expand | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
|
Complete Example
Below is a full example of this web service call. To use it for yourself, carry out the following the steps:
- Copy the code and save it as ws_ addtofavourites.jsp.
- Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
- Adjust the host, port, and admin user according to your environment.
- Run http://<host>:<port>/ws_ addtofavourites.jsp from your Internet browser.
Code Block | ||||
---|---|---|---|---|
| ||||
/* ws_addtofavourites.jsp */
%>
<%@ page language="java" contentType="text/html; charset=UTF-8" %>
<%@ page import="com.hof.util.*, java.util.*, java.text.*" %>
<%@ page import="com.hof.web.form.*" %>
<%@ page import="com.hof.mi.web.service.*" %>
<%
AdministrationServiceService s_adm = new AdministrationServiceServiceLocator("localhost",8080, "/services/AdministrationService", false); // adjust host and port number
AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService();
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
rsr.setLoginId("admin@yellowfin.com.au"); // provide your Yellowfin webservices admin account
rsr.setPassword("test"); // change to be the password of the account above
rsr.setOrgId(1);
rsr.setFunction("ADDTOFAVORITES");
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("test.user@yellowfin.com.au");
rsr.setPerson(ap);
rsr.setReportId(56361);
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
out.write("<br>Success");
} else {
out.write("Failure");
out.write(" Code: " + rs.getErrorCode());
}
%>
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
Anchor | | addtofavap | addtofavap |
AdministrationPerson Element | Data Type | Description |
---|---|---|
UserId | String | ID of the user to add the report as their favourite. This value could be the user ID or user's email address, depending on the Logon ID method. |
Request Example
Below is a SOAP XML example for this request:
Code Block | ||||
---|---|---|---|---|
| ||||
|
Response Parameters
The returned response will contain the following parameter:
Response Element | Data Type | Description |
---|---|---|
StatusCode | String | Status of the web service call. Possible values include:
|
Response Example
The service will return the below response, according to our SOAP example:
Code Block | ||||
---|---|---|---|---|
| ||||
|
Instructions
See below for step-by-step instructions on how to perform this call, using a Java example:
title | Step-by-step instructions |
---|
Code Block | ||
---|---|---|
| ||
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
rsr.setFunction("ADDTOFAVOURITES"); |
You can identify the user for whom to check the report's favourite status:
Code Block | ||
---|---|---|
| ||
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("test.user@yellowfin.com.au");
rsr.setPerson(ap); |
Specify which report to check the favourite status for:
Code Block | ||
---|---|---|
| ||
rsr.setReportId(61131); |
Once the request is configured, perform the call:
Code Block language java AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
Initialize the Administration web service. Click here to learn how to do this.
The response will contain the StatusCode. See the Response Parameter table above for details on this.
Complete Example
Below is a full example of this web service call. To use it for yourself, carry out the following the steps:
- Copy the code and save it as ws_ addtofavourites.jsp.
- Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
- Adjust the host, port, and admin user according to your environment.
- Run http://<host>:<port>/ws_ addtofavourites.jsp from your Internet browser.
Code Block | ||||
---|---|---|---|---|
| ||||
/* ws_addtofavourites.jsp */ %> <%@ page language="java" contentType="text/html; charset=UTF-8" %> <%@ page import="com.hof.util.*, java.util.*, java.text.*" %> <%@ page import="com.hof.web.form.*" %> <%@ page import="com.hof.mi.web.service.*" %> <% AdministrationServiceService s_adm = new AdministrationServiceServiceLocator("localhost",8080, "/services/AdministrationService", false); // adjust host and port number AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService(); AdministrationServiceRequest rsr = new AdministrationServiceRequest(); rsr.setLoginId("admin@yellowfin.com.au"); // provide your Yellowfin webservices admin account rsr.setPassword("test"); // change to be the password of the account above rsr.setOrgId(1); rsr.setFunction("ADDTOFAVORITES"); AdministrationPerson ap = new AdministrationPerson(); ap.setUserId("test.user@yellowfin.com.au"); rsr.setPerson(ap); rsr.setReportId(56361); AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode()) ) { <loginId>admin@yellowfin.com.au</loginId> <password>test</password> <orgId>1</orgId> out.write("<br>Success");<function>REMOVEFAVOURITE</function> <reportId>56401</reportId> <person> } else { <userId>admin@yellowfin.com.au</userId> out.write("Failure"); </person> </arg0> out.write(" Code: " + rs.getErrorCode()); } %> |
title | REMOVEFAVOURITE |
---|
</web:remoteAdministrationCall>
</soapenv:Body>
</soapenv:Envelope> |
Response Parameters
The returned response will contain the following parameter:
Response Element | Data Type | Description |
---|---|---|
StatusCode | String | Status of the web service call. Possible values include:
|
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 Parameters
The following parameters should be passed with this request:
Request Element | Data Type | Description |
---|---|---|
LoginId | String | An admin account to connect to Yellowfin web services. This can be the user ID or the email address, depending on the Logon ID method. This account must have the “web services” role enabled, and must belong to the default (i.e. primary) org. |
Password | String | Password of the above account. |
OrgId | Integer | Default (i.e. primary) organization ID within Yellowfin. Always set this to 1. |
Function | String | Web service function. Set this to "REMOVEFAVOURITE" or "REMOVEFAVORITE". |
Person | AdministrationPerson | This object contains details of the user. See table below. |
ReportId | Integer | The ID of the report that is to be
These are the main parameters that you must set in the AdministrationPerson object for this web service call:
AdministrationPerson Element | Data Type | Description |
---|---|---|
UserId | String | ID of the user to remove the report from their favourite list. This value could be the user ID or user's email address, depending on the Logon ID method
|
|
Request
Response Example
Below is a SOAP XML example for this requestThe service will return the below response, according to our SOAP example:
Code Block | ||||
---|---|---|---|---|
| ||||
|
Response Parameters
The returned response will contain the following parameter:
Response Element | Data Type | Description |
---|---|---|
StatusCode | String | Status of the web service call. Possible values include:
|
Response Example
The service will return the below response, according to our SOAP example:
Code Block | ||||
---|---|---|---|---|
| ||||
|
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
<return>
<errorCode>0</errorCode>
<messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
<messages>Web Service Request Complete</messages>
<sessionId>1be6b980918323dab6f41fec3c040c56</sessionId>
<statusCode>SUCCESS</statusCode>
</return>
</ns2:remoteAdministrationCallResponse>
</S:Body>
</S:Envelope> |
Instructions
See below for step-by-step instructions on how to perform this call, using a Java example:
Expand | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||
|
Complete Example
Below is a full example of this web service call. To use it for yourself, carry out the following the steps:
- Copy the code and save it as ws_ removefavourite.jsp.
- Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
- Adjust the host, port, and admin user according to your environment.
- Run http://<host>:<port>/ws_ removefavourite.jsp from your Internet browser.
Code Block | ||||
---|---|---|---|---|
| ||||
/* ws_removefavourite.jsp */ %> <%@ page language="java" contentType="text/html; charset=UTF-8" %> <%@ page import="com.hof.util.*, java.util.*, java.text.*" %> <%@ page import="com.hof.web.form.*" %> <%@ page import="com.hof.mi.web.service.*" %> <% AdministrationServiceService s_adm = new AdministrationServiceServiceLocator("localhost",8080, "/services/AdministrationService", false); // adjust host and port number AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService(); AdministrationServiceRequest rsr = new AdministrationServiceRequest(); rsr.setLoginId("admin@yellowfin.com.au"); // provide your Yellowfin web services admin account rsr.setPassword("test"); // set to the password of the account above rsr.setOrgId(1); rsr.setFunction("REMOVEFAVOURITE"); AdministrationPerson ap = new AdministrationPerson(); ap.setUserId("test.user@yellowfin.com.au"); rsr.setPerson(ap); rsr.setReportId(56361); AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode()) ) { out.write("<br>Success"); } else { out.write("Failure"); out.write(" Code: " + rs.getErrorCode()); } %> |
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
|
...
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
|