> ## Documentation Index
> Fetch the complete documentation index at: https://help.dingtalk.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Memperbarui lembar kerja

> Panggil API ini untuk memperbarui atribut meta lembar kerja tertentu di DingTalk Spreadsheet, termasuk nama, visibilitas, serta baris atau kolom yang dibekukan, dengan beberapa atribut dapat diperbarui dalam satu permintaan.

Panggil API ini untuk mengubah metadata lembar kerja tertentu dalam DingTalk Spreadsheet, termasuk nama lembar kerja, visibilitas, serta jumlah baris dan kolom yang dibekukan. API ini cocok untuk mengelola konfigurasi lembar kerja secara terprogram dan mendukung pembaruan beberapa atribut dalam satu permintaan. id lembar kerja dikembalikan setelah pembaruan.

## Permintaan

### Informasi dasar

| Bidang                       | Nilai                                                                      |
| ---------------------------- | -------------------------------------------------------------------------- |
| URL HTTP                     | `https://api.dingtalk.io/v1.0/doc/workbooks/{workbookId}/sheets/{sheetId}` |
| Metode HTTP                  | PUT                                                                        |
| Jenis aplikasi yang didukung | appType-Internal app                                                       |
| Izin                         | 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. Untuk memperoleh kredensial, panggil API [Mendapatkan access token dari aplikasi internal](/id/open/development/obtain-the-access-token-of-an-internal-app). |

### Parameter path

| Nama       | Tipe   | Wajib | Deskripsi                                                                                                                                                                                                                                                                                                                                                              |
| ---------- | ------ | ----- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| workbookId | String | Ya    | ID file spreadsheet. `nodeId(dentryUuid)` yang dikembalikan oleh [Knowledge Base API](/id/open/development/knowledge-base-overview) adalah `workbookId` dari spreadsheet. Untuk memperolehnya, panggil API [Get node](https://open.dingtalk.com/document/development/get-node) atau [Membuat dokumen Knowledge Base](/id/open/development/create-team-space-document). |
| sheetId    | String | Ya    | ID atau judul lembar kerja. Untuk memperoleh id dan judul lembar kerja, panggil API [Mendapatkan semua lembar kerja](/id/open/development/obtain-all-worksheets).                                                                                                                                                                                                      |

### Parameter query

| Nama       | Tipe   | Wajib | Deskripsi                                                                                                                                                                                                                                        |
| ---------- | ------ | ----- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| operatorId | String | Ya    | unionId dari operator. Untuk memperolehnya, panggil API [Menanyakan detail pengguna](/id/open/development/query-user-details). Jika operator tidak memiliki izin yang diperlukan, API akan mengembalikan error `The operator has no permission`. |

### Isi permintaan

| Nama              | Tipe   | Wajib | Deskripsi                                                                                                                                                             |
| ----------------- | ------ | ----- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| frozenRowCount    | Long   | Tidak | Indeks baris tempat baris dibekukan. Dimulai dari 1. Nilai 0 berarti tidak ada baris yang dibekukan. Misalnya, atur nilai ini ke 3 untuk membekukan baris 1 hingga 3. |
| frozenColumnCount | Long   | Tidak | Indeks kolom tempat kolom dibekukan. Dimulai dari 1. Nilai 0 berarti tidak ada kolom yang dibekukan. Misalnya, atur nilai ini ke 3 untuk membekukan kolom 1 hingga 3. |
| visibility        | String | Tidak | Apakah lembar kerja disembunyikan. Nilai yang valid:   - **visible**: Tampilkan. - **hidden**: Sembunyikan.                                                           |
| name              | String | Tidak | Nama lembar kerja baru.                                                                                                                                               |

### Contoh permintaan

HTTP

```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
PUT /v1.0/doc/workbooks/e54Lq3xxx/sheets/Sheet1?operatorId=ppgAxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:f86e0bxxx
Content-Type:application/json

{
  "frozenRowCount" : 1,
  "frozenColumnCount" : 1,
  "visibility" : "hidden",
  "name" : "Sheet2"
}
```

Java

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>Initialize the account Client using 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.UpdateSheetHeaders updateSheetHeaders = new com.aliyun.dingtalkdoc_1_0.models.UpdateSheetHeaders();
        updateSheetHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_1_0.models.UpdateSheetRequest updateSheetRequest = new com.aliyun.dingtalkdoc_1_0.models.UpdateSheetRequest()
                .setOperatorId("ppgAxxx")
                .setFrozenRowCount(1L)
                .setFrozenColumnCount(1L)
                .setVisibility("hidden")
                .setName("Sheet2");
        try {
            client.updateSheetWithOptions("e54Lq3xxx", "Sheet1", updateSheetRequest, updateSheetHeaders, 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
            }

        }        
    }
}
```

Python

```python theme={"theme":{"light":"github-light","dark":"github-dark"}}
# -*- coding: utf-8 -*-
# File ini dibuat otomatis, jangan diedit. Terima kasih.
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 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()
        update_sheet_headers = dingtalkdoc__1__0_models.UpdateSheetHeaders()
        update_sheet_headers.x_acs_dingtalk_access_token = '<your access token>'
        update_sheet_request = dingtalkdoc__1__0_models.UpdateSheetRequest(
            operator_id='ppgAxxx',
            frozen_row_count=1,
            frozen_column_count=1,
            visibility='hidden',
            name='Sheet2'
        )
        try:
            client.update_sheet_with_options('e54Lq3xxx', 'Sheet1', update_sheet_request, update_sheet_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()
        update_sheet_headers = dingtalkdoc__1__0_models.UpdateSheetHeaders()
        update_sheet_headers.x_acs_dingtalk_access_token = '<your access token>'
        update_sheet_request = dingtalkdoc__1__0_models.UpdateSheetRequest(
            operator_id='ppgAxxx',
            frozen_row_count=1,
            frozen_column_count=1,
            visibility='hidden',
            name='Sheet2'
        )
        try:
            await client.update_sheet_with_options_async('e54Lq3xxx', 'Sheet1', update_sheet_request, update_sheet_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

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
<?php

// File ini dibuat otomatis, jangan diedit. Terima kasih.
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\UpdateSheetHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\UpdateSheetRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client using 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();
        $updateSheetHeaders = new UpdateSheetHeaders([]);
        $updateSheetHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $updateSheetRequest = new UpdateSheetRequest([
            "operatorId" => "ppgAxxx",
            "frozenRowCount" => 1,
            "frozenColumnCount" => 1,
            "visibility" => "hidden",
            "name" => "Sheet2"
        ]);
        try {
            $client->updateSheetWithOptions("e54Lq3xxx", "Sheet1", $updateSheetRequest, $updateSheetHeaders, 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));
```

Go

```go theme={"theme":{"light":"github-light","dark":"github-dark"}}
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 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
  }

  updateSheetHeaders := &dingtalkdoc_1_0.UpdateSheetHeaders{}
  updateSheetHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  updateSheetRequest := &dingtalkdoc_1_0.UpdateSheetRequest{
    OperatorId: tea.String("ppgAxxx"),
    FrozenRowCount: tea.Int64(1),
    FrozenColumnCount: tea.Int64(1),
    Visibility: tea.String("hidden"),
    Name: tea.String("Sheet2"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.UpdateSheetWithOptions(tea.String("e54Lq3xxx"), tea.String("Sheet1"), updateSheetRequest, updateSheetHeaders, &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)
  }
}
```

Node.js

```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
'use strict';
// File ini dibuat otomatis, jangan diedit
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 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 updateSheetHeaders = new dingtalkdoc_1_0.UpdateSheetHeaders({ });
    updateSheetHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let updateSheetRequest = new dingtalkdoc_1_0.UpdateSheetRequest({
      operatorId: 'ppgAxxx',
      frozenRowCount: 1,
      frozenColumnCount: 1,
      visibility: 'hidden',
      name: 'Sheet2',
    });
    try {
      await client.updateSheetWithOptions('e54Lq3xxx', 'Sheet1', updateSheetRequest, updateSheetHeaders, 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));
```

C#

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
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 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.UpdateSheetHeaders updateSheetHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.UpdateSheetHeaders();
            updateSheetHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.UpdateSheetRequest updateSheetRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.UpdateSheetRequest
            {
                OperatorId = "ppgAxxx",
                FrozenRowCount = 1,
                FrozenColumnCount = 1,
                Visibility = "hidden",
                Name = "Sheet2",
            };
            try
            {
                client.UpdateSheetWithOptions("e54Lq3xxx", "Sheet1", updateSheetRequest, updateSheetHeaders, 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        |
| ---- | ------ | ---------------- |
| id   | String | id lembar kerja. |

### Contoh isi respons

```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
HTTP/1.1 200 OK
Content-Type:application/json

{
  "id" : "sheet_id"
}
```

### Kode error

Jika error dikembalikan saat Anda memanggil API ini, cari solusinya di dokumen [Kode error global](/id/open/development/server-api-error-codes-1) 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.                                                          |
| 400      | invalidRequest.inputArgs.unionIdIllegal    | The operatorId is illegal.                                                                                                                          | operatorId tidak valid.                                                                                   |
| 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 target 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 konten spreadsheet.                                        |
| 404      | invalidRequest.resource.notFound           | %s                                                                                                                                                  | Permintaan gagal karena resource target 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.                                           | Terjadi error internal layanan. Coba lagi nanti.                                                          |