> ## Documentation Index
> Fetch the complete documentation index at: https://help.dingtalk.io/llms.txt
> Use this file to discover all available pages before exploring further.

# ナレッジベース一覧の取得

> 操作者のナレッジベース一覧を権限情報や複数の並び替え条件と共に取得できます

本インターフェースを呼び出し、操作者の unionId に基づきナレッジベース一覧情報を取得します。

## リクエスト

### 基本情報

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

### リクエストヘッダー

| 名前                          | タイプ    | 必須 | 説明                                                                                                                                                                                                                                                                                                                                            |
| --------------------------- | ------ | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| x-acs-dingtalk-access-token | String | はい | 本インターフェースを呼び出すためのアクセス認証情報です。以下の方法で取得します:   - 社内アプリの場合は、[社内アプリのアクセストークンを取得](/ja/open/development/obtain-the-access-token-of-an-internal-app#)インターフェースを呼び出して取得します。 - サードパーティ社内アプリの場合は、[サードパーティアプリの認可企業のアクセストークンを取得](https://open.dingtalk.com/document/development/obtain-the-access-token-of-the-authorized-enterprise-1#)インターフェースを呼び出して取得します。 |

### クエリパラメータ

| 名前                 | タイプ     | 必須  | 説明                                                                                                                  |
| ------------------ | ------- | --- | ------------------------------------------------------------------------------------------------------------------- |
| nextToken          | String  | いいえ | ページネーションカーソル。初回取得時には不要です。                                                                                           |
| maxResults         | Integer | いいえ | ページサイズ。デフォルトは 30 です。  最大値は 30 です。                                                                                   |
| orderBy            | String  | いいえ | 並び替え方式。列挙値:   - **VIEW\_TIME\_DESC**: 閲覧時間の降順 - **CREATE\_TIME\_DESC**: 作成時間の降順 - **MODIFIED\_TIME\_DESC**: 編集時間の降順 |
| withPermissionRole | Boolean | いいえ | 権限を同時にクエリするかどうか:   - true: クエリする - false: クエリしない   デフォルトは false です。                                                 |
| operatorId         | String  | はい  | 操作者の unionId です。                                                                                                    |

### リクエスト例

HTTP

```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
GET /v2.0/wiki/workspaces?nextToken=next_token&maxResults=30&orderBy=VIEW_TIME_DESC&withPermissionRole=false&operatorId=tXguN309iPhE4roSKPlLURAiEiE HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:access_token
Content-Type:application/json
```

Java

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>Token を使用してアカウント Client を初期化します</p>
     * @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 {
        
        com.aliyun.dingtalkwiki_2_0.Client client = Sample.createClient();
        com.aliyun.dingtalkwiki_2_0.models.ListWorkspacesHeaders listWorkspacesHeaders = new com.aliyun.dingtalkwiki_2_0.models.ListWorkspacesHeaders();
        listWorkspacesHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkwiki_2_0.models.ListWorkspacesRequest listWorkspacesRequest = new com.aliyun.dingtalkwiki_2_0.models.ListWorkspacesRequest()
                .setNextToken("next_token")
                .setMaxResults(30)
                .setOrderBy("VIEW_TIME_DESC")
                .setWithPermissionRole(false)
                .setOperatorId("tXguN309iPhE4roSKPlLURAiEiE");
        try {
            client.listWorkspacesWithOptions(listWorkspacesRequest, listWorkspacesHeaders, 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

```python theme={"theme":{"light":"github-light","dark":"github-dark"}}
# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import os
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:
        """
        Token を使用してアカウント 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_workspaces_headers = dingtalkwiki__2__0_models.ListWorkspacesHeaders()
        list_workspaces_headers.x_acs_dingtalk_access_token = '<your access token>'
        list_workspaces_request = dingtalkwiki__2__0_models.ListWorkspacesRequest(
            next_token='next_token',
            max_results=30,
            order_by='VIEW_TIME_DESC',
            with_permission_role=False,
            operator_id='tXguN309iPhE4roSKPlLURAiEiE'
        )
        try:
            client.list_workspaces_with_options(list_workspaces_request, list_workspaces_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_workspaces_headers = dingtalkwiki__2__0_models.ListWorkspacesHeaders()
        list_workspaces_headers.x_acs_dingtalk_access_token = '<your access token>'
        list_workspaces_request = dingtalkwiki__2__0_models.ListWorkspacesRequest(
            next_token='next_token',
            max_results=30,
            order_by='VIEW_TIME_DESC',
            with_permission_role=False,
            operator_id='tXguN309iPhE4roSKPlLURAiEiE'
        )
        try:
            await client.list_workspaces_with_options_async(list_workspaces_request, list_workspaces_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

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
<?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\ListWorkspacesHeaders;
use AlibabaCloud\SDK\Dingtalk\Vwiki_2_0\Models\ListWorkspacesRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Token を使用してアカウント 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();
        $listWorkspacesHeaders = new ListWorkspacesHeaders([]);
        $listWorkspacesHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $listWorkspacesRequest = new ListWorkspacesRequest([
            "nextToken" => "next_token",
            "maxResults" => 30,
            "orderBy" => "VIEW_TIME_DESC",
            "withPermissionRole" => false,
            "operatorId" => "tXguN309iPhE4roSKPlLURAiEiE"
        ]);
        try {
            $client->listWorkspacesWithOptions($listWorkspacesRequest, $listWorkspacesHeaders, 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));
```

Go

```go theme={"theme":{"light":"github-light","dark":"github-dark"}}
// This file is auto-generated, don't edit it. Thanks.
package main

import (
  "encoding/json"
  "strings"
  "fmt"
  "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"
)

// Description:
// 
// Token を使用してアカウント 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
  }

  listWorkspacesHeaders := &dingtalkwiki_2_0.ListWorkspacesHeaders{}
  listWorkspacesHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  listWorkspacesRequest := &dingtalkwiki_2_0.ListWorkspacesRequest{
    NextToken: tea.String("next_token"),
    MaxResults: tea.Int32(30),
    OrderBy: tea.String("VIEW_TIME_DESC"),
    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.ListWorkspacesWithOptions(listWorkspacesRequest, listWorkspacesHeaders, &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

```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
'use strict';
// This file is auto-generated, don't edit it
const Util = require('@alicloud/tea-util');
const dingtalkwiki_2_0 = require('@alicloud/dingtalk/wiki_2_0');
const OpenApi = require('@alicloud/openapi-client');
const Tea = require('@alicloud/tea-typescript');

class Client {

  /**
   * Token を使用してアカウント Client を初期化します
   * @return Client
   * @throws Exception
   */
  static createClient() {
    let config = new OpenApi.Config({ });
    config.protocol = 'https';
    config.regionId = 'central';
    return new dingtalkwiki_2_0.default(config);
  }

  static async main(args) {
    let client = Client.createClient();
    let listWorkspacesHeaders = new dingtalkwiki_2_0.ListWorkspacesHeaders({ });
    listWorkspacesHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let listWorkspacesRequest = new dingtalkwiki_2_0.ListWorkspacesRequest({
      nextToken: 'next_token',
      maxResults: 30,
      orderBy: 'VIEW_TIME_DESC',
      withPermissionRole: false,
      operatorId: 'tXguN309iPhE4roSKPlLURAiEiE',
    });
    try {
      await client.listWorkspacesWithOptions(listWorkspacesRequest, listWorkspacesHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err には code と message プロパティが含まれており、開発時の問題特定に役立ちます
      }

    }    
  }

}

exports.Client = Client;
Client.main(process.argv.slice(2));
```

C#

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
// 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 
    {

        /// <term><b>Description:</b></term>
        /// <description>
        /// <para>Token を使用してアカウント Client を初期化します</para>
        /// </description>
        /// 
        /// <returns>
        /// Client
        /// </returns>
        /// 
        /// <term><b>Exception:</b></term>
        /// 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.ListWorkspacesHeaders listWorkspacesHeaders = new AlibabaCloud.SDK.Dingtalkwiki_2_0.Models.ListWorkspacesHeaders();
            listWorkspacesHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkwiki_2_0.Models.ListWorkspacesRequest listWorkspacesRequest = new AlibabaCloud.SDK.Dingtalkwiki_2_0.Models.ListWorkspacesRequest
            {
                NextToken = "next_token",
                MaxResults = 30,
                OrderBy = "VIEW_TIME_DESC",
                WithPermissionRole = false,
                OperatorId = "tXguN309iPhE4roSKPlLURAiEiE",
            };
            try
            {
                client.ListWorkspacesWithOptions(listWorkspacesRequest, listWorkspacesHeaders, 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 プロパティが含まれており、開発時の問題特定に役立ちます
                }
            }
        }

    }
}
```

## レスポンス

### レスポンスボディ

| 名前             | タイプ    | 説明                                                                                                                                                           |
| -------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| workspaces     | Array  | ナレッジベース一覧。最大サイズは 30 です。                                                                                                                                      |
| workspaceId    | String | ナレッジベース ID（spaceUuid）。                                                                                                                                       |
| corpId         | String | ナレッジベースが属する企業の組織 ID。                                                                                                                                         |
| teamId         | String | ナレッジベースが属するナレッジグループの ID。  いずれのナレッジグループにも属さない場合は空を返します。                                                                                                       |
| rootNodeId     | String | ルートノード ID（ルートノードの dentryUuid）。                                                                                                                               |
| name           | String | ナレッジベース名。                                                                                                                                                    |
| type           | String | ナレッジベースのタイプ。列挙値:   - **TEAM**: ナレッジベース - **PERSONAL**: マイドキュメント                                                                                              |
| description    | String | ナレッジベースの概要。                                                                                                                                                  |
| url            | String | ナレッジベースのアクセス URL。                                                                                                                                            |
| icon           | Object | ナレッジベースのアイコン。                                                                                                                                                |
| type           | String | アイコンタイプ。列挙値:   - **URL**: リンク - **EMOJI**: emoji アイコン                                                                                                        |
| value          | String | アイコンの値:   - type が URL の場合は、アイコンのリンクを返します。 - type が EMOJI の場合は、emoji アイコンの Unicode 値を返します。                                                                   |
| cover          | String | ナレッジベースのカバー画像 URL。                                                                                                                                           |
| creatorId      | String | ナレッジベース作成者の userId。                                                                                                                                          |
| modifierId     | String | ナレッジベース編集者の userId。                                                                                                                                          |
| createTime     | String | ナレッジベースの作成時間。                                                                                                                                                |
| modifiedTime   | String | ナレッジベースの編集時間。                                                                                                                                                |
| permissionRole | String | クエリ実行者のナレッジベースに対する権限ロール。列挙値:   - **OWNER**: 所有者 - **MANAGER**: 管理者 - **EDITOR**: 編集者 - **DOWNLOADER**: 閲覧およびダウンロード可能者 - **READER**: 閲覧のみ可能者 - **NONE**: 権限なし |
| nextToken      | String | ページネーションカーソル。  空でない場合は、さらにデータがあることを示します。                                                                                                                     |

### レスポンスボディ例

```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
HTTP/1.1 200 OK
Content-Type:application/json

{
  "workspaces" : [ {
    "workspaceId" : "By8jQS1ZYjGn5b0M",
    "corpId" : "ding16b241fd05********288",
    "rootNodeId" : "ZgpG2NdyVXXjrKKzIBqMp5zkVMwvDqPk",
    "name" : "workspace_name",
    "type" : "TEAM",
    "description" : "workspace_description",
    "url" : "workspace_url",
    "icon" : {
      "type" : "URL",
      "value" : "icon_url"
    },
    "cover" : "https://example/file-manage-files/zh-CN/202***13/ldet/XXXX.jpg",
    "creatorId" : "workspace_creator_id",
    "modifierId" : "workspace_modifier_id",
    "createTime" : "2023-05-15T11:29Z",
    "modifiedTime" : "2023-05-15T11:29Z",
    "permissionRole" : "READER"
  } ],
  "nextToken" : "next_token"
}
```

### エラーコード

本インターフェースの呼び出しでエラーが発生した場合は、エラーメッセージをもとに[グローバルエラーコード](/ja/open/development/server-api-error-codes-1)ドキュメントから解決方法を検索してください。

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