文档中心 > API类目 > 钉钉API

dingtalk.oapi.collection.form.list (获取用户创建的填表模板)

获取用户创建的填表模板

公共参数

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

名称	类型	是否必须	描述
access_token	String	是	钉钉提供的授权Token，想了解详情，ISV开发者请点击这里，企业开发者请点击这里。若有疑问，咨询邮箱dingding_open_dingtalk#list.alibaba-inc.com。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
biz_type	Number	可选	0	默认值：0	填表类型。0表示通用填表，1表示教育版填表
creator	String	可选	userid		填表创建人userid
offset	Number	必须	0		分页游标，从0开始。后续取返回结果中next_cursor的值
size	Number	必须	200	最大长度：500	分页大小，最大200

响应参数

名称	类型	示例值	描述
errcode	Number	0	错误码
errmsg	String	success	错误信息
result	PageResult		结果
└ has_more Boolean true 是否有下一页 └ next_cursor Number 200 下次分页的起始offset list FormSchemaResponse [] 列表 └ form_code String PROC 表单code └ name String name 填表名称 └ memo String aa 填表提示 setting FormSchemaSettingVo 设置 └ form_type Number 0 0表示通用智能填表，1表示教育版填表 └ loop_time String 17:11 填表时间 └ loop_days Number [] 1 填表周期，周一到周日分别用1-7表示 └ should_participation_cnt Number 4 应填人数 └ end_time Date 1111 填表截止时间 └ create_time Date 1111 创建时间 └ biz_type Number 0 表单类型 └ stop Boolean true 填表是否终止的标记 └ creator String a 创建人

请求示例

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/collection/form/list");
OapiCollectionFormListRequest req = new OapiCollectionFormListRequest();
req.setBizType(0L);
req.setCreator("userid");
req.setOffset(0L);
req.setSize(200L);
OapiCollectionFormListResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/collection/form/list");
OapiCollectionFormListRequest req = new OapiCollectionFormListRequest();
req.BizType = 0L;
req.Creator = "userid";
req.Offset = 0L;
req.Size = 200L;
OapiCollectionFormListResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);

include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');

$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_OAPI, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new OapiCollectionFormListRequest;
$req->setBizType("0");
$req->setCreator("userid");
$req->setOffset("0");
$req->setSize("200");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/collection/form/list");

curl -X POST "https://oapi.dingtalk.com/topapi/collection/form/list" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=c9c5cefa-1871-46ce-b318-b5e67ce9d8fd' \
-d 'biz_type=0' \
-d 'creator=userid' \
-d 'offset=0' \
-d 'size=200'

# -*- coding: utf-8 -*-
import dingtalk.api

req=dingtalk.api.OapiCollectionFormListRequest("https://oapi.dingtalk.com/topapi/collection/form/list")

req.biz_type=0
req.creator="userid"
req.offset=0
req.size=200
try:
	resp= req.getResponse(access_token)
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"dingtalk.oapi.collection.form.list");
add_param(pRequest,"biz_type","0");
add_param(pRequest,"creator","userid");
add_param(pRequest,"offset","0");
add_param(pRequest,"size","200");
pResponse = top_execute(pClient,pRequest,sessionKey);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('dingtalk.oapi.collection.form.list', {
	'biz_type':'0',
	'creator':'userid',
	'offset':'0',
	'size':'200'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "errcode":0,
    "errmsg":"success",
    "result":{
        "has_more":true,
        "next_cursor":200,
        "list":[
            {
                    "form_code":"PROC",
                    "name":"name",
                    "memo":"aa",
                    "setting":{
                        "form_type":0,
                        "loop_time":"17:11",
                        "loop_days":{
                            "number":[
                                1
                            ]
                        },
                        "should_participation_cnt":4,
                        "end_time":"1111",
                        "create_time":"1111",
                        "biz_type":0,
                        "stop":true
                    },
                    "creator":"a"
            }
        ]
    }
}

异常示例

JSON示例

{
	"errcode":88,
	"errmsg":"ding talk error"
}

错误码解释

错误码	错误描述	解决方案

API工具

API测试工具错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问

返回
顶部

淘宝开放平台

钉钉API

dingtalk.oapi.collection.form.list (获取用户创建的填表模板)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ