Request
Basic information
| Field | Value |
|---|---|
| HTTP URL | https://api.dingtalk.io/v1.0/doc/workbooks/{workbookId}/sheets/{sheetId}/floatImages/{id} |
| HTTP Method | DELETE |
| Supported app type | appType-Internal app |
| Permission required | permission-Document.Workbook.Write-DingTalk Spreadsheet write permission |
Request header
| Name | Type | Required | Description |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | Yes | The access credential for calling this API. Call the Get the access token of an internal app API to obtain it. |
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
| workbookId | String | Yes | The spreadsheet file ID. The nodeId(dentryUuid) returned by the Knowledge Base API is the spreadsheet workbookId. You can obtain it by calling the Get node and Create knowledge base document APIs. |
| sheetId | String | Yes | The worksheet ID or title. Call the Get all worksheets API to obtain the ID and title of the worksheet. |
| id | String | Yes | The ID of the floating image. Obtain it by calling the “Query floating images” API. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
| operatorId | String | Yes | The unionId of the operator. Call the Query user details API to obtain it. If the operator does not have the required permissions, the API returns the error The operator has no permission. |
Request example
HTTPDELETE /v1.0/doc/workbooks/xxx/sheets/xxx/floatImages/xxx?operatorId=xxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxx
Content-Type:application/json
package com.aliyun.sample;
import com.aliyun.tea.*;
public class Sample {
/**
* <b>description</b> :
* <p>Initialize the account Client with 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.DeleteFloatImageHeaders deleteFloatImageHeaders = new com.aliyun.dingtalkdoc_1_0.models.DeleteFloatImageHeaders();
deleteFloatImageHeaders.xAcsDingtalkAccessToken = "<your access token>";
com.aliyun.dingtalkdoc_1_0.models.DeleteFloatImageRequest deleteFloatImageRequest = new com.aliyun.dingtalkdoc_1_0.models.DeleteFloatImageRequest()
.setOperatorId("xxx");
try {
client.deleteFloatImageWithOptions("xxx", "xxx", "xxx", deleteFloatImageRequest, deleteFloatImageHeaders, new com.aliyun.teautil.models.RuntimeOptions());
} catch (TeaException err) {
if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
// The err contains 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)) {
// The err contains code and message attributes, which help locate the 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 with 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()
delete_float_image_headers = dingtalkdoc__1__0_models.DeleteFloatImageHeaders()
delete_float_image_headers.x_acs_dingtalk_access_token = '<your access token>'
delete_float_image_request = dingtalkdoc__1__0_models.DeleteFloatImageRequest(
operator_id='xxx'
)
try:
client.delete_float_image_with_options('xxx', 'xxx', 'xxx', delete_float_image_request, delete_float_image_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# The err contains code and message attributes, which help locate the issue
pass
@staticmethod
async def main_async(
args: List[str],
) -> None:
client = Sample.create_client()
delete_float_image_headers = dingtalkdoc__1__0_models.DeleteFloatImageHeaders()
delete_float_image_headers.x_acs_dingtalk_access_token = '<your access token>'
delete_float_image_request = dingtalkdoc__1__0_models.DeleteFloatImageRequest(
operator_id='xxx'
)
try:
await client.delete_float_image_with_options_async('xxx', 'xxx', 'xxx', delete_float_image_request, delete_float_image_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# The err contains code and message attributes, which help locate the 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\DeleteFloatImageHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\DeleteFloatImageRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
class Sample {
/**
* Initialize the account Client with 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();
$deleteFloatImageHeaders = new DeleteFloatImageHeaders([]);
$deleteFloatImageHeaders->xAcsDingtalkAccessToken = "<your access token>";
$deleteFloatImageRequest = new DeleteFloatImageRequest([
"operatorId" => "xxx"
]);
try {
$client->deleteFloatImageWithOptions("xxx", "xxx", "xxx", $deleteFloatImageRequest, $deleteFloatImageHeaders, 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)) {
// The err contains 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 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
}
deleteFloatImageHeaders := &dingtalkdoc_1_0.DeleteFloatImageHeaders{}
deleteFloatImageHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
deleteFloatImageRequest := &dingtalkdoc_1_0.DeleteFloatImageRequest{
OperatorId: tea.String("xxx"),
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.DeleteFloatImageWithOptions(tea.String("xxx"), tea.String("xxx"), tea.String("xxx"), deleteFloatImageRequest, deleteFloatImageHeaders, &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)) {
// The err contains 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)
}
}
'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 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 deleteFloatImageHeaders = new dingtalkdoc_1_0.DeleteFloatImageHeaders({ });
deleteFloatImageHeaders.xAcsDingtalkAccessToken = '<your access token>';
let deleteFloatImageRequest = new dingtalkdoc_1_0.DeleteFloatImageRequest({
operatorId: 'xxx',
});
try {
await client.deleteFloatImageWithOptions('xxx', 'xxx', 'xxx', deleteFloatImageRequest, deleteFloatImageHeaders, new Util.RuntimeOptions({ }));
} catch (err) {
if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
// The err contains 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 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.DeleteFloatImageHeaders deleteFloatImageHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.DeleteFloatImageHeaders();
deleteFloatImageHeaders.XAcsDingtalkAccessToken = "<your access token>";
AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.DeleteFloatImageRequest deleteFloatImageRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.DeleteFloatImageRequest
{
OperatorId = "xxx",
};
try
{
client.DeleteFloatImageWithOptions("xxx", "xxx", "xxx", deleteFloatImageRequest, deleteFloatImageHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
}
catch (TeaException err)
{
if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
{
// The err contains 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))
{
// The err contains code and message attributes, which help locate the issue
}
}
}
}
}
Response
Response body
| Name | Type | Description |
|---|---|---|
| success | Boolean | Indicates whether the operation was successful. |
Response body example
HTTP/1.1 200 OK
Content-Type:application/json
{
"success" : true
}
Error codes
If the API call fails, look up the solution in the Global error codes document based on the error message.| HttpCode | Error code | Error message | Description |
|---|---|---|---|
| 400 | invalidRequest.inputArgs.invalid | %s | The request parameters are invalid. Refer to the error message for details. |
| 400 | invalidRequest.inputArgs.workbookIdIllegal | The workbookId is illegal. | The workbookId is invalid. |
| 400 | invalidRequest.resource.notWorkbook | %s | Unsupported document type. Check the workbookId. |
| 403 | forbidden.accessDenied | The operator has no permission. | The current user does not have permission for this action. |
| 403 | forbidden.acrossOrg | %s | The requested action is invalid. Refer to the error message for details. |
| 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. | The spreadsheet content is too large. Try reducing the spreadsheet content. |
| 404 | invalidRequest.resource.notFound | %s | The request failed. The resource being accessed cannot be found. |
| 500 | internalError | The server encountered an internal error and was unable to complete your request. Please try again later. | Internal server error. Try again later. |
| 500 | serviceBusy | The server is busy and unable to complete your request. Please try again later. | The service is busy. Try again later. |