Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Zoho

Zoho Modeling APIs API

Modeling APIs manage workspaces, views, columns, and folders, and support copying across or within Zoho Analytics accounts.

Documentation Provider Profile APIs.io OpenAPI GitHub

Zoho Modeling APIs API is one of 205 APIs that Zoho publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Modeling APIs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and code examples.

This API exposes 58 operations across 45 paths, and defines 71 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

58 operations 45 paths 71 schemas 13 DELETE2 GET25 POST18 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Authentication
custom
Resource Areas
1

Authentication & Security 1

Zoho Modeling APIs API declares 1 security scheme for authenticating requests. It defines a custom scheme (iam-oauth2-schema).

Paths & Operations 58

Across 45 paths, the API surfaces 58 operations — 13 DELETE, 2 GET, 25 POST, 18 PUT. Each is listed below with its method, path, parameters, and response codes.

Modeling APIs 58

Modeling APIs manage workspaces, views, columns, and folders, and support copying across or within Zoho Analytics accounts.

POST
/restapi/v2/workspaces
Create Workspace
createWorkspace 1 param body → 200default
POST
/restapi/v2/workspaces/{workspace-id}
Copy Workspace
copyWorkspace 3 params body → 200default
PUT
/restapi/v2/workspaces/{workspace-id}
Rename Workspace
renameWorkspace 2 params body → 204default
DELETE
/restapi/v2/workspaces/{workspace-id}
Delete Workspace
deleteWorkspace 2 params → 204default
POST
/restapi/v2/workspaces/{workspace-id}/tables
Create Table
createTable 2 params body → 200default
POST
/restapi/v2/workspaces/{workspace-id}/querytables
Create Query Table
createQueryTable 2 params body → 200default
PUT
/restapi/v2/workspaces/{workspace-id}/querytables/{table-id}
Edit Query Table
editQueryTable 3 params body → 204default
POST
/restapi/v2/workspaces/{workspace-id}/reports
Create Report
createReport 2 params body → 200default
PUT
/restapi/v2/workspaces/{workspace-id}/reports/{report-id}
Update Report
updateReport 3 params body → 204default
POST
/restapi/v2/workspaces/{workspace-id}/views/{view-id}/saveas
Save As View
saveAsView 3 params body → 200default
PUT
/restapi/v2/workspaces/{workspace-id}/views/movetofolder
Move Views To Folder
moveViewsToFolder 2 params body → 204default
PUT
/restapi/v2/workspaces/{workspace-id}/views/{view-id}
Rename View
renameView 3 params body → 204default
DELETE
/restapi/v2/workspaces/{workspace-id}/views/{view-id}
Delete View
deleteView 3 params body → 204default
POST
/restapi/v2/workspaces/{workspace-id}/trash/{view-id}
Restore Trash View
restoreTrashView 3 params body → 204default
DELETE
/restapi/v2/workspaces/{workspace-id}/trash/{view-id}
Delete Trash View
deleteTrashView 3 params body → 204default
POST
/restapi/v2/workspaces/{workspace-id}/folders
Create Folder
createFolder 2 params body → 200default
PUT
/restapi/v2/workspaces/{workspace-id}/folders/{folder-id}
Rename Folder
renameFolder 3 params body → 204default
DELETE
/restapi/v2/workspaces/{workspace-id}/folders/{folder-id}
Delete Folder
deleteFolder 3 params body → 204default
POST
/restapi/v2/workspaces/{workspace-id}/folders/{folder-id}/default
Make Default Folder
makeDefaultFolder 3 params → 204default
PUT
/restapi/v2/workspaces/{workspace-id}/folders/{folder-id}/move
Change Folder Hierarchy
changeFolderHierarchy 3 params body → 204default
PUT
/restapi/v2/workspaces/{workspace-id}/folders/{folder-id}/reorder
Change Folder Position
changeFolderPosition 3 params body → 204default
PUT
/restapi/v2/workspaces/{workspace-id}/views/{view-id}/data/sort
Sort Data by Columns
sortDataByColumns 3 params body → 204default
POST
/restapi/v2/workspaces/{workspace-id}/views/{view-id}/columns
Add Column
addColumn 3 params body → 200default
PUT
/restapi/v2/workspaces/{workspace-id}/views/{view-id}/columns/{column-id}
Rename Column
renameColumn 4 params body → 204default
DELETE
/restapi/v2/workspaces/{workspace-id}/views/{view-id}/columns/{column-id}
Delete Column
deleteColumn 4 params body → 204default
POST
/restapi/v2/workspaces/{workspace-id}/views/{view-id}/columns/{column-id}/lookup
Add Lookup
addLookup 4 params body → 204default
DELETE
/restapi/v2/workspaces/{workspace-id}/views/{view-id}/columns/{column-id}/lookup
Remove Lookup
removeLookup 4 params body → 204default
PUT
/restapi/v2/workspaces/{workspace-id}/views/{view-id}/columns/hide
Hide Columns
hideColumns 3 params body → 204default
PUT
/restapi/v2/workspaces/{workspace-id}/views/{view-id}/columns/show
Show Columns
showColumns 3 params body → 204default
PUT
/restapi/v2/workspaces/{workspace-id}/views/{view-id}/columns/reorder
Reorder Columns
reorderColumns 3 params body → 204default
POST
/restapi/v2/workspaces/{source-workspace-id}/views/copy
Copy Views
copyViews 3 params body → 200default
POST
/restapi/v2/workspaces/{workspace-id}/views/{view-id}/formulas/copy
Copy Formulas
copyFormulas 4 params body → 204default
POST
/restapi/v2/workspaces/{workspace-id}/views/{view-id}/similarviews
Create Similar Views
createSimilarViews 3 params body → 204default
POST
/restapi/v2/workspaces/{workspace-id}/views/{view-id}/autoanalyse
Auto Analyse View
autoAnalyseView 3 params body → 204default
POST
/restapi/v2/workspaces/{workspace-id}/views/{view-id}/columns/{column-id}/autoanalyse
Auto Analyse Column
autoAnalyseColumn 4 params → 204default
GET
/restapi/v2/workspaces/{workspace-id}/variables
Get all variables in a workspace
getVariables 2 params → 200default
POST
/restapi/v2/workspaces/{workspace-id}/variables
Create a variable
createVariable 2 params body → 200default
GET
/restapi/v2/workspaces/{workspace-id}/variables/{variable-id}
Get details of a specific variable
getVariableDetails 3 params → 200default
PUT
/restapi/v2/workspaces/{workspace-id}/variables/{variable-id}
Update a variable
updateVariable 3 params body → 204default
DELETE
/restapi/v2/workspaces/{workspace-id}/variables/{variable-id}
Delete a variable
deleteVariable 3 params → 204default
POST
/restapi/v2/workspaces/{workspace-id}/views/{view-id}/customformulas
Add Formula Column
addFormulaColumn 3 params body → 200default
PUT
/restapi/v2/workspaces/{workspace-id}/views/{view-id}/customformulas/{formula-id}
Edit Formula Column
editFormulaColumn 4 params body → 204default
DELETE
/restapi/v2/workspaces/{workspace-id}/views/{view-id}/customformulas/{formula-id}
Delete Formula Column
deleteFormulaColumn 4 params body → 204default
POST
/restapi/v2/workspaces/{workspace-id}/views/{view-id}/aggregateformulas
Add Aggregate Formula
addAggregateFormula 3 params body → 200default
PUT
/restapi/v2/workspaces/{workspace-id}/views/{view-id}/aggregateformulas/{formula-id}
Edit Aggregate Formula
editAggregateFormula 4 params body → 204default
DELETE
/restapi/v2/workspaces/{workspace-id}/views/{view-id}/aggregateformulas/{formula-id}
Delete Aggregate Formula
deleteAggregateFormula 4 params body → 204default
POST
/restapi/v2/workspaces/{workspace-id}/views/{view-id}/emailschedules
Create Email Schedule
createEmailSchedule 4 params → 200default
PUT
/restapi/v2/workspaces/{workspace-id}/views/{view-id}/emailschedules/{schedule-id}
Update Email Schedule
updateEmailSchedule 5 params → 200default
DELETE
/restapi/v2/workspaces/{workspace-id}/views/{view-id}/emailschedules/{schedule-id}
Delete Email Schedule
deleteEmailSchedule 4 params → 204default
POST
/restapi/v2/workspaces/{workspace-id}/views/{view-id}/emailschedules/{schedule-id}/trigger
Trigger Email Schedule
triggerEmailSchedule 4 params → 204default
PUT
/restapi/v2/workspaces/{workspace-id}/views/{view-id}/emailschedules/{schedule-id}/status
Change Email Schedule Status
changeEmailScheduleStatus 5 params → 204default
POST
/restapi/v2/automl/workspaces/{workspace-id}/analysis
Create AutoML Analysis
createAutoMLAnalysis 2 params body → 200default
POST
/restapi/v2/automl/workspaces/{workspace-id}/analysis/{analysis-id}/models/{model-id}/deployments
Create AutoML Analysis Deployment
createAutoMLAnalysisDeployment 4 params body → 200default
POST
/restapi/v2/automl/workspaces/{workspace-id}/analysis/{analysis-id}/models/{model-id}/whatif
AutoML What If Analysis
autoMLWhatIfAnalysis 4 params body → 200default
POST
/restapi/v2/automl/workspaces/{workspace-id}/analysis/{analysis-id}/deployments/{deployment-id}/execute
Run AutoML Analysis
runAutoMLAnalysis 4 params → 204default
DELETE
/restapi/v2/automl/workspaces/{workspace-id}/analysis/{analysis-id}/deployments/{deployment-id}
Delete AutoML Analysis Model Deployment
deleteAutoMLAnalysisModelDeployment 4 params → 204default
DELETE
/restapi/v2/automl/workspaces/{workspace-id}/analysis/{analysis-id}/models/{model-id}
Delete AutoML Analysis Model
deleteAutoMLAnalysisModel 4 params → 204default
DELETE
/restapi/v2/automl/workspaces/{workspace-id}/analysis/{analysis-id}
Delete AutoML Analysis
deleteAutoMLAnalysis 3 params → 204default

Schemas 71

The contract defines 71 schemas that model the data the API accepts and returns. The most detailed are CreateEmailScheduleConfig (11 properties), CreateReportConfig (10 properties), CreateAutoMLAnalysisDeploymentConfig (9 properties), ColumnDesign (9 properties). Each schema is shown below with its type and property counts.

DeleteTrashViewConfig
object
1 property
RenameViewConfig
object
2 properties 1 required
CreateQueryTableConfig
object
4 properties 2 required
CopyViewsConfig
object
5 properties 2 required
AddFormulaColumnResponse
object
3 properties
GetVariablesResponse
object
3 properties
CreateAutoMLAnalysisResponse
object
3 properties
CreateReportResponse
object
3 properties
SaveAsViewConfig
object
5 properties 1 required
ChangeEmailScheduleStatusConfig
object
1 property 1 required
AxisColumn
object
3 properties 3 required
GetVariableDetailsResponse
object
3 properties
FilterColumn
object
3 properties 3 required
UserSpecificVariableData
object
7 properties
CreateEmailScheduleConfig
object
11 properties 4 required
CreateTableResponse
object
3 properties
ChangeFolderHierarchyConfig
object
2 properties 1 required
LookupColumnDesign
object
2 properties 2 required
DeleteAggregateFormulaConfig
object
1 property
SaveAsViewResponse
object
3 properties
RenameColumnConfig
object
1 property 1 required
DeleteColumnConfig
object
1 property
AddFormulaColumnConfig
object
3 properties 2 required
CreateFolderConfig
object
4 properties 1 required
CreateReportConfig
object
10 properties 4 required
CopyViewsResponse
object
3 properties
UpdateEmailScheduleResponse
object
3 properties
CopyWorkspaceResponse
object
3 properties
EditQueryTableConfig
object
2 properties 1 required
UpdateEmailScheduleConfig
object
7 properties 2 required
CreateAutoMLAnalysisConfig
object
8 properties 6 required
ColumnDesign
object
9 properties 2 required
MoveViewsToFolderConfig
object
2 properties 2 required
AddColumnResponse
object
3 properties
CreateVariableResponse
object
3 properties
AddColumnConfig
object
4 properties 2 required
VariableFormat
object
8 properties
RenameFolderConfig
object
2 properties 1 required
ChangeFolderPositionConfig
object
1 property 1 required
DeleteFolderConfig
object
1 property
CreateWorkspaceConfig
object
2 properties 1 required
VariableConfig
object
6 properties 3 required
CopyWorkspaceConfig
object
5 properties 1 required
CreateTableConfig
object
1 property 1 required
CreateWorkspaceResponse
object
3 properties
DeleteViewConfig
object
1 property
EditAggregateFormulaConfig
object
2 properties 1 required
CreateFolderResponse
object
3 properties
AddAggregateFormulaConfig
object
3 properties 2 required
CreateQueryTableResponse
object
3 properties
AddLookupConfig
object
2 properties 2 required
ReorderColumnsConfig
object
1 property 1 required
RenameWorkspaceConfig
object
1 property 1 required
EditFormulaColumnConfig
object
2 properties 1 required
CopyFormulasConfig
object
3 properties 2 required
UpdateReportConfig
object
8 properties 1 required
RestoreTrashViewConfig
object
1 property
RemoveLookupConfig
object
1 property
SortDataByColumnsConfig
object
3 properties 2 required
CreateSimilarViewsConfig
object
Configuration for creating similar views based on a reference view.
4 properties 2 required
CreateAutoMLAnalysisDeploymentResponse
object
3 properties
DeleteFormulaColumnConfig
object
1 property
HideShowColumnConfig
object
1 property 1 required
CreateAutoMLAnalysisDeploymentConfig
object
9 properties 7 required
AutoAnalyseViewConfig
object
Configuration for auto-analysing a view.
1 property
DefaultVariableData
object
5 properties
TableDesign
object
4 properties 2 required
CreateEmailScheduleResponse
object
3 properties
AutoMLWhatIfAnalysisResponse
object
3 properties
AutoMLWhatIfAnalysisConfig
object
1 property 1 required
AddAggregateFormulaResponse
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zoho-modeling-apis-api-openapi.yml Raw ↑

Other APIs Zoho publishes across the network.

Zoho Inventory
AE Profile APIs.io
Zoho Books
AE Profile APIs.io
Zoho Invoice
AE Profile APIs.io
Zoho Billing
AE Profile APIs.io
Zoho Expense
AE Profile APIs.io
Zoho People
AE Profile APIs.io
Zoho Recruit
AE Profile APIs.io
Zoho Projects
AE Profile APIs.io
Zoho Mail
AE Profile APIs.io
Zoho Sign
AE Profile APIs.io
Zoho Campaigns
AE Profile APIs.io
Zoho SalesIQ
AE Profile APIs.io
#Modeling APIs
← Back to Z APIs
API Details
ID
zoho:zoho-modeling-apis-api
Docs
https://www.zoho.com/inventory/api/v1/introduction/
Provider
Zoho
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network