> ## 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.

# フィールドの更新

> AIテーブルのデータテーブル内のフィールド名と属性を更新してテーブル構成を変更します

本インターフェースを呼び出し、データテーブル内のフィールドを 1 つ更新します。

## リクエスト

### 基本情報

| フィールド       | 値                                                                                                   |
| ----------- | --------------------------------------------------------------------------------------------------- |
| HTTP URL    | `https://api.dingtalk.io/v1.0/notable/bases/{baseId}/sheets/{sheetIdOrName}/fields/{fieldIdOrName}` |
| HTTP Method | PUT                                                                                                 |
| 対応アプリタイプ    | appType-社内アプリ                                                                                       |
| 権限要件        | permission-Notable.Base.Write.All-AIテーブルアプリ書き込み権限                                                   |

### リクエストヘッダー

| 名前                          | タイプ    | 必須 | 説明                                                                                                                                        |
| --------------------------- | ------ | -- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| x-acs-dingtalk-access-token | String | はい | 本インターフェースを呼び出すためのアクセス認証情報。[社内アプリの accessToken を取得](/ja/open/development/obtain-the-access-token-of-an-internal-app#) インターフェースを呼び出して取得します。 |

### パスパラメータ

| 名前            | タイプ    | 必須 | 説明                                                                                                                                                                                                                              |
| ------------- | ------ | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| baseId        | String | はい | AIテーブル ID。取得方法は [データ構造](/ja/open/development/data-structure#) を参照してください。                                                                                                                                                        |
| sheetIdOrName | String | はい | データテーブル ID またはデータテーブル名。データテーブル ID は以下の 2 つの方法で取得できます。   - [すべてのデータテーブルを取得](/ja/open/development/api-notable-getallsheets#) インターフェースを呼び出して取得します。 - [データテーブルを取得](/ja/open/development/api-notable-getsheet#) インターフェースを呼び出して取得します。 |
| fieldIdOrName | String | はい | フィールド ID またはフィールド名。フィールド ID は [すべてのフィールドを取得](/ja/open/development/api-noatable-getallfields#) インターフェースを呼び出して取得できます。                                                                                                             |

### クエリパラメータ

| 名前         | タイプ    | 必須 | 説明                                                                                                                                                                                                                                      |
| ---------- | ------ | -- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| operatorId | String | はい | 操作者の unionId。以下の 2 つの方法で取得できます。   - [ユーザー詳細の照会](/ja/open/development/query-user-details#) インターフェースを呼び出して取得します。 - [サイレントログインコードでユーザー情報を取得](/ja/open/development/obtain-the-userid-of-a-user-by-using-the-log-free#) インターフェースを呼び出して取得します。 |

### リクエストボディ

| 名前       | タイプ                | 必須  | 説明                                                                                                          |
| -------- | ------------------ | --- | ----------------------------------------------------------------------------------------------------------- |
| name     | String             | はい  | フィールド名。                                                                                                     |
| property | `Map<String, Any>` | いいえ | フィールドの属性。具体的なフォーマットは [フィールド属性](https://open.dingtalk.com/document/development/field-properties#) を参照してください。 |
|          | Any                | いいえ | フィールドの属性。                                                                                                   |

### リクエスト例

HTTP

```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
PUT /v1.0/notable/bases/xxxxx/sheets/データテーブル/fields/名前?operatorId=xxxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json

{
  "name" : "性別",
  "property" : {
    "key" : "{}"
  }
}
```

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 {

    /**
     * <b>description</b> :
     * <p>トークンを使用してアカウント Client を初期化します</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.UpdateFieldHeaders updateFieldHeaders = new com.aliyun.dingtalknotable_1_0.models.UpdateFieldHeaders();
        updateFieldHeaders.xAcsDingtalkAccessToken = "<your access token>";
        java.util.Map<String, java.util.Map<String, Object>> property = TeaConverter.buildMap(
            new TeaPair("key", new java.util.HashMap<>())
        );
        com.aliyun.dingtalknotable_1_0.models.UpdateFieldRequest updateFieldRequest = new com.aliyun.dingtalknotable_1_0.models.UpdateFieldRequest()
                .setOperatorId("xxxxx")
                .setName("性別")
                .setProperty(property);
        try {
            client.updateFieldWithOptions("xxxxx", "データテーブル", "名前", updateFieldRequest, updateFieldHeaders, 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 には code と message プロパティが含まれており、問題の特定に役立ちます
            }

        } 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 には code と message プロパティが含まれており、問題の特定に役立ちます
            }

        }        
    }
}
```

Python

```python theme={"theme":{"light":"github-light","dark":"github-dark"}}
# -*- 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:
        """
        トークンを使用してアカウント Client を初期化します
        @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()
        update_field_headers = dingtalknotable__1__0_models.UpdateFieldHeaders()
        update_field_headers.x_acs_dingtalk_access_token = '<your access token>'
        property = {
            'key': {}
        }
        update_field_request = dingtalknotable__1__0_models.UpdateFieldRequest(
            operator_id='xxxxx',
            name='性別',
            property=property
        )
        try:
            client.update_field_with_options('xxxxx', 'データテーブル', '名前', update_field_request, update_field_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err には code と message プロパティが含まれており、問題の特定に役立ちます
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        update_field_headers = dingtalknotable__1__0_models.UpdateFieldHeaders()
        update_field_headers.x_acs_dingtalk_access_token = '<your access token>'
        property = {
            'key': {}
        }
        update_field_request = dingtalknotable__1__0_models.UpdateFieldRequest(
            operator_id='xxxxx',
            name='性別',
            property=property
        )
        try:
            await client.update_field_with_options_async('xxxxx', 'データテーブル', '名前', update_field_request, update_field_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err には code と message プロパティが含まれており、問題の特定に役立ちます
                pass

if __name__ == '__main__':
    Sample.main(sys.argv[1:])
```

PHP

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
<?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\UpdateFieldHeaders;
use AlibabaCloud\SDK\Dingtalk\Vnotable_1_0\Models\UpdateFieldRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * トークンを使用してアカウント Client を初期化します
     * @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();
        $updateFieldHeaders = new UpdateFieldHeaders([]);
        $updateFieldHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $property = [
            "key" => []
        ];
        $updateFieldRequest = new UpdateFieldRequest([
            "operatorId" => "xxxxx",
            "name" => "性別",
            "property" => $property
        ]);
        try {
            $client->updateFieldWithOptions("xxxxx", "データテーブル", "名前", $updateFieldRequest, $updateFieldHeaders, 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 には code と message プロパティが含まれており、問題の特定に役立ちます
            }
        }
    }
}
$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 (
  "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:
// 
// トークンを使用してアカウント Client を初期化します
// 
// @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
  }

  updateFieldHeaders := &dingtalknotable_1_0.UpdateFieldHeaders{}
  updateFieldHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  property := map[string]map[string]interface{}{
    "key": map[string]interface{}{},
  }
  updateFieldRequest := &dingtalknotable_1_0.UpdateFieldRequest{
    OperatorId: tea.String("xxxxx"),
    Name: tea.String("性別"),
    Property: property,
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.UpdateFieldWithOptions(tea.String("xxxxx"), tea.String("データテーブル"), tea.String("名前"), updateFieldRequest, updateFieldHeaders, &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 には code と message プロパティが含まれており、問題の特定に役立ちます
    }

  }
  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';
// 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 {

  /**
   * トークンを使用してアカウント Client を初期化します
   * @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 updateFieldHeaders = new dingtalknotable_1_0.UpdateFieldHeaders({ });
    updateFieldHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let property = {
      key: { },
    };
    let updateFieldRequest = new dingtalknotable_1_0.UpdateFieldRequest({
      operatorId: 'xxxxx',
      name: '性別',
      property: property,
    });
    try {
      await client.updateFieldWithOptions('xxxxx', 'データテーブル', '名前', updateFieldRequest, updateFieldHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err には code と message プロパティが含まれており、問題の特定に役立ちます
      }

    }    
  }

}

exports.Client = Client;
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 
    {

        /// <term><b>Description:</b></term>
        /// <description>
        /// <para>トークンを使用してアカウント Client を初期化します</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.UpdateFieldHeaders updateFieldHeaders = new AlibabaCloud.SDK.Dingtalknotable_1_0.Models.UpdateFieldHeaders();
            updateFieldHeaders.XAcsDingtalkAccessToken = "<your access token>";
            Dictionary<string, Dictionary<string, object>> property = new Dictionary<string, Dictionary<string, object>>
            {
                {"key", new Dictionary<string, object>(){}},
            };
            AlibabaCloud.SDK.Dingtalknotable_1_0.Models.UpdateFieldRequest updateFieldRequest = new AlibabaCloud.SDK.Dingtalknotable_1_0.Models.UpdateFieldRequest
            {
                OperatorId = "xxxxx",
                Name = "性別",
                Property = property,
            };
            try
            {
                client.UpdateFieldWithOptions("xxxxx", "データテーブル", "名前", updateFieldRequest, updateFieldHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err には code と message プロパティが含まれており、問題の特定に役立ちます
                }
            }
            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 には code と message プロパティが含まれており、問題の特定に役立ちます
                }
            }
        }

    }
}
```

## レスポンス

### レスポンスボディ

| 名前 | タイプ    | 説明        |
| -- | ------ | --------- |
| id | String | フィールド ID。 |

### レスポンスボディ例

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

{
  "id" : "xxxxx"
}
```

### エラーコード

本インターフェースの呼び出し時にエラーが発生した場合は、エラーメッセージをもとに [グローバルエラーコード](/ja/open/development/server-api-error-codes-1) ドキュメントで解決策をご確認ください。

| HttpCode | エラーコード                                    | エラーメッセージ                                                                                                                                             | 説明                                    |
| -------- | ----------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- |
| 500      | internalError                             | The server encountered an internal error and was unable to complete your request. Please try again later.                                            | システムエラー                               |
| 500      | unknownError                              | Unknown Error                                                                                                                                        | 不明なエラー                                |
| 400      | invalidRequest.inputArgs.invalid          | %s                                                                                                                                                   | リクエストパラメータが不正です。エラーメッセージをご確認ください。     |
| 400      | invalidRequest.document.stillInitializing | The document is under initialization. Please try again later                                                                                         | ドキュメント初期化中です。後で再試行してください              |
| 400      | invalidRequest.document.broken            | The document is broken and the server is unable to complete your request.                                                                            | ドキュメントが破損しています                        |
| 403      | forbidden.operationIllegal                | %s                                                                                                                                                   | 権限がありません                              |
| 403      | invalidRequest.document.typeIllegal       | %s                                                                                                                                                   | サポートされていないドキュメントタイプです。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. | ドキュメントが存在しません                         |
| 404      | invalidRequest.resource.notFound          | %s                                                                                                                                                   | リソースが存在しません。データが存在しないか、完全に削除されています    |
| 504      | service.timeout                           | The server is busy and unable to complete your request. Please try again later.                                                                      | リクエストタイムアウト                           |