Yellowfin contains a functionality called Client Organization, which allows multiple virtual instances of Yellowfin to reside in the same server instance. This way private content can be created within one organization, and accessed only by the users of that organization; it will be hidden from other organization users logging into the same server. The following web service calls can be used to manage this functionality.
Note: Ensure that your instance of Yellowfin has the Client Org functionality switched on for this.
Use this web service call to create a new client organization in Yellowfin. The AdministrationClientOrg object will be required to provide the details of the new client.
Request ParametersThe following parameters should be passed with this request:
These are the main parameters that you can set in the AdministrationClientOrg object for this web service call:
Request ExampleBelow is a SOAP XML example for this request:
Response ParametersThe response returned 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:
|
Use this web service call to retrieve a list of all client organizations within Yellowfin.
Request ParametersThe following parameters should be passed with this request:
Request ExampleBelow is a SOAP XML example for this request:
Response ParametersThe response returned 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:
|
Use this web service call to retrieve details of a specified client organization, based on the client reference ID.
Request ParametersThe following parameters should be passed with this request:
Specify these main parameters for the AdministrationClientOrg object:
Request ExampleBelow is a SOAP XML example for this request:
Response ParametersThe response returned will contain these parameters:
Response ExampleThe service will return the below response, according to our above 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:
|
Use this web service call to delete a client organization from Yellowfin. The client can be specified by providing the client reference ID. Note however, that the default (primary) organization cannot be deleted.
Request ParametersThe following parameters should be passed with this request:
These are the main parameters that you must set in the AdministrationClientOrg object for this web service call:
Request ExampleBelow is a SOAP XML example for this request:
Response ParametersThe response returned 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:
|
Use this web service call to update the details of a client organization in Yellowfin.
Request ParametersThe following parameters should be passed with this request:
These are the main parameters that you can set in the AdministrationClientOrg object for this web service call:
Request ExampleBelow is a SOAP XML example for this request:
Response ParametersThe response returned 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:
|
Use this web service call to list all the users of a specified client organization. Identify the client using the client reference ID.
Request ParametersThe following parameters should be passed with this request:
These are the main parameters that you must set in the AdministrationClientOrg object for this web service call:
Request ExampleBelow is a SOAP XML example for this request:
Response ParametersThe response returned 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:
|
Use this call to add an existing Yellowfin user to a specified client oganization.
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:
These are the main parameters that you must set in the AdministrationClientOrg object for this web service call:
Request ExampleBelow is a SOAP XML example for this request:
Response ParametersThe response returned 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 call is used to list all the client organizations which a specified user belongs to. You can identify the user by using the AdministrationPerson object.
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 response returned 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 call is used to remove a specified user's access to a client organization. The user and the client org can be identified using the AdministrationPerson and AdministrationClientOrg objects, respectively. This removed user account will remain in the system, even if that user doesn't belong to any other client organizations. To delete that user account from the system, you can use the DELETEUSER call. Or you could even add that user to the default organization by using the ADDUSERACCESS call.
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:
These are the main parameters that you must set in the AdministrationClientOrg object for this web service call:
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:
|