ノードリストの取得

本インターフェースを呼び出して、ノードリストを取得します。

リクエスト

基本情報

フィールド	値
HTTP URL	https://api.dingtalk.io/v2.0/wiki/nodes
HTTP Method	GET
サポートされるアプリタイプ	appType-社内アプリ　appType-サードパーティ社内アプリ
権限要件	permission-Wiki.Node.Read-ナレッジベースノード読み取り権限

リクエストヘッダー

名前	タイプ	必須	説明
x-acs-dingtalk-access-token	String	はい	本インターフェースを呼び出すためのアクセス認証情報。以下の方法で取得します： - 社内アプリの場合は、社内アプリのアクセストークン取得インターフェースを呼び出して取得します。 - サードパーティ社内アプリの場合は、サードパーティアプリが認可された企業のアクセストークン取得インターフェースを呼び出して取得します。

クエリパラメータ

名前	タイプ	必須	説明
parentNodeId	String	はい	親ノード ID（親ノード dentryUuid）。ナレッジベースリスト取得インターフェースを呼び出し、レスポンスパラメータの`rootNodeId`フィールドから取得できます。
nextToken	String	いいえ	ページネーションカーソル。初回取得時は指定不要です。
maxResults	Integer	いいえ	ページサイズ。デフォルトは 50。最大値は 50。
withPermissionRole	Boolean	いいえ	権限情報を取得するかどうか： - true：取得する - false：取得しないデフォルトは false。
operatorId	String	はい	操作者の unionId。

リクエスト例

HTTP

GET /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

Java

// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * トークンを使用してアカウント Client を初期化
     * @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)) {
                // err には code と message 属性が含まれており、問題の特定に役立ちます
            }

        } 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)) {
                // err には code と message 属性が含まれており、問題の特定に役立ちます
            }

        }        
    }
}

Python

# -*- 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:
        """
        トークンを使用してアカウント Client を初期化
        @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):
                # err には code と message 属性が含まれており、問題の特定に役立ちます
                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):
                # err には code と message 属性が含まれており、問題の特定に役立ちます
                pass

if __name__ == '__main__':
    Sample.main(sys.argv[1:])

PHP

<?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 {

    /**
     * トークンを使用してアカウント Client を初期化
     * @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)) {
                // err には code と message 属性が含まれており、問題の特定に役立ちます
            }
        }
    }
}
$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"
)

/**
 * トークンを使用してアカウント Client を初期化
 * @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)) {
      // err には code と message 属性が含まれており、問題の特定に役立ちます
    }

  }
  return _err
}

func main() {
  err := _main(tea.StringSlice(os.Args[1:]))
  if err != nil {
    panic(err)
  }
}

Node.js

// 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 {

  /**
   * トークンを使用してアカウント Client を初期化
   * @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)) {
        // err には code と message 属性が含まれており、問題の特定に役立ちます
      }

    }    
  }

}

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 
    {

        /**
         * トークンを使用してアカウント Client を初期化
         * @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))
                {
                    // err には code と message 属性が含まれており、問題の特定に役立ちます
                }
            }
            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))
                {
                    // err には code と message 属性が含まれており、問題の特定に役立ちます
                }
            }
        }

    }
}

レスポンス

レスポンスボディ

名前	タイプ	説明
nodes	Array	ノードリスト。最大サイズは 50。
nodeId	String	ノード ID（dentryUuid）。
workspaceId	String	ナレッジベース ID（spaceUuid）。
name	String	名前。
size	Long	サイズ。
type	String	タイプ。列挙値： - FILE：ファイル - FOLDER：フォルダー
category	String	カテゴリ。列挙値： - ALIDOC：DingTalkドキュメント - DOCUMENT：ローカルドキュメント - IMAGE：画像 - VIDEO：動画 - AUDIO：音声 - ARCHIVE：アーカイブファイル - OTHER：その他のタイプ
extension	String	拡張子。
url	String	アクセス URL。
creatorId	String	作成者の userId。
modifierId	String	編集者の userId。
createTime	String	作成時間。
modifiedTime	String	編集時間。
hasChildren	Boolean	子ノードを持つかどうか： - true：あり - false：なし
statisticalInfo	Object	統計情報。
wordCount	Long	文字数。
permissionRole	String	現在のユーザーがナレッジベースノードに対して持つ権限ロール。列挙値： - OWNER：オーナー - MANAGER：管理者 - EDITOR：編集者 - DOWNLOADER：閲覧・ダウンロード可能者 - READER：閲覧のみ可能者 - NONE：権限なし
nextToken	String	ページネーションカーソル。空でない場合は、さらにデータがあることを示します。

レスポンスボディ例

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"
}

エラーコード

本インターフェースの呼び出しでエラーが発生した場合は、エラーメッセージをもとにグローバルエラーコードドキュメントから解決策を検索できます。

HttpCode	エラーコード	エラーメッセージ	説明
400	paramError	%s	パラメータエラー
403	permissionDenied	%s	現在のユーザーには本操作の権限がありません
404	parentNodeNotExist	%s	親ノードが存在しません
500	systemError	%s	サービスが混雑しています。後で再試行してください
500	unknownError	Unknown Error	不明なエラー
503	operationTimeout	%s	リクエストタイムアウト

API 呼び出しガイド

認証と認可

連絡先

カレンダー

会議

AI Table

Docs とファイル

IM

リクエスト

基本情報

リクエストヘッダー

クエリパラメータ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード

​リクエスト

​基本情報

​リクエストヘッダー

​クエリパラメータ

​リクエスト例

​レスポンス

​レスポンスボディ

​レスポンスボディ例

​エラーコード

リクエスト

基本情報

リクエストヘッダー

クエリパラメータ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード