Create a floating image

Call this API to retrieve the list of all floating images in a specified worksheet of a DingTalk Spreadsheet. This API applies to scenarios that require batch reading of floating images within a worksheet, such as export, sync, or audit. The response contains the unique identifier, image URL, anchor position, and size offset of each image.

Request

Basic information

Field	Value
HTTP URL	`https://api.dingtalk.io/v1.0/doc/workbooks/{workbookId}/sheets/{sheetId}/floatImages`
HTTP Method	POST
Supported app type	appType-Internal app
Required permissions	permission-Document.Workbook.Write-DingTalk Spreadsheet write permission

Request headers

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 ID of the spreadsheet file. The `nodeId(dentryUuid)` returned by the Knowledge Base API is the `workbookId` of the spreadsheet. Obtain it by calling the Get node and Create a Knowledge Base document APIs.
sheetId	String	Yes	The ID or title of the worksheet. Call the Get all worksheets API to obtain the ID and title of the worksheet.

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 has no permission, the API returns the error `The operator has no permission`.

Request body

Name	Type	Required	Description
src	String	Yes	The resource URL of the floating image. Obtain the `resourceUrl` by calling the Get resource upload information API.
anchor	Object	Yes	The positioning information of the floating image.
row	Integer	Yes	The row index for positioning. The cursor starts from 0.
col	Integer	Yes	The column index for positioning. The cursor starts from 0.
coordinate	Object	Yes	The geometry information.
width	double	Yes	The width of the image, in pixels.
height	double	Yes	The height of the image, in pixels.
offsetX	double	Yes	The horizontal offset relative to the positioning coordinate, in pixels.
offsetY	double	Yes	The vertical offset relative to the positioning coordinate, in pixels.

Request example

HTTP

POST /v1.0/doc/workbooks/e54Lqxxxxx/sheets/Sheet1/floatImages?operatorId=ppgAQuxxxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:f86e0bxxx
Content-Type:application/json

{
  "src" : "/core/api/resources/img/xxx",
  "anchor" : {
    "row" : 1,
    "col" : 1
  },
  "coordinate" : {
    "width" : 300.0,
    "height" : 300.0,
    "offsetX" : 8.0,
    "offsetY" : 8.0
  }
}

Java

package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>Initialize the account Client with a 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.CreateFloatImageHeaders createFloatImageHeaders = new com.aliyun.dingtalkdoc_1_0.models.CreateFloatImageHeaders();
        createFloatImageHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_1_0.models.CreateFloatImageRequest.CreateFloatImageRequestCoordinate coordinate = new com.aliyun.dingtalkdoc_1_0.models.CreateFloatImageRequest.CreateFloatImageRequestCoordinate()
                .setWidth(300D)
                .setHeight(300D)
                .setOffsetX(8D)
                .setOffsetY(8D);
        com.aliyun.dingtalkdoc_1_0.models.CreateFloatImageRequest.CreateFloatImageRequestAnchor anchor = new com.aliyun.dingtalkdoc_1_0.models.CreateFloatImageRequest.CreateFloatImageRequestAnchor()
                .setRow(1)
                .setCol(1);
        com.aliyun.dingtalkdoc_1_0.models.CreateFloatImageRequest createFloatImageRequest = new com.aliyun.dingtalkdoc_1_0.models.CreateFloatImageRequest()
                .setOperatorId("ppgAQuxxxxx")
                .setSrc("/core/api/resources/img/xxx")
                .setAnchor(anchor)
                .setCoordinate(coordinate);
        try {
            client.createFloatImageWithOptions("e54Lqxxxxx", "Sheet1", createFloatImageRequest, createFloatImageHeaders, 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 object contains the code and message attributes, which help diagnose 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 object contains the code and message attributes, which help diagnose the issue.
            }

        }        
    }
}

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:
        """
        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()
        create_float_image_headers = dingtalkdoc__1__0_models.CreateFloatImageHeaders()
        create_float_image_headers.x_acs_dingtalk_access_token = '<your access token>'
        coordinate = dingtalkdoc__1__0_models.CreateFloatImageRequestCoordinate(
            width=300,
            height=300,
            offset_x=8,
            offset_y=8
        )
        anchor = dingtalkdoc__1__0_models.CreateFloatImageRequestAnchor(
            row=1,
            col=1
        )
        create_float_image_request = dingtalkdoc__1__0_models.CreateFloatImageRequest(
            operator_id='ppgAQuxxxxx',
            src='/core/api/resources/img/xxx',
            anchor=anchor,
            coordinate=coordinate
        )
        try:
            client.create_float_image_with_options('e54Lqxxxxx', 'Sheet1', create_float_image_request, create_float_image_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # The err object contains the code and message attributes, which help diagnose the issue.
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        create_float_image_headers = dingtalkdoc__1__0_models.CreateFloatImageHeaders()
        create_float_image_headers.x_acs_dingtalk_access_token = '<your access token>'
        coordinate = dingtalkdoc__1__0_models.CreateFloatImageRequestCoordinate(
            width=300,
            height=300,
            offset_x=8,
            offset_y=8
        )
        anchor = dingtalkdoc__1__0_models.CreateFloatImageRequestAnchor(
            row=1,
            col=1
        )
        create_float_image_request = dingtalkdoc__1__0_models.CreateFloatImageRequest(
            operator_id='ppgAQuxxxxx',
            src='/core/api/resources/img/xxx',
            anchor=anchor,
            coordinate=coordinate
        )
        try:
            await client.create_float_image_with_options_async('e54Lqxxxxx', 'Sheet1', create_float_image_request, create_float_image_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # The err object contains the code and message attributes, which help diagnose the issue.
                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\CreateFloatImageHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\CreateFloatImageRequest\coordinate;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\CreateFloatImageRequest\anchor;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\CreateFloatImageRequest;
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();
        $createFloatImageHeaders = new CreateFloatImageHeaders([]);
        $createFloatImageHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $coordinate = new coordinate([
            "width" => 300,
            "height" => 300,
            "offsetX" => 8,
            "offsetY" => 8
        ]);
        $anchor = new anchor([
            "row" => 1,
            "col" => 1
        ]);
        $createFloatImageRequest = new CreateFloatImageRequest([
            "operatorId" => "ppgAQuxxxxx",
            "src" => "/core/api/resources/img/xxx",
            "anchor" => $anchor,
            "coordinate" => $coordinate
        ]);
        try {
            $client->createFloatImageWithOptions("e54Lqxxxxx", "Sheet1", $createFloatImageRequest, $createFloatImageHeaders, 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 object contains the code and message attributes, which help diagnose 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 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
  }

  createFloatImageHeaders := &dingtalkdoc_1_0.CreateFloatImageHeaders{}
  createFloatImageHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  coordinate := &dingtalkdoc_1_0.CreateFloatImageRequestCoordinate{
    Width: tea.Float64(300),
    Height: tea.Float64(300),
    OffsetX: tea.Float64(8),
    OffsetY: tea.Float64(8),
  }
  anchor := &dingtalkdoc_1_0.CreateFloatImageRequestAnchor{
    Row: tea.Int32(1),
    Col: tea.Int32(1),
  }
  createFloatImageRequest := &dingtalkdoc_1_0.CreateFloatImageRequest{
    OperatorId: tea.String("ppgAQuxxxxx"),
    Src: tea.String("/core/api/resources/img/xxx"),
    Anchor: anchor,
    Coordinate: coordinate,
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.CreateFloatImageWithOptions(tea.String("e54Lqxxxxx"), tea.String("Sheet1"), createFloatImageRequest, createFloatImageHeaders, &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 object contains the code and message attributes, which help diagnose the issue.
    }

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

  /**
   * Initialize the account Client with a 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 createFloatImageHeaders = new dingtalkdoc_1_0.CreateFloatImageHeaders({ });
    createFloatImageHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let coordinate = new dingtalkdoc_1_0.CreateFloatImageRequestCoordinate({
      width: 300,
      height: 300,
      offsetX: 8,
      offsetY: 8,
    });
    let anchor = new dingtalkdoc_1_0.CreateFloatImageRequestAnchor({
      row: 1,
      col: 1,
    });
    let createFloatImageRequest = new dingtalkdoc_1_0.CreateFloatImageRequest({
      operatorId: 'ppgAQuxxxxx',
      src: '/core/api/resources/img/xxx',
      anchor: anchor,
      coordinate: coordinate,
    });
    try {
      await client.createFloatImageWithOptions('e54Lqxxxxx', 'Sheet1', createFloatImageRequest, createFloatImageHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // The err object contains the code and message attributes, which help diagnose 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 a 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.CreateFloatImageHeaders createFloatImageHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CreateFloatImageHeaders();
            createFloatImageHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CreateFloatImageRequest.CreateFloatImageRequestCoordinate coordinate = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CreateFloatImageRequest.CreateFloatImageRequestCoordinate
            {
                Width = 300,
                Height = 300,
                OffsetX = 8,
                OffsetY = 8,
            };
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CreateFloatImageRequest.CreateFloatImageRequestAnchor anchor = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CreateFloatImageRequest.CreateFloatImageRequestAnchor
            {
                Row = 1,
                Col = 1,
            };
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CreateFloatImageRequest createFloatImageRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CreateFloatImageRequest
            {
                OperatorId = "ppgAQuxxxxx",
                Src = "/core/api/resources/img/xxx",
                Anchor = anchor,
                Coordinate = coordinate,
            };
            try
            {
                client.CreateFloatImageWithOptions("e54Lqxxxxx", "Sheet1", createFloatImageRequest, createFloatImageHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // The err object contains the code and message attributes, which help diagnose 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 object contains the code and message attributes, which help diagnose the issue.
                }
            }
        }

    }
}

Response

Response body

Name	Type	Description
result	Object	The floating image information.
id	String	The ID of the floating image.
src	String	The resource URL of the floating image.
anchor	Object	The anchor position that specifies the cell to which the image is fixed.
row	Integer	The row index for positioning. The cursor starts from 0.
col	Integer	The column index for positioning. The cursor starts from 0.
coordinate	Object	The size of the image and the offset relative to the anchor cell.
width	double	The width of the floating image.
height	double	The height of the floating image.
offsetX	double	The horizontal offset relative to the top-left corner of the anchor cell, in pixels.
offsetY	double	The vertical offset relative to the top-left corner of the anchor cell, in pixels.
success	Boolean	The success status.

Response body example

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

{
  "result" : {
    "id" : "xxx",
    "src" : "/core/api/resources/img/xxx",
    "anchor" : {
      "row" : 1,
      "col" : 1
    },
    "coordinate" : {
      "width" : 300,
      "height" : 300,
      "offsetX" : 1,
      "offsetY" : 1
    }
  },
  "success" : true
}

Error codes

If an error occurs when calling this API, find 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 parameter is invalid. Check the error message.
400	invalidRequest.inputArgs.workbookIdIllegal	The workbookId is illegal.	The workbookId is invalid.
400	invalidRequest.resource.notWorkbook	%s	The document type is not supported. 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 request action is invalid. Check the error message.
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 content.
404	invalidRequest.resource.notFound	%s	The request failed. The resource to access cannot be found.
500	internalError	The server encountered an internal error and was unable to complete your request. Please try again later.	An internal server error occurred. 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.

API calling guide

Authentication & authorization

Contacts

Calendar

Conferencing

AI Table

Docs & files

IM

Request

Basic information

Request headers

Path parameters

Query parameters

Request body

Request example

Response

Response body

Response body example

Error codes

​Request

​Basic information

​Request headers

​Path parameters

​Query parameters

​Request body

​Request example

​Response

​Response body

​Response body example

​Error codes

Request

Basic information

Request headers

Path parameters

Query parameters

Request body

Request example

Response

Response body

Response body example

Error codes