集简云教学 数据表教学 应用教学 开放平台 用户社区 语聚AI
打开导航
首页 > 开放平台 > 开放平台(上架应用) > 如何设置动作字段参数?
如何设置动作字段参数?
在开放平台应用授权和触发/执行字段时都会涉及到字段参数,这里我们介绍一下各个字段参数的配置。

如何设置动作字段参数? 

在开放平台应用授权和触发/执行字段时都会涉及到字段参数,这里我们介绍一下各个字段参数的配置。

应用授权时的字段参数设置界面:



 


 动作设置-添加普通字段时的字段参数设置界面:



 

字段参数包括:

字段Key:用于接口调用时的唯一字段标识,字段key应该为英文字母,例如API_Key。同时,接口调试中的{{input.data.xxx}}中的”xxx"部分为字段key,例如如果您的字段key为:phone_number, 接口调试中如需要引用此字段,可以输入{{input.data.phone_number}}



 

字段名称:在前端展现给用户的字段名称,例如用户名,非必填,如果不填写则以字段key做为字段名称

字段说明:非必填,在前端展现给用户,用于说明改字段内容如何填写,我们建议您填写字段说明例如格式示例,特别是日期时间类型的字段,需要填写格式在字段说明中。



 

字段类型:字段类型决定此字段的字段值在接口中以什么格式请求,如果是文本,多行文本则以文本格式请求,如果是数值,浮点则以数值格式请求。“展示字段”是一个前端展现的字段一般用于说明,展示字段不会用于接口请求。



 

是否必填:如果勾选则用户必须填写内容,否则无法进行下一步。



 

是否允许填写多个:如果勾选则用户在前端可以点击”+”, 添加多个此字段:



 

是否为动态字段:如果勾选则当此字段的字段值在前端变化时会请求接口刷新字段列表。

是否有下拉选项:如果勾选则此字段将设置为下拉选择字段.

下拉选项有两种:动态选项与固定选项

动态选项: 下拉列表选项不是固定的,需要请求接口获取,例如:企业部门成员列表。



您可以将下拉列表请求的接口创建为一个动作,建议设置为“不可见动作”。设置为不可见动作后此动作不会在用户前端展现,只能在获取下拉选项(动态选项)时调用:



 

更多关于动作可见范围的设置方法见:

动作的可见范围

https://www.jijyun.cn/help/detail/780


固定选项:下拉选项是固定值。添加json格式的选项,其中key为接口请求参数,在接口调用时将使用此参数请求。label为用户在前端看到的选项名称。格式示例:

 

[
{"key":"email","label":"邮箱"},
{"key":"mobile","label":"电话"},
{"key":"address","label":"地址"}
]

 

前端展示示例:



在配置完成字段和字段参数后,我们可以通过动作接口参数设置进行调用测试,详见文档:



如何配置动作接口参数?


 


 

本篇目录
  • 如何设置动作字段参数?