> ## 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. # Mendapatkan lembar kerja > Panggil API ini untuk mendapatkan properti lembar kerja di DingTalk Spreadsheet, termasuk ID, nama, jumlah baris, dan jumlah kolom lembar kerja. Panggil API ini untuk mendapatkan properti lembar kerja, termasuk ID lembar kerja, nama lembar kerja, jumlah baris, dan jumlah kolom. ## Permintaan ### Informasi dasar | Bidang | Nilai | | ---------------------------- | -------------------------------------------------------------------------- | | URL HTTP | `https://api.dingtalk.io/v1.0/doc/workbooks/{workbookId}/sheets/{sheetId}` | | Metode HTTP | GET | | Jenis aplikasi yang didukung | appType-Aplikasi internal | | Izin yang diperlukan | permission-Document.Workbook.Read-Izin baca untuk DingTalk Spreadsheet | ### Header permintaan | Nama | Tipe | Wajib | Deskripsi | | --------------------------- | ------ | ----- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | x-acs-dingtalk-access-token | String | Ya | Kredensial akses yang digunakan untuk memanggil API ini. Untuk mendapatkannya, panggil API [Mendapatkan access token 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. Anda dapat memperolehnya dengan memanggil API [Mendapatkan node](https://open.dingtalk.com/document/development/get-node#) dan [Membuat dokumen Knowledge Base](/id/open/development/create-team-space-document#). | | sheetId | String | Ya | ID atau nama lembar kerja. Panggil API [Mendapatkan semua lembar kerja](/id/open/development/obtain-all-worksheets#) untuk mendapatkan nilai parameter id atau name. | ### Parameter query | Nama | Tipe | Wajib | Deskripsi | | ---------- | ------ | ----- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | operatorId | String | Ya | unionId operator. - Panggil API [Mendapatkan userid pengguna menggunakan kode login senyap](/id/open/development/obtain-the-userid-of-a-user-by-using-the-log-free#) untuk mendapatkan nilai parameter unionid. - Panggil API [Kueri detail pengguna](/id/open/development/query-user-details#) untuk mendapatkan nilai parameter unionid. Jika operator tidak memiliki izin, API mengembalikan error `The operator has no permission`. | ### Contoh permintaan HTTP ```http theme={"theme":{"light":"github-light","dark":"github-dark"}} GET /v1.0/doc/workbooks/e54Lq3xxx/sheets/Sheet1?operatorId=ppgAxxx HTTP/1.1 Host:api.dingtalk.io x-acs-dingtalk-access-token:xxxxx Content-Type:application/json ``` Java ```java theme={"theme":{"light":"github-light","dark":"github-dark"}} // 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 using 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 args = java.util.Arrays.asList(args_); com.aliyun.dingtalkdoc_1_0.Client client = Sample.createClient(); com.aliyun.dingtalkdoc_1_0.models.GetSheetHeaders getSheetHeaders = new com.aliyun.dingtalkdoc_1_0.models.GetSheetHeaders(); getSheetHeaders.xAcsDingtalkAccessToken = ""; com.aliyun.dingtalkdoc_1_0.models.GetSheetRequest getSheetRequest = new com.aliyun.dingtalkdoc_1_0.models.GetSheetRequest() .setOperatorId("ppgAxxx"); try { client.getSheetWithOptions("e54Lq3xxx", "Sheet1", getSheetRequest, getSheetHeaders, 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 developer 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 developer menemukan issue } } } } ``` Python ```python theme={"theme":{"light":"github-light","dark":"github-dark"}} # -*- 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 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() get_sheet_headers = dingtalkdoc__1__0_models.GetSheetHeaders() get_sheet_headers.x_acs_dingtalk_access_token = '' get_sheet_request = dingtalkdoc__1__0_models.GetSheetRequest( operator_id='ppgAxxx' ) try: client.get_sheet_with_options('e54Lq3xxx', 'Sheet1', get_sheet_request, get_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 developer menemukan issue pass @staticmethod async def main_async( args: List[str], ) -> None: client = Sample.create_client() get_sheet_headers = dingtalkdoc__1__0_models.GetSheetHeaders() get_sheet_headers.x_acs_dingtalk_access_token = '' get_sheet_request = dingtalkdoc__1__0_models.GetSheetRequest( operator_id='ppgAxxx' ) try: await client.get_sheet_with_options_async('e54Lq3xxx', 'Sheet1', get_sheet_request, get_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 developer menemukan issue pass if __name__ == '__main__': Sample.main(sys.argv[1:]) ``` PHP ```java theme={"theme":{"light":"github-light","dark":"github-dark"}} protocol = "https"; $config->regionId = "central"; return new Dingtalk($config); } /** * @param string[] $args * @return void */ public static function main($args){ $client = self::createClient(); $getSheetHeaders = new GetSheetHeaders([]); $getSheetHeaders->xAcsDingtalkAccessToken = ""; $getSheetRequest = new GetSheetRequest([ "operatorId" => "ppgAxxx" ]); try { $client->getSheetWithOptions("e54Lq3xxx", "Sheet1", $getSheetRequest, $getSheetHeaders, 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 developer 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"}} // 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 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 } getSheetHeaders := &dingtalkdoc_1_0.GetSheetHeaders{} getSheetHeaders.XAcsDingtalkAccessToken = tea.String("") getSheetRequest := &dingtalkdoc_1_0.GetSheetRequest{ OperatorId: tea.String("ppgAxxx"), } tryErr := func()(_e error) { defer func() { if r := tea.Recover(recover()); r != nil { _e = r } }() _, _err = client.GetSheetWithOptions(tea.String("e54Lq3xxx"), tea.String("Sheet1"), getSheetRequest, getSheetHeaders, &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 developer menemukan issue } } return _err } func main() { err := _main(tea.StringSlice(os.Args[1:])) if err != nil { panic(err) } } ``` Node.js ```python theme={"theme":{"light":"github-light","dark":"github-dark"}} // 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 using 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 { let client = Client.createClient(); let getSheetHeaders = new $dingtalkdoc_1_0.GetSheetHeaders({ }); getSheetHeaders.xAcsDingtalkAccessToken = ""; let getSheetRequest = new $dingtalkdoc_1_0.GetSheetRequest({ operatorId: "ppgAxxx", }); try { await client.getSheetWithOptions("e54Lq3xxx", "Sheet1", getSheetRequest, getSheetHeaders, new $Util.RuntimeOptions({ })); } catch (err) { if (!Util.empty(err.code) && !Util.empty(err.message)) { // err berisi atribut code dan message yang membantu developer menemukan issue } } } } Client.main(process.argv.slice(2)); ``` C# ```java theme={"theme":{"light":"github-light","dark":"github-dark"}} // 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 using 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.GetSheetHeaders getSheetHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.GetSheetHeaders(); getSheetHeaders.XAcsDingtalkAccessToken = ""; AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.GetSheetRequest getSheetRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.GetSheetRequest { OperatorId = "ppgAxxx", }; try { client.GetSheetWithOptions("e54Lq3xxx", "Sheet1", getSheetRequest, getSheetHeaders, 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 developer menemukan issue } } catch (Exception _err) { TeaException err = new TeaException(new Dictionary { { "message", _err.Message } }); if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message)) { // err berisi atribut code dan message yang membantu developer menemukan issue } } } } } ``` ## Respons ### Isi respons | Nama | Tipe | Deskripsi | | ------------------ | ------ | ------------------------------------------------------------------------------------------------ | | id | String | ID lembar kerja. | | name | String | Nama lembar kerja. | | visibility | String | Visibilitas lembar kerja. | | lastNonEmptyRow | Long | Posisi baris tidak kosong terakhir, dimulai dari 0. Mengembalikan -1 ketika lembar kerja kosong. | | lastNonEmptyColumn | Long | Posisi kolom tidak kosong terakhir, dimulai dari 0. Mengembalikan -1 ketika lembar kerja kosong. | | rowCount | Long | Jumlah baris dalam lembar kerja. | | columnCount | Long | Jumlah kolom dalam lembar kerja. | ### Contoh isi respons ```text theme={"theme":{"light":"github-light","dark":"github-dark"}} HTTP/1.1 200 OK Content-Type:application/json { "id" : "stxxxx", "name" : "Sheet1", "visibility" : "visible", "lastNonEmptyRow" : 10, "lastNonEmptyColumn" : 20, "rowCount" : 200, "columnCount" : 40 } ``` ### Kode error Jika terjadi error saat Anda memanggil API ini, cari solusinya dalam 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. | | 400 | invalidRequest.inputArgs.workbookIdIllegal | The workbookId is illegal. | workbookId tidak valid. | | 400 | invalidRequest.resource.notWorkbook | %s | Tipe dokumen tidak didukung. Periksa workbookId. | | 400 | invalidRequest.document.stillInitializing | The document is still initializing. Please try again later. | Dokumen masih dalam proses inisialisasi. Coba lagi nanti. | | 403 | forbidden.accessDenied | The operator has no permission. | Pengguna saat ini tidak memiliki izin untuk 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. | | 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. 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. | Terjadi error internal layanan. Coba lagi nanti. |