Documentation

WorkspaceAPI extends AnalyticsClient
in package

AnalyticsClient provides the PHP based language binding to the https based API of ZohoAnalytics.

Table of Contents

Constants

CLIENT_VERSION  = "2.6.0"

Properties

$ac  : mixed
$accounts_server_url  : string
$analytics_server_url  : string
$connection_timeout  : int
$proxy  : bool
$proxy_host  : string
$proxy_password  : string
$proxy_port  : int
$proxy_type  : string
$proxy_user_name  : string
$read_timeout  : int
$req_headers  : mixed
$workspace_end_point  : mixed

Methods

__construct()  : mixed
Creates a new WorkspaceAPI instance.
addAdmins()  : mixed
Add admins for the specified workspace.
addDefault()  : mixed
Adds a specified workspace as default.
addFavorite()  : mixed
Adds a specified workspace as favorite.
addGroupMembers()  : mixed
Add users to the specified group.
addWorkspaceUsers()  : mixed
Add users to the specified workspace.
changeEmailScheduleStatus()  : mixed
Update email schedule status.
changeFolderHierarchy()  : mixed
Swaps the hierarchy of a parent folder and a subfolder.
changeFolderPosition()  : mixed
Place the folder above the reference folder.
changeWorkspaceUserRole()  : mixed
Change role of the specified users in the workspace.
changeWorkspaceUserStatus()  : mixed
Change users staus in the specified workspace.
copy()  : string
Copy the specified workspace from one organization to another or within the organization.
copyViews()  : array<string|int, mixed>
Copy the specified views from one workspace to another workspace.
createReport()  : string
Create a report in the specified workspace.
createEmailSchedule()  : string
Create an email schedule in the specified workspace.
createFolder()  : string
Create a folder in the specified workspace.
createGroup()  : string
Create a group in the specified workspace.
createQueryTable()  : string
Create a new query table in the workspace.
createSlideshow()  : string
Create a slideshow in the specified workspace.
createTable()  : string
Create a table in the specified workspace.
createVariable()  : string
Create a variable in the workspace.
delete()  : mixed
Delete a specified workspace in the organization.
deleteEmailSchedule()  : mixed
Delete the specified email schedule in the workspace.
deleteFolder()  : mixed
Delete a specified folder in the workspace.
deleteGroup()  : mixed
Delete a specified group.
deleteSlideshow()  : mixed
Delete a specified slideshow in the workspace.
deleteTrashView()  : mixed
Delete the specified view permanently from trash.
deleteVariable()  : mixed
Delete the specified variable in the workspace.
disableDomainAccess()  : mixed
Disable workspace from the specified white label domain.
editQueryTable()  : mixed
Update the mentioned query table in the workspace.
enableDomainAccess()  : mixed
Enable workspace to the specified white label domain.
exportAsTemplate()  : mixed
Export the mentioned table (or) view data.
getAdmins()  : array<string|int, mixed>
Returns list of admins for the specified workspace.
getAggregateFormulaDependents()  : array<string|int, mixed>
Returns list of all dependent views and formulas for the specified aggregate formula.
getAggregateFormulas()  : array<string|int, mixed>
Returns list of all aggregate formulas for the specified workspace.
getAggregateFormulaValue()  : string
Returns the value of the aggregate formula.
getBulkInstance()  : BulkAPI
Returns a new BulkAPI instance.
getConnectionTimeout()  : int
Returns the timeout until a connection is established.A value of zero means the timeout is not used.
getDashboards()  : array<string|int, mixed>
Returns list of all accessible dashboards.
getDatasources()  : array<string|int, mixed>
Returns list of datasources for the specified workspace.
getEmailSchedules()  : array<string|int, mixed>
Returns list of email schedules available in the specified workspace.
getFolders()  : array<string|int, mixed>
Returns list of all accessible folders for the specified workspace.
getGroupDetails()  : array<string|int, mixed>
Get the details of the specified group.
getGroups()  : array<string|int, mixed>
Returns list of groups for the specified workspace.
getOrgInstance()  : OrgAPI
Returns a new OrgAPI instance.
getOrgs()  : array<string|int, mixed>
Returns list of all accessible organizations.
getOwnedDashboards()  : array<string|int, mixed>
Returns list of owned dashboards.
getOwnedWorkspaces()  : array<string|int, mixed>
Returns list of owned workspaces.
getReadTimeout()  : int
Returns the timeout until waiting to read data. A value of zero means the timeout is not used. The default value is 15000.
getRecentViews()  : array<string|int, mixed>
Returns list of recently accessed views.
getSecretKey()  : string
Returns the secret key of the specified workspace.
getSharedDashboards()  : array<string|int, mixed>
Returns list of shared dashboards.
getSharedDetailsForViews()  : mixed
Returns shared details of the specified views.
getSharedWorkspaces()  : array<string|int, mixed>
Returns list of shared workspaces.
getShareInfo()  : array<string|int, mixed>
Returns shared details of the specified workspace.
getSlideshowDetails()  : array<string|int, mixed>
Returns details of the specified slideshow.
getSlideshows()  : array<string|int, mixed>
Returns list of slideshows for the specified workspace.
getSlideshowUrl()  : array<string|int, mixed>
Returns slide URL to access the specified slideshow.
getTrashViews()  : array<string|int, mixed>
Returns list of all views available in trash for the specified workspace.
getVariableDetails()  : array<string|int, mixed>
Returns details of the specified variable.
getVariables()  : array<string|int, mixed>
Returns list of variables for the specified workspace.
getViewDetails()  : array<string|int, mixed>
Returns details of the specified view.
getViewInstance()  : ViewAPI
Returns a new ViewAPI instance.
getViews()  : array<string|int, mixed>
Returns list of all accessible views for the specified workspace.
getWorkspaceDetails()  : array<string|int, mixed>
Returns details of the specified workspace.
getWorkspaceInstance()  : WorkspaceAPI
Returns a new WorkspaceAPI instance.
getWorkspaces()  : array<string|int, mixed>
Returns list of all accessible workspaces.
getWorkspaceUsers()  : array<string|int, mixed>
Returns list of users for the specified workspace.
makeDefaultFolder()  : mixed
Make the specified folder as default.
moveViewsToFolder()  : mixed
Place the folder above the reference folder.
removeAdmins()  : mixed
Remove admins from the specified workspace.
removeDefault()  : mixed
Remove a specified workspace from default.
removeFavorite()  : mixed
Remove a specified workspace from favorite.
removeGroupMembers()  : mixed
Remove users from the specified group.
removeShare()  : mixed
Remove shared views for the specified users.
removeWorkspaceUsers()  : mixed
Remove users from the specified workspace.
rename()  : mixed
Rename a specified workspace in the organization.
renameFolder()  : mixed
Rename a specified folder in the workspace.
renameGroup()  : mixed
Rename a specified group.
restoreTrashView()  : mixed
Restore the specified view from trash.
setConnectionTimeout()  : mixed
Sets the timeout until a connection is established. A value of zero means the timeout is not used. The default value is 15000.
setProxy()  : mixed
Used to specify the proxy server details.
setReadTimeout()  : mixed
Sets the timeout until waiting to read data. A value of zero means the timeout is not used. The default value is 15000.
shareViews()  : mixed
Share views to the specified users.
syncData()  : mixed
Initiate data sync for the specified datasource.
triggerEmailSchedule()  : mixed
Trigger configured email schedules instantly.
updateReport()  : mixed
Update the design and configuration of the specified report.
updateDatasourceConnection()  : mixed
Update connection details for the specified datasource.
updateEmailSchedule()  : string
Update configurations of the specified email schedule in the workspace.
updateSlideshow()  : string
Update details of the specified slideshow.
updateVariable()  : mixed
Update details of the specified variable in the workspace.

Constants

CLIENT_VERSION

public const CLIENT_VERSION = "2.6.0"

CLIENT_VERSION It contain the API client version.It is a constant one.

Properties

$accounts_server_url

private string $accounts_server_url = "https://accounts.zoho.com"

Account URL.

$analytics_server_url

private string $analytics_server_url = "https://analyticsapi.zoho.com"

The base request API URL.

$connection_timeout

private int $connection_timeout

It is a time value until a connection is established.

$proxy

private bool $proxy = \FALSE

It will indicate whether the proxy is set or not.

$proxy_host

private string $proxy_host

The hostname/ip address of the proxy-server.

$proxy_password

private string $proxy_password

The password for proxy-server authentication.

$proxy_type

private string $proxy_type

Can be any one ( HTTP , HTTPS , BOTH ).Specify "BOTH" if same configuration can be used for both HTTP and HTTPS.

$proxy_user_name

private string $proxy_user_name

The user name for proxy-server authentication.

$read_timeout

private int $read_timeout

It is a time value until waiting to read data.

Methods

__construct()

Creates a new WorkspaceAPI instance.

public __construct(AnalyticsClient $ac, string $org_id, string $workspace_id) : mixed
Parameters
$ac : AnalyticsClient

AnalyticsClient instance.

$org_id : string

The ID of the organization.

$workspace_id : string

The ID of the workspace.

addAdmins()

Add admins for the specified workspace.

public addAdmins(array<string|int, mixed> $email_ids[, array<string|int, mixed> $config = array() ]) : mixed
Parameters
$email_ids : array<string|int, mixed>

The email address of the admin users to be added.

$config : array<string|int, mixed> = array()

Contains any additional control parameters. Can be null.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

addDefault()

Adds a specified workspace as default.

public addDefault() : mixed
Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

addFavorite()

Adds a specified workspace as favorite.

public addFavorite() : mixed
Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

addGroupMembers()

Add users to the specified group.

public addGroupMembers(string $group_id, array<string|int, mixed> $email_ids[, array<string|int, mixed> $config = array() ]) : mixed
Parameters
$group_id : string

Id of the group.

$email_ids : array<string|int, mixed>

The email address of the users to be added to the group.

$config : array<string|int, mixed> = array()

Contains any additional control parameters. Can be null.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

addWorkspaceUsers()

Add users to the specified workspace.

public addWorkspaceUsers(array<string|int, mixed> $email_ids, string $role[, array<string|int, mixed> $config = array() ]) : mixed
Parameters
$email_ids : array<string|int, mixed>

The email address of the users to be added.

$role : string

Role of the user to be added.

$config : array<string|int, mixed> = array()

Contains any additional control parameters. Can be null.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

changeEmailScheduleStatus()

Update email schedule status.

public changeEmailScheduleStatus(string $schedule_id, string $operation) : mixed
Parameters
$schedule_id : string

Id for the email schedule.

$operation : string

New status for the schedule (Values - activate | deactivate).

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

changeFolderHierarchy()

Swaps the hierarchy of a parent folder and a subfolder.

public changeFolderHierarchy(string $folder_id, int $hierarchy[, array<string|int, mixed> $config = array() ]) : mixed
Parameters
$folder_id : string

Id of the folder.

$hierarchy : int

New hierarchy for the folder. (0 - Parent; 1 - Child)

$config : array<string|int, mixed> = array()

Contains any additional control parameters. Can be null.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

changeFolderPosition()

Place the folder above the reference folder.

public changeFolderPosition(string $folder_id, string $reference_folder_id[, array<string|int, mixed> $config = array() ]) : mixed
Parameters
$folder_id : string

Id of the folder.

$reference_folder_id : string

Id of the reference folder.

$config : array<string|int, mixed> = array()

Contains any additional control parameters. Can be null.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

changeWorkspaceUserRole()

Change role of the specified users in the workspace.

public changeWorkspaceUserRole(array<string|int, mixed> $email_ids, string $role[, array<string|int, mixed> $config = array() ]) : mixed
Parameters
$email_ids : array<string|int, mixed>

The email address of the users.

$role : string

Name of the role.

$config : array<string|int, mixed> = array()

Contains any additional control parameters. Can be null.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

changeWorkspaceUserStatus()

Change users staus in the specified workspace.

public changeWorkspaceUserStatus(array<string|int, mixed> $email_ids, string $operation[, array<string|int, mixed> $config = array() ]) : mixed
Parameters
$email_ids : array<string|int, mixed>

The email address of the users.

$operation : string

New status for the users ( Values - activate | deactivate )

$config : array<string|int, mixed> = array()

Contains any additional control parameters. Can be null.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

copy()

Copy the specified workspace from one organization to another or within the organization.

public copy(string $new_workspace_name[, array<string|int, mixed> $config = array() ][, string $dest_org_id = NULL ]) : string
Parameters
$new_workspace_name : string

Name of the new workspace.

$config : array<string|int, mixed> = array()

Contains any additional control parameters. Can be null.

$dest_org_id : string = NULL

Id of the organization where the destination workspace is present. Can be null.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

Return values
string

Copied workspace id.

copyViews()

Copy the specified views from one workspace to another workspace.

public copyViews(array<string|int, mixed> $view_ids, string $dest_workspace_id[, array<string|int, mixed> $config = array() ][, string $dest_org_id = NULL ]) : array<string|int, mixed>
Parameters
$view_ids : array<string|int, mixed>

The id of the views to be copied.

$dest_workspace_id : string

The destination workspace id.

$config : array<string|int, mixed> = array()

Contains any additional control parameters. Can be null.

$dest_org_id : string = NULL

Id of the organization where the destination workspace is present. Can be null.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

Return values
array<string|int, mixed>

View list.

createReport()

Create a report in the specified workspace.

public createReport([array<string|int, mixed> $config = array() ]) : string
Parameters
$config : array<string|int, mixed> = array()

Contains the control parameters.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

Return values
string

Created view id.

createEmailSchedule()

Create an email schedule in the specified workspace.

public createEmailSchedule(string $schedule_name, array<string|int, mixed> $view_ids, string $format, array<string|int, mixed> $email_ids, array<string|int, mixed> $schedule_details[, array<string|int, mixed> $config = array() ]) : string
Parameters
$schedule_name : string

Name of the email schedule.

$view_ids : array<string|int, mixed>

View ids to be mailed.

$format : string

The format in which the data has to be mailed.

$email_ids : array<string|int, mixed>

The recipients' email addresses for sending views.

$schedule_details : array<string|int, mixed>

Contains schedule frequency, date, and time info.

$config : array<string|int, mixed> = array()

Contains any additional control parameters. Can be null.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

Return values
string

Created email schedule id.

createFolder()

Create a folder in the specified workspace.

public createFolder(string $folder_name[, array<string|int, mixed> $config = array() ]) : string
Parameters
$folder_name : string

Name of the folder to be created.

$config : array<string|int, mixed> = array()

Contains any additional control parameters. Can be null.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

Return values
string

Created folder id.

createGroup()

Create a group in the specified workspace.

public createGroup(string $group_name, array<string|int, mixed> $email_ids[, array<string|int, mixed> $config = array() ]) : string
Parameters
$group_name : string

Name of the group.

$email_ids : array<string|int, mixed>

The email address of the users to be added to the group.

$config : array<string|int, mixed> = array()

Contains any additional control parameters. Can be null.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

Return values
string

Created group id.

createQueryTable()

Create a new query table in the workspace.

public createQueryTable(string $sql_query, string $query_table_name[, array<string|int, mixed> $config = array() ]) : string
Parameters
$sql_query : string

SQL query to construct the query table.

$query_table_name : string

Name of the query table to be created.

$config : array<string|int, mixed> = array()

Contains any additional control parameters. Can be null.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

Return values
string

Created query table id.

createSlideshow()

Create a slideshow in the specified workspace.

public createSlideshow(string $slide_name, array<string|int, mixed> $view_ids[, array<string|int, mixed> $config = array() ]) : string
Parameters
$slide_name : string

Name of the slideshow.

$view_ids : array<string|int, mixed>

Ids of the view to be included in the slideshow.

$config : array<string|int, mixed> = array()

Contains any additional control parameters. Can be null.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

Return values
string

Created slideshow id.

createTable()

Create a table in the specified workspace.

public createTable(array<string|int, mixed> $table_design) : string
Parameters
$table_design : array<string|int, mixed>

Table structure.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

Return values
string

Created table id.

createVariable()

Create a variable in the workspace.

public createVariable(string $variable_name, string $variable_datatype, string $variable_type[, array<string|int, mixed> $config = array() ]) : string
Parameters
$variable_name : string

Name of the variable to be created.

$variable_datatype : string

Datatype of the variable to be created.

$variable_type : string

Type of the variable to be created.

$config : array<string|int, mixed> = array()

Contains the control parameters.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

Return values
string

Created variable id.

delete()

Delete a specified workspace in the organization.

public delete() : mixed
Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

deleteEmailSchedule()

Delete the specified email schedule in the workspace.

public deleteEmailSchedule(string $schedule_id) : mixed
Parameters
$schedule_id : string

Id for the email schedule.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

deleteFolder()

Delete a specified folder in the workspace.

public deleteFolder(string $folder_id) : mixed
Parameters
$folder_id : string

Id of the folder.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

deleteGroup()

Delete a specified group.

public deleteGroup(string $group_id) : mixed
Parameters
$group_id : string

Id of the group.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

deleteSlideshow()

Delete a specified slideshow in the workspace.

public deleteSlideshow(string $slide_id) : mixed
Parameters
$slide_id : string

Id of the slideshow.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

deleteTrashView()

Delete the specified view permanently from trash.

public deleteTrashView(string $view_id[, array<string|int, mixed> $config = array() ]) : mixed
Parameters
$view_id : string

Id of the view.

$config : array<string|int, mixed> = array()

Contains any additional control parameters. Can be null.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

deleteVariable()

Delete the specified variable in the workspace.

public deleteVariable(string $variable_id) : mixed
Parameters
$variable_id : string

Id of the variable.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

disableDomainAccess()

Disable workspace from the specified white label domain.

public disableDomainAccess() : mixed
Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

editQueryTable()

Update the mentioned query table in the workspace.

public editQueryTable(string $view_id, string $sql_query[, array<string|int, mixed> $config = array() ]) : mixed
Parameters
$view_id : string

Id of the query table to be updated.

$sql_query : string

SQL query to construct the query table.

$config : array<string|int, mixed> = array()

Contains any additional control parameters. Can be null.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

enableDomainAccess()

Enable workspace to the specified white label domain.

public enableDomainAccess() : mixed
Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

exportAsTemplate()

Export the mentioned table (or) view data.

public exportAsTemplate(array<string|int, mixed> $view_ids, string $file_path[, array<string|int, mixed> $config = array() ]) : mixed
Parameters
$view_ids : array<string|int, mixed>

Ids of the view to be exported.

$file_path : string

Path of the file where the data exported to be stored. ( Should be in 'atpt' format )

$config : array<string|int, mixed> = array()

Contains any additional control parameters. Can be null.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

getAdmins()

Returns list of admins for the specified workspace.

public getAdmins() : array<string|int, mixed>
Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

Return values
array<string|int, mixed>

Workspace admin list.

getAggregateFormulaDependents()

Returns list of all dependent views and formulas for the specified aggregate formula.

public getAggregateFormulaDependents(string $formula_id) : array<string|int, mixed>
Parameters
$formula_id : string

Id for the aggregate formula.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

Return values
array<string|int, mixed>

Dependent details.

getAggregateFormulas()

Returns list of all aggregate formulas for the specified workspace.

public getAggregateFormulas([array<string|int, mixed> $config = array() ]) : array<string|int, mixed>
Parameters
$config : array<string|int, mixed> = array()

Contains any additional control parameters. Can be null.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

Return values
array<string|int, mixed>

Aggregate formula list.

getAggregateFormulaValue()

Returns the value of the aggregate formula.

public getAggregateFormulaValue(string $formula_id) : string
Parameters
$formula_id : string

Id for the aggregate formula.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

Return values
string

Aggregate formula value.

getBulkInstance()

Returns a new BulkAPI instance.

public getBulkInstance(string $org_id, string $workspace_id) : BulkAPI
Parameters
$org_id : string

The ID of the organization.

$workspace_id : string

The ID of the workspace.

Return values
BulkAPI

instance.

getConnectionTimeout()

Returns the timeout until a connection is established.A value of zero means the timeout is not used.

public getConnectionTimeout() : int
Return values
int

Connection timeout limit.

getDashboards()

Returns list of all accessible dashboards.

public getDashboards() : array<string|int, mixed>
Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

Return values
array<string|int, mixed>

Dashboard list.

getDatasources()

Returns list of datasources for the specified workspace.

public getDatasources() : array<string|int, mixed>
Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

Return values
array<string|int, mixed>

Datasource list.

getEmailSchedules()

Returns list of email schedules available in the specified workspace.

public getEmailSchedules() : array<string|int, mixed>
Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

Return values
array<string|int, mixed>

List of email schedules.

getFolders()

Returns list of all accessible folders for the specified workspace.

public getFolders() : array<string|int, mixed>
Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

Return values
array<string|int, mixed>

Folder list.

getGroupDetails()

Get the details of the specified group.

public getGroupDetails(string $group_id) : array<string|int, mixed>
Parameters
$group_id : string

Id of the group.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

Return values
array<string|int, mixed>

Details of the specified group.

getGroups()

Returns list of groups for the specified workspace.

public getGroups() : array<string|int, mixed>
Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

Return values
array<string|int, mixed>

Group list.

getOrgInstance()

Returns a new OrgAPI instance.

public getOrgInstance(string $org_id) : OrgAPI
Parameters
$org_id : string

The ID of the organization.

Return values
OrgAPI

instance.

getOrgs()

Returns list of all accessible organizations.

public getOrgs() : array<string|int, mixed>
Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

Return values
array<string|int, mixed>

Organization list.

getOwnedDashboards()

Returns list of owned dashboards.

public getOwnedDashboards() : array<string|int, mixed>
Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

Return values
array<string|int, mixed>

Dashboard list.

getOwnedWorkspaces()

Returns list of owned workspaces.

public getOwnedWorkspaces() : array<string|int, mixed>
Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

Return values
array<string|int, mixed>

Workspace list.

getReadTimeout()

Returns the timeout until waiting to read data. A value of zero means the timeout is not used. The default value is 15000.

public getReadTimeout() : int
Return values
int

Read timeout limit.

getRecentViews()

Returns list of recently accessed views.

public getRecentViews() : array<string|int, mixed>
Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

Return values
array<string|int, mixed>

View list.

getSecretKey()

Returns the secret key of the specified workspace.

public getSecretKey([array<string|int, mixed> $config = array() ]) : string
Parameters
$config : array<string|int, mixed> = array()

Contains any additional control parameters. Can be null.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

Return values
string

Workspace secret key.

getSharedDashboards()

Returns list of shared dashboards.

public getSharedDashboards() : array<string|int, mixed>
Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

Return values
array<string|int, mixed>

Dashboard list.

getSharedDetailsForViews()

Returns shared details of the specified views.

public getSharedDetailsForViews(array<string|int, mixed> $view_ids) : mixed
Parameters
$view_ids : array<string|int, mixed>

View ids for which sharing details are required.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

getSharedWorkspaces()

Returns list of shared workspaces.

public getSharedWorkspaces() : array<string|int, mixed>
Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

Return values
array<string|int, mixed>

Workspace list.

getShareInfo()

Returns shared details of the specified workspace.

public getShareInfo() : array<string|int, mixed>
Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

Return values
array<string|int, mixed>

Workspace share info.

getSlideshowDetails()

Returns details of the specified slideshow.

public getSlideshowDetails(string $slide_id) : array<string|int, mixed>
Parameters
$slide_id : string

Id of the slideshow.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

Return values
array<string|int, mixed>

Slideshow details.

getSlideshows()

Returns list of slideshows for the specified workspace.

public getSlideshows() : array<string|int, mixed>
Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

Return values
array<string|int, mixed>

Slideshow list.

getSlideshowUrl()

Returns slide URL to access the specified slideshow.

public getSlideshowUrl(string $slide_id[, array<string|int, mixed> $config = array() ]) : array<string|int, mixed>
Parameters
$slide_id : string

Id of the slideshow.

$config : array<string|int, mixed> = array()

Contains any additional control parameters. Can be null.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

Return values
array<string|int, mixed>

Slideshow URL.

getTrashViews()

Returns list of all views available in trash for the specified workspace.

public getTrashViews() : array<string|int, mixed>
Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

Return values
array<string|int, mixed>

Trash view list.

getVariableDetails()

Returns details of the specified variable.

public getVariableDetails(string $variable_id) : array<string|int, mixed>
Parameters
$variable_id : string

Id of the variable.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

Return values
array<string|int, mixed>

Variable details.

getVariables()

Returns list of variables for the specified workspace.

public getVariables() : array<string|int, mixed>
Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

Return values
array<string|int, mixed>

Variables list.

getViewDetails()

Returns details of the specified view.

public getViewDetails(string $view_id[, array<string|int, mixed> $config = array() ]) : array<string|int, mixed>
Parameters
$view_id : string

The ID of the view.

$config : array<string|int, mixed> = array()

Contains any additional control parameters. Can be null.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

Return values
array<string|int, mixed>

View details.

getViewInstance()

Returns a new ViewAPI instance.

public getViewInstance(string $org_id, string $workspace_id, string $view_id) : ViewAPI
Parameters
$org_id : string

The ID of the organization.

$workspace_id : string

The ID of the workspace.

$view_id : string

The ID of the view.

Return values
ViewAPI

instance.

getViews()

Returns list of all accessible views for the specified workspace.

public getViews([array<string|int, mixed> $config = array() ]) : array<string|int, mixed>
Parameters
$config : array<string|int, mixed> = array()

Contains any additional control parameters. Can be null.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

Return values
array<string|int, mixed>

View list.

getWorkspaceDetails()

Returns details of the specified workspace.

public getWorkspaceDetails(string $workspace_id) : array<string|int, mixed>
Parameters
$workspace_id : string

The ID of the workspace.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

Return values
array<string|int, mixed>

Workspace details.

getWorkspaceInstance()

Returns a new WorkspaceAPI instance.

public getWorkspaceInstance(string $org_id, string $workspace_id) : WorkspaceAPI
Parameters
$org_id : string

The ID of the organization.

$workspace_id : string

The ID of the workspace.

Return values
WorkspaceAPI

instance.

getWorkspaces()

Returns list of all accessible workspaces.

public getWorkspaces() : array<string|int, mixed>
Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

Return values
array<string|int, mixed>

Workspace list.

getWorkspaceUsers()

Returns list of users for the specified workspace.

public getWorkspaceUsers() : array<string|int, mixed>
Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

Return values
array<string|int, mixed>

User list.

makeDefaultFolder()

Make the specified folder as default.

public makeDefaultFolder(string $folder_id) : mixed
Parameters
$folder_id : string

Id of the folder.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

moveViewsToFolder()

Place the folder above the reference folder.

public moveViewsToFolder(string $folder_id, mixed $view_ids[, array<string|int, mixed> $config = array() ]) : mixed
Parameters
$folder_id : string

Id of the folder.

$view_ids : mixed
$config : array<string|int, mixed> = array()

Contains any additional control parameters. Can be null.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

removeAdmins()

Remove admins from the specified workspace.

public removeAdmins(array<string|int, mixed> $email_ids[, array<string|int, mixed> $config = array() ]) : mixed
Parameters
$email_ids : array<string|int, mixed>

The email address of the admin users to be removed.

$config : array<string|int, mixed> = array()

Contains any additional control parameters. Can be null.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

removeDefault()

Remove a specified workspace from default.

public removeDefault() : mixed
Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

removeFavorite()

Remove a specified workspace from favorite.

public removeFavorite() : mixed
Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

removeGroupMembers()

Remove users from the specified group.

public removeGroupMembers(string $group_id, array<string|int, mixed> $email_ids[, array<string|int, mixed> $config = array() ]) : mixed
Parameters
$group_id : string

Id of the group.

$email_ids : array<string|int, mixed>

The email address of the users to be removed from the group.

$config : array<string|int, mixed> = array()

Contains any additional control parameters. Can be null.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

removeShare()

Remove shared views for the specified users.

public removeShare(array<string|int, mixed> $view_ids, array<string|int, mixed> $email_ids[, array<string|int, mixed> $config = array() ]) : mixed
Parameters
$view_ids : array<string|int, mixed>

View ids whose sharing needs to be removed.

$email_ids : array<string|int, mixed>

The email address of the users to whom the sharing need to be removed.

$config : array<string|int, mixed> = array()

Contains any additional control parameters. Can be null.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

removeWorkspaceUsers()

Remove users from the specified workspace.

public removeWorkspaceUsers(array<string|int, mixed> $email_ids[, array<string|int, mixed> $config = array() ]) : mixed
Parameters
$email_ids : array<string|int, mixed>

The email address of the users to be removed.

$config : array<string|int, mixed> = array()

Contains any additional control parameters. Can be null.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

rename()

Rename a specified workspace in the organization.

public rename(string $workspace_name[, array<string|int, mixed> $config = array() ]) : mixed
Parameters
$workspace_name : string

New name for the workspace.

$config : array<string|int, mixed> = array()

Contains any additional control parameters. Can be null.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

renameFolder()

Rename a specified folder in the workspace.

public renameFolder(string $folder_id, string $folder_name[, array<string|int, mixed> $config = array() ]) : mixed
Parameters
$folder_id : string

Id of the folder.

$folder_name : string

New name for the folder.

$config : array<string|int, mixed> = array()

Contains any additional control parameters. Can be null.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

renameGroup()

Rename a specified group.

public renameGroup(string $group_id, string $new_group_name[, array<string|int, mixed> $config = array() ]) : mixed
Parameters
$group_id : string

Id of the group.

$new_group_name : string

New name for the group.

$config : array<string|int, mixed> = array()

Contains any additional control parameters. Can be null.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

restoreTrashView()

Restore the specified view from trash.

public restoreTrashView(string $view_id[, array<string|int, mixed> $config = array() ]) : mixed
Parameters
$view_id : string

Id of the view.

$config : array<string|int, mixed> = array()

Contains any additional control parameters. Can be null.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

setConnectionTimeout()

Sets the timeout until a connection is established. A value of zero means the timeout is not used. The default value is 15000.

public setConnectionTimeout(int $time_limit) : mixed
Parameters
$time_limit : int

An integer value.

setProxy()

Used to specify the proxy server details.

public setProxy(string $proxy_host, int $proxy_port, string $proxy_type, string $proxy_user_name, string $proxy_password) : mixed
Parameters
$proxy_host : string

The hostname/ip address of the proxy-server.

$proxy_port : int

The proxy server port.

$proxy_type : string

Can be any one ( HTTP , HTTPS , BOTH ).Specify "BOTH" if same configuration can be used for both HTTP and HTTPS.

$proxy_user_name : string

The user name for proxy-server authentication.

$proxy_password : string

The password for proxy-server authentication.

setReadTimeout()

Sets the timeout until waiting to read data. A value of zero means the timeout is not used. The default value is 15000.

public setReadTimeout(int $time_limit) : mixed
Parameters
$time_limit : int

An integer value.

shareViews()

Share views to the specified users.

public shareViews(array<string|int, mixed> $view_ids, array<string|int, mixed> $email_ids, array<string|int, mixed> $permissions[, array<string|int, mixed> $config = array() ]) : mixed
Parameters
$view_ids : array<string|int, mixed>

View ids which to be shared.

$email_ids : array<string|int, mixed>

The email address of the users to whom the views need to be shared.

$permissions : array<string|int, mixed>

Contains permission details.

$config : array<string|int, mixed> = array()

Contains any additional control parameters. Can be null.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

syncData()

Initiate data sync for the specified datasource.

public syncData(string $datasource_id[, array<string|int, mixed> $config = array() ]) : mixed
Parameters
$datasource_id : string

Id of the datasource.

$config : array<string|int, mixed> = array()

Contains any additional control parameters. Can be null.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

triggerEmailSchedule()

Trigger configured email schedules instantly.

public triggerEmailSchedule(string $schedule_id) : mixed
Parameters
$schedule_id : string

Id for the email schedule.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

updateReport()

Update the design and configuration of the specified report.

public updateReport(string $view_id[, array<string|int, mixed> $config = array() ]) : mixed
Parameters
$view_id : string

Id of the view.

$config : array<string|int, mixed> = array()

Contains the control parameters.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

updateDatasourceConnection()

Update connection details for the specified datasource.

public updateDatasourceConnection(string $datasource_id[, array<string|int, mixed> $config = array() ]) : mixed
Parameters
$datasource_id : string

Id of the datasource.

$config : array<string|int, mixed> = array()

Contains the control parameters.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

updateEmailSchedule()

Update configurations of the specified email schedule in the workspace.

public updateEmailSchedule(string $schedule_id, array<string|int, mixed> $config) : string
Parameters
$schedule_id : string

Id for the email schedule.

$config : array<string|int, mixed>

Contains the control configurations.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

Return values
string

Updated schedule id.

updateSlideshow()

Update details of the specified slideshow.

public updateSlideshow(string $slide_id[, array<string|int, mixed> $config = array() ]) : string
Parameters
$slide_id : string

Id of the slideshow.

$config : array<string|int, mixed> = array()

Contains the control configurations

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.

Return values
string

Created slideshow id.

updateVariable()

Update details of the specified variable in the workspace.

public updateVariable(string $variable_id, string $variable_name, string $variable_datatype, string $variable_type[, array<string|int, mixed> $config = array() ]) : mixed
Parameters
$variable_id : string

Id of the variable.

$variable_name : string

New name for the variable.

$variable_datatype : string

New datatype for the variable.

$variable_type : string

New type for the variable.

$config : array<string|int, mixed> = array()

Contains the control parameters.

Tags
throws
IOException

If any communication related error(s) like request time out occurs when trying to contact the service.

throws
ServerException

If the server has received the request but did not process the request due to some error.

throws
ParseException

If the server has responded but client was not able to parse the response.


        
On this page

Search results