ドキュメント全体を上書きする（アプリ認可）

この API を呼び出すと、Markdown 形式でドキュメント全体のコンテンツを上書きできます。

権限

この API を呼び出すには、以下のいずれかの権限が必要です。

アプリタイプ	サポート可否	権限	API Explorer デバッグ
社内アプリ	サポート	企業ストレージファイル書き込み権限	API Explorer
サードパーティ社内アプリ	未サポート	未サポート	未サポート
サードパーティ個人アプリ	未サポート	未サポート	未サポート

HTTP メソッド

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

名前	タイプ	必須	説明
x-acs-dingtalk-access-token	String	必須	この API を呼び出すためのアクセス認証情報。社内アプリのアクセストークンを取得 API を呼び出して取得します。

Path パラメータ

名前	タイプ	必須	説明
docKey	String	必須	ドキュメント ID（ドキュメントの docKey または dentryUuid）。ナレッジベースドキュメントの作成 API を呼び出してドキュメントを作成した後、レスポンスから `docKey` パラメータを取得します。説明ドキュメント URL から `dentryUuid` を取得する場合、https://docs.dingtalk.io/i/nodes/Z9xxxxa-id を例にすると、dentryUuid は Z9xxxxa-id です。

Query パラメータ

名前	タイプ	必須	説明
operatorId	String	必須	ユーザーの unionId。ユーザー詳細の取得 API を呼び出して unionid パラメータの値を取得できます。

Body パラメータ

名前	タイプ	必須	説明
dataType	String	任意	上書きするコンテンツのデータ形式。値： - markdown：上書き対象のコンテンツが markdown 形式です（デフォルト）。
content	String	必須	書き込むコンテンツの文字列。注意事項： - dataType が markdown の場合、ここには markdown 形式の文字列を指定します。 - 最大長は 50000 文字です。

レスポンスパラメータ

名前	タイプ	説明
success	Boolean	リクエストが成功したかどうか。
result	Object	リクエスト結果。
data	`Map<String, Any>`	リクエスト結果。
	Any	リクエスト結果。

サンプル

リクエスト例

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>Token を使用してアカウント Client を初期化します</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 には 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

# -*- 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:
        """
        Token を使用してアカウント Client を初期化します
        @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 には code と message 属性が含まれており、開発者の問題特定に役立ちます
                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 には code と message 属性が含まれており、開発者の問題特定に役立ちます
                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 {

    /**
     * Token を使用してアカウント Client を初期化します
     * @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 には 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));

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:
// 
// Token を使用してアカウント Client を初期化します
// 
// @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 には code と message 属性が含まれており、開発者の問題特定に役立ちます
    }

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

  /**
   * Token を使用してアカウント Client を初期化します
   * @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 には code と message 属性が含まれており、開発者の問題特定に役立ちます
      }

    }    
  }

}

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>Token を使用してアカウント Client を初期化します</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 には code と message 属性が含まれており、開発者の問題特定に役立ちます
                }
            }
            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 には code と message 属性が含まれており、開発者の問題特定に役立ちます
                }
            }
        }

    }
}

レスポンス例

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

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

エラーコード

HttpCode	エラーコード	エラーメッセージ	説明
400	paramError	%s	パラメータエラー
400	invalidRequest.inputArgs.invalid	%s	パラメータエラーです。エラーメッセージをご確認ください。
403	forbidden.accessDenied	%s	権限がありません
403	forbidden.acrossOrg	%s	リクエストが不正です。アクセスするドキュメントが accessToken で指定した組織に所属しているかご確認ください。
404	docNotExist	%s	ドキュメントが存在しません
404	invalidRequest.resource.notFound	%s	アクセスするリソースが見つかりません
500	forbidden.operationIllegal	%s	リクエスト操作が不正です
500	systemError	%s	サービスが混雑しています。後で再試行してください
500	unknownError	Unknown Error	不明なエラー
503	operationTimeout	%s	リクエストタイムアウト

API 呼び出しガイド

認証と認可

連絡先

カレンダー

会議

AI Table

Docs とファイル

IM

ドキュメント全体を上書きする（アプリ認可）

権限

HTTP メソッド

Header パラメータ

Path パラメータ

Query パラメータ

Body パラメータ

レスポンスパラメータ

サンプル

リクエスト例

レスポンス例

エラーコード

​権限

​HTTP メソッド

​Header パラメータ

​Path パラメータ

​Query パラメータ

​Body パラメータ

​レスポンスパラメータ

​サンプル

​リクエスト例

​レスポンス例

​エラーコード

権限

HTTP メソッド

Header パラメータ

Path パラメータ

Query パラメータ

Body パラメータ

レスポンスパラメータ

サンプル

リクエスト例

レスポンス例

エラーコード