> ## 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. # ナレッジベース取得 > 指定したナレッジベースについて詳細情報と権限情報を確認して取得できます ナレッジベースを取得します。GET リクエストで呼び出します。 ## リクエスト ### 基本情報 | フィールド | 値 | | ------------ | ------------------------------------------------------------ | | HTTP URL | `https://api.dingtalk.io/v2.0/wiki/workspaces/{workspaceId}` | | HTTP Method | GET | | サポートするアプリタイプ | appType-社内アプリ　appType-サードパーティ社内アプリ | | 権限要件 | permission-Wiki.Workspace.Read-ナレッジベース読み取り権限 | ### リクエストヘッダー | 名前 | タイプ | 必須 | 説明 | | --------------------------- | ------ | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | x-acs-dingtalk-access-token | String | はい | この API を呼び出すためのアクセス認証情報。 - 社内アプリの場合は [社内アプリのアクセストークン取得](https://open.dingtalk.com/document/orgapp/obtain-the-access_token-of-an-internal-app) API を呼び出して取得します。 - サードパーティ社内アプリの場合は [サードパーティアプリが認可された企業のアクセストークン取得](https://open.dingtalk.com/document/isvapp/obtain-the-access_token-of-the-authorized-enterprise) API を呼び出して取得します。 | ### パスパラメータ | 名前 | タイプ | 必須 | 説明 | | ----------- | ------ | -- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | workspaceId | String | はい | ナレッジベース ID： - 社内アプリの場合は [ナレッジベース一覧取得](/ja/open/development/get-knowledge-base-list) API を呼び出し、レスポンスパラメータ `workspaceId` フィールドから取得します。 - サードパーティ社内アプリの場合は [ナレッジベース一覧取得](/ja/open/development/get-knowledge-base-list) API を呼び出し、レスポンスパラメータ `workspaceId` フィールドから取得します。 | ### クエリパラメータ | 名前 | タイプ | 必須 | 説明 | | ------------------ | ------- | --- | ------------------------------------------------------------- | | withPermissionRole | Boolean | いいえ | 権限情報を取得するかどうか： - true：取得する - false：取得しない デフォルトは false です。 | | operatorId | String | はい | 操作者の unionId。 | ### リクエスト例 HTTP ```http theme={"theme":{"light":"github-light","dark":"github-dark"}} GET /v2.0/wiki/workspaces/MJ0pDSKMV9dO20E4?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 { /** * トークンを使用してアカウント 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 args = java.util.Arrays.asList(args_); com.aliyun.dingtalkwiki_2_0.Client client = Sample.createClient(); com.aliyun.dingtalkwiki_2_0.models.GetWorkspaceHeaders getWorkspaceHeaders = new com.aliyun.dingtalkwiki_2_0.models.GetWorkspaceHeaders(); getWorkspaceHeaders.xAcsDingtalkAccessToken = ""; com.aliyun.dingtalkwiki_2_0.models.GetWorkspaceRequest getWorkspaceRequest = new com.aliyun.dingtalkwiki_2_0.models.GetWorkspaceRequest() .setWithPermissionRole(false) .setOperatorId("tXguN309iPhE4roSKPlLURAiEiE"); try { client.getWorkspaceWithOptions("MJ0pDSKMV9dO20E4", getWorkspaceRequest, getWorkspaceHeaders, 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 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() get_workspace_headers = dingtalkwiki__2__0_models.GetWorkspaceHeaders() get_workspace_headers.x_acs_dingtalk_access_token = '' get_workspace_request = dingtalkwiki__2__0_models.GetWorkspaceRequest( with_permission_role=False, operator_id='tXguN309iPhE4roSKPlLURAiEiE' ) try: client.get_workspace_with_options('MJ0pDSKMV9dO20E4', get_workspace_request, get_workspace_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() get_workspace_headers = dingtalkwiki__2__0_models.GetWorkspaceHeaders() get_workspace_headers.x_acs_dingtalk_access_token = '' get_workspace_request = dingtalkwiki__2__0_models.GetWorkspaceRequest( with_permission_role=False, operator_id='tXguN309iPhE4roSKPlLURAiEiE' ) try: await client.get_workspace_with_options_async('MJ0pDSKMV9dO20E4', get_workspace_request, get_workspace_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"}} protocol = "https"; $config->regionId = "central"; return new Dingtalk($config); } /** * @param string[] $args * @return void */ public static function main($args){ $client = self::createClient(); $getWorkspaceHeaders = new GetWorkspaceHeaders([]); $getWorkspaceHeaders->xAcsDingtalkAccessToken = ""; $getWorkspaceRequest = new GetWorkspaceRequest([ "withPermissionRole" => false, "operatorId" => "tXguN309iPhE4roSKPlLURAiEiE" ]); try { $client->getWorkspaceWithOptions("MJ0pDSKMV9dO20E4", $getWorkspaceRequest, $getWorkspaceHeaders, 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 ( "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 } getWorkspaceHeaders := &dingtalkwiki_2_0.GetWorkspaceHeaders{} getWorkspaceHeaders.XAcsDingtalkAccessToken = tea.String("") getWorkspaceRequest := &dingtalkwiki_2_0.GetWorkspaceRequest{ 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.GetWorkspaceWithOptions(tea.String("MJ0pDSKMV9dO20E4"), getWorkspaceRequest, getWorkspaceHeaders, &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 ```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 { /** * トークンを使用してアカウント 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 { let client = Client.createClient(); let getWorkspaceHeaders = new $dingtalkwiki_2_0.GetWorkspaceHeaders({ }); getWorkspaceHeaders.xAcsDingtalkAccessToken = ""; let getWorkspaceRequest = new $dingtalkwiki_2_0.GetWorkspaceRequest({ withPermissionRole: false, operatorId: "tXguN309iPhE4roSKPlLURAiEiE", }); try { await client.getWorkspaceWithOptions("MJ0pDSKMV9dO20E4", getWorkspaceRequest, getWorkspaceHeaders, new $Util.RuntimeOptions({ })); } catch (err) { if (!Util.empty(err.code) && !Util.empty(err.message)) { // err には code と message プロパティが含まれ、問題の特定に役立ちます } } } } 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 { /** * トークンを使用してアカウント 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.GetWorkspaceHeaders getWorkspaceHeaders = new AlibabaCloud.SDK.Dingtalkwiki_2_0.Models.GetWorkspaceHeaders(); getWorkspaceHeaders.XAcsDingtalkAccessToken = ""; AlibabaCloud.SDK.Dingtalkwiki_2_0.Models.GetWorkspaceRequest getWorkspaceRequest = new AlibabaCloud.SDK.Dingtalkwiki_2_0.Models.GetWorkspaceRequest { WithPermissionRole = false, OperatorId = "tXguN309iPhE4roSKPlLURAiEiE", }; try { client.GetWorkspaceWithOptions("MJ0pDSKMV9dO20E4", getWorkspaceRequest, getWorkspaceHeaders, 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 { { "message", _err.Message } }); if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message)) { // err には code と message プロパティが含まれ、問題の特定に役立ちます } } } } } ``` ## レスポンス ### レスポンスボディ | 名前 | タイプ | 説明 | | -------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------- | | workspace | Object | ナレッジベース。 | | 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**：権限なし | ### レスポンスボディ例 ```text theme={"theme":{"light":"github-light","dark":"github-dark"}} HTTP/1.1 200 OK Content-Type:application/json { "workspace" : { "workspaceId" : "MJ0pDSKMV9dO20E4", "corpId" : "ding16b241fd05********288", "teamId" : "lHiicjNFM2iSFYSdz2iPuI8ZwiEiE", "rootNodeId" : "ydxXB52LJqqK7xxNTXyo390kJqjMp697", "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" } } ``` ### エラーコード この API の呼び出しでエラーが発生した場合は、エラーメッセージをもとに [グローバルエラーコード](/ja/open/development/server-api-error-codes-1) ドキュメントで解決方法を確認してください。 | HttpCode | エラーコード | エラーメッセージ | 説明 | | -------- | ----------------- | ------------- | ------------------------ | | 400 | paramError | %s | パラメータエラー | | 400 | isNotWorkspace | %s | ナレッジベースではありません | | 403 | permissionDenied | %s | 現在のユーザーには本操作の権限がありません | | 404 | workspaceNotExist | %s | ナレッジベースが存在しません | | 500 | systemError | %s | サービスが混雑しています。後で再試行してください | | 500 | unknownError | Unknown Error | 不明なエラー | | 503 | operationTimeout | %s | リクエストタイムアウト |