Skip to main content
Transfer ownership of a Knowledge Base to another user.

Request

Basic information

FieldValue
HTTP URLhttps://api.dingtalk.io/v2.0/doc/dentries/workspace/handover
HTTP MethodPOST
Supported app typesappType-Internal app
Required permissionspermission-SNS.Document.WorkspaceDocument.Write-SNS Knowledge Base document write permission

Request header

NameTypeRequiredDescription
x-acs-dingtalk-access-tokenStringYesThe access credential for calling this API. Obtain it by calling the Get the access token of an internal app API.

Request body

NameTypeRequiredDescription
paramObjectYesRequired parameter.
resourceIdStringYesThe rootNodeUUid of the Knowledge Base to be transferred. Obtain it by calling the Batch get Knowledge Bases API.
receiverUnionIdStringYesThe unionId of the recipient.
leaveBooleanNoWhether the current Owner leaves the Knowledge Base after the transfer. Optional. Default: false.

Request example

HTTP
POST /v2.0/doc/dentries/workspace/handover HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:example-token
Content-Type:application/json

{
  "param" : {
    "resourceId" : "root_node_uuid",
    "receiverUnionId" : "unionId",
    "leave" : false
  }
}
Java
// 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>Initialize the account Client with a Token</p>
     * @return Client
     * 
     * @throws Exception
     */
    public static com.aliyun.dingtalkdoc_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.dingtalkdoc_2_0.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        
        com.aliyun.dingtalkdoc_2_0.Client client = Sample.createClient();
        com.aliyun.dingtalkdoc_2_0.models.HandoveryWorkspaceHeaders handoveryWorkspaceHeaders = new com.aliyun.dingtalkdoc_2_0.models.HandoveryWorkspaceHeaders();
        handoveryWorkspaceHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_2_0.models.HandoveryWorkspaceRequest.HandoveryWorkspaceRequestParam param = new com.aliyun.dingtalkdoc_2_0.models.HandoveryWorkspaceRequest.HandoveryWorkspaceRequestParam()
                .setResourceId("root_node_uuid")
                .setReceiverUnionId("unionId")
                .setLeave(false);
        com.aliyun.dingtalkdoc_2_0.models.HandoveryWorkspaceRequest handoveryWorkspaceRequest = new com.aliyun.dingtalkdoc_2_0.models.HandoveryWorkspaceRequest()
                .setParam(param);
        try {
            client.handoveryWorkspaceWithOptions(handoveryWorkspaceRequest, handoveryWorkspaceHeaders, 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 the code and message Attribute, which can help developers 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 the code and message Attribute, which can help developers locate the issue
            }

        }        
    }
}
Python
# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import os
import sys

from typing import List

from alibabacloud_dingtalk.doc_2_0.client import Client as dingtalkdoc_2_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.doc_2_0 import models as dingtalkdoc__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() -> dingtalkdoc_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 dingtalkdoc_2_0Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        handovery_workspace_headers = dingtalkdoc__2__0_models.HandoveryWorkspaceHeaders()
        handovery_workspace_headers.x_acs_dingtalk_access_token = '<your access token>'
        param = dingtalkdoc__2__0_models.HandoveryWorkspaceRequestParam(
            resource_id='root_node_uuid',
            receiver_union_id='unionId',
            leave=False
        )
        handovery_workspace_request = dingtalkdoc__2__0_models.HandoveryWorkspaceRequest(
            param=param
        )
        try:
            client.handovery_workspace_with_options(handovery_workspace_request, handovery_workspace_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains the code and message Attribute, which can help developers locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        handovery_workspace_headers = dingtalkdoc__2__0_models.HandoveryWorkspaceHeaders()
        handovery_workspace_headers.x_acs_dingtalk_access_token = '<your access token>'
        param = dingtalkdoc__2__0_models.HandoveryWorkspaceRequestParam(
            resource_id='root_node_uuid',
            receiver_union_id='unionId',
            leave=False
        )
        handovery_workspace_request = dingtalkdoc__2__0_models.HandoveryWorkspaceRequest(
            param=param
        )
        try:
            await client.handovery_workspace_with_options_async(handovery_workspace_request, handovery_workspace_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains the code and message Attribute, which can help developers 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\Vdoc_2_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;

use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vdoc_2_0\Models\HandoveryWorkspaceHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_2_0\Models\HandoveryWorkspaceRequest\param;
use AlibabaCloud\SDK\Dingtalk\Vdoc_2_0\Models\HandoveryWorkspaceRequest;
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();
        $handoveryWorkspaceHeaders = new HandoveryWorkspaceHeaders([]);
        $handoveryWorkspaceHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $param = new param([
            "resourceId" => "root_node_uuid",
            "receiverUnionId" => "unionId",
            "leave" => false
        ]);
        $handoveryWorkspaceRequest = new HandoveryWorkspaceRequest([
            "param" => $param
        ]);
        try {
            $client->handoveryWorkspaceWithOptions($handoveryWorkspaceRequest, $handoveryWorkspaceHeaders, 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 the code and message Attribute, which can help developers 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));
Go
// 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"
  dingtalkdoc_2_0  "github.com/alibabacloud-go/dingtalk/doc_2_0"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/v2/client"
  "github.com/alibabacloud-go/tea/tea"
)

// Description:
// 
// Initialize the account Client with a Token
// 
// @return Client
// 
// @throws Exception
func CreateClient () (_result *dingtalkdoc_2_0.Client, _err error) {
  config := &openapi.Config{}
  config.Protocol = tea.String("https")
  config.RegionId = tea.String("central")
  _result = &dingtalkdoc_2_0.Client{}
  _result, _err = dingtalkdoc_2_0.NewClient(config)
  return _result, _err
}

func _main (args []*string) (_err error) {
  client, _err := CreateClient()
  if _err != nil {
    return _err
  }

  handoveryWorkspaceHeaders := &dingtalkdoc_2_0.HandoveryWorkspaceHeaders{}
  handoveryWorkspaceHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  param := &dingtalkdoc_2_0.HandoveryWorkspaceRequestParam{
    ResourceId: tea.String("root_node_uuid"),
    ReceiverUnionId: tea.String("unionId"),
    Leave: tea.Bool(false),
  }
  handoveryWorkspaceRequest := &dingtalkdoc_2_0.HandoveryWorkspaceRequest{
    Param: param,
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.HandoveryWorkspaceWithOptions(handoveryWorkspaceRequest, handoveryWorkspaceHeaders, &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 the code and message Attribute, which can help developers locate the issue
    }

  }
  return _err
}

func main() {
  err := _main(tea.StringSlice(os.Args[1:]))
  if err != nil {
    panic(err)
  }
}
Node.js
'use strict';
// This file is auto-generated, don't edit it
const Util = require('@alicloud/tea-util');
const dingtalkdoc_2_0 = require('@alicloud/dingtalk/doc_2_0');
const OpenApi = require('@alicloud/openapi-client');
const Tea = require('@alicloud/tea-typescript');

class Client {

  /**
   * Initialize the account Client with a Token
   * @return Client
   * @throws Exception
   */
  static createClient() {
    let config = new OpenApi.Config({ });
    config.protocol = 'https';
    config.regionId = 'central';
    return new dingtalkdoc_2_0.default(config);
  }

  static async main(args) {
    let client = Client.createClient();
    let handoveryWorkspaceHeaders = new dingtalkdoc_2_0.HandoveryWorkspaceHeaders({ });
    handoveryWorkspaceHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let param = new dingtalkdoc_2_0.HandoveryWorkspaceRequestParam({
      resourceId: 'root_node_uuid',
      receiverUnionId: 'unionId',
      leave: false,
    });
    let handoveryWorkspaceRequest = new dingtalkdoc_2_0.HandoveryWorkspaceRequest({
      param: param,
    });
    try {
      await client.handoveryWorkspaceWithOptions(handoveryWorkspaceRequest, handoveryWorkspaceHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err contains the code and message Attribute, which can help developers locate the issue
      }

    }    
  }

}

exports.Client = Client;
Client.main(process.argv.slice(2));
C#
// 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>Initialize the account Client with a Token</para>
        /// </description>
        /// 
        /// <returns>
        /// Client
        /// </returns>
        /// 
        /// <term><b>Exception:</b></term>
        /// Exception
        public static AlibabaCloud.SDK.Dingtalkdoc_2_0.Client CreateClient()
        {
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
            config.Protocol = "https";
            config.RegionId = "central";
            return new AlibabaCloud.SDK.Dingtalkdoc_2_0.Client(config);
        }

        public static void Main(string[] args)
        {
            AlibabaCloud.SDK.Dingtalkdoc_2_0.Client client = CreateClient();
            AlibabaCloud.SDK.Dingtalkdoc_2_0.Models.HandoveryWorkspaceHeaders handoveryWorkspaceHeaders = new AlibabaCloud.SDK.Dingtalkdoc_2_0.Models.HandoveryWorkspaceHeaders();
            handoveryWorkspaceHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_2_0.Models.HandoveryWorkspaceRequest.HandoveryWorkspaceRequestParam param = new AlibabaCloud.SDK.Dingtalkdoc_2_0.Models.HandoveryWorkspaceRequest.HandoveryWorkspaceRequestParam
            {
                ResourceId = "root_node_uuid",
                ReceiverUnionId = "unionId",
                Leave = false,
            };
            AlibabaCloud.SDK.Dingtalkdoc_2_0.Models.HandoveryWorkspaceRequest handoveryWorkspaceRequest = new AlibabaCloud.SDK.Dingtalkdoc_2_0.Models.HandoveryWorkspaceRequest
            {
                Param = param,
            };
            try
            {
                client.HandoveryWorkspaceWithOptions(handoveryWorkspaceRequest, handoveryWorkspaceHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err contains the code and message Attribute, which can help developers 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 the code and message Attribute, which can help developers locate the issue
                }
            }
        }

    }
}

Response

Response body

NameTypeDescription
resultBooleanThe execution result.

Response body example

HTTP/1.1 200 OK
Content-Type:application/json

{
  "result" : true
}

Error codes

If an error is returned when you call this API, refer to the Global error codes document for solutions based on the error message.
HttpCodeError codeError messageDescription
400paramError%sParameter error.
500systemError%sThe service is busy. Try again later.
500unknownErrorUnknown ErrorUnknown error.
503operationTimeout%sRequest timeout.