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

dingtalk.oapi.process.template.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。

请求参数

名称	类型	是否必须	示例值	描述
userid	String	可选	abc123	abc123
offset	Number	可选	0	游标属性
size	Number	可选	20	每页数量

响应参数

名称	类型	示例值	描述
result	CorpTemplateVo		result
template_list Templatelist [] list └ can_modify Boolean true 是否有管理权限 └ form_content String {"iconUrl":"leave","memo":"适用于请假申请，精确扣减出勤时间，并同步考勤报表","isDeleted":"n","visibleRange":"PRIVATE"} 模板内容 └ icon_url String https://gw.alicdn.com/tfs/TB1akESdcLJ8KJjy0FnXXcFDpXa-102-102.png 模板图标url └ name String 请假模板名称 └ process_code String PROC-xxx 模板code └ url String https://xxx 模板跳转地址 └ can_be_upgraded Boolean false 是否可升级，加入收款账户组件 └ next_cursor String 0 下次调用时的offset入参
errcode	Number	0	dingOpenErrcode
errmsg	String	成功	errorMsg
success	Boolean	true	是否成功

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/process/template/list");
OapiProcessTemplateListRequest req = new OapiProcessTemplateListRequest();
req.setUserid("abc123");
req.setOffset(0L);
req.setSize(20L);
OapiProcessTemplateListResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/process/template/list");
OapiProcessTemplateListRequest req = new OapiProcessTemplateListRequest();
req.Userid = "abc123";
req.Offset = 0L;
req.Size = 20L;
OapiProcessTemplateListResponse 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 OapiProcessTemplateListRequest;
$req->setUserid("abc123");
$req->setOffset("0");
$req->setSize("20");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/process/template/list");

curl -X POST "https://oapi.dingtalk.com/topapi/process/template/list" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=caa4ae0b-7b22-43e2-81ab-df5c1fe8ba1d' \
-d 'offset=0' \
-d 'size=20' \
-d 'userid=abc123'

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

req=dingtalk.api.OapiProcessTemplateListRequest("https://oapi.dingtalk.com/topapi/process/template/list")

req.userid="abc123"
req.offset=0
req.size=20
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.process.template.list");
add_param(pRequest,"userid","abc123");
add_param(pRequest,"offset","0");
add_param(pRequest,"size","20");
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.process.template.list', {
	'userid':'abc123',
	'offset':'0',
	'size':'20'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":{
        "template_list":[
            {
                    "can_modify":true,
                    "form_content":"{\"iconUrl\":\"leave\",\"memo\":\"适用于请假申请，精确扣减出勤时间，并同步考勤报表\",\"isDeleted\":\"n\",\"visibleRange\":\"PRIVATE\"}",
                    "icon_url":"https:\/\/gw.alicdn.com\/tfs\/TB1akESdcLJ8KJjy0FnXXcFDpXa-102-102.png",
                    "name":"请假",
                    "process_code":"PROC-xxx",
                    "url":"https:\/\/xxx",
                    "can_be_upgraded":false
            }
        ],
        "next_cursor":"0"
    },
    "errcode":0,
    "errmsg":"成功",
    "success":true
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.process.template.list (分页获取企业下所有的流程模板)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ