Analytics-Plus Help

Modeling API

This section lists all the modeling APIs. Modeling APIs can be used to add, delete & rename columns in a Analytics Plus table. It also offers APIs to copy objects (databases, reports and formulas) from one database to another present in the same account or across different accounts.

 

Copy Database

The Copy Database API is used to copy the database from one Analytics Plus Account to another Analytics Plus Account.

 

URL

https://<server_hostname>:<portnumber>/api/<Email>/<Databasename>

 

URL PARAMETERS

Parameter NamePossible ValuesDescription
ZOHO_ACTIONCOPYDATABASEThis parameter specifies the action to be performed by the API request.
ZOHO_OUTPUT_FORMATXML/JSONThis parameter specifies the output format for the response.
ZOHO_ERROR_FORMATXML/JSONSpecifies the output format for the response in case an error occurs when trying to process the request.
authtokenuser authtokenAuth Token is an unique token that authenticates the user to access the Analytics Plus account.
ZOHO_API_VERSION1.0The API version of Analytics Plus based on which the application(/service) has been written. This parameter allows the Analytics Plus to handle applications based on the older versions.The current API version is 1.0.

 

URL PARAMETERS

Parameter NamePossible ValuesDescription
ZOHO_DATABASE_NAME
(mandatory)
<databasename>This parameter holds the name of the destination database
ZOHO_DATABASE_DESC 
(optional)
<database description>This parameter holds the description of the description database
ZOHO_COPY_WITHDATA
(optional)
true/false
  • true - The data present in all tables of source database will be copied into destination database.
  • false - The data present in all tables of source database will not be copied into destination database
ZOHO_COPY_DB_KEY 
(mandatory)
<databasekey>The secret key used for allowing the user to copy the database / reports. 
The source database owner has to invoke the below URL to get the Copy Database Secret Key. 
https://<server_hostname>:<hostname>/api/abcd@zoho.com/SourceEmployeeDB?ZOHO_ACTION=GETCOPYDBKEY&ZOHO_OUTPUT_FORMAT=XML&ZOHO_ERROR_FORMAT=XML&authtoken=<source_db_owner_authtoken>&ZOHO_API_VERSION=1.0 .
Note: You need to provide the appropriate values in the above URL to generate the corresponding Copy Database Key for your setup.

 

ERROR CODES:

ERROR CODEREASONSOLUTION
7103The database specified does not existsCheck the name of the database to be copied

 

In case of any error other than the above said, mail the API request URL parameters and error response details to analyticsplus-support@manageengine.com. Analytics Plus will get back to you with the best possible solution.

 

Sample Request:

https://<server_hostname>:<portnumber>/api/<email_address_of_database_administrator>/<name_of_the_source_database>?ZOHO_ACTION=COPYDATABASE
&ZOHO_DATABASE_NAME=<destination_database_name>&ZOHO_DATABASE_DESC=<destination_database_description>&ZOHO_COPY_WITHDATA=<true/false>
&ZOHO_OUTPUT_FORMAT=XML&ZOHO_ERROR_FORMAT=XML
&authtoken=<authtoken_of_the_user_who_want_to_copy>&ZOHO_API_VERSION=1.0&ZOHO_COPY_DB_KEY=<copy_database_key_of_the_original_database>

 

Sample Response XML Format:

<response uri="/api/abc@zoho.com/Employee" action="COPYDATABASE">
<result>
<message>
Successfully Database Copied
</message>
<dbid>
100000000000889
</dbid>
</result>
</response>

Sample Response JSON Format:
{
"response":
{
"uri": "\/api\/abc@zoho.com/Employee",
"action": "COPYDATABASE",
"result":
{
"message": "Successfully Database Copied",
"dbid": "10000000000889"
}
}
}

 

Error Handling

This section explains the possible errors responses that could be returned on failure of the Copy Database API call.

 

XML Format:

<response uri="/api/abc@zoho.com/Employee" action="COPYDATABASE">
<error>
<code>
7103
</code>
<message>
Database not found! Please check whether the database exists
</message>
</error>
</response>

 

JSON Format:

{
"response":
{
"uri": "\/api\/abc@zoho.com/Employee",
"action": "COPYDATABASE",
"error":
{
"code":6021,
"message": "Database not found! Please check whether
the database exists"
}
}
}

 

Delete Database

The Delete Database API is used to delete the database from your Analytics Plus Account. This API will delete the database present in the user account who is invoking this API, and not the database from other accounts. Please note that if a database is deleted using this API, the same database cannot be restored back.

 

URL

https://<server_hostname>:<portnumber>/api/<Email>

 

URL PARAMETERS

Parameter NamePossible ValuesDescription
ZOHO_ACTIONDELETEDATABASEThis parameter specifies the action to be performed by the API request.
ZOHO_OUTPUT_FORMATXML/JSONThis parameter specifies the output format for the response.
ZOHO_ERROR_FORMATXML/JSONSpecifies the output format for the response in case an error occurs when trying to process the request.
authtokenuser authtokenAuth Token is an unique token that authenticates the user to access the Analytics Plus account.
ZOHO_API_VERSION1.0The API version of Analytics Plus based on which the application(/service) has been written. This parameter allows the Analytics Plus to handle applications based on the older versions.The current API version is 1.0.

 

URL PARAMETERS 

Parameter NamePossible ValuesDescription
ZOHO_DATABASE_NAME
(mandatory)
Database nameThis parameter holds the name of the database to be deleted

 

ERROR CODES:

Error CodeReasonSolution
7103The database specified does not existsCheck the name of the database to be deleted
7165The database specified is a system database which cannot be deleted

The system database cannot be deleted

 

In case of any error other than the above said, mail the API request URL parameters and error response details to analyticsplus-support@manageengine.com. Analytics Plus will get back to you with the best possible solution.

 

Sample Request:

https://<server_hostname>:<portnumber>/api/abc@zoho.com?ZOHO_ACTION=DELETEDATABASE&ZOHO_DATABASE_NAME=EmployeeDB
&ZOHO_OUTPUT_FORMAT=XML&ZOHO_ERROR_FORMAT=XML
&authtoken=g38sl4j4856guvncrywox8251sssds&ZOHO_API_VERSION=1.0

 

Sample Response XML Format:

<response uri="/api/abc@zoho.com" action="DELETEDATABASE">
<result>
<message>
Database deleted successfully
</message>
</result>
</response>

 

Sample Response JSON Format:

{
"response":
{
"uri": "\/api\/abc@zoho.com",
"action": "DELETEDATABASE",
"result":
{
"message": "Database deleted successfully"
}
}
}

 

Error Handling

This section explains the possible errors responses that could be returned on
failure of the Delete Database API call.

 

XML Format:

<response uri="/api/abc@zoho.com" action="DELETEDATABASE">
<error>
<code>
7103
</code>
<message>
Database not found! Please check whether the database exists
</message>
</error>
</response>

 

JSON Format:

{
"response":
{
"uri": "\/api\/abc@zoho.com",
"action": "DELETEDATABASE",
"error":
{
"code":6021,
"message": "Database not found! Please check whether the
database exists"
}
}
}

 

Copy Reports

The source database administrator should generate and provide the Copy Database Key, the secret key used to authorize the destination database administrator. Copying the reports using this API will copy the report along with the relationships involved and the formula columns associated with the source report. It is necessary that the parent tables of the view in the source database should exists with the same name in the destination database.

 

URL

https://<server_hostname>:<portnumber>/api/<Email>/<Databasename>

 

URL PARAMETERS 

Parameter NamePossible ValuesDescription
ZOHO_ACTIONCOPYREPORTSThis parameter specifies the action to be performed by the API request.
ZOHO_OUTPUT_FORMATXML/JSONThis parameter specifies the output format for the response.
ZOHO_ERROR_FORMATXML/JSONSpecifies the output format for the response in case an error occurs when trying to process the request.
authtokenuser authtokenAuth Token is an unique token that authenticates the user to access the Analytics Plus account.
ZOHO_API_VERSION1.0The API version of Analytics Plus based on which the application(/service) has been written. This parameter allows the Analytics Plus to handle applications based on the older versions.The current API version is 1.0.

 

URL PARAMETERS

Parameter NamePossible ValuesDescription
ZOHO_VIEWTOCOPY 
(mandatory)
view namesThis parameter holds the list of view names. In case of more than one views, the view names should be separated by comma ( , ).Example:ZOHO_VIEWTOCOPY=View1,View2,View3,…
ZOHO_DATABASE_NAME
(mandatory)
database nameThis parameter holds the name of the database (destination database) where the reports (specified in ZOHO_VIEWSTOCOPY parameter) has to be copied
ZOHO_COPY_DB_KEY 
(mandatory)
Database keyThe secret key used for allowing the user to copy the database / reports. 
The source database owner has to invoke the below URL to get the Copy Database Secret Key.
https://<server_hostname>:/api/abcd@zoho.com/SourceEmployeeDB?ZOHO_ACTION=GETCOPYDBKEY&ZOHO_OUTPUT_FORMAT=XML&ZOHO_ERROR_FORMAT=XML&authtoken=<source_db_owner_authtoken>&ZOHO_API_VERSION=1.0 . 
Note: You need to provide the appropriate values in the above URL to generate the corresponding Copy Database Key for your setup
 

 

ERROR CODES:

Error CodeReasonSolution
15000A table / view which is needed to copy the specified report is missing in the destination databaseCheck the destination database and create the missing table/view
15001A column which is needed to copy the specified report is missing in the destination databaseCheck the destination database and create the column before copying the report
15002A formula column which is needed to copy the specified report is missing in the destination databaseCheck the destination database and create the formula column before copying the report
15005The report name specified already exists in the destination databaseCheck whether the report with the same name exists in the destination database. Try renaming the source report or the report in destination database and invoke the API again.
15007Insufficient privileges to copy the reportCheck whether the Copy Database Key is valid
15012The reports specified in the API request is not present in the Source DatabaseCheck the reports specified in the ZOHO_VIEWTOCOPY parameter is correct and are available.

 

In case of any error other than the above said, mail the API request URL parameters and error response details to analyticsplus-support@manageengine.com. Analytics Plus will get back to you with the best possible solution.

 

Sample Request:

https://<server_hostname>:<portnumber>/api/source_account@zoho.com/SourceEmployeeDB?ZOHO_ACTION=COPYREPORTS
&ZOHO_VIEWTOCOPY=EmployeeDetails,Employee Salary&ZOHO_DATABASE_NAME=DestinationEmployeeDB
&ZOHO_COPY_DB_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxxx
&ZOHO_OUTPUT_FORMAT=XML&ZOHO_ERROR_FORMAT=XML
&authtoken=g38sl4j4856guvncrywox8251sssds&ZOHO_API_VERSION=1.0

 

Sample Response XML Format:

<response uri="/api/source_account@zoho.com/SourceEmployeeDB"
action="COPYREPORTS">
<result>
<message>
Successfully View(s) Copied
</message>
</result>
</response>

 

Sample Response JSON Format:

{
"response":
{
"uri":"\/api\/source_account@zoho.com\/SourceEmployeeDB",
"action":"COPYREPORTS",
"result":
{
"message": "Successfully View(s) Copied"
}
}
}

 

Error Handling

This section explains about the error response sent from the Zoho Reports
server on failure of Copy Reports API. The sample error response is below..

 

XML Format:

<response uri="/api/source_account@zoho.com/SourceEmployeeDB"
action="COPYREPORTS">
<error>
<code>
15005
</code>
<message>
The View name 'EmployeeDetails' for the given View id '3682000000564002'
is already exists in the destination database '3835000001921020'.
</message>
</error>
</response>

 

JSON Format:

{
"response":
{
"uri": "\/api\/source_account@zoho.com\/SourceEmployeeDB",
"action": "COPYREPORTS",
"error":
{
"code":15005,
"message": "The View name \'EmployeeDetails\' for the given View id
\'3682000000564002\' is
already exists in the destination database \'3835000001921020\'."
}
}
}

 

Copy Formula

The Copy Formula API is used to copy one or more formula columns from one table to another within the same database or across databases and even across one user account to another. The source database administrator should generate and provide the Copy Database Key, the secret key used to authorize the destination database administrator. It is necessary that the table and column name in the destination database should be the same as that of the table and column names in the source database on which the formula is dependent. Both Custom Formula and Aggregate Formula can be copied using this API.

 

URL

https://<server_hostname>:<portnumber>/api/<Email>/<Databasename>/<Tablename>

 

URL PARAMETERS

Parameter NamePossible ValuesDescription
ZOHO_ACTIONCOPYFORMULAThis parameter specifies the action to be performed by the API request.
ZOHO_OUTPUT_FORMATXML/JSONThis parameter specifies the output format for the response.
ZOHO_ERROR_FORMATXML/JSONSpecifies the output format for the response in case an error occurs when trying to process the request.
authtokenuser authtokenAuth Token is an unique token that authenticates the user to access the Analytics Plus account.
ZOHO_API_VERSION1.0The API version of Analytics Plus based on which the application(/service) has been written. This parameter allows the Analytics Plus to handle applications based on the older versions.The current API version is 1.0.

 

URL PARAMETERS

Parameter NamePossible ValuesDescription
ZOHO_FORMULATOCOPYFormula nameThis parameter holds the FORMULA NAME to be copied from the source database into another table in the destination database. 
In case more than one formulas are to be copied, the formula names should be separated by comma ( , ).
Example:ZOHO_FORMULATOCOPY=MyFormula1,MyFormula2,MyFormulaN
ZOHO_DATABASE_NAMEDatabase nameThis parameter holds the name of the database (destination database) where the destination table is present.
The specified formula are copied to the table which has same name (SourceEmployeeDetails) as specified in the API URL
ZOHO_COPY_DB_KEYDatabase keyThe secret key used for allowing the user to copy the database / reports. 
The source database owner has to invoke the below URL to get the Copy Database Secret Key.
https://<server_hostname>:/api/abcd@zoho.com/SourceEmployeeDB?ZOHO_ACTION=GETCOPYDBKEY&ZOHO_OUTPUT_FORMAT=XML&ZOHO_ERROR_FORMAT=XML&authtoken=<source_db_owner_authtoken>&ZOHO_API_VERSION=1.0 . 
Note: You need to provide the appropriate values in the above URL to generate the corresponding Copy Database Key for your setup

 

ERROR CODES: 

Error CodeReasonSolution
15000A table / view which is needed to copy the specified report is missing in the destination databaseCheck the destination database and create the missing table/view
15001A column which is needed to copy the specified report is missing in the destination databaseCheck the destination database and create the column before copying the report
15002A formula column which is needed to copy the specified report is missing in the destination databaseCheck the destination database and create the formula column before copying the report
15005The report name specified already exists in the destination databaseCheck whether the report with the same name exists in the destination database. Try renaming the source report or the report in destination database and invoke the API again.
15007Insufficient privileges to copy the reportCheck whether the Copy Database Key is valid
15009The formula column name specified already exists in the destination databaseCheck whether the formula column is already copied, otherwise, try renaming the formula column in the source table or in the destination database and invoke the API again.
15010The Formula Column name specified in the API request is not present in the Source DatabaseCheck the formula column name(s) specified in the ZOHO_FORMULATOCOPY parameter is correct

 

In case of any error other than the above said, mail the API request URL parameters and error response details to analyticsplus-support@manageengine.com. Analytics Plus will get back to you with the best possible solution.

 

Sample Request:

https://<server_hostname>:<portnumber>/api/source@zoho.com/SourceEmployeeDB/SourceEmployeeDetails?ZOHO_ACTION=COPYFORMULA
&ZOHO_FORMULATOCOPY=MyFormula1,MyFormula2&ZOHO_DATABASE_NAME=DestinationEmployeeDB
&ZOHO_COPY_DB_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxxx

&ZOHO_OUTPUT_FORMAT=XML&ZOHO_ERROR_FORMAT=XML
&authtoken=g38sl4j4856guvncrywox8251sssds&ZOHO_API_VERSION=1.0
 

 

Sample Response XML Format:

<response uri="/api/source_account@zoho.com/SourceEmployeeDB/EmployeeDetails"
action="COPYFORMULA">
<result>
<message>
Successfully formula(s) Copied
</message>
</result>
</response>

 

Sample Response JSON Format:

{
"response":
{
"uri":"\/api\/source_account@zoho.com\/EmployeeDB\/EmployeeDetails",
"action":"COPYFORMULA",
"result":
{
"message": "Successfully Formula(s) Copied"
}
}
}

 

Error Handling

This section explains about the error response sent from the Zoho Reports server
on failure of Copy Formula API. The sample error response is below.

 

XML Format:

<response uri="/api/source_account@zoho.com/SourceEmployeeDB/EmployeeDetails"
action="COPYFORMULA">
<error>
<code>15009</code>
<message>The formula 'MyFormula1' is already copied to the destination
table 'SourceEmployeeDetails' of database '3835000001921187'.</message>
</error>
</response>

 

JSON Format:

{
"response":
{
"uri": "\/api\/source_account@zoho.com\/EmployeeDB\/EmployeeDetails",
"action": "COPYFORMULA",
"error":
{
"code":15009,
"message": "The formula 'MyFormula1' is already copied to the
destination table 'SourceEmployeeDetails' of database
'3835000001921187'."
}
}
}

 

 

ADD COLUMN

The Add Column API is used to add a column into Analytics Plus Table. The account Administrator and the Database Owner alone can use this API to add a column in the Analytics Plus table.

 

URL

https://<server_hostname>:<portnumber>/api/<Email>/<Databasename>/<Tablename>

Note: In case of database owner adding a column, they need to specify the login E-mail ID of the account Administrator only.

 

URL PARAMETERS

Parameter NamePossible ValuesDescription
ZOHO_ACTIONADDCOLUMNThis parameter specifies the action to be performed by the API request.
ZOHO_OUTPUT_FORMATXML/JSONThis parameter specifies the output format for the response.
ZOHO_ERROR_FORMATXML/JSONSpecifies the output format for the response in case an error occurs when trying to process the request.
authtokenuser authtokenAuth Token is an unique token that authenticates the user to access the Analytics Plus account.
ZOHO_API_VERSION1.0The API version of Analytics Plus based on which the application(/service) has been written. This parameter allows the Analytics Plus to handle applications based on the older versions.The current API version is 1.0.

 

URL PARAMETERS

Parameter NamePossible ValuesDescription
ZOHO_COLUMNNAME
(mandatory)
<columnname>The name of the column to be added into Analytics Plus Table. 
Example:ZOHO_COLUMNNAME=Region . 
Note: The column name should be url encoded if the column name contain space or any special characters.
ZOHO_DATATYPE 
(mandatory)
Supported data types are:
  • PLAIN
  • MULTI_LINE
  • EMAIL
  • NUMBER
  • POSITIVE_NUMBER
  • DECIMAL_NUMBER
  • CURRENCY
  • PERCENT
  • DATE
  • BOOLEAN
  • URL
  • AUTO_NUMBER
The datatype of the column to be added into Analytics Plus Table.
 
 

ERROR CODES:

 
Error CodeReasonSolution
7128The column is already exists in the specified Analytics Plus TableProvide a different name for the ZOHO_COLUMNNAME parameter
7161The Analytics Plus Table specified in this API is a system table (created for Service Integration)Adding columns into System Table is not allowed. You could only add columns in a non-system table using this API.

 

In case of any error other than the above said, mail the API request URL parameters and error response details to analyticsplus-support@manageengine.com. Analytics Plus team will get back to you with the best possible solution.

 

Sample Request:

https://<server_hostname>:<portnumber>/api/abc@zoho.com/SalesDB/Sales?ZOHO_ACTION=ADDCOLUMN
&ZOHO_COLUMNNAME=Region&ZOHO_DATATYPE=PLAIN
&ZOHO_OUTPUT_FORMAT=XML&ZOHO_ERROR_FORMAT=XML
&authtoken=g38sl4j4856guvncrywox8251sssds&ZOHO_API_VERSION=1.0

 

Sample Response XML Format:

<response uri="/api/abc@zoho.com/SalesDB/Sales" action="ADDCOLUMN">
<result>
Column created successfully
</result>
</response>

 

Sample Response JSON Format:

{
"response":
{
"uri":"\/api\/abc@zoho.com\/SalesDB\/Sales",
"action":"ADDCOLUMN",
"result": {"message":"Column created successfully"}
}
}

 

Error Handling

The following is a sample error response format in case of failure of
Add Column API.

 

XML Format:

<response uri="/api/abc@zoho.com/SalesDB/Sales" action="ADDCOLUMN">
<error>
<code>7128</code>
<message>
The following column names are duplicated in this table [Region]
</message>
</error>
</response>

 

JSON Format:

{
"response":
{
"uri":"\/api\/abc@zoho.com\/SalesDB\/Sales",
"action":"ADDCOLUMN",
"error":
{
"code":7128,
"message":"The following column names are duplicated in this
table [Region]"
}
}
}

 

DELETE COLUMN 

The Delete Column API is used to delete a column in Analytics Plus Table. The account Administrator and the Database Owner alone can use this API to delete a column in a Analytics Plus table.

 

URL

https://<server_hostname>:<portnumber>/api/<Email>/<Databasename>/<Tablename>

Note: In case of database owner deleting a column, they need to specify the login E-mail ID of the account Administrator only.

 

URL PARAMETERS

Parameter NamePossible ValuesDescription
ZOHO_ACTIONDELETECOLUMNThis parameter specifies the action to be performed by the API request.
ZOHO_OUTPUT_FORMATXML/JSONThis parameter specifies the output format for the response.
ZOHO_ERROR_FORMATXML/JSONSpecifies the output format for the response in case an error occurs when trying to process the request.
authtokenuser authtokenAuth Token is an unique token that authenticates the user to access the Analytics Plus account.
ZOHO_API_VERSION1.0The API version of Analytics Plus based on which the application(/service) has been written. This parameter allows the Analytics Plus to handle applications based on the older versions.The current API version is 1.0.

 

URL PARAMETERS

Parameter NamePossible ValuesDescription
ZOHO_COLUMNNAME
(mandatory)
<columnname>The name of the column to be deleted in Analytics Plus Table. 
Example:ZOHO_COLUMNNAME=Region

 

ERROR CODES:

Error CodeReasonSolution
7107The column does not exists in the specified Analytics Plus TableProvide the correct name of the column to be deleted in the ZOHO_COLUMNNAME parameter
7159The column to be deleted is used in Reports, Formula Columns, Query Tables, etc.The column with dependent views cannot be deleted. Please delete the dependent views and formula columns associated with this column before calling this delete column API.
7161The Analytics Plus Table specified in this API is a system table (created for Service Integration)Deleting columns in System Table is not allowed. You could only delete a column in a user created/defined table using this API.

 

In case of any error other than the above said, mail the API request URL parameters and error response details to analyticsplus-support@manageengine.com. Analytics Plus will get back to you with the best possible solution.

 

Sample Request:

https://<server_hostname>:<portnumber>/api/your_account@zoho.com/SalesDB/Sales?ZOHO_ACTION=DELETECOLUMN
&ZOHO_COLUMNNAME=SalesRegion&
&ZOHO_OUTPUT_FORMAT=XML&ZOHO_ERROR_FORMAT=XML
&authtoken=g38sl4j4856guvncrywox8251sssds&ZOHO_API_VERSION=1.0

 

Sample Response XML Format:

<response uri="/api/abc@zoho.com/SalesDB/Sales" action="DELETECOLUMN">
<result>
Column deleted successfully
</result>
</response>

 

Sample Response JSON Format:

{
"response":
{
"uri":"\/api\/abc@zoho.com\/SalesDB\/Sales",
"action":"DELETECOLUMN",
"result": {"message":"Column deleted successfully"}
}
}

 

Error Handling

The following is a sample error response format in case of failure of

Delete Column API.

 

XML Format:

<response uri="/api/abc@zoho.com/SalesDB/Sales" action="DELETECOLUMN">
<error>
<code>7107</code>
<message>
Column Region does not exists
</message>
</error>
</response>

 

JSON Format:

{
"response":
{
"uri":"\/api\/abc@zoho.com\/SalesDB\/Sales",
"action":"DELETECOLUMN",
"error":
{
"code":7107,
"message":"Column Region does not exists"
}
}
}

 

RENAME COLUMN

The Rename Column API is used to rename the column in Analytics Plus Table. The account Administrator and the Database Owner alone can use this API to rename a column in the Analytics Plus table.

 

URL

https://<server_hostname>:<portnumber>/api/<Email>/<Databasename>/<Tablename>

Note: In case of database owner renaming a column, they need to specify the login E-mail ID of the account Administrator only.

 

 

URL PARAMETERS

Parameter NamePossible ValuesDescription
ZOHO_ACTIONRENAMECOLUMNThis parameter specifies the action to be performed by the API request.
ZOHO_OUTPUT_FORMATXML/JSONThis parameter specifies the output format for the response.
ZOHO_ERROR_FORMATXML/JSONSpecifies the output format for the response in case an error occurs when trying to process the request.
authtokenuser authtokenAuth Token is an unique token that authenticates the user to access the Analytics Plus account.
ZOHO_API_VERSION1.0The API version of Analytics Plus based on which the application(/service) has been written. This parameter allows the Analytics Plus to handle applications based on the older versions.The current API version is 1.0.

 

URL PARAMETERS

Parameter NamePossible ValuesDescription
OLDCOLUMNNAME 
(mandatory)
<oldcolumnname>The name of the column to be renamed in Analytics Plus Table. Example: OLDCOLUMNNAME=Region
NEWCOLUMNNAME
(mandatory)
<newcolumnname>The new name you wanted to give for the column.Example:NEWCOLUMNNAME=SalesRegion
 

 

ERROR CODES:

Error CodeReasonSolution
7107The column does not exists in the specified Analytics Plus TableProvide the correct name of the column to be renamed in the ZOHO_COLUMNNAME parameter
7161The Analytics Plus Table specified in this API is a system table (created for Service Integration)Renaming columns in a System Table is not allowed. You could only rename a column in a non-system table using this API.

In case of any error other than the above said, mail the API request URL parameters and error response details to analyticsplus-support@manageengine.com. Analytics Plus will get back to you with the best possible solution.

 

Sample Request:

https://<server_hostname>:<portnumber>/api/your_account@zoho.com/SalesDB/Sales?ZOHO_ACTION=RENAMECOLUMN
&OLDCOLUMNNAME=Region&NEWCOLUMNNAME=SalesRegion
&ZOHO_OUTPUT_FORMAT=XML&ZOHO_ERROR_FORMAT=XML
&authtoken=g38sl4j4856guvncrywox8251sssds&ZOHO_API_VERSION=1.0

 

Sample Response XML Format:

<response uri="/api/abc@zoho.com/SalesDB/Sales" action="RENAMECOLUMN">
<result>
Column renamed successfully
</result>
</response>

 

Sample Response JSON Format:

{
"response":
{
"uri":"\/api\/abc@zoho.com\/SalesDB\/Sales",
"action":"RENAMECOLUMN",
"result":
{
"message":"Column renamed successfully"
}
}
}

 

Error Handling

The following is a sample error response format in case of failure of
Rename Column API.

 

XML Format:

<response uri="/api/abc@zoho.com/SalesDB/Sales" action="RENAMECOLUMN">
<error>
<code>7107</code>
<message>
Column Region does not exists
</message>
</error>
</response>

 

JSON Format:

{
"response":
{
"uri":"\/api\/abc@zoho.com\/SalesDB\/Sales",
"action":"RENAMECOLUMN",
"error":
{
"code":7107,
"message":"Column Region does not exists"
}
}
}

 

Share this post : FacebookTwitter