记录添加——REST API - POST方式
百会Creator的REST方式Web API允许客户端通过HTTP POST方法将数据添加进百会Creator表单中。您一次只能向一个表单中添加一个数据,同时您将从调用的方法中得到一个格式化的XML/CSV/JSON回复。
哪些人可以添加记录?
-
公共表单:任何拥有有效的API key的人均可以向表单中添加记录。
-
私有表单:只有拥有有效的API key的应用程序拥有者可以向表单中添加记录。
-
共享表单:任何拥有有效的API key和共享许可的人可以向表单中添加记录。
要求的网址
下面为用于添加记录要求加入的链接网址:
XML格式 : http://creator.baihui.com/api/xml/<applicationName>/<formName>/add/
CSV格式 : http://creator.baihui.com/api/csv/<applicationName>/<formName>/add/
JSON格式 : http://creator.baihui.com/api/json/<applicationName>/<formName>/add/
要求的参量
要求的参量由输入类型、以deluge语言确定的该项目名称以及项目的值三部分组成。
项目
|
描述
|
Column Name
|
[string类型] 表单中单项的名称。
|
Column Value
|
[string类型] 单项中将被确定的值。 |
表单示例
(
POST 格式方法
)
<form method="POST" action="http://creator.baihui.com/api/xml/<application
name>/<form name>/add/apikey=[APIKEY]
&ticket=[Ticket]">
<input type="text" name=" Column Name " value=" Column Value ">
<input type="text" name=" Column Name " value=" Column Value ">
<input type="submit" value="Submit XML String">
</form>
注意事项:若要向共享或公开的应用中添加记录,必须规定zc_ownername作为上面的POST方法的输入者,代码示例如下:
<input type="text"
name="zc_ownername"
value="Application Owner
Name">
注意事项:
- 您在一个确定的表单中一次只能添加一个数据。
- 多重项目值需要使用逗号加以隔开。
- 请参见http://creator.baihui.com/api/reference查看清单,其中包含已开发的应用、应用中的表单名称和项目名称,以及相应的deluge命名。
请求示例
1. 向一个单独的表单中添加记录的请求示例。下述为向一个名为"sample"的应用中的一个名为"Department"的表单中添加数据。
<input type="text" name=" Name "
value=" Gary
">
<input type="text" name=" DOB " value="
12-Jun-1980
">
<input type="text" name=" Address "
value=" USA
">
<input type="text" name=" Basic " value="
10000
">
<input type="text" name=" Hobbies "
value=" Reading,Writing ">
应答示例
XML格式
<?xml version="1.0" encoding="UTF-8" ?>
<value>12-Jun-1980</value>
</field>
</values>
</add>
</form>
</result>
</response>
等价的JSON格式
{
"formname":
[
"Employee_Details",
{"operation":
[
"add",
{
"values":
[
{
"Address":"USA",
"Basic":"10000",
"Name":"Gary",
"DOB":"12-Jun-1980"
},
{
"Hobbies":["Reading","Writing"]
},
{
"status":
[
"Success"
]
}
]
}
]
}
]
}
等价的CSV格式
Form Name, Operation
Employee_Details,add
Status,Values
Success,[Name = Gary , DOB = 12-Jun-1980 , Basic = 10000 , Address = USAHobbies = "Reading,Writing"]
如果在应答格式中出现错误,对应的错误代码及错误信息将显示出来。请参考此专题Error codes and description,获悉错误代码显示列表相关信息。
当记录添加进数据库后,应答信息将显示数据及提示信息如"Success"。