ブロック要素の更新

本 API を呼び出すことで、ドキュメント内の任意の 1 つのブロック要素のコンテンツまたは属性を更新できます。

API 呼び出し説明

本質的には PATCH 操作（非冪等）であり、渡されたフィールドのみが更新され、渡されないフィールドはそのまま維持されます。
現時点では、段落タイプのブロック要素の更新のみサポートしています。

リクエスト

基本情報

フィールド	値
HTTP URL	`https://api.dingtalk.io/v1.0/doc/suites/documents/{documentId}/blocks/{blockId}`
HTTP Method	PUT
サポートするアプリタイプ	appType-社内アプリ
必要な権限	permission-Storage.File.Write-企業ストレージファイル書き込み権限

リクエストヘッダー

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

パスパラメータ

名前	タイプ	必須	説明
documentId	String	はい	ドキュメント ID（ドキュメントの docKey または dentryUuid）。ナレッジベースドキュメントの作成 API を呼び出してドキュメントを作成した後、戻り値から `docKey` パラメータを取得します。ドキュメント URL から `dentryUuid` を取得します。例えば https://docs.dingtalk.io/i/nodes/Zxxxxa-id の場合、dentryUuid は Zxxxxa-id となります。
blockId	String	はい	対象段落の一意な識別子です。ブロック要素の検索 API を呼び出すことで、該当段落の `blockId` パラメータを取得できます。

クエリパラメータ

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

リクエストボディ

名前	タイプ	必須	説明
element	`Map<String, Any>`	はい	更新対象のブロック要素 BlockElement タイプおよび対応するタイプに必要な属性です（詳細はブロック要素データ構造を参照）。構造は以下の通りです。 `{ "blockType": enum(BlockType), [blockType]: Object(ElementProperties), }`
	Any	いいえ	更新対象のブロック要素属性。

リクエスト例

HTTP

PUT /v1.0/doc/suites/documents/doc_id/blocks/block_id?operatorId=union_id HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:access_token
Content-Type:application/json

{
  "element" : {
    "blockType" : "paragraph",
    "paragraph" : {
      "folded": true
    }
  }
}

Java

package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>トークンを使用してアカウント 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.DocBlocksModifyHeaders docBlocksModifyHeaders = new com.aliyun.dingtalkdoc_1_0.models.DocBlocksModifyHeaders();
        docBlocksModifyHeaders.xAcsDingtalkAccessToken = "<your access token>";
        java.util.Map<String, java.util.Map<String, Object>> element = TeaConverter.buildMap(
            new TeaPair("key", new java.util.HashMap<>())
        );
        com.aliyun.dingtalkdoc_1_0.models.DocBlocksModifyRequest docBlocksModifyRequest = new com.aliyun.dingtalkdoc_1_0.models.DocBlocksModifyRequest()
                .setOperatorId("union_id")
                .setElement(element);
        try {
            client.docBlocksModifyWithOptions("doc_id", "block_id", docBlocksModifyRequest, docBlocksModifyHeaders, 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:
        """
        トークンを使用してアカウント 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_blocks_modify_headers = dingtalkdoc__1__0_models.DocBlocksModifyHeaders()
        doc_blocks_modify_headers.x_acs_dingtalk_access_token = '<your access token>'
        element = {
            'key': {}
        }
        doc_blocks_modify_request = dingtalkdoc__1__0_models.DocBlocksModifyRequest(
            operator_id='union_id',
            element=element
        )
        try:
            client.doc_blocks_modify_with_options('doc_id', 'block_id', doc_blocks_modify_request, doc_blocks_modify_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_blocks_modify_headers = dingtalkdoc__1__0_models.DocBlocksModifyHeaders()
        doc_blocks_modify_headers.x_acs_dingtalk_access_token = '<your access token>'
        element = {
            'key': {}
        }
        doc_blocks_modify_request = dingtalkdoc__1__0_models.DocBlocksModifyRequest(
            operator_id='union_id',
            element=element
        )
        try:
            await client.doc_blocks_modify_with_options_async('doc_id', 'block_id', doc_blocks_modify_request, doc_blocks_modify_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\DocBlocksModifyHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\DocBlocksModifyRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * トークンを使用してアカウント 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();
        $docBlocksModifyHeaders = new DocBlocksModifyHeaders([]);
        $docBlocksModifyHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $element = [
            "key" => []
        ];
        $docBlocksModifyRequest = new DocBlocksModifyRequest([
            "operatorId" => "union_id",
            "element" => $element
        ]);
        try {
            $client->docBlocksModifyWithOptions("doc_id", "block_id", $docBlocksModifyRequest, $docBlocksModifyHeaders, 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:
// 
// トークンを使用してアカウント 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
  }

  docBlocksModifyHeaders := &dingtalkdoc_1_0.DocBlocksModifyHeaders{}
  docBlocksModifyHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  element := map[string]map[string]interface{}{
    "key": map[string]interface{}{},
  }
  docBlocksModifyRequest := &dingtalkdoc_1_0.DocBlocksModifyRequest{
    OperatorId: tea.String("union_id"),
    Element: element,
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.DocBlocksModifyWithOptions(tea.String("doc_id"), tea.String("block_id"), docBlocksModifyRequest, docBlocksModifyHeaders, &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 {

  /**
   * トークンを使用してアカウント 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 docBlocksModifyHeaders = new dingtalkdoc_1_0.DocBlocksModifyHeaders({ });
    docBlocksModifyHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let element = {
      key: { },
    };
    let docBlocksModifyRequest = new dingtalkdoc_1_0.DocBlocksModifyRequest({
      operatorId: 'union_id',
      element: element,
    });
    try {
      await client.docBlocksModifyWithOptions('doc_id', 'block_id', docBlocksModifyRequest, docBlocksModifyHeaders, 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>トークンを使用してアカウント 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.DocBlocksModifyHeaders docBlocksModifyHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.DocBlocksModifyHeaders();
            docBlocksModifyHeaders.XAcsDingtalkAccessToken = "<your access token>";
            Dictionary<string, Dictionary<string, object>> element = new Dictionary<string, Dictionary<string, object>>
            {
                {"key", new Dictionary<string, object>(){}},
            };
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.DocBlocksModifyRequest docBlocksModifyRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.DocBlocksModifyRequest
            {
                OperatorId = "union_id",
                Element = element,
            };
            try
            {
                client.DocBlocksModifyWithOptions("doc_id", "block_id", docBlocksModifyRequest, docBlocksModifyHeaders, 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 属性が含まれており、開発者の問題特定に役立ちます
                }
            }
        }

    }
}

レスポンス

レスポンスボディ

名前	タイプ	説明
success	Boolean	リクエストが成功したかどうか。
result	Object	リクエスト結果。
result	Array of Any	リクエスト結果。

レスポンスボディの例

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

{
  "success" : true,
  "result" : {
    "result" : [ "{}" ]
  }
}

エラーコード

本 API の呼び出しでエラーが発生した場合は、エラーメッセージをもとにグローバルエラーコードドキュメントから解決策を検索してください。

HttpCode	エラーコード	エラーメッセージ	説明
400	paramError	%s	パラメータエラー
400	invalidRequest.inputArgs.invalid	%s	パラメータエラーです。エラーメッセージをご確認ください。
403	forbidden.accessDenied	%s	権限がありません
403	forbidden.acrossOrg	%s	リクエストが不正です。アクセス対象のドキュメントが、アクセストークンで指定された組織に所属しているかご確認ください。
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

API 呼び出し説明

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディの例

エラーコード

​API 呼び出し説明

​リクエスト

​基本情報

​リクエストヘッダー

​パスパラメータ

​クエリパラメータ

​リクエストボディ

​リクエスト例

​レスポンス

​レスポンスボディ

​レスポンスボディの例

​エラーコード

API 呼び出し説明

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディの例

エラーコード