Перейти к основному содержимому

Обновить справочник по внешнему ID

PUT 
/api/v1/clients/:clientId/customStructuresByExternalId/:customStructureExternalId

Описание метода​

⚠️ Будьте осторожны!

Методы PUT перезаписывают запись целиком: любые непереданные поля считаются null и затирают данные в БД. Поэтому при обновлении нужно указывать все поля.

Валидации запроса​

  • Тело запроса задано.
  • Клиент существует, не удалён, и к нему относится пользователь, выполняющий операцию.
  • IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. пользовательского справочника структур указан корректно.
  • Пользовательский справочник структур с заданным IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. существует в системе.
  • Описание пользовательского справочника структур имеет корректную длину.
  • Другого пользовательского справочника структур с заданным названием не существует в системе.
  • Другого пользовательского справочника структур с заданным IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. во внешней системе не существует.
  • Название пользовательского справочника структур имеет корректную длину.
  • Код цвета пользовательского справочника структур имеет допустимый формат.
  • Указана корректная версия данных пользовательского справочника структур.
  • У пользователя клиента должно быть право CUSTOM_STRUCTURES_UPDATE на уровне пользователя клиента.
  • Проверяет, что IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. пользовательского справочника структур указан корректно и пользовательский справочник структур с заданным IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. существует в системе, и возвращает пользовательский справочник структур, если он существует.
  • IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента соответствует формату UUID.
  • По заданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента существует клиент.
  • Пользователь, выполняющий операцию, относится к клиенту.
  • Проверяет, что описание пользовательского справочника структур имеет корректную длину.
  • Проверяет, что другого пользовательского справочника структур с заданным названием не существует в клиенте.
  • Проверяет, что другого пользовательского справочника структур с заданным IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. во внешней системе не существует в клиенте.
  • Проверяет, что название пользовательского справочника структур имеет корректную длину.
  • Проверяет, что код цвета пользовательского справочника структур имеет допустимый формат.
  • Проверяет, что указана корректная версия данных пользовательского справочника структур.
  • Проверяет, есть ли у пользователя клиента с заданным IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. заданное право на уровне пользователя клиента.
  • Проверяет, что текущий пользователь относится к заданному клиенту и возвращает пользователя клиента, если он существует.
  • Проверяет, что IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента, заданный в виде строки, соответствует формату, и возвращает типизированный IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента.
  • Проверяет существование клиента по заданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. и возвращает клиента, если он существует.
  • Проверяет, что клиент не удален.

Request​

Responses​

Успешная операция.