Get a Knowledge Base - DingTalk Help Center

Used to get a Knowledge Base. Use a GET request.

Request

Basic information

Field	Value
HTTP URL	`https://api.dingtalk.io/v2.0/wiki/workspaces/{workspaceId}`
HTTP Method	GET
Supported app types	appType-Internal app　appType-Third-party enterprise app
Permission required	permission-Wiki.Workspace.Read-Knowledge Base read permission

Request headers

Name	Type	Required	Description
x-acs-dingtalk-access-token	String	Yes	The access credential for calling this API. - For an internal app, call the Get the access token of an internal app API to obtain it. - For a third-party enterprise app, call the Get the access token of an authorized organization for a third-party app API to obtain it.

Path parameters

Name	Type	Required	Description
workspaceId	String	Yes	The Knowledge Base ID: - For an internal app, call the Get Knowledge Base list API to obtain the `workspaceId` field in the response. - For a third-party enterprise app, call the Get Knowledge Base list API to obtain the `workspaceId` field in the response.

Query parameters

Name	Type	Required	Description
withPermissionRole	Boolean	No	Whether to retrieve permission information: - true: retrieve - false: do not retrieve Default: false.
operatorId	String	Yes	The unionId of the operator.

Request example

HTTP

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

// 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 the 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.GetWorkspaceHeaders getWorkspaceHeaders = new com.aliyun.dingtalkwiki_2_0.models.GetWorkspaceHeaders();
        getWorkspaceHeaders.xAcsDingtalkAccessToken = "<your access token>";
        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 contains 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)) {
                // err contains code and message properties, which help locate the issue
            }

        }        
    }
}

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:
        """
        Initialize the account Client using the 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_workspace_headers = dingtalkwiki__2__0_models.GetWorkspaceHeaders()
        get_workspace_headers.x_acs_dingtalk_access_token = '<your 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 contains code and message properties, which help locate the issue
                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 = '<your 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 contains code and message properties, which help locate the issue
                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\GetWorkspaceHeaders;
use AlibabaCloud\SDK\Dingtalk\Vwiki_2_0\Models\GetWorkspaceRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client using the 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();
        $getWorkspaceHeaders = new GetWorkspaceHeaders([]);
        $getWorkspaceHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $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 contains 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 the 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
  }

  getWorkspaceHeaders := &dingtalkwiki_2_0.GetWorkspaceHeaders{}
  getWorkspaceHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  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 contains 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)
  }
}

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 {

  /**
   * Initialize the account Client using the 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 getWorkspaceHeaders = new $dingtalkwiki_2_0.GetWorkspaceHeaders({ });
    getWorkspaceHeaders.xAcsDingtalkAccessToken = "<your access token>";
    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 contains 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 the 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.GetWorkspaceHeaders getWorkspaceHeaders = new AlibabaCloud.SDK.Dingtalkwiki_2_0.Models.GetWorkspaceHeaders();
            getWorkspaceHeaders.XAcsDingtalkAccessToken = "<your access token>";
            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 contains 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))
                {
                    // err contains code and message properties, which help locate the issue
                }
            }
        }

    }
}

Response

Response body

Name	Type	Description
workspace	Object	The Knowledge Base.
workspaceId	String	The Knowledge Base ID (spaceUuid).
corpId	String	The organization ID that the Knowledge Base belongs to.
teamId	String	The ID of the Knowledge Group that the Knowledge Base belongs to. Empty if not associated with any Knowledge Group.
rootNodeId	String	The root node ID (root dentryUuid).
name	String	The name of the Knowledge Base.
type	String	The Knowledge Base type. Enum values: - TEAM: Knowledge Base - PERSONAL: My Docs
description	String	The description of the Knowledge Base.
url	String	The access URL of the Knowledge Base.
icon	Object	The icon of the Knowledge Base.
type	String	The icon type. Enum values: - URL: link - EMOJI: emoji icon
value	String	The icon value: - When type is URL, returns the icon link. - When type is EMOJI, returns the Unicode value of the emoji icon.
cover	String	The cover URL of the Knowledge Base.
creatorId	String	The userId of the Knowledge Base creator.
modifierId	String	The userId of the Knowledge Base modifier.
createTime	String	The created time of the Knowledge Base.
modifiedTime	String	The modified time of the Knowledge Base.
permissionRole	String	The permission role of the requester on the Knowledge Base. Enum values: - OWNER: Owner - MANAGER: Manager - EDITOR: Editor - DOWNLOADER: Viewer with download permission - READER: Viewer only - NONE: No permission

Response body example

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

Error codes

If an error occurs when calling this API, refer to the Global error codes document to find a solution based on the error message.

HttpCode	Error code	Error message	Description
400	paramError	%s	Parameter error
400	isNotWorkspace	%s	Not a Knowledge Base
403	permissionDenied	%s	The current user does not have permission for this action
404	workspaceNotExist	%s	Knowledge Base does not exist
500	systemError	%s	Service busy. Try again later
500	unknownError	Unknown Error	Unknown error
503	operationTimeout	%s	Request timed out

​Request

​Basic information

​Request headers

​Path parameters

​Query parameters

​Request example

​Response

​Response body

​Response body example

​Error codes