Overwrite a document (App authorization)

Call this API to overwrite the entire content of a document in Markdown format.

Permissions

To call this API, one of the following permissions is required.

App type	Supported	Permissions	API Explorer debugging
Internal app	Supported	Write permission for organization storage files	API Explorer
Third-party enterprise app	Not supported	Not supported	Not supported
Third-party personal app	Not supported	Not supported	Not supported

HTTP method

POST /v1.0/doc/suites/documents/{docKey}/overwriteContent?operatorId=String HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:String
Content-Type:application/json

{
  "dataType" : "String",
  "content" : "String"
}

Header parameters

Name	Type	Required	Description
x-acs-dingtalk-access-token	String	Yes	The access credential used to call this API. Obtain it by calling the Get the access token of an internal app API.

Path parameters

Name	Type	Required	Description
docKey	String	Yes	The document ID (the `docKey` or `dentryUuid` of the document). After creating a document by calling the Create a Knowledge Base document API, obtain the `docKey` parameter from the response. Note Obtain the `dentryUuid` from the document URL. For example, in https://alidocs.dingtalk.io/i/nodes/Z9xxxxa-id, the `dentryUuid` is `Z9xxxxa-id`.

Query parameters

Name	Type	Required	Description
operatorId	String	Yes	The unionId of the user. Obtain the `unionid` parameter value by calling the Query user details API.

Body parameters

Name	Type	Required	Description
dataType	String	No	The data format of the content to be overwritten. Valid values: - markdown: The content to be overwritten is in markdown format. This is the default value.
content	String	Yes	The content string to write. Note: - If `dataType` is markdown, this must be a markdown-formatted string. - The maximum length is 50,000 characters.

Response parameters

Name	Type	Description
success	Boolean	Whether the request was successful.
result	Object	The request result.
data	`Map<String, Any>`	The request result.
	Any	The request result.

Examples

Request example

HTTP

POST /v1.0/doc/suites/documents/someDocKey/overwriteContent?operatorId=someOperatorId HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:7dc9ec4xxx
Content-Type:application/json

{
  "dataType" : "markdown",
  "content" : "# heading"
}

Java

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_1_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_1_0.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        
        com.aliyun.dingtalkdoc_1_0.Client client = Sample.createClient();
        com.aliyun.dingtalkdoc_1_0.models.DocUpdateContentHeaders docUpdateContentHeaders = new com.aliyun.dingtalkdoc_1_0.models.DocUpdateContentHeaders();
        docUpdateContentHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_1_0.models.DocUpdateContentRequest docUpdateContentRequest = new com.aliyun.dingtalkdoc_1_0.models.DocUpdateContentRequest()
                .setOperatorId("someOperatorId")
                .setDataType("markdown")
                .setContent("# heading");
        try {
            client.docUpdateContentWithOptions("someDocKey", docUpdateContentRequest, docUpdateContentHeaders, 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 attributes, 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 the code and message attributes, which help locate the issue
            }

        }        
    }
}

Python

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

from typing import List

from alibabacloud_dingtalk.doc_1_0.client import Client as dingtalkdoc_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.doc_1_0 import models as dingtalkdoc__1__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_1_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_1_0Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        doc_update_content_headers = dingtalkdoc__1__0_models.DocUpdateContentHeaders()
        doc_update_content_headers.x_acs_dingtalk_access_token = '<your access token>'
        doc_update_content_request = dingtalkdoc__1__0_models.DocUpdateContentRequest(
            operator_id='someOperatorId',
            data_type='markdown',
            content='# heading'
        )
        try:
            client.doc_update_content_with_options('someDocKey', doc_update_content_request, doc_update_content_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 attributes, which help locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        doc_update_content_headers = dingtalkdoc__1__0_models.DocUpdateContentHeaders()
        doc_update_content_headers.x_acs_dingtalk_access_token = '<your access token>'
        doc_update_content_request = dingtalkdoc__1__0_models.DocUpdateContentRequest(
            operator_id='someOperatorId',
            data_type='markdown',
            content='# heading'
        )
        try:
            await client.doc_update_content_with_options_async('someDocKey', doc_update_content_request, doc_update_content_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 attributes, 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\Vdoc_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;

use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\DocUpdateContentHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\DocUpdateContentRequest;
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();
        $docUpdateContentHeaders = new DocUpdateContentHeaders([]);
        $docUpdateContentHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $docUpdateContentRequest = new DocUpdateContentRequest([
            "operatorId" => "someOperatorId",
            "dataType" => "markdown",
            "content" => "# heading"
        ]);
        try {
            $client->docUpdateContentWithOptions("someDocKey", $docUpdateContentRequest, $docUpdateContentHeaders, 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 attributes, 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));

package main

import (
  "encoding/json"
  "strings"
  "fmt"
  "os"
  util  "github.com/alibabacloud-go/tea-utils/v2/service"
  dingtalkdoc_1_0  "github.com/alibabacloud-go/dingtalk/doc_1_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_1_0.Client, _err error) {
  config := &openapi.Config{}
  config.Protocol = tea.String("https")
  config.RegionId = tea.String("central")
  _result = &dingtalkdoc_1_0.Client{}
  _result, _err = dingtalkdoc_1_0.NewClient(config)
  return _result, _err
}

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

  docUpdateContentHeaders := &dingtalkdoc_1_0.DocUpdateContentHeaders{}
  docUpdateContentHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  docUpdateContentRequest := &dingtalkdoc_1_0.DocUpdateContentRequest{
    OperatorId: tea.String("someOperatorId"),
    DataType: tea.String("markdown"),
    Content: tea.String("# heading"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.DocUpdateContentWithOptions(tea.String("someDocKey"), docUpdateContentRequest, docUpdateContentHeaders, &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 attributes, which help 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_1_0 = require('@alicloud/dingtalk/doc_1_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_1_0.default(config);
  }

  static async main(args) {
    let client = Client.createClient();
    let docUpdateContentHeaders = new dingtalkdoc_1_0.DocUpdateContentHeaders({ });
    docUpdateContentHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let docUpdateContentRequest = new dingtalkdoc_1_0.DocUpdateContentRequest({
      operatorId: 'someOperatorId',
      dataType: 'markdown',
      content: '# heading',
    });
    try {
      await client.docUpdateContentWithOptions('someDocKey', docUpdateContentRequest, docUpdateContentHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err contains the code and message attributes, which help locate the issue
      }

    }    
  }

}

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

using Newtonsoft.Json;
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_1_0.Client CreateClient()
        {
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
            config.Protocol = "https";
            config.RegionId = "central";
            return new AlibabaCloud.SDK.Dingtalkdoc_1_0.Client(config);
        }

        public static void Main(string[] args)
        {
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Client client = CreateClient();
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.DocUpdateContentHeaders docUpdateContentHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.DocUpdateContentHeaders();
            docUpdateContentHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.DocUpdateContentRequest docUpdateContentRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.DocUpdateContentRequest
            {
                OperatorId = "someOperatorId",
                DataType = "markdown",
                Content = "# heading",
            };
            try
            {
                client.DocUpdateContentWithOptions("someDocKey", docUpdateContentRequest, docUpdateContentHeaders, 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 attributes, 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 the code and message attributes, which help locate the issue
                }
            }
        }

    }
}

Response example

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

{
  "success" : true,
  "result" : {
    "data" : {
      "key" : "value"
    }
  }
}

Error codes

HttpCode	Error code	Error message	Description
400	paramError	%s	Parameter error.
400	invalidRequest.inputArgs.invalid	%s	Parameter error. Refer to the error message for details.
403	forbidden.accessDenied	%s	No permission.
403	forbidden.acrossOrg	%s	Invalid request. Check whether the document being accessed belongs to the organization specified by the access token.
404	docNotExist	%s	Document does not exist.
404	invalidRequest.resource.notFound	%s	Unable to find the requested resource.
500	forbidden.operationIllegal	%s	Invalid request action.
500	systemError	%s	Service is busy. Try again later.
500	unknownError	Unknown Error	Unknown error.
503	operationTimeout	%s	Request timed out.

​Permissions

​HTTP method

​Header parameters

​Path parameters

​Query parameters

​Body parameters

​Response parameters

​Examples

​Request example

​Response example

​Error codes

Permissions

HTTP method

Header parameters

Path parameters

Query parameters

Body parameters

Response parameters

Examples

Request example

Response example

Error codes