Permintaan
Informasi dasar
| Bidang | Nilai |
|---|---|
| URL HTTP | https://api.dingtalk.io/v1.0/doc/workbooks/{workbookId}/sheets/{sheetId}/setColumnsVisibility |
| Metode HTTP | POST |
| Tipe aplikasi yang didukung | appType-Aplikasi internal appType-Aplikasi perusahaan pihak ketiga |
| Izin yang diperlukan | permission-Document.Workbook.Write-Izin tulis DingTalk Spreadsheet |
Header permintaan
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | Ya | Kredensial akses untuk memanggil API ini. Dapatkan dengan cara berikut: - Untuk aplikasi internal, panggil API Mendapatkan access token aplikasi internal. - Untuk aplikasi perusahaan pihak ketiga, panggil API Mendapatkan access token perusahaan yang diberi otorisasi kepada aplikasi pihak ketiga. |
Parameter path
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| workbookId | String | Ya | ID file spreadsheet. nodeId(dentryUuid) yang dikembalikan oleh Knowledge Base API adalah workbookId dari spreadsheet. Dapatkan dengan memanggil API Get node atau Membuat dokumen Knowledge Base. |
| sheetId | String | Ya | ID atau judul lembar kerja. - Untuk aplikasi internal, panggil API Mendapatkan semua lembar kerja untuk mendapatkan id, atau masukkan judul lembar kerja. - Untuk aplikasi perusahaan pihak ketiga, kami menyarankan Anda memasukkan judul lembar kerja. Langkah-langkah untuk melihat judul lembar kerja ditunjukkan pada gambar berikut. |
Parameter query
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| operatorId | String | Ya | unionId operator. Panggil API Kueri detail pengguna untuk mendapatkannya. |
Isi permintaan
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| column | Long | Ya | Cursor kolom pertama yang akan ditampilkan atau disembunyikan. Dimulai dari 0. |
| columnCount | Long | Ya | Jumlah kolom yang akan ditampilkan atau disembunyikan. |
| visibility | String | Ya | Visibilitas. - visible: terlihat - hidden: tersembunyi |
Contoh permintaan
HTTPPOST /v1.0/doc/workbooks/e54Lq3xxx/sheets/Sheet1/setColumnsVisibility?operatorId=ppgAxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json
{
"column" : 0,
"columnCount" : 1,
"visibility" : "hidden"
}
// 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 with 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<String> args = java.util.Arrays.asList(args_);
com.aliyun.dingtalkdoc_1_0.Client client = Sample.createClient();
com.aliyun.dingtalkdoc_1_0.models.SetColumnsVisibilityHeaders setColumnsVisibilityHeaders = new com.aliyun.dingtalkdoc_1_0.models.SetColumnsVisibilityHeaders();
setColumnsVisibilityHeaders.xAcsDingtalkAccessToken = "<your access token>";
com.aliyun.dingtalkdoc_1_0.models.SetColumnsVisibilityRequest setColumnsVisibilityRequest = new com.aliyun.dingtalkdoc_1_0.models.SetColumnsVisibilityRequest()
.setOperatorId("ppgAxxx")
.setColumn(0L)
.setColumnCount(1L)
.setVisibility("hidden");
try {
client.setColumnsVisibilityWithOptions("e54Lq3xxx", "Sheet1", setColumnsVisibilityRequest, setColumnsVisibilityHeaders, 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 code and message attributes that 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)) {
// err contains code and message attributes that help locate the issue
}
}
}
}
# -*- 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 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()
set_columns_visibility_headers = dingtalkdoc__1__0_models.SetColumnsVisibilityHeaders()
set_columns_visibility_headers.x_acs_dingtalk_access_token = '<your access token>'
set_columns_visibility_request = dingtalkdoc__1__0_models.SetColumnsVisibilityRequest(
operator_id='ppgAxxx',
column=0,
column_count=1,
visibility='hidden'
)
try:
client.set_columns_visibility_with_options('e54Lq3xxx', 'Sheet1', set_columns_visibility_request, set_columns_visibility_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# err contains code and message attributes that help locate the issue
pass
@staticmethod
async def main_async(
args: List[str],
) -> None:
client = Sample.create_client()
set_columns_visibility_headers = dingtalkdoc__1__0_models.SetColumnsVisibilityHeaders()
set_columns_visibility_headers.x_acs_dingtalk_access_token = '<your access token>'
set_columns_visibility_request = dingtalkdoc__1__0_models.SetColumnsVisibilityRequest(
operator_id='ppgAxxx',
column=0,
column_count=1,
visibility='hidden'
)
try:
await client.set_columns_visibility_with_options_async('e54Lq3xxx', 'Sheet1', set_columns_visibility_request, set_columns_visibility_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# err contains code and message attributes that 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\SetColumnsVisibilityHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\SetColumnsVisibilityRequest;
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();
$setColumnsVisibilityHeaders = new SetColumnsVisibilityHeaders([]);
$setColumnsVisibilityHeaders->xAcsDingtalkAccessToken = "<your access token>";
$setColumnsVisibilityRequest = new SetColumnsVisibilityRequest([
"operatorId" => "ppgAxxx",
"column" => 0,
"columnCount" => 1,
"visibility" => "hidden"
]);
try {
$client->setColumnsVisibilityWithOptions("e54Lq3xxx", "Sheet1", $setColumnsVisibilityRequest, $setColumnsVisibilityHeaders, 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 code and message attributes that 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));
// 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 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
}
setColumnsVisibilityHeaders := &dingtalkdoc_1_0.SetColumnsVisibilityHeaders{}
setColumnsVisibilityHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
setColumnsVisibilityRequest := &dingtalkdoc_1_0.SetColumnsVisibilityRequest{
OperatorId: tea.String("ppgAxxx"),
Column: tea.Int64(0),
ColumnCount: tea.Int64(1),
Visibility: tea.String("hidden"),
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.SetColumnsVisibilityWithOptions(tea.String("e54Lq3xxx"), tea.String("Sheet1"), setColumnsVisibilityRequest, setColumnsVisibilityHeaders, &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 code and message attributes that help locate the issue
}
}
return _err
}
func main() {
err := _main(tea.StringSlice(os.Args[1:]))
if err != nil {
panic(err)
}
}
// 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 with 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<void> {
let client = Client.createClient();
let setColumnsVisibilityHeaders = new $dingtalkdoc_1_0.SetColumnsVisibilityHeaders({ });
setColumnsVisibilityHeaders.xAcsDingtalkAccessToken = "<your access token>";
let setColumnsVisibilityRequest = new $dingtalkdoc_1_0.SetColumnsVisibilityRequest({
operatorId: "ppgAxxx",
column: 0,
columnCount: 1,
visibility: "hidden",
});
try {
await client.setColumnsVisibilityWithOptions("e54Lq3xxx", "Sheet1", setColumnsVisibilityRequest, setColumnsVisibilityHeaders, new $Util.RuntimeOptions({ }));
} catch (err) {
if (!Util.empty(err.code) && !Util.empty(err.message)) {
// err contains code and message attributes that help locate the issue
}
}
}
}
Client.main(process.argv.slice(2));
// 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 with 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.SetColumnsVisibilityHeaders setColumnsVisibilityHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SetColumnsVisibilityHeaders();
setColumnsVisibilityHeaders.XAcsDingtalkAccessToken = "<your access token>";
AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SetColumnsVisibilityRequest setColumnsVisibilityRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SetColumnsVisibilityRequest
{
OperatorId = "ppgAxxx",
Column = 0,
ColumnCount = 1,
Visibility = "hidden",
};
try
{
client.SetColumnsVisibilityWithOptions("e54Lq3xxx", "Sheet1", setColumnsVisibilityRequest, setColumnsVisibilityHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
}
catch (TeaException err)
{
if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
{
// err contains code and message attributes that 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))
{
// err contains code and message attributes that help locate the issue
}
}
}
}
}
Respons
Isi respons
| Nama | Tipe | Deskripsi |
|---|---|---|
| id | String | ID lembar kerja. |
Contoh isi respons
HTTP/1.1 200 OK
Content-Type:application/json
{
"id" : "stxxx"
}
Kode error
Jika panggilan API mengembalikan error, lihat dokumen Kode error global untuk menemukan solusi berdasarkan pesan error.| HttpCode | Kode error | Pesan error | Deskripsi |
|---|---|---|---|
| 400 | invalidRequest.inputArgs.workbookIdIllegal | The workbookId is illegal. | workbookId tidak valid. |
| 400 | invalidRequest.inputArgs.operatorIdIllegal | The operatorId is illegal. | operatorId tidak valid. |
| 400 | invalidRequest.inputArgs.invalid | %s | Parameter permintaan tidak valid. Periksa pesan error. |
| 403 | forbidden.operationIllegal | %s | Tindakan permintaan tidak valid. Periksa pesan error. |
| 403 | forbidden.accessDenied | The operator has no permission. | Pengguna saat ini tidak memiliki izin untuk tindakan ini. |
| 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 diminta tidak dapat ditemukan. |
| 500 | internalError | The server encountered an internal error and was unable to complete your request. Please try again later. | Terjadi error internal server. Coba lagi nanti. |
| 503 | serviceBusy | The server is busy and unable to complete your request. Please try again later. | Layanan sedang sibuk. Coba lagi nanti. |