Deskripsi panggilan API
- Ini pada dasarnya adalah operasi PATCH (non-idempoten). Hanya bidang yang diberikan yang diperbarui; bidang yang tidak diberikan tetap tidak berubah.
- Saat ini, hanya elemen block bertipe paragraf yang dapat diperbarui.
Permintaan
Informasi dasar
| Bidang | Nilai |
|---|---|
| URL HTTP | https://api.dingtalk.io/v1.0/doc/suites/documents/{documentId}/blocks/{blockId} |
| Metode HTTP | PUT |
| Jenis aplikasi yang didukung | appType-Aplikasi internal |
| Izin yang diperlukan | permission-Storage.File.Write-Izin tulis file penyimpanan organisasi |
Header permintaan
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | Ya | Kredensial akses yang digunakan untuk memanggil API ini. Peroleh dengan memanggil API Memperoleh access token aplikasi internal. |
Parameter jalur
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| documentId | String | Ya | ID Dokumen (docKey atau dentryUuid dokumen). Setelah membuat dokumen dengan memanggil API Membuat dokumen Knowledge Base, peroleh parameter docKey dari respons. Untuk memperoleh dentryUuid dari URL dokumen, ambil contoh https://docs.dingtalk.io/i/nodes/Zxxxxa-id, di mana dentryUuid adalah Zxxxxa-id. |
| blockId | String | Ya | Pengidentifikasi unik dari paragraf target. Peroleh parameter blockId paragraf ini dengan memanggil API Mengueri elemen block. |
Parameter kueri
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| operatorId | String | Ya | unionId pengguna. Peroleh nilai parameter unionid dengan memanggil API Mengueri detail pengguna. |
Isi permintaan
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| element | Map<String, Any> | Ya | Tipe BlockElement dari elemen block yang akan diperbarui dan atribut yang diperlukan untuk tipe yang bersangkutan (lihat Struktur data elemen block untuk detailnya). Strukturnya adalah sebagai berikut: { "blockType": enum(BlockType), [blockType]: Object(ElementProperties), } |
| Any | Tidak | Atribut dari elemen block yang akan diperbarui. |
Contoh permintaan
HTTPPUT /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
}
}
}
package com.aliyun.sample;
import com.aliyun.tea.*;
public class Sample {
/**
* <b>description</b> :
* <p>Initialize the account Client using the 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.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 berisi atribut code dan message yang membantu menemukan 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 berisi atribut code dan message yang membantu menemukan issue
}
}
}
}
# -*- 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 using the 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_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 berisi atribut code dan message yang membantu menemukan issue
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 berisi atribut code dan message yang membantu menemukan issue
pass
if __name__ == '__main__':
Sample.main(sys.argv[1:])
<?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 {
/**
* 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();
$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 berisi atribut code dan message yang membantu menemukan 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 using the 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
}
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 berisi atribut code dan message yang membantu menemukan issue
}
}
return _err
}
func main() {
err := _main(tea.StringSlice(os.Args[1:]))
if err != nil {
panic(err)
}
}
'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 using the 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 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 berisi atribut code dan message yang membantu menemukan 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 using the 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.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 berisi atribut code dan message yang membantu menemukan 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 berisi atribut code dan message yang membantu menemukan issue
}
}
}
}
}
Respons
Isi respons
| Nama | Tipe | Deskripsi |
|---|---|---|
| success | Boolean | Apakah permintaan berhasil. |
| result | Object | Hasil permintaan. |
| result | Array of Any | Hasil permintaan. |
Contoh isi respons
HTTP/1.1 200 OK
Content-Type:application/json
{
"success" : true,
"result" : {
"result" : [ "{}" ]
}
}
Kode error
Jika error dikembalikan saat Anda memanggil API ini, cari solusinya di dokumen Kode error global berdasarkan pesan error.| HttpCode | Kode error | Pesan error | Deskripsi |
|---|---|---|---|
| 400 | paramError | %s | Error parameter. |
| 400 | invalidRequest.inputArgs.invalid | %s | Error parameter. Lihat pesan error untuk detailnya. |
| 403 | forbidden.accessDenied | %s | Tidak ada izin. |
| 403 | forbidden.acrossOrg | %s | Permintaan tidak valid. Periksa apakah dokumen yang akan diakses termasuk dalam organisasi yang ditentukan oleh access token. |
| 404 | docNotExist | %s | Dokumen tidak ada. |
| 404 | invalidRequest.resource.notFound | %s | Sumber daya yang akan diakses tidak dapat ditemukan. |
| 500 | forbidden.operationIllegal | %s | Operasi yang diminta tidak valid. |
| 500 | systemError | %s | Layanan sedang sibuk. Coba lagi nanti. |
| 500 | unknownError | Unknown Error | Error tidak diketahui. |
| 503 | operationTimeout | %s | Permintaan kehabisan waktu. |