These web services are used in a cluster environment, where Yellowfin is set up amongst multiple nodes connected to a local database. Most of these are used to transmit messages between the cluster nodes, and to clear the cache of a specific node, when data is updated or deleted locally, ensuring consistency in content throughout the cluster. Each of these services remove a specific type of content/data.
This web service is used to remove classes that are in the binary class loader. For example, this could be classes that were loaded as plug-ins such as connectors or data transformation steps that are stored in the database rather than on the file system.
Request ParametersThe following parameters should be passed with this request:
Request ExampleBelow is a SOAP XML example for this request:
Response ParametersThe returned response will contain these parameters:
Response ExampleThe service will return the below response, according to our SOAP example:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete ExampleBelow is a full example of this web service call. To use it for yourself, carry out the following the steps:
|
This web service is used to upload a new licence for the Yellowfin instance.
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:
|
This web service removes a specified Geopack from the Geopack cache. Note, however, that it does not delete the Geopack from the server.
Request ParametersThe following parameters should be passed with this request:
Request ExampleBelow is a SOAP XML example for this request:
Response ParametersThe returned response will contain these parameters:
Response ExampleThe service will return the below response, according to our SOAP example:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete ExampleBelow is a full example of this web service call. To use it for yourself, carry out the following the steps:
|
This web service is used to refresh cached filters associated with a particular dashboard. The dashboard is specified by providing 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:
|
This web service is used to refresh cached filters associated with a particular view. The view is specified by providing 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:
|
This service refreshes all access source filters for the specified data source connection.
Request ParametersThe following parameters should be passed with this request:
Request ExampleBelow is a SOAP XML example for this request:
Response ParametersThe returned response will contain these parameters:
Response ExampleThe service will return the below response, according to our SOAP example:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete ExampleBelow is a full example of this web service call. To use it for yourself, carry out the following the steps:
|
This web service will reload the specified Org Reference Codes within Yellowfin.
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:
|
This web service will clear the geometry cache in Yellowfin.
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:
|
This web service will remove a view's cache in Yellowfin.
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:
|
This web service will remove a report's cached definitions.
Request ParametersThe following parameters should be passed with this request:
Request ExampleBelow is a SOAP XML example for this request:
Response ParametersThe returned response will contain these parameters:
Response ExampleThe service will return the below response, according to our SOAP example:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete ExampleBelow is a full example of this web service call. To use it for yourself, carry out the following the steps:
|
This web service will remove a dashboard tab's cached definitions in Yellowfin.
Request ParametersThe following parameters should be passed with this request:
Request ExampleBelow is a SOAP XML example for this request:
Response ParametersThe returned response will contain these parameters:
Response ExampleThe service will return the below response, according to our SOAP example:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete ExampleBelow is a full example of this web service call. To use it for yourself, carry out the following the steps:
|
This web service will remove a person's cached details. Request ParametersThe following parameters should be passed with this request:
Request ExampleBelow is a SOAP XML example for this request:
Response ParametersThe returned response will contain these parameters:
Response ExampleThe service will return the below response, according to our SOAP example:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete ExampleBelow is a full example of this web service call. To use it for yourself, carry out the following the steps:
|
This web service will reload a licence in Yellowfin.
Request ParametersThe following parameters should be passed with this request:
Request ExampleThe following SOAP XML example shows how perform this request with the mandatory parameters:
Response ParametersThe returned response will contain these parameters:
Response ExampleThe following SOAP XML response will be returned based on our example:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete ExampleBelow is a full example of this web service call. To use it for yourself, carry out the following the steps:
|
This web service will close the connection pool of a specified data source.
Request ParametersThe following parameters should be passed with this request:
Request ExampleThe following SOAP XML example shows how perform this request with the mandatory parameters:
Response ParametersThe returned response will contain these parameters:
Response ExampleThe following SOAP XML response will be returned based on our example:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete ExampleBelow is a full example of this web service call. To use it for yourself, carry out the following the steps:
|
This web service removes a cached text entity.
Request ParametersThe following parameters should be passed with this request:
Request ExampleThe following SOAP XML example shows how perform this request with the mandatory parameters:
Response ParametersThe returned response will contain these parameters:
Response ExampleThe following SOAP XML response will be returned based on our example:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete ExampleBelow is a full example of this web service call. To use it for yourself, carry out the following the steps:
|
This web service removes cached filter definitions.
Request ParametersThe following parameters should be passed with this request:
Request ExampleThe following SOAP XML example shows how perform this request with the mandatory parameters:
Response ParametersThe returned response will contain these parameters:
Response ExampleThe following SOAP XML response will be returned based on our example:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete ExampleBelow is a full example of this web service call. To use it for yourself, carry out the following the steps:
|
This web service removes a specified document from the cache.
Request ParametersThe following parameters should be passed with this request:
Request ExampleThe following SOAP XML example shows how perform this request with the mandatory parameters:
Response ParametersThe returned response will contain these parameters:
Response ExampleThe following SOAP XML response will be returned based on our example:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete ExampleBelow is a full example of this web service call. To use it for yourself, carry out the following the steps:
|
This web service refreshes the access levels for a specific content. The content is specified by providing its ID via a parameter element. This could be a Report ID, Dashboard Tab ID, or ETL Process (data transformation flow) UUID. Request ParametersThe following parameters should be passed with this request:
Request ExampleThe following SOAP XML example shows how perform this request with the mandatory parameters:
Response ParametersThe returned response will contain these parameters:
Response ExampleThe following SOAP XML response will be returned based on our example:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete ExampleBelow is a full example of this web service call. To use it for yourself, carry out the following the steps:
|
This web service is used to 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:
|
This web service is used to delete a specified data source Yellowfin. You can identify the data source by providing its ID.
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:
|
This function is used for cluster messaging. It removes content management records from remote caches when such a record is altered or deleted locally.
Request ParametersThe following parameters should be passed with this request:
Request ExampleBelow is a SOAP XML example for this request:
Response ParametersThe returned response will contain these parameters:
Response ExampleThe service will return the below response, according to our SOAP example:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete ExampleBelow is a full example of this web service call. To use it for yourself, carry out the following the steps:
|