Request
Basic information
| Field | Value |
|---|---|
| HTTP URL | https://api.dingtalk.io/v2.0/wiki/nodes |
| HTTP Method | GET |
| Supported app types | appType-Internal app appType-Third-party enterprise app |
| Required permissions | permission-Wiki.Node.Read-Knowledge Base node read permission |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | Yes | The access credential for calling this API. Obtain it in one of the following ways: - For an internal app, call the Obtain the access token of an internal app API. - For a third-party enterprise app, call the Obtain the access token of an authorized enterprise for a third-party app API. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
| parentNodeId | String | Yes | The parent node ID (parent node dentryUuid). Obtain it from the rootNodeId field returned by the Get the knowledge base list API. |
| nextToken | String | No | The pagination cursor. Leave it empty for the first request. |
| maxResults | Integer | No | The page size. Default: 50. Maximum: 50. |
| withPermissionRole | Boolean | No | Whether to return permission information: - true: Return permissions. - false: Do not return permissions. Default: false. |
| operatorId | String | Yes | The unionId of the operator. |
Request example
HTTPGET /v2.0/wiki/nodes?parentNodeId=MNDoBb60VLBPraakI1Ywxyyn8lemrZQ3&nextToken=next_token&maxResults=30&withPermissionRole=false&operatorId=tXguN309iPhE4roSKPlLURAiEiE HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:access_token
Content-Type:application/json
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;
import com.aliyun.tea.*;
public class Sample {
/**
* Initialize the account Client using a Token
* @return Client
* @throws Exception
*/
public static com.aliyun.dingtalkwiki_2_0.Client createClient() throws Exception {
com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config();
config.protocol = "https";
config.regionId = "central";
return new com.aliyun.dingtalkwiki_2_0.Client(config);
}
public static void main(String[] args_) throws Exception {
java.util.List<String> args = java.util.Arrays.asList(args_);
com.aliyun.dingtalkwiki_2_0.Client client = Sample.createClient();
com.aliyun.dingtalkwiki_2_0.models.ListNodesHeaders listNodesHeaders = new com.aliyun.dingtalkwiki_2_0.models.ListNodesHeaders();
listNodesHeaders.xAcsDingtalkAccessToken = "<your access token>";
com.aliyun.dingtalkwiki_2_0.models.ListNodesRequest listNodesRequest = new com.aliyun.dingtalkwiki_2_0.models.ListNodesRequest()
.setParentNodeId("MNDoBb60VLBPraakI1Ywxyyn8lemrZQ3")
.setNextToken("next_token")
.setMaxResults(30)
.setWithPermissionRole(false)
.setOperatorId("tXguN309iPhE4roSKPlLURAiEiE");
try {
client.listNodesWithOptions(listNodesRequest, listNodesHeaders, new com.aliyun.teautil.models.RuntimeOptions());
} catch (TeaException err) {
if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
// The err object contains the code and message properties, which help locate the issue.
}
} catch (Exception _err) {
TeaException err = new TeaException(_err.getMessage(), _err);
if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
// The err object contains the code and message properties, which help locate the issue.
}
}
}
}
# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import sys
from typing import List
from alibabacloud_dingtalk.wiki_2_0.client import Client as dingtalkwiki_2_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.wiki_2_0 import models as dingtalkwiki__2__0_models
from alibabacloud_tea_util import models as util_models
from alibabacloud_tea_util.client import Client as UtilClient
class Sample:
def __init__(self):
pass
@staticmethod
def create_client() -> dingtalkwiki_2_0Client:
"""
Initialize the account Client using a Token
@return: Client
@throws Exception
"""
config = open_api_models.Config()
config.protocol = 'https'
config.region_id = 'central'
return dingtalkwiki_2_0Client(config)
@staticmethod
def main(
args: List[str],
) -> None:
client = Sample.create_client()
list_nodes_headers = dingtalkwiki__2__0_models.ListNodesHeaders()
list_nodes_headers.x_acs_dingtalk_access_token = '<your access token>'
list_nodes_request = dingtalkwiki__2__0_models.ListNodesRequest(
parent_node_id='MNDoBb60VLBPraakI1Ywxyyn8lemrZQ3',
next_token='next_token',
max_results=30,
with_permission_role=False,
operator_id='tXguN309iPhE4roSKPlLURAiEiE'
)
try:
client.list_nodes_with_options(list_nodes_request, list_nodes_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# The err object contains the code and message properties, which help locate the issue.
pass
@staticmethod
async def main_async(
args: List[str],
) -> None:
client = Sample.create_client()
list_nodes_headers = dingtalkwiki__2__0_models.ListNodesHeaders()
list_nodes_headers.x_acs_dingtalk_access_token = '<your access token>'
list_nodes_request = dingtalkwiki__2__0_models.ListNodesRequest(
parent_node_id='MNDoBb60VLBPraakI1Ywxyyn8lemrZQ3',
next_token='next_token',
max_results=30,
with_permission_role=False,
operator_id='tXguN309iPhE4roSKPlLURAiEiE'
)
try:
await client.list_nodes_with_options_async(list_nodes_request, list_nodes_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# The err object contains the code and message properties, which help locate the issue.
pass
if __name__ == '__main__':
Sample.main(sys.argv[1:])
<?php
// This file is auto-generated, don't edit it. Thanks.
namespace AlibabaCloud\SDK\Sample;
use AlibabaCloud\SDK\Dingtalk\Vwiki_2_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;
use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vwiki_2_0\Models\ListNodesHeaders;
use AlibabaCloud\SDK\Dingtalk\Vwiki_2_0\Models\ListNodesRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
class Sample {
/**
* Initialize the account Client using a Token
* @return Dingtalk Client
*/
public static function createClient(){
$config = new Config([]);
$config->protocol = "https";
$config->regionId = "central";
return new Dingtalk($config);
}
/**
* @param string[] $args
* @return void
*/
public static function main($args){
$client = self::createClient();
$listNodesHeaders = new ListNodesHeaders([]);
$listNodesHeaders->xAcsDingtalkAccessToken = "<your access token>";
$listNodesRequest = new ListNodesRequest([
"parentNodeId" => "MNDoBb60VLBPraakI1Ywxyyn8lemrZQ3",
"nextToken" => "next_token",
"maxResults" => 30,
"withPermissionRole" => false,
"operatorId" => "tXguN309iPhE4roSKPlLURAiEiE"
]);
try {
$client->listNodesWithOptions($listNodesRequest, $listNodesHeaders, new RuntimeOptions([]));
}
catch (Exception $err) {
if (!($err instanceof TeaError)) {
$err = new TeaError([], $err->getMessage(), $err->getCode(), $err);
}
if (!Utils::empty_($err->code) && !Utils::empty_($err->message)) {
// The err object contains the code and message properties, which help locate the issue.
}
}
}
}
$path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
require_once $path;
}
Sample::main(array_slice($argv, 1));
// This file is auto-generated, don't edit it. Thanks.
package main
import (
"os"
util "github.com/alibabacloud-go/tea-utils/v2/service"
dingtalkwiki_2_0 "github.com/alibabacloud-go/dingtalk/wiki_2_0"
openapi "github.com/alibabacloud-go/darabonba-openapi/v2/client"
"github.com/alibabacloud-go/tea/tea"
)
/**
* Initialize the account Client using a Token
* @return Client
* @throws Exception
*/
func CreateClient () (_result *dingtalkwiki_2_0.Client, _err error) {
config := &openapi.Config{}
config.Protocol = tea.String("https")
config.RegionId = tea.String("central")
_result = &dingtalkwiki_2_0.Client{}
_result, _err = dingtalkwiki_2_0.NewClient(config)
return _result, _err
}
func _main (args []*string) (_err error) {
client, _err := CreateClient()
if _err != nil {
return _err
}
listNodesHeaders := &dingtalkwiki_2_0.ListNodesHeaders{}
listNodesHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
listNodesRequest := &dingtalkwiki_2_0.ListNodesRequest{
ParentNodeId: tea.String("MNDoBb60VLBPraakI1Ywxyyn8lemrZQ3"),
NextToken: tea.String("next_token"),
MaxResults: tea.Int32(30),
WithPermissionRole: tea.Bool(false),
OperatorId: tea.String("tXguN309iPhE4roSKPlLURAiEiE"),
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.ListNodesWithOptions(listNodesRequest, listNodesHeaders, &util.RuntimeOptions{})
if _err != nil {
return _err
}
return nil
}()
if tryErr != nil {
var err = &tea.SDKError{}
if _t, ok := tryErr.(*tea.SDKError); ok {
err = _t
} else {
err.Message = tea.String(tryErr.Error())
}
if !tea.BoolValue(util.Empty(err.Code)) && !tea.BoolValue(util.Empty(err.Message)) {
// The err object contains the code and message properties, which help locate the issue.
}
}
return _err
}
func main() {
err := _main(tea.StringSlice(os.Args[1:]))
if err != nil {
panic(err)
}
}
// This file is auto-generated, don't edit it
import Util, * as $Util from '@alicloud/tea-util';
import dingtalkwiki_2_0, * as $dingtalkwiki_2_0 from '@alicloud/dingtalk/wiki_2_0';
import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
import * as $tea from '@alicloud/tea-typescript';
export default class Client {
/**
* Initialize the account Client using a Token
* @return Client
* @throws Exception
*/
static createClient(): dingtalkwiki_2_0 {
let config = new $OpenApi.Config({ });
config.protocol = "https";
config.regionId = "central";
return new dingtalkwiki_2_0(config);
}
static async main(args: string[]): Promise<void> {
let client = Client.createClient();
let listNodesHeaders = new $dingtalkwiki_2_0.ListNodesHeaders({ });
listNodesHeaders.xAcsDingtalkAccessToken = "<your access token>";
let listNodesRequest = new $dingtalkwiki_2_0.ListNodesRequest({
parentNodeId: "MNDoBb60VLBPraakI1Ywxyyn8lemrZQ3",
nextToken: "next_token",
maxResults: 30,
withPermissionRole: false,
operatorId: "tXguN309iPhE4roSKPlLURAiEiE",
});
try {
await client.listNodesWithOptions(listNodesRequest, listNodesHeaders, new $Util.RuntimeOptions({ }));
} catch (err) {
if (!Util.empty(err.code) && !Util.empty(err.message)) {
// The err object contains the code and message properties, which help locate the issue.
}
}
}
}
Client.main(process.argv.slice(2));
// This file is auto-generated, don't edit it. Thanks.
using System;
using System.Collections;
using System.Collections.Generic;
using System.IO;
using System.Threading.Tasks;
using Tea;
using Tea.Utils;
namespace AlibabaCloud.SDK.Sample
{
public class Sample
{
/**
* Initialize the account Client using a Token
* @return Client
* @throws Exception
*/
public static AlibabaCloud.SDK.Dingtalkwiki_2_0.Client CreateClient()
{
AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
config.Protocol = "https";
config.RegionId = "central";
return new AlibabaCloud.SDK.Dingtalkwiki_2_0.Client(config);
}
public static void Main(string[] args)
{
AlibabaCloud.SDK.Dingtalkwiki_2_0.Client client = CreateClient();
AlibabaCloud.SDK.Dingtalkwiki_2_0.Models.ListNodesHeaders listNodesHeaders = new AlibabaCloud.SDK.Dingtalkwiki_2_0.Models.ListNodesHeaders();
listNodesHeaders.XAcsDingtalkAccessToken = "<your access token>";
AlibabaCloud.SDK.Dingtalkwiki_2_0.Models.ListNodesRequest listNodesRequest = new AlibabaCloud.SDK.Dingtalkwiki_2_0.Models.ListNodesRequest
{
ParentNodeId = "MNDoBb60VLBPraakI1Ywxyyn8lemrZQ3",
NextToken = "next_token",
MaxResults = 30,
WithPermissionRole = false,
OperatorId = "tXguN309iPhE4roSKPlLURAiEiE",
};
try
{
client.ListNodesWithOptions(listNodesRequest, listNodesHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
}
catch (TeaException err)
{
if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
{
// The err object contains the code and message properties, which help locate the issue.
}
}
catch (Exception _err)
{
TeaException err = new TeaException(new Dictionary<string, object>
{
{ "message", _err.Message }
});
if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
{
// The err object contains the code and message properties, which help locate the issue.
}
}
}
}
}
Response
Response body
| Name | Type | Description |
|---|---|---|
| nodes | Array | The list of nodes. Maximum size: 50. |
| nodeId | String | The node ID (dentryUuid). |
| workspaceId | String | The knowledge base ID (spaceUuid). |
| name | String | The name. |
| size | Long | The size. |
| type | String | The type. Enum values: - FILE: File - FOLDER: Folder |
| category | String | The category. Enum values: - ALIDOC: DingTalk Docs - DOCUMENT: Local document - IMAGE: Image - VIDEO: Video - AUDIO: Audio - ARCHIVE: Archive file - OTHER: Other type |
| extension | String | The file extension. |
| url | String | The access URL. |
| creatorId | String | The userId of the creator. |
| modifierId | String | The userId of the last modifier. |
| createTime | String | The created time. |
| modifiedTime | String | The modified time. |
| hasChildren | Boolean | Whether the node has child nodes: - true: Yes - false: No |
| statisticalInfo | Object | The statistical information. |
| wordCount | Long | The word count. |
| permissionRole | String | The permission role of the current user on the knowledge base node. Enum values: - OWNER: Owner - MANAGER: Manager - EDITOR: Editor - DOWNLOADER: Viewer with download permission - READER: View-only - NONE: No permission |
| nextToken | String | The pagination cursor. A non-empty value indicates more data is available. |
Response example
HTTP/1.1 200 OK
Content-Type:application/json
{
"nodes" : [ {
"nodeId" : "MNDoBb60VLBPraakI1Ywxyyn8lemrZQ3",
"workspaceId" : "MNDoBb60VLBPraakI1Ywxyyn8lemrZQ3",
"name" : "node_name",
"size" : 512,
"type" : "FILE",
"category" : "ALIDOC",
"extension" : "adoc",
"url" : "node_url",
"creatorId" : "01472825524039877041",
"modifierId" : "01472825524039877041",
"createTime" : "2023-05-15T11:29Z",
"modifiedTime" : "2023-05-15T11:29Z",
"hasChildren" : false,
"statisticalInfo" : {
"wordCount" : 123
},
"permissionRole" : "READER"
} ],
"nextToken" : "next_token"
}
Error codes
If this API returns an error, refer to the Global error codes document for solutions.| HttpCode | Error code | Error message | Description |
|---|---|---|---|
| 400 | paramError | %s | Parameter error |
| 403 | permissionDenied | %s | The current user does not have permission for this operation. |
| 404 | parentNodeNotExist | %s | The parent node does not exist. |
| 500 | systemError | %s | The service is busy. Try again later. |
| 500 | unknownError | Unknown Error | Unknown error |
| 503 | operationTimeout | %s | Request timed out |