Copy Application - REST API - POST Method
Zoho Creator
REST style Web API allows copying a Zoho Creator
application, using the HTTP POST method. In return the user gets a formatted XML/JSON response from the called method.
Who
can copy an application?
- Public Application: Anyone with a valid apikey can copy a public
application.
- Private Application: Only the owner of the application with a
valid apikey can copy a private application.
Request URL
The request url to copy a Zoho
Creator application in xml/json format is given below:
XML :
http://creator.zoho.com/api/xml/copyapp/
JSON : http://creator.zoho.com/api/json/copyapp/
Request Parameters
The request parameters comprises of application name to be copied,
the new name of the application (optional) and the zc_ownername (to copy a
public application).
Field
|
Description
|
applinkname
|
[string] - The name of the
application as specified in deluge script. Refer http://creator.zoho.com/api/reference to
view the list of applications created and its deluge
name. |
newappname
|
[string] - This field is optional. If the new name is not
specified or if the new name already exists, the application will be copied as
"Copy-of-<applinkname>". |
| zc_ownername |
To
copy a public application, the zc_ownername must be
specified. |
Sample Form ( POST Method Format )
<form method="POST"
action="http://creator.zoho.com/api/xml/copyapp/apikey=[APIKEY]&ticket=[Ticket]">
<input type="text" name="applinkname" value="Name of the application to be copied">
<input type="text" name="newappname " value="Name to the new
application">
<input type="submit" value="Copy Application">
</form>
Note:
1. Refer http://creator.zoho.com/api/reference to
view the list of applications created, the form names and field names used in
each application and the deluge field names.
2. To
copy a public application, the zc_ownername must be specified as input to the POST method, in
the following format
<input type="text"
name="zc_ownername"
value="Application Owner
Name">
Sample Request
1. Sample request to copy an application named "Issue
Manager" with deluge name "issue-manager". In this sample, we have not specified
the new name and hence the application will be copied as
"copy-of-issue-manager"
<input type="text" name=" applinkname
" value=" issue-manager
">
Sample Response
XML
Format
<response>
<copy-application>
<application-name>
Copy of Issue
Manager</application-name>
<link-name>
copy-of-issue-manager</link-name>
</copy-application>
</response>
Equivalent JSON format
{
"copy-application":
[
{
"link-name":"copy-of-issue-manager",
"application-name":"Copy of Issue Manager"
}
]
}
If there is an error in the request format, the corresponding error
code with the error message will be displayed. Please refer the topic, Error codes and description , to learn about the list of
error code displayed.
