Обновление Записи

​

Путь

​

Запрос

​

Параметры пути

• tableId (string): Уникальный идентификатор Таблицы (как получить).
• recordId (string): Уникальный идентификатор обновляемой Записи (как получить).

​

Тело запроса

• record (обязательный)
  • Описание: Данные Записи для обновления
  • Тип: Object
  • Пример:
    {
      "fields": {
        "Name": "John Doe",
        "Age": 31,
        "Email": "john.doe@example.com"
      }
    }
    
  • Примечание: Объект fields содержит имена Полей и соответствующие новые значения. Каждый тип Поля имеет свою структуру значений; подробности см. в разделе Типы значений Полей Записи.

• fieldKeyType (необязательный)
  • Описание: Определяет тип ключа Поля
  • Тип: String
  • Допустимые значения:
    • “name”: использовать имя Поля как ключ
    • “id”: использовать ID Поля как ключ
    • “dbFieldName”: использовать dbFieldName Поля как ключ
  • Пример: "name" или "id" или "dbFieldName"
  • Примечание: Если параметр не указан, в качестве ключа по умолчанию используется имя Поля.
  • Использование:
    • Если установлено значение “name”:
      {
        "fields": {
          "Name": "John Doe",
          "Age": 30
        }
      }
      
    • Если установлено значение “id”:
      {
        "fields": {
          "fldABCDEFGHIJKLMN": "John Doe",
          "fldOPQRSTUVWXYZ12": 30
        }
      }
      
• typecast (необязательный)
  • Описание: Следует ли автоматически преобразовывать типы значений Полей. По умолчанию применяется строгая проверка, требующая соответствия входных значений текущему типу данных Поля. Если параметр включён, система попытается выполнить автоматическое преобразование.
  • Тип: Boolean
  • Допустимые значения: true или false
  • Пример: true
  • Примечание: Если установлено значение true, система попытается преобразовать входные значения в корректный тип значения Поля.
  • Примеры использования:
    • Поле ссылки: для связывания можно напрямую использовать текст первичного ключа
      {
        "User table": "John Smith"
      }
      
    • Поле даты: можно использовать строки с датой в нестандартном формате
      {
        "Date": "2023-05-15"
      }
      
    • Поле пользователя: можно напрямую использовать имя пользователя
      {
        "Assigned To": "John Doe"
      }
      

• order (необязательный)
  • Описание: После обновления Записи переместить её в указанную позицию в указанном Представлении.
  • Тип: Object
  • Свойства:
    • viewId: ID Представления
    • anchorId: ID опорной Записи
    • position: Положение относительно опорной Записи. Допустимые значения: "before" или "after"
  • Пример:
    {
      "viewId": "viwABCDEFGHIJKLMN",
      "anchorId": "rec123456789ABCDE",
      "position": "after"
    }
    

​

Ответ

​

Успешный ответ

• Код состояния: 200 OK
• Тело ответа: Возвращает данные обновлённой Записи.

{
    "id": "rec123456789ABCDE",
    "fields": {
        "Name": "John Doe",
        "Age": 31,
        "Email": "john.doe@example.com"
    }
}

​

Ответы с ошибками

• Код состояния: 400 Bad Request: ошибка формата тела запроса или отсутствуют обязательные Поля.
• Код состояния: 404 Not Found: указанный tableId или recordId не существует.

​

Пример кода

curl -X PATCH 'https://app.teable.ai/api/table/__tableId__/record/__recordId__' \
  -H 'Authorization: Bearer __token__' \
  -H 'Content-Type: application/json' \
  -d '{
    "record": {
      "fields": {
        "Name": "John Doe",
        "Age": 31
      }
    }
  }'

import { configApi, updateRecord } from '@teable/openapi';

configApi({
  endpoint: 'https://app.teable.ai',
  token,
});

const response = await updateRecord('__tableId__', '__recordId__', {
  record: {
    fields: {
      Name: 'John Doe',
      Age: 31
    }
  }
});

console.log(response.data);

const response = await fetch('https://app.teable.ai/api/table/__tableId__/record/__recordId__', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer __token__',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    record: {
      fields: {
        Name: 'John Doe',
        Age: 31
      }
    }
  })
});

console.log(await response.json());

import requests

response = requests.patch(
    'https://app.teable.ai/api/table/__tableId__/record/__recordId__',
    headers={
        'Authorization': 'Bearer __token__',
        'Content-Type': 'application/json'
    },
    json={
        'record': {
            'fields': {
                'Name': 'John Doe',
                'Age': 31
            }
        }
    }
)

print(response.json())