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

Обновлено: 21.06.2026

НазначениеНазначение

Обновление записи позволяет изменить существующую сущность.

Для этого используется HTTP-метод PATCH с передачей изменяемых полей в теле запроса.

Обновляются только переданные свойства. Остальные значения сохраняются без изменений.

Базовый запросБазовый запрос

Например, обновление названия и дат проекта:

PATCH https://api.timetta.com/odata/Projects('45eb27e2-161e-4eeb-9b56-72eaea30511d')
Content-Type: application/json

Тело запроса:

{
  "name": "СпецЭкоСервис - Пресейл (обновлено)",
  "startDate": "2025-11-01",
  "endDate": "2025-12-31"
}

Если запрос выполнен успешно, API возвращает код:

• 200 OK
• 204 No Content

Конкретный формат ответа зависит от сущности и операции.

Частичное обновлениеЧастичное обновление

PATCH поддерживает частичное обновление.

Например, если необходимо изменить только название:

{
  "name": "Новое название проекта"
}

В этом случае остальные поля останутся без изменений.

Обновление связанных сущностейОбновление связанных сущностей

Для изменения ссылок на связанные объекты используются идентификаторы.

Например:

{
  "managerId": "04f9aa6d-4918-4221-bcaf-f9703cc63959"
}

Передача вложенных объектов вместо идентификаторов не поддерживается.

Некорректный пример:

{
  "manager": {
    "id": "04f9aa6d-4918-4221-bcaf-f9703cc63959"
  }
}

Для обновления связей необходимо использовать ключевые поля.

Обновление агрегатов с дочерними коллекциямиОбновление агрегатов с дочерними коллекциями

Для агрегатных сущностей допускается обновление дочерних коллекций.

Такие свойства в описании сущности имеют тип метамодели CollectionProperty.

Например, сущность ExpenseRequest может содержать коллекцию lines.

Поведение зависит от переданного значения:

Свойство отсутствует или равно nullСвойство отсутствует или равно null

Коллекция не изменяется.

Пример:

{
  "name": "Командировка в офис клиента",
  "lines": null
}

Или:

{
  "name": "Командировка в офис клиента"
}

В обоих случаях текущий состав строк останется без изменений.

Передан пустой массивПередан пустой массив

Коллекция будет очищена.

Пример:

{
  "lines": []
}

Все дочерние элементы будут удалены.

Передан массив элементовПередан массив элементов

Коллекция будет полностью обновлена.

Пример:

{
  "lines": [
    {
      "name": "Авиабилеты",
      "amount": 18000
    },
    {
      "name": "Проживание",
      "amount": 26000
    }
  ]
}

Текущий состав дочерней коллекции будет заменён переданным.

Обработка ошибокОбработка ошибок

Если запись не найдена:

• 404 Not Found

Если переданы некорректные данные:

• 400 Bad Request

Если отсутствует или истёк токен доступа:

• 401 Unauthorized

Если недостаточно прав:

• 403 Forbidden

Если нарушены бизнес-правила:

• 500 Internal Server Error

Пример ошибки:

{
  "error": {
    "code": "validation_error",
    "message": "Project end date must be greater than start date",
    "details": {}
  }
}

РекомендацииРекомендации

При обновлении сущностей рекомендуется:

• использовать PATCH вместо полной замены объекта;
• передавать только изменяемые поля;
• использовать идентификаторы для связанных сущностей;
• внимательно обновлять дочерние коллекции агрегатов;
• учитывать, что пустой массив очищает коллекцию;
• учитывать, что null не изменяет коллекцию.