Permintaan
Informasi dasar
| Bidang | Nilai |
|---|---|
| URL HTTP | https://api.dingtalk.io/v1.0/notable/bases/{baseId}/sheets |
| Metode HTTP | POST |
| Jenis aplikasi yang didukung | appType-Internal app |
| Izin yang diperlukan | permission-Notable.Base.Write.All-AI Table app write permission |
Header permintaan
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | Ya | Kredensial akses untuk memanggil API ini. Dapatkan dengan memanggil API Mendapatkan access token dari aplikasi internal. |
Parameter jalur
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| baseId | String | Ya | ID dari AI Table. Untuk cara memperolehnya, lihat Struktur data. |
Parameter kueri
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| operatorId | String | Ya | unionId dari operator. Dapatkan dengan salah satu cara berikut: - Panggil API Kueri detail pengguna. - Panggil API Mendapatkan informasi pengguna melalui kode login senyap. |
Isi permintaan
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| name | String | Tidak | Nama tabel. |
| fields | Array | Tidak | Konfigurasi bidang tabel. |
| name | String | Ya | Nama field. |
| type | String | Ya | Tipe bidang. Untuk tipe yang didukung, lihat Properti bidang. |
| property | Map<String, Any> | Tidak | Properti bidang. Untuk formatnya, lihat Properti bidang. |
| Any | Tidak | Properti bidang. Tipe bidang yang berbeda memiliki konfigurasi properti yang berbeda. |
Contoh permintaan
HTTPPOST /v1.0/notable/bases/qnYxxx/sheets?operatorId=union_id HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json
{
"name" : "Table2",
"fields" : [ {
"name" : "Teks",
"type" : "text",
"property" : {
"key" : "{}"
}
} ]
}
// This file is auto-generated, don't edit it. Thanks.
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.dingtalknotable_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.dingtalknotable_1_0.Client(config);
}
public static void main(String[] args_) throws Exception {
com.aliyun.dingtalknotable_1_0.Client client = Sample.createClient();
com.aliyun.dingtalknotable_1_0.models.CreateSheetHeaders createSheetHeaders = new com.aliyun.dingtalknotable_1_0.models.CreateSheetHeaders();
createSheetHeaders.xAcsDingtalkAccessToken = "<your access token>";
java.util.Map<String, java.util.Map<String, Object>> fields0Property = TeaConverter.buildMap(
new TeaPair("key", new java.util.HashMap<>())
);
com.aliyun.dingtalknotable_1_0.models.CreateSheetRequest.CreateSheetRequestFields fields0 = new com.aliyun.dingtalknotable_1_0.models.CreateSheetRequest.CreateSheetRequestFields()
.setName("Text")
.setType("text")
.setProperty(fields0Property);
com.aliyun.dingtalknotable_1_0.models.CreateSheetRequest createSheetRequest = new com.aliyun.dingtalknotable_1_0.models.CreateSheetRequest()
.setOperatorId("union_id")
.setName("Table2")
.setFields(java.util.Arrays.asList(
fields0
));
try {
client.createSheetWithOptions("qnYxxx", createSheetRequest, createSheetHeaders, 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 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 code dan message, yang membantu menemukan issue
}
}
}
}
# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import os
import sys
from typing import List
from alibabacloud_dingtalk.notable_1_0.client import Client as dingtalknotable_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.notable_1_0 import models as dingtalknotable__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() -> dingtalknotable_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 dingtalknotable_1_0Client(config)
@staticmethod
def main(
args: List[str],
) -> None:
client = Sample.create_client()
create_sheet_headers = dingtalknotable__1__0_models.CreateSheetHeaders()
create_sheet_headers.x_acs_dingtalk_access_token = '<your access token>'
fields_0property = {
'key': {}
}
fields_0 = dingtalknotable__1__0_models.CreateSheetRequestFields(
name='Text',
type='text',
property=fields_0property
)
create_sheet_request = dingtalknotable__1__0_models.CreateSheetRequest(
operator_id='union_id',
name='Table2',
fields=[
fields_0
]
)
try:
client.create_sheet_with_options('qnYxxx', create_sheet_request, create_sheet_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# err berisi code dan message, yang membantu menemukan issue
pass
@staticmethod
async def main_async(
args: List[str],
) -> None:
client = Sample.create_client()
create_sheet_headers = dingtalknotable__1__0_models.CreateSheetHeaders()
create_sheet_headers.x_acs_dingtalk_access_token = '<your access token>'
fields_0property = {
'key': {}
}
fields_0 = dingtalknotable__1__0_models.CreateSheetRequestFields(
name='Text',
type='text',
property=fields_0property
)
create_sheet_request = dingtalknotable__1__0_models.CreateSheetRequest(
operator_id='union_id',
name='Table2',
fields=[
fields_0
]
)
try:
await client.create_sheet_with_options_async('qnYxxx', create_sheet_request, create_sheet_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# err berisi code dan message, yang membantu menemukan 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\Vnotable_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;
use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vnotable_1_0\Models\CreateSheetHeaders;
use AlibabaCloud\SDK\Dingtalk\Vnotable_1_0\Models\CreateSheetRequest\fields;
use AlibabaCloud\SDK\Dingtalk\Vnotable_1_0\Models\CreateSheetRequest;
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();
$createSheetHeaders = new CreateSheetHeaders([]);
$createSheetHeaders->xAcsDingtalkAccessToken = "<your access token>";
$fields0Property = [
"key" => []
];
$fields0 = new fields([
"name" => "Text",
"type" => "text",
"property" => $fields0Property
]);
$createSheetRequest = new CreateSheetRequest([
"operatorId" => "union_id",
"name" => "Table2",
"fields" => [
$fields0
]
]);
try {
$client->createSheetWithOptions("qnYxxx", $createSheetRequest, $createSheetHeaders, 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 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));
// This file is auto-generated, don't edit it. Thanks.
package main
import (
"encoding/json"
"strings"
"fmt"
"os"
util "github.com/alibabacloud-go/tea-utils/v2/service"
dingtalknotable_1_0 "github.com/alibabacloud-go/dingtalk/notable_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 *dingtalknotable_1_0.Client, _err error) {
config := &openapi.Config{}
config.Protocol = tea.String("https")
config.RegionId = tea.String("central")
_result = &dingtalknotable_1_0.Client{}
_result, _err = dingtalknotable_1_0.NewClient(config)
return _result, _err
}
func _main (args []*string) (_err error) {
client, _err := CreateClient()
if _err != nil {
return _err
}
createSheetHeaders := &dingtalknotable_1_0.CreateSheetHeaders{}
createSheetHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
fields0Property := map[string]map[string]interface{}{
"key": map[string]interface{}{},
}
fields0 := &dingtalknotable_1_0.CreateSheetRequestFields{
Name: tea.String("Text"),
Type: tea.String("text"),
Property: fields0Property,
}
createSheetRequest := &dingtalknotable_1_0.CreateSheetRequest{
OperatorId: tea.String("union_id"),
Name: tea.String("Table2"),
Fields: []*dingtalknotable_1_0.CreateSheetRequestFields{fields0},
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.CreateSheetWithOptions(tea.String("qnYxxx"), createSheetRequest, createSheetHeaders, &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 code dan message, yang membantu menemukan issue
}
}
return _err
}
func main() {
err := _main(tea.StringSlice(os.Args[1:]))
if err != nil {
panic(err)
}
}
'use strict';
// This file is auto-generated, don't edit it
const Util = require('@alicloud/tea-util');
const dingtalknotable_1_0 = require('@alicloud/dingtalk/notable_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 dingtalknotable_1_0.default(config);
}
static async main(args) {
let client = Client.createClient();
let createSheetHeaders = new dingtalknotable_1_0.CreateSheetHeaders({ });
createSheetHeaders.xAcsDingtalkAccessToken = '<your access token>';
let fields0Property = {
key: { },
};
let fields0 = new dingtalknotable_1_0.CreateSheetRequestFields({
name: 'Text',
type: 'text',
property: fields0Property,
});
let createSheetRequest = new dingtalknotable_1_0.CreateSheetRequest({
operatorId: 'union_id',
name: 'Table2',
fields: [
fields0
],
});
try {
await client.createSheetWithOptions('qnYxxx', createSheetRequest, createSheetHeaders, new Util.RuntimeOptions({ }));
} catch (err) {
if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
// err berisi code dan message, yang membantu menemukan issue
}
}
}
}
exports.Client = Client;
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
{
/// <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.Dingtalknotable_1_0.Client CreateClient()
{
AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
config.Protocol = "https";
config.RegionId = "central";
return new AlibabaCloud.SDK.Dingtalknotable_1_0.Client(config);
}
public static void Main(string[] args)
{
AlibabaCloud.SDK.Dingtalknotable_1_0.Client client = CreateClient();
AlibabaCloud.SDK.Dingtalknotable_1_0.Models.CreateSheetHeaders createSheetHeaders = new AlibabaCloud.SDK.Dingtalknotable_1_0.Models.CreateSheetHeaders();
createSheetHeaders.XAcsDingtalkAccessToken = "<your access token>";
Dictionary<string, Dictionary<string, object>> fields0Property = new Dictionary<string, Dictionary<string, object>>
{
{"key", new Dictionary<string, object>(){}},
};
AlibabaCloud.SDK.Dingtalknotable_1_0.Models.CreateSheetRequest.CreateSheetRequestFields fields0 = new AlibabaCloud.SDK.Dingtalknotable_1_0.Models.CreateSheetRequest.CreateSheetRequestFields
{
Name = "Text",
Type = "text",
Property = fields0Property,
};
AlibabaCloud.SDK.Dingtalknotable_1_0.Models.CreateSheetRequest createSheetRequest = new AlibabaCloud.SDK.Dingtalknotable_1_0.Models.CreateSheetRequest
{
OperatorId = "union_id",
Name = "Table2",
Fields = new List<AlibabaCloud.SDK.Dingtalknotable_1_0.Models.CreateSheetRequest.CreateSheetRequestFields>
{
fields0
},
};
try
{
client.CreateSheetWithOptions("qnYxxx", createSheetRequest, createSheetHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
}
catch (TeaException err)
{
if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
{
// err berisi 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 code dan message, yang membantu menemukan issue
}
}
}
}
}
Respons
Isi respons
| Nama | Tipe | Deskripsi |
|---|---|---|
| id | String | ID dari tabel. |
| name | String | Nama tabel. |
Contoh isi respons
HTTP/1.1 200 OK
Content-Type:application/json
{
"id" : "stxxx",
"name" : "Tabel"
}
Kode error
Jika terjadi error saat memanggil API ini, lihat dokumen Kode error global berdasarkan pesan error untuk menemukan solusinya.| HttpCode | Kode error | Pesan error | Deskripsi |
|---|---|---|---|
| 500 | internalError | The server encountered an internal error and was unable to complete your request. Please try again later. | Error sistem. |
| 500 | unknownError | Unknown Error | Error tidak dikenal. |
| 400 | invalidRequest.inputArgs.invalid | %s | Parameter permintaan tidak valid. Lihat pesan error untuk detailnya. |
| 400 | invalidRequest.document.stillInitializing | The document is under initialization. Please try again later | Dokumen sedang diinisialisasi. Coba lagi nanti. |
| 400 | invalidRequest.document.broken | The document is broken and the server is unable to complete your request. | Dokumen rusak. |
| 403 | forbidden.operationIllegal | %s | Tidak ada izin. |
| 403 | invalidRequest.document.typeIllegal | %s | Tipe dokumen tidak didukung. Periksa baseId. |
| 404 | invalidRequest.document.notFound | Fail to find the requested resource by the given baseId. Please make sure the given baseId is valid, and the operatorId has permission to access it. | Dokumen tidak ada. |
| 404 | invalidRequest.resource.notFound | %s | Sumber daya tidak ada. Data tidak ada atau telah dihapus secara permanen. |
| 504 | service.timeout | The server is busy and unable to complete your request. Please try again later. | Permintaan melebihi batas waktu. |