This section covers a set of web services to update a Yellowfin view. These work in conjunction with one another and must be used in the following sequence:
Use the EDITVIEW web service to put a specified view in draft mode.
Then using the ADDCOLUMNTOVIEW function, update your view by adding database columns to it.
To save these changes, call the PUBLISHVIEW web service.
This web service sets the specified view into “draft” mode so that it can be edited by other web service calls. Request ParametersThe following parameters should be passed with this request:
Request ExampleBelow is a SOAP JAX example for this request:
Response ParametersThe returned response will contain these parameters:
Response ExampleThe service will return the below response, according to our SOAP example:
|
This web service call adds a new database column to the specified view, using the naming and category provided in an AdminsitrationViewField object. Request ParametersThe following parameters should be passed with this request:
The following are required parameters to the AdministrationViewField object.
Request ExampleBelow is a SOAP JAX example for this request:
Response ParametersThe returned response will contain these parameters:
Response ExampleThe service will return the below response, according to our SOAP example:
|
This web service saves and publishes a view to use reports. If this function is not called after EDITVIEW, the view will remain un-editable until the web service session times out. Request ParametersThe following parameters should be passed with this request:
Request Example Below is a SOAP JAX example for this request:
Response ParametersThe returned response will contain these parameters:
Response ExampleThe service will return the below response, according to our SOAP example:
|
This function allows the creation of a new folder in a view. Request ParametersThe following parameters should be passed with this request:
Request ExampleBelow is a SOAP JAX example for this request:
Response ParametersThe returned response will contain these parameters:
Response ExampleThe service will return the below response, according to our SOAP example:
|
Also included is a JavaScript example demonstrating how each of these web services are used together.
Complete example of View web servicesBelow is a full example of the EDITVIEW, ADDCOLUMNTOVIEW, and PUBLISHVIEW web services. (Contained in a single file, as they are meant to be used together.) To use it for yourself, carry out the following the steps:
|
This web service is used to delete a view in Yellowfin. You can specify the view by providing either its ID or UUID. Request ParametersThe following parameters should be passed with this request:
Response ParametersThe returned response will contain these parameters:
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:
|