Class ViewAPI

ViewAPI contains view level operations.

Inheritance

System.Object

ViewAPI

Implements

IViewAPI

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: ZohoAnalytics

Assembly: ZohoAnalytics.dll

Syntax

public class ViewAPI : IViewAPI

Methods

AddAggregateFormula(String, String, Dictionary<String, Object>)

Add a aggregate formula in the specified table.

Declaration

public long AddAggregateFormula(string formulaName, string expression, Dictionary<string, object> config)

Parameters

Type	Name	Description
System.String	formulaName	Name of the formula to be created.
System.String	expression	Formula expression.
Dictionary<System.String, System.Object>	config	Contains any additional control configurations. Can be null.

Returns

Type	Description
System.Int64	Formula id.

AddColumn(String, String, Dictionary<String, Object>)

Add a column in the specified table.

Declaration

public long AddColumn(string columnName, string dataType, Dictionary<string, object> config)

Parameters

Type	Name	Description
System.String	columnName	The name of the column.
System.String	dataType	The data-type of the column.
Dictionary<System.String, System.Object>	config	Contains any additional control configurations. Can be null.

Returns

Type	Description
System.Int64	Column id.

AddFavorite()

Adds a specified view as favourite.

Declaration

public void AddFavorite()

AddFormulaColumn(String, String, Dictionary<String, Object>)

Add a formula column in the specified table.

Declaration

public long AddFormulaColumn(string formulaName, string expression, Dictionary<string, object> config)

Parameters

Type	Name	Description
System.String	formulaName	Name of the formula column to be created.
System.String	expression	Formula expression.
Dictionary<System.String, System.Object>	config	Contains any additional control configurations. Can be null.

Returns

Type	Description
System.Int64	Formula id.

AddLookup(Int64, Int64, Int64, Dictionary<String, Object>)

Add a lookup in the specified child table.

Declaration

public void AddLookup(long columnId, long refViewId, long refColumnId, Dictionary<string, object> config)

Parameters

Type	Name	Description
System.Int64	columnId	The id of the column.
System.Int64	refViewId	The ID of the table contains the parent column.
System.Int64	refColumnId	The ID of the parent column.
Dictionary<System.String, System.Object>	config	Contains any additional control configurations. Can be null.

AddRow(Dictionary<String, String>, Dictionary<String, Object>)

Add a single row in the specified table.

Declaration

public JsonElement AddRow(Dictionary<string, string> columnValues, Dictionary<string, object> config)

Parameters

Type	Name	Description
Dictionary<System.String, System.String>	columnValues	Contains the values for the row. The column names are the key.
Dictionary<System.String, System.Object>	config	Contains any additional control configurations. Can be null.

Returns

Type	Description
System.Text.Json.JsonElement	Added rows details.

AutoAnalyse(Dictionary<String, Object>)

Auto generate reports for the specified table.

Declaration

public void AutoAnalyse(Dictionary<string, object> config)

Parameters

Type	Name	Description
Dictionary<System.String, System.Object>	config	Contains any additional control configurations. Can be null.

AutoAnalyseColumn(Int64, Dictionary<String, Object>)

Auto generate reports for the specified column.

Declaration

public void AutoAnalyseColumn(long columnId, Dictionary<string, object> config)

Parameters

Type	Name	Description
System.Int64	columnId	The id of the column.
Dictionary<System.String, System.Object>	config	Contains any additional control configurations. Can be null.

CopyFormulas(List<String>, Int64, Dictionary<String, Object>, Nullable<Int64>)

Copy the specified formulas from one table to another within the workspace or across workspaces.

Declaration

public void CopyFormulas(List<string> formulaNames, long destWorkspaceId, Dictionary<string, object> config, long? destOrgId)

Parameters

Type	Name	Description
List<System.String>	formulaNames	The name of the formula columns to be copied.
System.Int64	destWorkspaceId	The ID of the destination workspace.
Dictionary<System.String, System.Object>	config	Contains any additional control configurations. Can be null.
System.Nullable<System.Int64>	destOrgId	Id of the organization where the destination workspace is present. Can be null.

CreatePrivateURL(Dictionary<String, Object>)

Create a private URL for the specified view.

Declaration

public string CreatePrivateURL(Dictionary<string, object> config)

Parameters

Type	Name	Description
Dictionary<System.String, System.Object>	config	Contains any additional control configurations. Can be null.

Returns

Type	Description
System.String	Private URL.

CreateSimilarViews(Int64, Int64, Dictionary<String, Object>)

Create reports for the specified table based on the reference table.

Declaration

public void CreateSimilarViews(long refViewId, long folderId, Dictionary<string, object> config)

Parameters

Type	Name	Description
System.Int64	refViewId	The ID of the reference view.
System.Int64	folderId	The folder id where the views to be saved.
Dictionary<System.String, System.Object>	config	Contains any additional control configurations. Can be null.

Delete(Dictionary<String, Object>)

Delete a specified view in the workspace.

Declaration

public void Delete(Dictionary<string, object> config)

Parameters

Type	Name	Description
Dictionary<System.String, System.Object>	config	Contains any additional control configurations. Can be null.

DeleteAggregateFormula(Int64, Dictionary<String, Object>)

Delete the specified aggregate formula.

Declaration

public void DeleteAggregateFormula(long formulaId, Dictionary<string, object> config)

Parameters

Type	Name	Description
System.Int64	formulaId	Id of the formula column to be deleted.
Dictionary<System.String, System.Object>	config	Contains any additional control configurations. Can be null.

DeleteColumn(Int64, Dictionary<String, Object>)

Delete a specified column in the table.

Declaration

public void DeleteColumn(long columnId, Dictionary<string, object> config)

Parameters

Type	Name	Description
System.Int64	columnId	The id of the column.
Dictionary<System.String, System.Object>	config	Contains any additional control configurations. Can be null.

DeleteFormulaColumn(Int64, Dictionary<String, Object>)

Delete the specified formula column.

Declaration

public void DeleteFormulaColumn(long formulaId, Dictionary<string, object> config)

Parameters

Type	Name	Description
System.Int64	formulaId	Id of the formula column to be deleted.
Dictionary<System.String, System.Object>	config	Contains any additional control configurations. Can be null.

DeleteRow(String, Dictionary<String, Object>)

Delete rows in the specified table.

Declaration

public int DeleteRow(string criteria, Dictionary<string, object> config)

Parameters

Type	Name	Description
System.String	criteria	The criteria to be applied for deleting data. Only rows matching the criteria will be deleted. Should be null for delete all rows.
Dictionary<System.String, System.Object>	config	Contains any additional control configurations. Can be null.

Returns

Type	Description
System.Int32	Deleted rows count.

EditAggregateFormula(Int64, String, Dictionary<String, Object>)

Edit the specified aggregate formula.

Declaration

public void EditAggregateFormula(long formulaId, string expression, Dictionary<string, object> config)

Parameters

Type	Name	Description
System.Int64	formulaId	Id of the aggregate formula to be updated.
System.String	expression	Formula expression.
Dictionary<System.String, System.Object>	config	Contains any additional control configurations. Can be null.

EditFormulaColumn(Int64, String, Dictionary<String, Object>)

Edit the specified formula column.

Declaration

public void EditFormulaColumn(long formulaId, string expression, Dictionary<string, object> config)

Parameters

Type	Name	Description
System.Int64	formulaId	Id of the formula column to be updated.
System.String	expression	Formula expression.
Dictionary<System.String, System.Object>	config	Contains any additional control configurations. Can be null.

GetAggregateFormulas()

Returns list of all aggregate formulas for the specified table.

Declaration

public JsonElement GetAggregateFormulas()

Returns

Type	Description
System.Text.Json.JsonElement	Aggregate formula list

GetColumnDependents(Int64)

Returns list of dependents views and formulas for the specified column.

Declaration

public JsonElement GetColumnDependents(long columnId)

Parameters

Type	Name	Description
System.Int64	columnId	Id of the column.

Returns

Type	Description
System.Text.Json.JsonElement	Dependent details.

GetEmbedURL(Dictionary<String, Object>)

Returns embed URL to access the specified view.

Declaration

public string GetEmbedURL(Dictionary<string, object> config)

Parameters

Type	Name	Description
Dictionary<System.String, System.Object>	config	Contains any additional control configurations. Can be null.

Returns

Type	Description
System.String	Embed URL.

GetFormulaColumns()

Returns list of all formula columns for the specified table.

Declaration

public JsonElement GetFormulaColumns()

Returns

Type	Description
System.Text.Json.JsonElement	Formula list

GetLastImportDetails()

Returns last import details of the specified view.

Declaration

public JsonElement GetLastImportDetails()

Returns

Type	Description
System.Text.Json.JsonElement	Last import details.

GetMyPermissions()

Returns permissions for the specified view.

Declaration

public JsonElement GetMyPermissions()

Returns

Type	Description
System.Text.Json.JsonElement	Permission details.

GetPrivateURL(Dictionary<String, Object>)

Returns private URL to access the specified view.

Declaration

public string GetPrivateURL(Dictionary<string, object> config)

Parameters

Type	Name	Description
Dictionary<System.String, System.Object>	config	Contains any additional control configurations. Can be null.

Returns

Type	Description
System.String	Private URL.

GetPublishConfigurations()

Returns publish configurations for the specified view.

Declaration

public JsonElement GetPublishConfigurations()

Returns

Type	Description
System.Text.Json.JsonElement	Publish details.

GetViewDependents()

Returns list of dependents views for the specified view.

Declaration

public JsonElement GetViewDependents()

Returns

Type	Description
System.Text.Json.JsonElement	Dependent view list.

GetViewURL(Dictionary<String, Object>)

Returns the URL to access the specified view.

Declaration

public string GetViewURL(Dictionary<string, object> config)

Parameters

Type	Name	Description
Dictionary<System.String, System.Object>	config	Contains any additional control configurations. Can be null.

Returns

Type	Description
System.String	View URL.

HideColumns(List<Int64>)

Hide the specified columns in the table.

Declaration

public void HideColumns(List<long> columnIds)

Parameters

Type	Name	Description
List<System.Int64>	columnIds	The array of column ids to be hidden.

MakeViewPublic(Dictionary<String, Object>)

Make the specified view publically accessible.

Declaration

public string MakeViewPublic(Dictionary<string, object> config)

Parameters

Type	Name	Description
Dictionary<System.String, System.Object>	config	Contains any additional control configurations. Can be null.

Returns

Type	Description
System.String	View URL.

RefetchData(Dictionary<String, Object>)

Sync data from available datasource for the specified view.

Declaration

public void RefetchData(Dictionary<string, object> config)

Parameters

Type	Name	Description
Dictionary<System.String, System.Object>	config	Contains any additional control configurations. Can be null.

RemoveFavorite()

Remove a specified view from favourite.

Declaration

public void RemoveFavorite()

RemoveLookup(Int64, Dictionary<String, Object>)

Remove the lookup for the specified column in the table.

Declaration

public void RemoveLookup(long columnId, Dictionary<string, object> config)

Parameters

Type	Name	Description
System.Int64	columnId	The id of the column.
Dictionary<System.String, System.Object>	config	Contains any additional control configurations. Can be null.

RemovePrivateAccess()

Remove private link access for the specified view.

Declaration

public void RemovePrivateAccess()

RemovePublicAccess()

Remove public access for the specified view.

Declaration

public void RemovePublicAccess()

Rename(String, Dictionary<String, Object>)

Rename a specified view in the workspace.

Declaration

public void Rename(string newViewName, Dictionary<string, object> config)

Parameters

Type	Name	Description
System.String	newViewName	The new name of the view.
Dictionary<System.String, System.Object>	config	Contains any additional control configurations. Can be null.

RenameColumn(Int64, String)

Rename a specified column in the table.

Declaration

public void RenameColumn(long columnId, string columnName)

Parameters

Type	Name	Description
System.Int64	columnId	The id of the column.
System.String	columnName	The new name of the column.

SaveAs(String, Dictionary<String, Object>)

Copy a specified view within the workspace.

Declaration

public long SaveAs(string newViewName, Dictionary<string, object> config)

Parameters

Type	Name	Description
System.String	newViewName	The name of the new view.
Dictionary<System.String, System.Object>	config	Contains any additional control configurations. Can be null.

Returns

Type	Description
System.Int64	View id.

ShowColumns(List<Int64>)

Show the specified hidden columns in the table.

Declaration

public void ShowColumns(List<long> columnIds)

Parameters

Type	Name	Description
List<System.Int64>	columnIds	The array of column ids to be shown.

UpdatePublishConfigurations(Dictionary<String, Object>)

Update publish configurations for the specified view.

Declaration

public void UpdatePublishConfigurations(Dictionary<string, object> config)

Parameters

Type	Name	Description
Dictionary<System.String, System.Object>	config	Contains the control configurations.

UpdateRow(Dictionary<String, String>, String, Dictionary<String, Object>)

Update rows in the specified table.

Declaration

public JsonElement UpdateRow(Dictionary<string, string> columnValues, string criteria, Dictionary<string, object> config)

Parameters

Type	Name	Description
Dictionary<System.String, System.String>	columnValues	Contains the values for the row. The column names are the key.
System.String	criteria	The criteria to be applied for updating data. Only rows matching the criteria will be updated. Should be null for update all rows.
Dictionary<System.String, System.Object>	config	Contains any additional control configurations. Can be null.

Returns

Type	Description
System.Text.Json.JsonElement	Updated rows details.

UpdateSharedDetails(Dictionary<String, Object>)

Update the existing sharing configuration for views.

Declaration

public void UpdateSharedDetails(Dictionary<string, object> config)

Parameters

Type	Name	Description
Dictionary<System.String, System.Object>	config	Contains the control configurations.

Implements

IViewAPI