Page History
...
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
以下のコードは、ユーザーを作成するためのYellowfin Webサービスを呼び出します。
このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、ユーザー作成プロセスが失敗した理由を説明するエラーメッセージを返します。でSUCCESSを返します。それ以外の場合は、ユーザー作成プロセスが失敗した理由を説明するエラーメッセージを返します。この関数はYellowfinにユーザーを作成します。AdministrationPersonオブジェクト内の詳細がユーザー作成プロセスで使用されます。 この関数はYellowfinにユーザーを作成します。AdministrationPersonオブジェクト内の詳細がユーザー作成プロセスで使用されます。||
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
These are the parameters that you need to set in the AdministrationPerson object:||
The response returned will contain these parameters:||
|
Retrieving & Validating User Information
...
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
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
These are the parameters that you need to set in the AdministrationPerson object:||
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.
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
These are the parameters that you need to set in the AdministrationPerson object:||
The response returned will contain these parameters:||
|
Manipulating User Information
...
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
These are the parameters that you can set in the AdministrationPerson object:||
|
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and change the password for the specified Yellowfin user:
The code will return |
...
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 |
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 || Data Type || Description || LoginId | String | Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.com.au || Password | String | Password of the account used to connect to Yellowfin webservices || OrgId | Integer | Primary organisation ID within Yellowfin. Always set this to 1. || Function = "GETUSERREPORTS" | String | Web services function || OrgRef | String | Client Reference ID if this function is to be applied for a particular client organisation. This parameter is optional. || Person | AdministrationPerson | The AdministrationPerson object holding the Yellowfin user's User ID for the retrieval process ||These are the parameters that you need to set in the AdministrationPerson object:|| AdministrationPerson Element || Data Type || Description ||| UserId | String | User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method | |
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 |
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 |
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 |
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 |
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 |
Expand | ||
---|---|---|
| ||
This function will return a list of reports contained within a specified dashboard tab, that is accessible by a specified user in Yellowfin.|| Request Element || Data Type || Description ||| LoginId | String | Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.com.au || Password | String | Password of the account used to connect to Yellowfin webservices || OrgId | Integer | Primary organisation ID within Yellowfin. Always set this to 1. || Function = "LOADTABREPORTS" | String | Web services function || Person | AdministrationPerson | The AdministrationPerson object holding the Yellowfin user's User ID for the retrieval process || ReportGroup | AdministrationReportGroup | The AdministrationReportGroup object holding the Dashboard Tab ID for the retrieval process | || Data Type || Description || ReportGroupId | String | Dashboard Tab ID ||The response returned will contain these parameters:|| Response Element || Data Type || Description ||| StatusCode | String Status of the web service call. Possible values include:* SUCCESS* FAILURE || ReportGroups | AdministrationReportGroup | An array of AdministrationReportGroup objects. These objects hold dashboard metadata. For this particular function, the reports' metadata is also loaded into this object's GroupReports() parameter. | |
...
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 |
Expand | ||
---|---|---|
| ||
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 |
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 create the specified group in Yellowfin:
The code will return |
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 || Data Type || Description || UserId | String | User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method ||The response returned will contain these parameters:|| Response Element || Data Type || Description ||| StatusCode | String | Status of the web service call. Possible values include:* SUCCESS* FAILURE | |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and exclude a specified user from a specified group in Yellowfin.
The code will return || Data Type || Description || LoginId | String | Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.com.au || Password | String | Password of the account used to connect to Yellowfin webservices || OrgId | Integer | Primary organisation ID within Yellowfin. Always set this to 1. || Function = "EXCLUDEUSERINGROUP" | String | Web services function || OrgRef | String | Client Reference ID if this function is to be applied for a particular client organisation. The parameter is optional. || Group | AdministrationGroup | The AdministrationGroup object holding the Yellowfin user group's name for the retrieval process || Person | AdministrationPerson | The AdministrationPerson object holding the Yellowfin user's User Id for the retrieval process ||These are the parameters that you need to set in the AdministrationGroup and AdministrationPerson objects:|| AdministrationGroup Element || Data Type || Description ||| GroupName | String | Name of the specified Yellowfin group ||| AdministrationPerson Element || Data Type || Description || UserId | String | User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method ||The response returned will contain these parameters:|| Response Element || Data Type || Description ||| StatusCode | String | Status of the web service call. Possible values include:* SUCCESS* FAILURE | |
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 || Data Type || Description || UserId | String | User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method ||The response returned will contain these parameters:|| Response Element || Data Type || Description ||| StatusCode | String | Status of the web service call. Possible values include:* SUCCESS* FAILURE | |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and modify the specified group in Yellowfin:
The code will return |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and delete the specified group in Yellowfin:
The code will return || Data Type || Description || LoginId | String | Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.com.au || Password | String | Password of the account used to connect to Yellowfin webservices || OrgId | Integer | Primary organisation ID within Yellowfin. Always set this to 1. || Function = "DELETEGROUP" | String | Web services function || OrgRef | String | Client Reference ID if this function is to be applied for a particular client organisation. The parameter is optional. || Group | AdministrationGroup | The AdministrationGroup object holding the Yellowfin user group's name for the retrieval process ||These are the parameters that you need to set in the AdministrationGroup object:|| AdministrationGroup Element || Data Type || Description ||| GroupName | String | Name of the specified Yellowfin group | |
...
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 || Data Type || Description || LoginId | String | Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.com.au || Password | String | Password of the account used to connect to Yellowfin webservices || OrgId | Integer | Primary organisation ID within Yellowfin. Always set this to 1. || Function = "GETUSERACCESS" | String | Web services function || Person | AdministrationPerson | The AdministrationPerson object holding the Yellowfin user's User ID for the retrieval process ||These are the parameters that you need to set in the AdministrationClientOrg object:|| AdministrationPersonElement || Data Type || Description ||| UserId | String | User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method | |
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 || Data Type || Description || ClientReferenceId | Integer | Client Reference ID for the specified client organisation ||The response returned will contain these parameters:|| Response Element || Data Type || Description ||| StatusCode | String | Status of the web service call. Possible values include:* SUCCESS* FAILURE | |
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 || Data Type || Description || ClientReferenceId | Integer | Client Reference ID for the specified client organisation ||The response returned will contain these parameters:|| Response Element || Data Type || Description ||| StatusCode | String | Status of the web service call. Possible values include:* SUCCESS* FAILURE | |
Expand | ||
---|---|---|
| ||
This function will check if a specified report is in a specified user's favourites list in Yellowfin.|| Request Element || Data Type || Description ||| LoginId | String | Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au || Password | String | Password of the account used to connect to Yellowfin webservices || OrgId | Integer | Primary Organisation ID within Yellowfin. Always set this to 1. || Function = "ISUSERFAVOURITE" | String | Web services function || OrgRef | String | Client Reference ID if this function is to be applied for a particular client organisation. This parameter is optional. || Person | AdministrationPerson | The AdministrationPerson object holding the Yellowfin user's User ID for the retrieval process || ReportId | Integer | Unique ID for the report | |
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 | ||
---|---|---|
| ||
This function will return all avatar images of specified users within Yellowfin:|| Request Element || Data Type || Description ||| LoginId | String | Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au || Password | String | Password of the account used to connect to Yellowfin webservices || OrgId | Integer | Primary Organisation ID within Yellowfin. Always set this to 1. || Function = "GETAVATARS" | String Web services function || Parameters | Array (String) | The Unique IDs of Yellowfin users | |
Expand | ||
---|---|---|
| ||
This function will set the avatar image of the specified user's profile within Yellowfin:|| Request Element || Data Type || Description ||| LoginId | String | Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au || Password | String | Password of the account used to connect to Yellowfin webservices || OrgId | Integer | Primary Organisation ID within Yellowfin. Always set this to 1. || Function = "SETAVATARIMAGE" | String | Web services function || OrgRef | String | Client Reference ID if this function is to be applied for a particular client organisation. This parameter is optional. || Person | AdministrationPerson | The AdministrationPerson object holding the Yellowfin user's User ID for the retrieval process || Parameters | Array (Bytes) | Base64 encoded avatar image | |
Expand | ||
---|---|---|
| ||
This function will reload the specified Org Reference Codes within Yellowfin.|| Request Element || Data Type || Description ||| LoginId | String | Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au || Password | String | Password of the account used to connect to Yellowfin webservices || OrgId | Integer | Primary Organisation ID within Yellowfin. Always set this to 1. || Function = "RELOADCODES" | String | Web services function || Parameters | Array (String) | The list of Org Reference Codes | |
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 || Data Type || Description || LoginId | String | Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au || Password | String | Password of the account used to connect to Yellowfin webservices || OrgId | Integer | Primary Organisation ID within Yellowfin. Always set this to 1. || Function = "FLUSHREPORT" | String | Web services function || Parameters | Array (String) | The list of Report IDs ||The response returned will contain these parameters:|| Response Element || Data Type || Description ||| StatusCode | String | Status of the web service call. Possible values include:* SUCCESS* FAILURE | |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and remove a dashboard's cached definitions in Yellowfin:
The code will return || Data Type || Description || LoginId | String | Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au || Password | String | Password of the account used to connect to Yellowfin webservices || OrgId | Integer | Primary Organisation ID within Yellowfin. Always set this to 1. || Function = "FLUSHTAB" | String | Web services function || Parameters | Array (String) | The list of Tab IDs ||The response returned will contain these parameters:|| Response Element || Data Type || Description ||| StatusCode | String | Status of the web service call. Possible values include:* SUCCESS* FAILURE | |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and delete a report in Yellowfin:
The code will return || Data Type || Description || LoginId | String | Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au || Password | String | Password of the account used to connect to Yellowfin webservices || OrgId | Integer | Primary Organisation ID within Yellowfin. Always set this to 1. || Function = "DELETEREPORT" | String | Web services function || Parameters | Array (String) | The UUID of the Yellowfin Report. Note, you do not need to set this if ReportId is set || ReportId | Integer | The Yellowfin Report ID. Note, you do not need to set this if the UUID is set in the Parameter array ||The response returned will contain these parameters:|| Response Element || Data Type || Description ||| StatusCode | String | Status of the web service call. Possible values include:* SUCCESS* FAILURE | |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and delete a view in Yellowfin:
The code will return || Data Type || Description || LoginId | String | Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au || Password | String | Password of the account used to connect to Yellowfin webservices || OrgId | Integer | Primary Organisation ID within Yellowfin. Always set this to 1. || Function = "DELETEVIEW" | String | Web services function || Parameters | Array (String) | Either the Yellowfin View ID or UUID can be set here ||The response returned will contain these parameters:|| Response Element || Data Type || Description ||| StatusCode | String | Status of the web service call. Possible values include:* SUCCESS* FAILURE | |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and delete a data source in Yellowfin:
The code will return { || Data Type || Description || LoginId | String | Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au || Password | String | Password of the account used to connect to Yellowfin webservices || OrgId | Integer | Primary Organisation ID within Yellowfin. Always set this to 1. || Function = "DELETESOURCE" | String | Web services function || Parameters | Array (String) | Either the Yellowfin Data Source ID or UUID can be set here ||The response returned will contain these parameters:|| Response Element || Data Type || Description ||| StatusCode | String | Status of the web service call. Possible values include:* SUCCESS* FAILURE | |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and delete a dashboard tab in Yellowfin:
The code will return || Data Type || Description || LoginId | String | Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au || Password | String | Password of the account used to connect to Yellowfin webservices || OrgId | Integer | Primary Organisation ID within Yellowfin. Always set this to 1. || Function = "DELETETAB" | String | Web services function || Parameters | Array (String) | UUID of the Yellowfin Dashboard Tab. Note that this does not need to be set if the DashboardTabId parameter is set || DashboardTabId | Integer | Dashboard Tab ID ||The response returned will contain these parameters:|| Response Element || Data Type || Description ||| StatusCode | String | Status of the web service call. Possible values include:* SUCCESS* FAILURE | |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and reload the licence definitions in Yellowfin:
The code will return || Data Type || Description || LoginId | String | Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au || Password | String | Password of the account used to connect to Yellowfin webservices || OrgId | Integer | Primary Organisation ID within Yellowfin. Always set this to 1. || Function = "RELOADLICENCE" | String | Web services function ||The response returned will contain these parameters:|| Response Element || Data Type || Description ||| StatusCode | String | Status of the web service call. Possible values include:* SUCCESS* FAILURE | |
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 || Data Type || Description || LoginId | String | Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au || Password | String | Password of the account used to connect to Yellowfin webservices || OrgId | Integer | Primary Organisation ID within Yellowfin. Always set this to 1. || Function = "CLOSECONNECTIONPOOL" | String | Web services function || Parameters | Array (String) | Yellowfin Data Source ID ||The response returned will contain these parameters:|| Response Element || Data Type || Description ||| StatusCode | String | Status of the web service call. Possible values include:* SUCCESS* FAILURE | |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and flush the specified filter's filter cache in Yellowfin:
The code will return || Data Type || Description || LoginId | String | Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au || Password | String | Password of the account used to connect to Yellowfin webservices || OrgId | Integer | Primary Organisation ID within Yellowfin. Always set this to 1. || Function = "FLUSHCACHEDFILTERCACHE" | String | Web services function || Parameters | Array (String) | Filter ID ||The response returned will contain these parameters:|| Response Element || Data Type || Description ||| StatusCode | String | Status of the web service call. Possible values include:* SUCCESS* FAILURE | |
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 || Data Type || Description || LoginId | String | Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au || Password | String | Password of the account used to connect to Yellowfin webservices || OrgId | Integer | Primary Organisation ID within Yellowfin. Always set this to 1. || Function = "APPROVEREPORT" | String | Web services function || ReportId | Integer | Report ID ||The response returned will contain these parameters:|| Response Element || Data Type || Description ||| StatusCode | String | Status of the web service call. Possible values include:* SUCCESS* FAILURE | |
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 || Data Type || Description || LoginId | String | Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au || Password | String | Password of the account used to connect to Yellowfin webservices || OrgId | Integer | Primary Organisation ID within Yellowfin. Always set this to 1. || Function = "GETCONTENT" | String | Web services function ||The response returned will contain these parameters:|| Response Element || Data Type || Description ||| StatusCode | String | Status of the web service call. Possible values include:* SUCCESS* FAILURE || ContentResources | Array (ContentResource) | Array of Content Resource objects. Each ContentResource object holds export metadata for all exportable content in Yellowfin. | |
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 |
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 |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and import the specified Yellowfin import objects into the application:
The code will return || Data Type || Description || LoginId | String | Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au || Password | String | Password of the account used to connect to Yellowfin webservices || OrgId | Integer | Primary Organisation ID within Yellowfin. Always set this to 1 || Function = "IMPORTCONTENT" | String | Web services function || Parameters | Array (String) | An array of Base64 encoded chunks of the XML import file || ImportOptions | Array(ImportOption) | An array of ImportOption objects that controls how content is imported. ||The response returned will contain these parameters:|| Response Element || Data Type || Description ||| StatusCode | String | Status of the web service call. Possible values include:* SUCCESS* FAILURE | |
...