Deskripsi panggilan API
Panggil API ini untuk menghapus seluruh konten dalam rentang yang ditentukan, termasuk format dan data. Hasilnya sama dengan operasi yang ditunjukkan pada gambar di bawah ini.Permintaan
Informasi dasar
| Bidang | Nilai |
|---|---|
| URL HTTP | https://api.dingtalk.io/v1.0/doc/workbooks/{workbookId}/sheets/{sheetId}/ranges/{rangeAddress}/clear |
| Metode HTTP | POST |
| Tipe aplikasi yang didukung | appType-Internal app appType-Third-party enterprise app |
| Izin yang diperlukan | permission-Document.Workbook.Write-DingTalk Spreadsheet write permission |
Header permintaan
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | Ya | Kredensial akses untuk memanggil API ini. Dapatkan dengan cara berikut: - Untuk aplikasi internal, panggil API Mendapatkan access token aplikasi internal. - Untuk aplikasi perusahaan pihak ketiga, panggil API Mendapatkan access token perusahaan yang memberikan otorisasi ke aplikasi pihak ketiga. |
Parameter path
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| workbookId | String | Ya | ID file spreadsheet. nodeId(dentryUuid) yang dikembalikan oleh API Knowledge Base merupakan workbookId dari spreadsheet. Dapatkan dengan memanggil API Mendapatkan node dan Membuat dokumen Knowledge Base. |
| sheetId | String | Ya | ID atau judul Lembar Kerja. - Untuk aplikasi internal, panggil API Mendapatkan semua Lembar Kerja untuk memperoleh ID, atau berikan judul Lembar Kerja. - Untuk aplikasi perusahaan pihak ketiga, kami sarankan untuk memberikan judul Lembar Kerja. Langkah untuk melihat judul Lembar Kerja ditunjukkan pada gambar di bawah ini. |
| rangeAddress | String | Ya | Rentang sel yang akan dihapus, dalam format sel kiri atas rentang:sel kanan bawah rentang. Misalnya, B2:C3 menunjukkan rentang seperti yang ditampilkan pada gambar di bawah ini. |
Parameter query
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| operatorId | String | Ya | unionId dari operator. Panggil API Mengambil detail pengguna untuk memperolehnya. |
Contoh permintaan
HTTPPOST /v1.0/doc/workbooks/e54Lq3xxx/sheets/Sheet1/ranges/B2:C3/clear?operatorId=ppgAxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;
import com.aliyun.tea.*;
public class Sample {
/**
* Initialize the account client with a Token
* @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 {
java.util.List<String> args = java.util.Arrays.asList(args_);
com.aliyun.dingtalkdoc_1_0.Client client = Sample.createClient();
com.aliyun.dingtalkdoc_1_0.models.ClearHeaders clearHeaders = new com.aliyun.dingtalkdoc_1_0.models.ClearHeaders();
clearHeaders.xAcsDingtalkAccessToken = "<your access token>";
com.aliyun.dingtalkdoc_1_0.models.ClearRequest clearRequest = new com.aliyun.dingtalkdoc_1_0.models.ClearRequest()
.setOperatorId("ppgAxxx");
try {
client.clearWithOptions("e54Lq3xxx", "Sheet1", "B2:C3", clearRequest, clearHeaders, 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 properti code dan message untuk membantu Anda menemukan masalah
}
} 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 properti code dan message untuk membantu Anda menemukan masalah
}
}
}
}
# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import sys
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()
clear_headers = dingtalkdoc__1__0_models.ClearHeaders()
clear_headers.x_acs_dingtalk_access_token = '<your access token>'
clear_request = dingtalkdoc__1__0_models.ClearRequest(
operator_id='ppgAxxx'
)
try:
client.clear_with_options('e54Lq3xxx', 'Sheet1', 'B2:C3', clear_request, clear_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# err berisi properti code dan message untuk membantu Anda menemukan masalah
pass
@staticmethod
async def main_async(
args: List[str],
) -> None:
client = Sample.create_client()
clear_headers = dingtalkdoc__1__0_models.ClearHeaders()
clear_headers.x_acs_dingtalk_access_token = '<your access token>'
clear_request = dingtalkdoc__1__0_models.ClearRequest(
operator_id='ppgAxxx'
)
try:
await client.clear_with_options_async('e54Lq3xxx', 'Sheet1', 'B2:C3', clear_request, clear_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# err berisi properti code dan message untuk membantu Anda menemukan masalah
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\ClearHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\ClearRequest;
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();
$clearHeaders = new ClearHeaders([]);
$clearHeaders->xAcsDingtalkAccessToken = "<your access token>";
$clearRequest = new ClearRequest([
"operatorId" => "ppgAxxx"
]);
try {
$client->clearWithOptions("e54Lq3xxx", "Sheet1", "B2:C3", $clearRequest, $clearHeaders, 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 properti code dan message untuk membantu Anda menemukan masalah
}
}
}
}
$path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
require_once $path;
}
Sample::main(array_slice($argv, 1));
// This file is auto-generated, don't edit it. Thanks.
package main
import (
"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"
)
/**
* 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
}
clearHeaders := &dingtalkdoc_1_0.ClearHeaders{}
clearHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
clearRequest := &dingtalkdoc_1_0.ClearRequest{
OperatorId: tea.String("ppgAxxx"),
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.ClearWithOptions(tea.String("e54Lq3xxx"), tea.String("Sheet1"), tea.String("B2:C3"), clearRequest, clearHeaders, &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 properti code dan message untuk membantu Anda menemukan masalah
}
}
return _err
}
func main() {
err := _main(tea.StringSlice(os.Args[1:]))
if err != nil {
panic(err)
}
}
// This file is auto-generated, don't edit it
import Util, * as $Util from '@alicloud/tea-util';
import dingtalkdoc_1_0, * as $dingtalkdoc_1_0 from '@alicloud/dingtalk/doc_1_0';
import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
import * as $tea from '@alicloud/tea-typescript';
export default class Client {
/**
* Initialize the account client with a Token
* @return Client
* @throws Exception
*/
static createClient(): dingtalkdoc_1_0 {
let config = new $OpenApi.Config({ });
config.protocol = "https";
config.regionId = "central";
return new dingtalkdoc_1_0(config);
}
static async main(args: string[]): Promise<void> {
let client = Client.createClient();
let clearHeaders = new $dingtalkdoc_1_0.ClearHeaders({ });
clearHeaders.xAcsDingtalkAccessToken = "<your access token>";
let clearRequest = new $dingtalkdoc_1_0.ClearRequest({
operatorId: "ppgAxxx",
});
try {
await client.clearWithOptions("e54Lq3xxx", "Sheet1", "B2:C3", clearRequest, clearHeaders, new $Util.RuntimeOptions({ }));
} catch (err) {
if (!Util.empty(err.code) && !Util.empty(err.message)) {
// err berisi properti code dan message untuk membantu Anda menemukan masalah
}
}
}
}
Client.main(process.argv.slice(2));
// 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
{
/**
* Initialize the account client with a Token
* @return Client
* @throws 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.ClearHeaders clearHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.ClearHeaders();
clearHeaders.XAcsDingtalkAccessToken = "<your access token>";
AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.ClearRequest clearRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.ClearRequest
{
OperatorId = "ppgAxxx",
};
try
{
client.ClearWithOptions("e54Lq3xxx", "Sheet1", "B2:C3", clearRequest, clearHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
}
catch (TeaException err)
{
if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
{
// err berisi properti code dan message untuk membantu Anda menemukan masalah
}
}
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 properti code dan message untuk membantu Anda menemukan masalah
}
}
}
}
}
Respons
Isi respons
| Nama | Tipe | Deskripsi |
|---|---|---|
| a1Notation | String | Alamat sel. |
Contoh isi respons
HTTP/1.1 200 OK
Content-Type:application/json
{
"a1Notation" : "B2:C3"
}
Kode error
Jika terjadi error saat memanggil API ini, lihat dokumen Kode error global untuk solusi berdasarkan pesan error.| HttpCode | Kode error | Pesan error | Deskripsi |
|---|---|---|---|
| 400 | invalidRequest.inputArgs.invalid | %s | Parameter permintaan tidak valid. Lihat pesan error untuk detailnya. |
| 400 | invalidRequest.inputArgs.workbookIdIllegal | The workbookId is illegal. | workbookId tidak valid. |
| 400 | invalidRequest.resource.notWorkbook | %s | Tipe dokumen tidak didukung. Periksa workbookId. |
| 403 | forbidden.accessDenied | The operator has no permission. | Pengguna saat ini tidak memiliki izin untuk melakukan tindakan ini. |
| 403 | forbidden.acrossOrg | %s | Permintaan tidak valid. Periksa apakah dokumen yang diakses milik organisasi yang ditentukan oleh access token. |
| 403 | forbidden.operationIllegal | %s | Tindakan permintaan tidak valid. Lihat pesan error untuk detailnya. |
| 403 | forbidden.document.sizeOverLimit | The document size is over limit and the server is unable to complete your request. Retry is unlikely to work unless the document size is decreased. | Konten spreadsheet terlalu besar. Coba kurangi kontennya. |
| 404 | invalidRequest.resource.notFound | %s | Permintaan gagal. Sumber daya yang diakses tidak dapat ditemukan. |
| 500 | serviceBusy | The server is busy and unable to complete your request. Please try again later. | Layanan sedang sibuk. Coba lagi nanti. |
| 500 | internalError | The server encountered an internal error and was unable to complete your request. Please try again later. | Kesalahan internal server. Coba lagi nanti. |