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

dingtalk.oapi.collection.instance.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。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
form_code	String	必须	aaa		填表code
action_date	String	可选	2019-01-01		时间，必须是YYYY-MM-DD的格式
offset	Number	必须	0		分页起始
size	Number	必须	10		分页大小，最大100
biz_type	Number	可选	0	默认值：0	填表类型

响应参数

名称	类型	示例值	描述
errcode	Number	0	错误码
errmsg	String	成功	错误信息
result	PageResult		结果
└ has_more Boolean true 是否还有下一页 list FormInstanceResponse [] 列表 └ create_time Date 1111 毫秒级时间戳，填表提交时间 └ submitter_userid String a 提交人userid └ submitter_user_name String a 提交人姓名 forms FormData [] 表单内容列表 └ value String a 表单的值 └ label String a 名称。当label字段为空或不存在时，忽略这个label和value └ key String Field 表单控件key └ modify_time Date 1111 更新时间 └ form_instance_id String 111 实例id └ student_class_name String a 学生班级名称 └ student_name String a 学生名称 └ student_class_id Number 1 学生班级id └ student_user_id String 11 学生id └ next_cursor Number 1 下一次分页offset的值

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/collection/instance/list");
OapiCollectionInstanceListRequest req = new OapiCollectionInstanceListRequest();
req.setFormCode("aaa");
req.setActionDate("2019-01-01");
req.setOffset(0L);
req.setSize(10L);
req.setBizType(0L);
OapiCollectionInstanceListResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/collection/instance/list");
OapiCollectionInstanceListRequest req = new OapiCollectionInstanceListRequest();
req.FormCode = "aaa";
req.ActionDate = "2019-01-01";
req.Offset = 0L;
req.Size = 10L;
req.BizType = 0L;
OapiCollectionInstanceListResponse 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 OapiCollectionInstanceListRequest;
$req->setFormCode("aaa");
$req->setActionDate("2019-01-01");
$req->setOffset("0");
$req->setSize("10");
$req->setBizType("0");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/collection/instance/list");

curl -X POST "https://oapi.dingtalk.com/topapi/collection/instance/list" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=4698f554-70bf-46b6-9be2-d9298c231195' \
-d 'action_date=2019-01-01' \
-d 'biz_type=0' \
-d 'form_code=aaa' \
-d 'offset=0' \
-d 'size=10'

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

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

req.form_code="aaa"
req.action_date="2019-01-01"
req.offset=0
req.size=10
req.biz_type=0
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.instance.list");
add_param(pRequest,"form_code","aaa");
add_param(pRequest,"action_date","2019-01-01");
add_param(pRequest,"offset","0");
add_param(pRequest,"size","10");
add_param(pRequest,"biz_type","0");
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.instance.list', {
	'form_code':'aaa',
	'action_date':'2019-01-01',
	'offset':'0',
	'size':'10',
	'biz_type':'0'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "errcode":0,
    "errmsg":"成功",
    "result":{
        "has_more":true,
        "list":[
            {
                    "create_time":"1111",
                    "submitter_userid":"a",
                    "submitter_user_name":"a",
                    "forms":[
                        {
                                "value":"a",
                                "label":"a",
                                "key":"Field"
                        }
                    ],
                    "modify_time":"1111",
                    "form_instance_id":"111",
                    "student_class_name":"a",
                    "student_name":"a",
                    "student_class_id":1,
                    "student_user_id":"11"
            }
        ],
        "next_cursor":1
    }
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.collection.instance.list (批量获取填表记录)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ