记录更新——Get方式
GET调用协议只支持测试用途。对于产品的应用,请使用HTTP POST方式。
概述
百会Creator的REST方式Web API允许客户端通过HTTP GET方法在百会Creator表单中更新数据。所有满足约束条件的数据将被更新。您可以使用"AND"或"OR"操作符确定复合标准,同时您将从调用的方法中得到一个格式化的XML/CSV/JSON回复。
哪些人可以更新记录?
在百会Creator中,只有拥有有效的API key的应用程序拥有者可以在表单中更新记录。
使用记录id更新数据
要求的网址
XML格式
http://creator.zoho.com/api/xml/<applicationName>/<formName>/<recordId>/update/apikey=<API
Key>&ticket=<Ticket>&<setColumnName>=<newValue>
CSV格式
http://creator.zoho.com/api/csv/<applicationName>/<formName>/<recordId>/update/apikey=<API
Key>&ticket=<Ticket>&<setColumnName>=<newValue>
JSON格式
http://creator.zoho.com/api/json/<applicationName>/<formName>/<recordId>/update/apikey=<API
Key>&ticket=<Ticket>&<setColumnName>=<newValue>
要求的参量
要求的参量由应用名、表单名、记录ID、设定的项目名称和新的值五部分组成。
项目
|
描述
|
applicationName
|
百会Creator应用名。 |
formName
|
应用中的表单名。 |
recordID
|
由百会Creator生成的表单中每个记录唯一的记录id。 |
setColumnName
|
将被更新的项目。 |
newValue
|
将向该项目更新的新数据。 |
请求示例
http://creator.zoho.com/api/xml/recruitment/Employee/4000000002208/update/
apikey=a14289d3322417901bea85df60f96101&ticket=xxxxxxxxxxxxxxxxxxx&Name=Vishal
应答示例
以下为对上述请求的XML格式应答:
<?xml version="1.0" encoding="UTF-8" ?>
<response>
<result>
<form name="Employee">
<update>
<criteria>
<fieldname="ID" compOperator="EQUALS" value="4000000002208" />
<newvalues>
<field name="Name">
</update>
</form>
</result>
</response>
等价的CSV应答格式
Form Name, Operation
Employee,update
Status,Criteria
Success,[ID EQUALS 2000000003003 SET Name = Vishal ]
等价的JSON应答格式
{
"formname":
[
"Employee",
{
"operation":
[
"update",
{
"Criteria":
[
"ID EQUALS 2000000003003"
]
},
{
"newvalues":
[
{
"Name":"Vishal"
}
]
},
{
"status":
[
"Success"
]
}
]
}
]
}
依据AND操作符形成的标准更新数据
XML格式:
http://creator.zoho.com/api/test/xml/<applicationName>/<formName>/
update/matchall/<criteriaString>/apikey=<API Key>&<setColumnName>=<newValue>
CSV格式:
http://creator.zoho.com/api/test/csv/<applicationName>/<formName>/
update/matchall/<criteriaString>/apikey=<API Key>&<setColumnName>=<newValue>
JSON格式:
http://creator.zoho.com/api/test/json/<applicationName>/<formName>/
update/matchall/<criteriaString>/apikey=<API Key>&<setColumnName>=<newValue>
要求的参量
要求的参量由应用名、表单名、标准、设定的项目名称和新的值五部分组成。
项目
|
描述
|
applicationName
|
百会Creator应用名。 |
formName
|
应用中的表单名。 |
criteriaString
|
标准必须以"<criteria column
name> <operator> <value>"格式确定。
其中, <Criteria Column Name > :用于确定更新标准的项目名称。 <operator> :在标准中使用的操作符。 <value> :标准项目的值。
|
setColumnName
|
将被更新的项目。 |
newValue
|
将向该项目更新的新数据。 |
XML格式请求示例
http://creator.zoho.com/api/test/xml/recruitment/Employee/update/matchall/
EmailId=Jessy@adventnet.com,DOB=05-Sep-1980/apikey=81d0d3fb0f81892ff681fb4e5c4efd2f&Hobbies=Reading
应答示例
以下为对上述请求的XML格式应答:
<?xml version="1.0" encoding="UTF-8" ?>
<response>
<result>
<form name="Employee">
<update>
<criteria>
<fieldname="EmailId" compOperator="Equals" value="Jessy@adventnet.com" />
<reloperator>And</reloperator>
<fieldname="DOB" compOperator="Equals" value="05-Sep-1980" />
</criteria>
<status>Success</status>
</update>
</form>
</result>
</response>
等价的CSV应答格式
Form Name, Operation
Employee,update
Status,Criteria
Success,[EmailId Equals Jessy@adventnet.com And DOB Equals 05-Sep-1980 SET Age = 25]
等价的JSON应答格式
{
"formname":
[
"Employee",
{
"operation":
[
"update",
{
"Criteria":
[
"EmailId Equals craig@adventnet.com And DOB Equals 05-Sep-1980"
]
},
{
"newvalues":
[
{
"Hobbies":"Reading"
}
]
},
{
"status":
[
"Success"
]
}
]
}
]
}
依据OR操作符形成的标准更新数据
XML格式:
http://creator.zoho.com/api/test/xml/<applicationName>/<formName>/
update/matchany/<criteriaString>/apikey=<API Key>&<setColumnName>=<newValue>
CSV格式:
http://creator.zoho.com/api/test/csv/<applicationName>/<formName>/
update/matchany/<criteriaString>/apikey=<API Key>&<setColumnName>=<newValue>
JSON格式:
http://creator.zoho.com/api/test/json/<applicationName>/<formName>/
update/matchany/<criteriaString>/apikey=<API Key>&<setColumnName>=<newValue>
要求的参量
要求的参量由应用名、表单名、标准、设定的项目名称和新的值五部分组成。
项目
|
描述
|
applicationName
|
百会Creator应用名。 |
formName
|
应用中的表单名。 |
criteriaString
|
标准必须以"<criteria column
name> <operator> <value>"格式确定。
其中, <Criteria Column Name > :用于确定更新标准的项目名称。 <operator> :在标准中使用的操作符。 <value> :标准项目的值。
|
setColumnName
|
将被更新的项目。 |
newValue
|
将向该项目更新的新数据。 |
请求示例
http://creator.zoho.com/api/test/xml/Sample_Application/Employee_Form/update/matchany/Name=Henry,Age=23/
apikey=a71b267fd787f9954db3ae42b20bd09b&Age=25
应答示例
以下为对上述请求的XML格式应答:
<?xml version="1.0" encoding="UTF-8" ?>
<response>
<result>
<form name="Employee_Form">
<update>
<criteria>
<fieldname="Name" compOperator="Equals" value="Henry" />
<reloperator>Or</reloperator>
<fieldname="Age" compOperator="Equals" value="23" />
</criteria>
</update>
</form>
</result>
</response>
等价的CSV应答格式
Form Name, Operation
Employee,update
Status,Criteria
Success,[EmailId Equals kevin@gmail.com Or DOB Equals 05-Sep-2007 SET Hobbies = Reading ]
等价的JSON应答格式
{
"formname":
[
"Employee",
{
"operation":
[
"update",
{
"Criteria":
[
"EmailId Equals lindsay@yahoo.com Or DOB Equals 05-Sep-2007"
]
},
{
"newvalues":
[
{
"Hobbies":"Reading"
}
]
},
{
"status":
[
"Success"
]
}
]
}
]
}
注意事项: 如果您没有登录您的账号,您需要一个ticket并需要发送请求。