> ## 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.

# Mendapatkan Knowledge Base secara massal

> Panggil API ini untuk mengambil Knowledge Base secara massal menggunakan parameter seperti workspaceIds, option, dan withPermissionRole di DingTalk.

Gunakan API ini untuk mendapatkan Knowledge Base secara massal. Saat memanggil API, kirim permintaan POST yang menyertakan bidang bisnis seperti `workspaceIds`, `option`, dan `withPermissionRole`.

## Permintaan

### Informasi dasar

| Bidang                      | Nilai                                                                                                              |
| --------------------------- | ------------------------------------------------------------------------------------------------------------------ |
| URL HTTP                    | [https://api.dingtalk.io/v2.0/wiki/workspaces/batchQuery](https://api.dingtalk.io/v2.0/wiki/workspaces/batchQuery) |
| Metode HTTP                 | POST                                                                                                               |
| Tipe aplikasi yang didukung | appType-Aplikasi internal　appType-Aplikasi perusahaan pihak ketiga                                                 |
| Izin yang diperlukan        | permission-Wiki.Workspace.Read-Izin baca Knowledge Base                                                            |

### Header permintaan

| Nama                        | Tipe   | Wajib | Deskripsi                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| --------------------------- | ------ | ----- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| x-acs-dingtalk-access-token | String | Ya    | Kredensial akses yang digunakan untuk memanggil API ini. Dapatkan dengan cara berikut:   - Untuk aplikasi internal, panggil API [Mendapatkan access token aplikasi internal](/id/open/development/obtain-the-access-token-of-an-internal-app#). - Untuk aplikasi perusahaan pihak ketiga, panggil API [Mendapatkan access token organisasi yang diberi otorisasi ke aplikasi pihak ketiga](https://open.dingtalk.com/document/development/obtain-the-access-token-of-the-authorized-enterprise-1#). |

### Parameter query

| Nama       | Tipe   | Wajib | Deskripsi              |
| ---------- | ------ | ----- | ---------------------- |
| operatorId | String | Ya    | unionId dari operator. |

### Isi permintaan

| Nama               | Tipe            | Wajib | Deskripsi                                                                                                                                                                                           |
| ------------------ | --------------- | ----- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| workspaceIds       | Array of String | Ya    | ID Knowledge Base. Panggil API [Mendapatkan daftar Knowledge Base](/id/open/development/get-knowledge-base-list#) dan dapatkan nilai bidang `workspaceId` dari respons.  Ukuran maksimum adalah 20. |
| option             | Object          | Tidak | Parameter opsional.                                                                                                                                                                                 |
| withPermissionRole | Boolean         | Tidak | Apakah akan mengembalikan informasi izin:   - **true**: Kembalikan - **false**: Jangan kembalikan   Default: false.                                                                                 |

### Contoh permintaan

HTTP

```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
POST /v2.0/wiki/workspaces/batchQuery?operatorId=tXguN309iPhE4roSKPlLURAiEiE HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:access_token
Content-Type:application/json

{
  "workspaceIds" : [ "9r09jSO3WARyxd8A" ],
  "option" : {
    "withPermissionRole" : false
  }
}
```

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 {

    /**
     * Initialize the account Client with 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.GetWorkspacesHeaders getWorkspacesHeaders = new com.aliyun.dingtalkwiki_2_0.models.GetWorkspacesHeaders();
        getWorkspacesHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkwiki_2_0.models.GetWorkspacesRequest.GetWorkspacesRequestOption option = new com.aliyun.dingtalkwiki_2_0.models.GetWorkspacesRequest.GetWorkspacesRequestOption()
                .setWithPermissionRole(false);
        com.aliyun.dingtalkwiki_2_0.models.GetWorkspacesRequest getWorkspacesRequest = new com.aliyun.dingtalkwiki_2_0.models.GetWorkspacesRequest()
                .setOperatorId("tXguN309iPhE4roSKPlLURAiEiE")
                .setWorkspaceIds(java.util.Arrays.asList(
                    "9r09jSO3WARyxd8A"
                ))
                .setOption(option);
        try {
            client.getWorkspacesWithOptions(getWorkspacesRequest, getWorkspacesHeaders, 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 berisi atribut code dan message yang membantu menemukan 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)) {
                // err berisi atribut code dan message yang membantu menemukan issue
            }

        }        
    }
}
```

Python

```python theme={"theme":{"light":"github-light","dark":"github-dark"}}
# -*- 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 with 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()
        get_workspaces_headers = dingtalkwiki__2__0_models.GetWorkspacesHeaders()
        get_workspaces_headers.x_acs_dingtalk_access_token = '<your access token>'
        option = dingtalkwiki__2__0_models.GetWorkspacesRequestOption(
            with_permission_role=False
        )
        get_workspaces_request = dingtalkwiki__2__0_models.GetWorkspacesRequest(
            operator_id='tXguN309iPhE4roSKPlLURAiEiE',
            workspace_ids=[
                '9r09jSO3WARyxd8A'
            ],
            option=option
        )
        try:
            client.get_workspaces_with_options(get_workspaces_request, get_workspaces_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err berisi atribut code dan message yang membantu menemukan issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        get_workspaces_headers = dingtalkwiki__2__0_models.GetWorkspacesHeaders()
        get_workspaces_headers.x_acs_dingtalk_access_token = '<your access token>'
        option = dingtalkwiki__2__0_models.GetWorkspacesRequestOption(
            with_permission_role=False
        )
        get_workspaces_request = dingtalkwiki__2__0_models.GetWorkspacesRequest(
            operator_id='tXguN309iPhE4roSKPlLURAiEiE',
            workspace_ids=[
                '9r09jSO3WARyxd8A'
            ],
            option=option
        )
        try:
            await client.get_workspaces_with_options_async(get_workspaces_request, get_workspaces_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err berisi atribut code dan message yang membantu menemukan issue
                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\GetWorkspacesHeaders;
use AlibabaCloud\SDK\Dingtalk\Vwiki_2_0\Models\GetWorkspacesRequest\option;
use AlibabaCloud\SDK\Dingtalk\Vwiki_2_0\Models\GetWorkspacesRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client with 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();
        $getWorkspacesHeaders = new GetWorkspacesHeaders([]);
        $getWorkspacesHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $option = new option([
            "withPermissionRole" => false
        ]);
        $getWorkspacesRequest = new GetWorkspacesRequest([
            "operatorId" => "tXguN309iPhE4roSKPlLURAiEiE",
            "workspaceIds" => [
                "9r09jSO3WARyxd8A"
            ],
            "option" => $option
        ]);
        try {
            $client->getWorkspacesWithOptions($getWorkspacesRequest, $getWorkspacesHeaders, 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 berisi atribut code dan message yang membantu menemukan 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));
```

Go

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

  getWorkspacesHeaders := &dingtalkwiki_2_0.GetWorkspacesHeaders{}
  getWorkspacesHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  option := &dingtalkwiki_2_0.GetWorkspacesRequestOption{
    WithPermissionRole: tea.Bool(false),
  }
  getWorkspacesRequest := &dingtalkwiki_2_0.GetWorkspacesRequest{
    OperatorId: tea.String("tXguN309iPhE4roSKPlLURAiEiE"),
    WorkspaceIds: []*string{tea.String("9r09jSO3WARyxd8A")},
    Option: option,
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.GetWorkspacesWithOptions(getWorkspacesRequest, getWorkspacesHeaders, &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 berisi atribut code dan message yang membantu menemukan issue
    }

  }
  return _err
}

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

Node.js

```python theme={"theme":{"light":"github-light","dark":"github-dark"}}
// 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 with 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 getWorkspacesHeaders = new $dingtalkwiki_2_0.GetWorkspacesHeaders({ });
    getWorkspacesHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let option = new $dingtalkwiki_2_0.GetWorkspacesRequestOption({
      withPermissionRole: false,
    });
    let getWorkspacesRequest = new $dingtalkwiki_2_0.GetWorkspacesRequest({
      operatorId: "tXguN309iPhE4roSKPlLURAiEiE",
      workspaceIds: [
        "9r09jSO3WARyxd8A"
      ],
      option: option,
    });
    try {
      await client.getWorkspacesWithOptions(getWorkspacesRequest, getWorkspacesHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // err berisi atribut code dan message yang membantu menemukan issue
      }

    }    
  }

}

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 
    {

        /**
         * Initialize the account Client with 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.GetWorkspacesHeaders getWorkspacesHeaders = new AlibabaCloud.SDK.Dingtalkwiki_2_0.Models.GetWorkspacesHeaders();
            getWorkspacesHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkwiki_2_0.Models.GetWorkspacesRequest.GetWorkspacesRequestOption option = new AlibabaCloud.SDK.Dingtalkwiki_2_0.Models.GetWorkspacesRequest.GetWorkspacesRequestOption
            {
                WithPermissionRole = false,
            };
            AlibabaCloud.SDK.Dingtalkwiki_2_0.Models.GetWorkspacesRequest getWorkspacesRequest = new AlibabaCloud.SDK.Dingtalkwiki_2_0.Models.GetWorkspacesRequest
            {
                OperatorId = "tXguN309iPhE4roSKPlLURAiEiE",
                WorkspaceIds = new List<string>
                {
                    "9r09jSO3WARyxd8A"
                },
                Option = option,
            };
            try
            {
                client.GetWorkspacesWithOptions(getWorkspacesRequest, getWorkspacesHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err berisi atribut code dan message yang membantu menemukan 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))
                {
                    // err berisi atribut code dan message yang membantu menemukan issue
                }
            }
        }

    }
}
```

## Respons

### Isi respons

| Nama           | Tipe   | Deskripsi                                                                                                                                                                                                                   |
| -------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| workspaces     | Array  | Daftar Knowledge Base.                                                                                                                                                                                                      |
| workspaceId    | String | ID Knowledge Base (spaceUuid).                                                                                                                                                                                              |
| corpId         | String | ID organisasi yang menjadi milik Knowledge Base.                                                                                                                                                                            |
| teamId         | String | ID Grup Pengetahuan yang menjadi milik Knowledge Base.  Mengembalikan kosong jika Knowledge Base tidak termasuk dalam Grup Pengetahuan mana pun.                                                                            |
| rootNodeId     | String | ID node akar (dentryUuid node akar).                                                                                                                                                                                        |
| name           | String | Nama Knowledge Base.                                                                                                                                                                                                        |
| type           | String | Tipe Knowledge Base. Nilai enum:   - **TEAM**: Knowledge Base - **PERSONAL**: Dokumen Saya                                                                                                                                  |
| description    | String | Deskripsi Knowledge Base.                                                                                                                                                                                                   |
| url            | String | URL yang digunakan untuk mengakses Knowledge Base.                                                                                                                                                                          |
| icon           | Object | Ikon Knowledge Base.                                                                                                                                                                                                        |
| type           | String | Tipe ikon. Nilai enum:   - **URL**: Tautan - **EMOJI**: Ikon emoji                                                                                                                                                          |
| value          | String | Nilai ikon:   - Jika type adalah URL, mengembalikan tautan ikon. - Jika type adalah EMOJI, mengembalikan nilai Unicode dari ikon emoji.                                                                                     |
| cover          | String | URL sampul Knowledge Base.                                                                                                                                                                                                  |
| creatorId      | String | userId pembuat Knowledge Base.                                                                                                                                                                                              |
| modifierId     | String | userId pengguna yang terakhir mengubah Knowledge Base.                                                                                                                                                                      |
| createTime     | String | Waktu Knowledge Base dibuat.                                                                                                                                                                                                |
| modifiedTime   | String | Waktu Knowledge Base terakhir diubah.                                                                                                                                                                                       |
| permissionRole | String | Peran izin peminta pada Knowledge Base. Nilai enum:   - **OWNER**: Pemilik - **MANAGER**: Manajer - **EDITOR**: Editor - **DOWNLOADER**: Penampil yang dapat mengunduh - **READER**: Hanya lihat - **NONE**: Tidak ada izin |

### Contoh isi respons

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

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

### Kode error

Jika error dikembalikan saat Anda memanggil API ini, cari pesan error di dokumen [Kode error global](/id/open/development/server-api-error-codes-1) untuk menemukan solusinya.

| HttpCode | Kode error        | Pesan error   | Deskripsi                                                           |
| -------- | ----------------- | ------------- | ------------------------------------------------------------------- |
| 400      | paramError        | %s            | Error parameter.                                                    |
| 403      | permissionDenied  | %s            | Pengguna saat ini tidak memiliki izin untuk melakukan tindakan ini. |
| 404      | workspaceNotExist | %s            | Knowledge Base tidak ada.                                           |
| 500      | systemError       | %s            | Layanan sedang sibuk. Coba lagi nanti.                              |
| 500      | unknownError      | Unknown Error | Error tidak dikenal.                                                |
| 503      | operationTimeout  | %s            | Permintaan telah melewati batas waktu.                              |
