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

Очистить внешний ID документа

PUT 
/api/v1/clients/:clientId/documents/:documentExternalId/externalId/clearExternalId

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

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

Методы PUT перезаписывают запись целиком: любые непереданные поля считаются null и затирают данные в БД. Поэтому при обновлении нужно указывать все поля. Метод работает для всех документов (и черновики, и отправленные на подпись, и удаленные). Затирает внешний IDexternalId Внешний идентификатор сущности — произвольная строка, задаваемая интегратором при создании. Связывает сущность HRlink с записью во внешней системе (1С, SAP и др.) без хранения маппинга UUID. документа по внешнему IDexternalId Внешний идентификатор сущности — произвольная строка, задаваемая интегратором при создании. Связывает сущность HRlink с записью во внешней системе (1С, SAP и др.) без хранения маппинга UUID. документа.

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

  • Клиент существует, не удалён, и к нему относится пользователь, выполняющий операцию.
  • Документ должен существовать по заданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. документа во внешней системе.
  • Документ должен принадлежать заданному клиенту.
  • У пользователя должно быть право на обновление документов на уровне ролей пользователя клиента или, если документ не связан ни с каким юрлицом, то он должен иметь права на уровне пользователя клиента или быть создателем документа, который при этом имеет право обновления документов на уровне сотрудника клиента или, если документ связан с юрлицом, то он должен быть сотрудником этого юрлица и иметь право на обновление документов на уровне ролей сотрудника заданного юрлица.
  • IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента соответствует формату UUID.
  • По заданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента существует клиент.
  • Пользователь, выполняющий операцию, относится к клиенту.
  • Проверяет существование документа по заданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. во внешней системе и возвращает документ, если он существует.
  • Проверяет, что документ относится к заданному клиенту.
  • Пользователь клиента должен являться создателем документа и иметь права на уровне сотрудника.
  • Пользователь клиента должен иметь права на уровне пользователя клиента.
  • Проверяет, есть ли у пользователя клиента с заданным IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. для заданного юрлица заданное право с учётом замещенийSubstitution Замещение — временная передача прав одного пользователя другому (например, на время отпуска). Настраивается для конкретных контекстов: документы, заявления, сотрудники, ЛНА..
  • В случае замещенияSubstitution Замещение — временная передача прав одного пользователя другому (например, на время отпуска). Настраивается для конкретных контекстов: документы, заявления, сотрудники, ЛНА. в режиме кадровика дополнительно проверяются его активные замещенияSubstitution Замещение — временная передача прав одного пользователя другому (например, на время отпуска). Настраивается для конкретных контекстов: документы, заявления, сотрудники, ЛНА..
  • Проверяет, что текущий пользователь относится к заданному клиенту и возвращает пользователя клиента, если он существует.
  • Проверяет, что IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента, заданный в виде строки, соответствует формату, и возвращает типизированный IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента.
  • Проверяет существование клиента по заданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. и возвращает клиента, если он существует.
  • Проверяет, что клиент не удален.

Request​

Responses​

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