Sort filtered data

Call this API to sort data within the global filter range in ascending or descending order by a specified column. This API applies to scenarios that require ordered display of filtered data, such as arranging sales data from highest to lowest by amount, or sorting a task list by due date in ascending order.

API call description

Sort actions permanently change the actual storage order of data records in the worksheet, not just the display order.

Request

Basic information

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

Request headers

Name	Type	Required	Description
x-acs-dingtalk-access-token	String	Yes	The access credential for calling this API. To obtain it, call Obtain the access token of an internal app.

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`. To obtain it, call Get a node or Create a Knowledge Base document.
sheetId	String	Yes	The worksheet ID or name. To obtain the id or name parameter value, call Get all worksheets.

Query parameters

Name	Type	Required	Description
operatorId	String	Yes	The unionId of the operator. - To obtain the unionid parameter value, call Obtain user information by silent login code. - To obtain the unionid parameter value, call Query user details. If the operator has no permission, the API returns the error `The operator has no permission`.

Request body

Name	Type	Required	Description
field	Object	Yes	The sorting rules object.
column	Long	Yes	The column offset relative to the first column of the filter range, starting from 0.
ascending	Boolean	No	Whether to sort in ascending order. The default is `true` (ascending). Set to `false` for descending order.

Request example

HTTP

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

{
  "field" : {
    "column" : 0,
    "ascending" : false
  }
}

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.SortFilterHeaders sortFilterHeaders = new com.aliyun.dingtalkdoc_1_0.models.SortFilterHeaders();
        sortFilterHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_1_0.models.SortFilterRequest.SortFilterRequestField field = new com.aliyun.dingtalkdoc_1_0.models.SortFilterRequest.SortFilterRequestField()
                .setColumn(0L)
                .setAscending(false);
        com.aliyun.dingtalkdoc_1_0.models.SortFilterRequest sortFilterRequest = new com.aliyun.dingtalkdoc_1_0.models.SortFilterRequest()
                .setOperatorId("ppgAxxx")
                .setField(field);
        try {
            client.sortFilterWithOptions("e54Lq3xxx", "Sheet1", sortFilterRequest, sortFilterHeaders, 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 contains the code and message Attributes, which help developers 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)) {
                // err contains the code and message Attributes, which help developers locate 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()
        sort_filter_headers = dingtalkdoc__1__0_models.SortFilterHeaders()
        sort_filter_headers.x_acs_dingtalk_access_token = '<your access token>'
        field = dingtalkdoc__1__0_models.SortFilterRequestField(
            column=0,
            ascending=False
        )
        sort_filter_request = dingtalkdoc__1__0_models.SortFilterRequest(
            operator_id='ppgAxxx',
            field=field
        )
        try:
            client.sort_filter_with_options('e54Lq3xxx', 'Sheet1', sort_filter_request, sort_filter_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains the code and message Attributes, which help developers locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        sort_filter_headers = dingtalkdoc__1__0_models.SortFilterHeaders()
        sort_filter_headers.x_acs_dingtalk_access_token = '<your access token>'
        field = dingtalkdoc__1__0_models.SortFilterRequestField(
            column=0,
            ascending=False
        )
        sort_filter_request = dingtalkdoc__1__0_models.SortFilterRequest(
            operator_id='ppgAxxx',
            field=field
        )
        try:
            await client.sort_filter_with_options_async('e54Lq3xxx', 'Sheet1', sort_filter_request, sort_filter_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains the code and message Attributes, which help developers locate 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\SortFilterHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\SortFilterRequest\field;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\SortFilterRequest;
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();
        $sortFilterHeaders = new SortFilterHeaders([]);
        $sortFilterHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $field = new field([
            "column" => 0,
            "ascending" => false
        ]);
        $sortFilterRequest = new SortFilterRequest([
            "operatorId" => "ppgAxxx",
            "field" => $field
        ]);
        try {
            $client->sortFilterWithOptions("e54Lq3xxx", "Sheet1", $sortFilterRequest, $sortFilterHeaders, 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 contains the code and message Attributes, which help developers 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 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
  }

  sortFilterHeaders := &dingtalkdoc_1_0.SortFilterHeaders{}
  sortFilterHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  field := &dingtalkdoc_1_0.SortFilterRequestField{
    Column: tea.Int64(0),
    Ascending: tea.Bool(false),
  }
  sortFilterRequest := &dingtalkdoc_1_0.SortFilterRequest{
    OperatorId: tea.String("ppgAxxx"),
    Field: field,
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.SortFilterWithOptions(tea.String("e54Lq3xxx"), tea.String("Sheet1"), sortFilterRequest, sortFilterHeaders, &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 contains the code and message Attributes, which help developers locate 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 sortFilterHeaders = new dingtalkdoc_1_0.SortFilterHeaders({ });
    sortFilterHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let field = new dingtalkdoc_1_0.SortFilterRequestField({
      column: 0,
      ascending: false,
    });
    let sortFilterRequest = new dingtalkdoc_1_0.SortFilterRequest({
      operatorId: 'ppgAxxx',
      field: field,
    });
    try {
      await client.sortFilterWithOptions('e54Lq3xxx', 'Sheet1', sortFilterRequest, sortFilterHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err contains the code and message Attributes, which help developers 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 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.SortFilterHeaders sortFilterHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SortFilterHeaders();
            sortFilterHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SortFilterRequest.SortFilterRequestField field = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SortFilterRequest.SortFilterRequestField
            {
                Column = 0,
                Ascending = false,
            };
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SortFilterRequest sortFilterRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SortFilterRequest
            {
                OperatorId = "ppgAxxx",
                Field = field,
            };
            try
            {
                client.SortFilterWithOptions("e54Lq3xxx", "Sheet1", sortFilterRequest, sortFilterHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err contains the code and message Attributes, which help developers 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))
                {
                    // err contains the code and message Attributes, which help developers locate the issue
                }
            }
        }

    }
}

Response

Response body

Name	Type	Description
id	String	The unique identifier of the filter.

Response body example

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

{
  "id" : "filter-xxxxx"
}

Error codes

If an error is returned when you call this API, 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 parameter is invalid. Check the error message.
400	invalidRequest.inputArgs.workbookIdIllegal	The workbookId is illegal.	The workbookId is invalid.
400	invalidRequest.resource.notWorkbook	%s	Unsupported document type. Check the workbookId.
400	invalidRequest.document.stillInitializing	The document is still initializing. Please try again later.	The document is initializing. Try again later.
403	forbidden.accessDenied	The operator has no permission.	The current user does not have permission to perform this action.
403	forbidden.acrossOrg	%s	The request is invalid. Verify that the document to be accessed belongs to the organization specified by the access token.
403	forbidden.operationIllegal	%s	The requested 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 to reduce the spreadsheet content.
404	invalidRequest.resource.notFound	%s	The request failed. The resource to be accessed cannot be found.
500	serviceBusy	The server is busy and unable to complete your request. Please try again later.	The service is busy. Try again later.
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.

API calling guide

Authentication & authorization

Contacts

Calendar

Conferencing

AI Table

Docs & files

IM

API call description

Request

Basic information

Request headers

Path parameters

Query parameters

Request body

Request example

Response

Response body

Response body example

Error codes

​API call description

​Request

​Basic information

​Request headers

​Path parameters

​Query parameters

​Request body

​Request example

​Response

​Response body

​Response body example

​Error codes

API call description

Request

Basic information

Request headers

Path parameters

Query parameters

Request body

Request example

Response

Response body

Response body example

Error codes