StaffCircle (предварительная версия)
StaffCircle — это платформа успеха сотрудников, которая объединяет культуру компании с управлением производительностью для создания высокопроизводительных команд даже в распределенных рабочих средах. StafffCircle включает в себя Objective, Reviews, Values и Feedback, связанный с вашей платформой компетенции. Повышение вовлеченности и производительности с глубоким пониманием.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | Class | Регионы |
|---|---|---|
| Copilot Studio | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Логические приложения | Стандарт | Все регионы Logic Apps , кроме следующих: — Регионы Azure для государственных организаций — Регионы Azure Для Китая - Министерство обороны США (DoD) |
| Power Apps | Премия | Все регионы Power Apps , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Power Automate | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Контакт | |
|---|---|
| Имя | Поддержка StaffCircle |
| URL | https://www.staffcircle.com/contact-us/ |
| Адрес электронной почты | support@staffcircle.com |
| Метаданные соединителя | |
|---|---|
| Publisher | StaffCircle |
| Website | https://www.staffcircle.com/ |
| Privacy Policy (Политика конфиденциальности) | https://www.staffcircle.com/privacy-policy/ |
| Категории | Коммуникация; Кадровые ресурсы |
StaffCircle помогает организациям управлять своими удаленными сотрудниками путем улучшения управления производительностью, comms и культуры. Вы можете подключиться к StaffCircle для управления своими обзорами one2one, целями производительности, okrs, отзывом в режиме реального времени, наградами и признанием. Вы можете выполнять различные действия, такие как создание или обновление целей производительности, назначение наград, создание статей и оповещений, обновление сведений о пользователях и многое другое.
Предпосылки
Чтобы использовать этот соединитель, вам потребуется доступ к учетной записи StaffCircle. StaffCircle является платным планом подписки. Если у вас нет доступа к учетной записи StaffCircle, см. дополнительные сведения здесь.
Получение учетных данных
Если у вас есть доступ к учетной записи StaffCircle, у вас уже есть учетные данные, которые необходимо начать использовать этот соединитель. При создании подключения для соединителя StaffCircle вам будет предложено ввести имя пользователя и пароль. Здесь можно использовать любые учетные данные учетной записи StaffCircle. Важно отметить, что соединитель будет работать в контексте предоставленных учетных данных, это включает в себя учет разрешений безопасности. Это означает, что учетная запись StaffCircle, используемая вами, имеет правильные разрешения для выполнения действия, которое активируется в соединителе.
Начало работы с соединителем
Приступая к работе с соединителем StaffCircle, вам просто нужна учетная запись StaffCircle. Учетные данные пользователя можно использовать для создания подключения к соединителю StaffCircle. После этого можно использовать один из наших триггеров, определенных в соединителе, для запуска автоматизированных рабочих процессов из событий, происходящих в экземпляре StaffCircle.
Ниже приведены некоторые примеры рабочих процессов
- Активируйте рабочий процесс при публикации статьи в StaffCircle и отправьте уведомление о статье в приложение чата, например Slack.
- Активируйте рабочий процесс, когда новый сотрудник добавляется в StaffCircle и выполняет процесс подключения, который может включать такие сообщения, как сообщения электронной почты новому сотруднику.
StaffCircle имеет множество веб-перехватчиков, которые не все предоставляются в соединителе в качестве триггеров. Если вы не можете найти триггер в соответствии с вашими потребностями, рассмотрите возможность просмотра наших веб-перехватчиков. Наши веб-перехватчики можно найти в веб-приложении StaffCircle в разделе интеграции параметров. Триггер потока "При получении HTTP-запроса" можно использовать для создания URL-адреса, который можно предоставить веб-перехватчику StaffCircle для активации рабочего процесса.
Пример такого рабочего процесса:
- Когда запрос на праздник выполняется для сотрудника, создайте событие календаря Outlook.
StaffCircle сделал доступной коллекцию действий для улучшения коммуникации и объективного управления в бизнесе. Такие действия, как "Создание нового оповещения", можно использовать для активации отправки сообщений в нескольких каналах, поддерживаемых StaffCircle, таких как электронная почта, sms, MS Teams, в приложении и push-уведомлениях. Это помогает вашей команде получать сведения о важных событиях, происходящих в других приложениях.
Действия "Цель" можно использовать для автоматизации отслеживания ключевых показателей эффективности. Так как события происходят в других приложениях, например, выиграв возможность, вы можете обновить цели, заданные в StaffCircle, со значением сделки.
StaffCircle предоставил удобные действия, такие как "Получить человека по электронной почте", чтобы упростить связывание сотрудников с другими действиями, такими как "Создание новой задачи".
Support
Если у вас возникли трудности с настройкой соединителя StaffCircle или требуются функциональные возможности для удовлетворения ваших бизнес-потребностей, обратитесь к нам по адресу support@staffcircle.com
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Обновление целевой оценки |
Обновляет цель с новым показателем и описанием |
| Поиск целей |
Поиск целей |
| Получение пользователя по электронной почте |
Пытается найти запись пользователя по электронной почте |
| Создание задачи |
Создает новую задачу и назначает ее пользователю |
| Создание нового оповещения |
Создает новое оповещение, которое можно распространить для пользователей StaffCircle с помощью нескольких каналов связи |
| Создание нового пользователя |
Создание человека |
| Создание новой статьи |
Создает новую статью, которую можно распространить для пользователей StaffCircle с помощью нескольких каналов связи |
| Создание новой цели |
Создает новую цель |
| Создание новой цели по шаблону |
Создает новую цель с помощью шаблона цели |
Обновление целевой оценки
Обновляет цель с новым показателем и описанием
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор цели
|
objectiveId | True | string |
Цель, для которую необходимо обновить оценку хода выполнения |
|
Ценность
|
value | True | double |
Текущий общий ход выполнения |
|
Увеличивается
|
isIncrement | boolean |
Если значение false, то переданное значение является текущим значением цели. Если значение true, то значение должно быть добавлено в существующую общую сумму. |
|
|
Description
|
description | True | string |
Краткое описание хода выполнения |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | integer |
Идентификатор целевой записи хода выполнения |
Поиск целей
Поиск целей
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Заголовок поиска
|
SearchTitle | string |
Свободное сопоставление строк для поиска на основе заголовка |
|
|
Электронная почта пользователя
|
PersonEmail | string |
Адрес электронной почты человека, которому назначена цель |
|
|
Тег
|
Tag | string |
Тег, выделенный для цели |
|
|
Закрытый
|
Closed | string |
Если цель закрыта. Значение True, если закрыто в противном случае значение false |
|
|
Тип цели
|
ObjectiveType | string |
Тип цели |
|
|
От
|
From | date-time |
Цель активна с этого времени |
|
|
Кому
|
To | date-time |
Цель активна с этого времени |
|
|
Активный в
|
ActiveAt | date-time |
Цель активна на данный момент времени |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
results
|
results | array of object |
results |
|
Идентификатор цели
|
results.id | integer |
Идентификатор цели |
|
Название
|
results.title | string |
Название, заданное цели |
|
Description
|
results.description | string |
Описание, заданное для цели |
|
Тег
|
results.tag | string |
Тег, связанный с целью |
|
Тип цели
|
results.objectiveType | string |
Тип цели |
|
Закрытый
|
results.closed | boolean |
Является ли цель закрытой |
|
Закрытая причина
|
results.closedReason | string |
Причина закрытия цели |
|
Идентификатор пользователя
|
results.person.id | integer |
Идентификатор пользователя, для которого предназначена цель |
|
Имя пользователя
|
results.person.firstName | string |
Первое имя человека, для которого является цель |
|
Имя семьи человека
|
results.person.secondName | string |
Имя семьи человека цели — для |
|
Идентификатор диспетчера
|
results.manager.id | integer |
Идентификатор руководителя |
|
Имя руководителя
|
results.manager.firstName | string |
Имя руководителя |
|
Имя семейства диспетчера
|
results.manager.secondName | string |
Имя семьи руководителя |
|
Создан идентификатором пользователя
|
results.createdBy.id | integer |
Идентификатор пользователя, создавшего цель |
|
Создание имени пользователя
|
results.createdBy.firstName | string |
Первое имя пользователя, создавшего цель |
|
Создано именем семьи пользователя
|
results.createdBy.secondName | string |
Имя семьи человека, создавшего цель |
|
Идентификатор отдела
|
results.department.id | integer |
Идентификатор отдела, связанный с целью |
|
Название отдела
|
results.department.name | string |
Имя отдела, связанного с целью |
|
Идентификатор цели отдела
|
results.departmentObjective.id | integer |
идентификатор цели отдела |
|
Название цели отдела
|
results.departmentObjective.title | string |
Название цели отдела |
|
Описание цели отдела
|
results.departmentObjective.description | string |
Описание цели отдела |
|
Идентификатор цели компании
|
results.companyObjective.id | integer |
Идентификатор цели компании |
|
Название цели компании
|
results.companyObjective.title | string |
Название цели компании |
|
Описание цели компании
|
results.companyObjective.description | string |
Описание цели компании |
|
Текущий ход выполнения
|
results.currentProgress | double |
Текущий прогресс по цели |
|
Дата начала
|
results.startDate | string |
От момента измерения цели |
|
Дата окончания
|
results.endDate | string |
Крайний срок для цели |
Получение пользователя по электронной почте
Пытается найти запись пользователя по электронной почте
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Поиск по электронной почте
|
SearchEmail | True | string |
Поиск по электронной почте |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
results
|
results | array of object |
results |
|
Идентификатор
|
results.id | integer |
Идентификатор пользователя |
|
Имя (Первое имя)
|
results.firstName | string |
Имя пользователя |
|
Surname
|
results.secondName | string |
Фамилия человека |
|
Известный как
|
results.knownAs | string |
Имя человека, которого нравится называть |
|
Адрес электронной почты
|
results.email | string |
Адрес электронной почты пользователя |
|
Код набора
|
results.dialingCode | string |
Код абонента для номера телефона пользователя |
|
Номер мобильного устройства
|
results.mobile | string |
Номер мобильного телефона пользователя |
|
Идентификатор основного сайта
|
results.mainSite.id | integer |
Идентификатор основного сайта, с которым связан пользователь |
|
Имя основного сайта
|
results.mainSite.name | string |
Имя, заданное главному сайту |
|
описание
|
results.mainSite.description | string |
описание |
|
руководитель
|
results.mainSite.manager | string |
руководитель |
|
Идентификатор диспетчера
|
results.manager.id | integer |
Идентификатор манджеров |
|
Имя руководителя
|
results.manager.firstName | string |
Имя руководителей |
|
Второе имя менеджеров
|
results.manager.secondName | string |
Второе имя руководителей |
|
Active
|
results.active | boolean |
Является ли человек активным в настоящее время или нет |
|
Идентификатор отдела
|
results.department.id | integer |
Идентификатор отдела, связанного с человеком |
|
Название отдела
|
results.department.name | string |
Имя, заданное отделу |
|
Тег
|
results.tag | string |
Тег, который отреагирует человека |
|
Идентификатор роли
|
results.role.id | integer |
Идентификатор роли |
|
Имя роли
|
results.role.name | string |
Имя роли |
|
Рисунок профиля
|
results.avatarURL | string |
URL-адрес изображения профиля пользователя |
|
Идентификатор состояния
|
results.status.id | integer |
Идентификатор состояния записи |
|
Название статуса
|
results.status.name | string |
Имя состояния записи |
|
Идентификатор состояния пользователя
|
results.personStatus.id | integer |
Идентификатор состояния пользователя |
|
Имя состояния пользователя
|
results.personStatus.name | string |
Имя состояния пользователя |
|
Дата начала
|
results.startDate | string |
Когда человек впервые начал работать в организации |
Создание задачи
Создает новую задачу и назначает ее пользователю
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Название
|
title | True | string |
Заголовок задачи |
|
Идентификатор приоритета
|
priorityId | integer |
Приоритет задачи. Обязательный, если не является производным от группы задач |
|
|
Description
|
description | string |
Описание задачи |
|
|
Рабочий лист
|
formId | True | integer |
Лист, используемый в задаче |
|
Срок
|
dueDate | date-time |
Дата завершения задачи |
|
|
Присвоен идентификатору
|
assignedToId | integer |
Кому назначена задача. Невозможно использовать, если передача назначена электронной почте |
|
|
Идентификатор диспетчера
|
managerId | integer |
Кто управляет задачей. Невозможно использовать, если передача электронной почты диспетчера |
|
|
Идентификатор группы задач
|
taskGroupId | True | integer |
Группа задач, которым назначена задача |
|
Назначено электронной почте
|
assignedToEmail | string |
Адрес электронной почты, которому назначена задача. Можно использовать при передаче идентификатора, назначенного идентификатору |
|
|
Электронная почта диспетчера
|
managerEmail | string |
Адрес электронной почты, который управляет задачей. Невозможно назначить, если идентификатор диспетчера передается |
|
|
Идентификатор интервала задач
|
taskIntervalId | integer |
Идентификатор интервала задачи. Обязательный, если задача рекурсивна |
|
|
Отправка push-уведомлений
|
push | boolean |
Отправляет push-уведомления о задаче |
|
|
Отправка SMS-уведомлений
|
sms | boolean |
Отправляет sms-уведомления о задаче |
|
|
Отправка уведомлений по электронной почте
|
boolean |
Отправляет уведомления по электронной почте о задаче |
||
|
Отправка уведомлений Microsoft Teams
|
teams | boolean |
Отправляет уведомления Microsoft Teams о задаче |
|
|
Отправка уведомлений в приложении
|
inApp | boolean |
Отправляет уведомления о задаче в приложении |
|
|
Разрешить нравится
|
allowLikes | boolean |
Разрешить пользователям добавлять комментарии к задаче |
|
|
Разрешить комментарии
|
allowComments | boolean |
Разрешить комментарии по задаче |
|
|
Разрешить изображения в комментариях
|
allowImagesInComments | boolean |
Все изображения, которые должны быть присоединены к комментариям |
|
|
Разрешить документы
|
allowDocuments | boolean |
Разрешить присоединению документов к комментариям |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | integer |
Идентификатор задачи |
Создание нового оповещения
Создает новое оповещение, которое можно распространить для пользователей StaffCircle с помощью нескольких каналов связи
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Название
|
title | True | string |
Заголовок оповещения |
|
Priority
|
priority | True | string |
Какой приоритет является оповещением |
|
Сводка
|
summary | string |
Основное содержимое оповещения |
|
|
Отправка всем пользователям
|
everyone | boolean |
Если это оповещение будет отправлено всем пользователям в компании |
|
|
Отправка тегов отдела
|
departmentTags | string |
Разделенный запятыми список тегов отдела, которые должны получать оповещение. Не используйте, если для отправки всем задано значение true |
|
|
Отправка тегов пользователей
|
peopleTags | string |
Разделенный запятыми список тегов людей, которые должны получать оповещение. Не используйте, если для отправки всем задано значение true |
|
|
Отправка тегов в группу
|
groupTags | string |
Разделенный запятыми список тегов групп, которые должны получать оповещение. Не используйте, если для отправки всем задано значение true |
|
|
Отправка на теги сайта
|
siteTags | string |
Разделенный запятыми список тегов сайта, которые должны получать оповещение. Не используйте, если для отправки всем задано значение true |
|
|
Отправка push-уведомлений
|
push | boolean |
Уведомление пользователей с помощью push-уведомлений |
|
|
Отправка SMS-уведомлений
|
sms | boolean |
Уведомление пользователей с помощью SMS-уведомлений |
|
|
Отправка уведомления по электронной почте
|
boolean |
Отправка уведомления оповещений по электронной почте |
||
|
Отправка в уведомлении о приложении
|
inApp | boolean |
Уведомление пользователей с помощью уведомлений о приложениях |
|
|
Отправка уведомлений Microsoft Teams
|
teams | boolean |
Уведомление пользователей с помощью уведомлений Microsoft Teams |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | integer |
Идентификатор оповещения |
Создание нового пользователя
Создание человека
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя (Первое имя)
|
firstName | True | string |
Имя пользователя |
|
Второе имя
|
secondName | True | string |
Второе имя пользователя |
|
Адрес электронной почты
|
True | string |
Рабочий адрес электронной почты пользователя |
|
|
мобильное устройство
|
mobile | True | string |
Номер мобильного телефона пользователя |
|
Дата рождения
|
dateOfBirth | True | date |
Дата рождения человека |
|
Дата начала
|
startDate | True | string |
Когда началось трудоустройство человека |
|
Адресная строка 1
|
addressLine1 | string |
Первая строка своего домашнего адреса человека |
|
|
Строка адреса 2
|
addressLine2 | string |
Вторая строка своего домашнего адреса человека |
|
|
Город
|
town | string |
Город проживания человека |
|
|
Почтовый индекс
|
postCode | string |
Почтовый код пользователя |
|
|
Имя округа
|
countyName | string |
Округ проживания человека |
|
|
Имя страны
|
countryName | string |
Страна проживания человека |
|
|
Название
|
titleName | string |
Название пользователя |
|
|
Второе имя
|
middleName | string |
По промежуточному имени пользователя |
|
|
Личная Email
|
homeEmail | string |
Личный адрес электронной почты пользователя |
|
|
Домашний телефон
|
homeTelephone | string |
Домашний номер телефона пользователя |
|
|
Тег
|
tag | string |
Тег, который можно использовать для ссылки на пользователя на платформе StaffCircle |
|
|
Электронная почта диспетчера
|
managerEmail | string |
Адрес электронной почты руководителя пользователя. Это можно использовать для связывания руководителя с человеком |
|
|
Название отдела
|
departmentName | string |
Имя отдела, к которому принадлежит человек |
|
|
Имя роли
|
roleName | string |
Роль человека. Это можно использовать для связывания роли с человеком |
|
|
Известный как
|
knownAs | string |
Имя, имя которого человек предпочитает называться |
|
|
URL-адрес рисунка профиля
|
avatarURL | string |
Изображение профиля пользователя |
|
|
Идентификатор заголовка
|
titleId | integer |
Название пользователя |
|
|
Идентификатор округа
|
countyId | integer |
Округ проживания человека |
|
|
Идентификатор страны
|
countryId | integer |
Страна проживания человека |
|
|
Идентификатор пола
|
genderId | integer |
Идентификатор пола пользователя |
|
|
Идентификатор национальности
|
nationalityId | integer |
Национальность лица |
|
|
Идентификатор этнической принадлежности
|
ethnicityId | integer |
Этническое происхождение человека |
|
|
Идентификатор состояния супругов
|
maritalStatusId | integer |
Семейное состояние человека |
|
|
Идентификатор диспетчера
|
managerId | integer |
Идентификатор руководителя пользователя (можно ввести только идентификатор диспетчера или адрес электронной почты диспетчера) |
|
|
Идентификатор отдела
|
departmentId | integer |
Идентификатор отдела пользователя (можно ввести только идентификатор отдела или имя отдела). |
|
|
Идентификатор роли
|
roleId | integer |
Идентификатор роли трудоустройства пользователя (можно ввести только идентификатор роли или имя роли). |
|
|
Идентификатор сайта
|
mainSiteId | integer |
Идентификатор сайта, к которому принадлежит пользователь |
|
|
Согласие для экстренного контакта
|
emergencyContactConsent | boolean |
Имеет ли контакт экстренного реагирования согласие на сохранение своих сведений |
|
|
Имя контакта в чрезвычайных ситуациях
|
emergencyContactName | string |
Имя экстренного контакта пользователя |
|
|
Идентификатор связи экстренного контакта
|
emergencyRelationshipId | integer |
Связь между экстренным контактом и человеком |
|
|
Телефон для экстренного реагирования
|
emergencyContactTelephone | string |
Номер телефона экстренного контакта человека |
|
|
Адрес экстренного реагирования
|
emergencyAddress | string |
Адрес экстренного реагирования лиц |
|
|
Следующее имя kin
|
nextOfKinName | string |
Имя следующего родственника человека |
|
|
Следующий идентификатор связи Kin
|
nextOfKinRelationshipId | integer |
Отношения между ближайшим родственником и человеком |
|
|
Следующий из kin телефон
|
nextOfKinTelephone | string |
Рядом с телефонным номером человека |
|
|
Код набора
|
dialingCode | string |
Международный телефонный код для номера телефона пользователя |
|
|
Расширение рабочей работы
|
workExtension | string |
Номер расширения работы пользователя |
|
|
Рабочий телефон
|
telephone | string |
Рабочий номер телефона пользователя |
|
|
Личное мобильное устройство
|
personalMobile | string |
Личный номер мобильного телефона пользователя |
|
|
Идентификатор состояния
|
statusId | integer |
Состояние учетной записи StaffCircle пользователя |
|
|
Идентификатор типа занятости
|
employmentTypeId | integer |
Тип занятости человека |
|
|
Идентификатор типа контракта
|
contractTypeId | integer |
Контракт человека |
|
|
Срок действия контракта
|
contractExpiry | date |
Дата истечения срока действия контракта на работу людей |
|
|
Состояние занятости
|
employmentStatusId | integer |
Статус занятости человека |
|
|
Состояние вторичной занятости
|
secondaryEmploymentStatusId | integer |
Состояние связанного дополнительного трудоустройства |
|
|
Заметки о занятости
|
employmentNotes | string |
Заметки о занятости, касающиеся лица |
|
|
Медицинские заметки
|
medicalNotes | string |
Любые важные медицинские заметки, связанные с человеком |
|
|
Включена личная обработка данных
|
isPersonalDataEnabled | boolean |
Включена ли личная обработка данных |
|
|
Включена ли контактная информация
|
isContactDataEnabled | boolean |
Включена ли контактная информация |
|
|
Часовой пояс
|
timeZone | string |
Часовой пояс, в который живет человек |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор пользователя
|
id | integer |
Идентификатор пользователя |
Создание новой статьи
Создает новую статью, которую можно распространить для пользователей StaffCircle с помощью нескольких каналов связи
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Название
|
title | True | string |
Название статьи. Максимальная длина 250 символов |
|
Priority
|
priority | True | string |
Что такое приоритет статьи |
|
Тип статьи
|
articleType | True | string |
Тип создаваемой статьи |
|
HTML-содержимое
|
htmlContent | True | string |
Основное HTML-содержимое статьи. |
|
URL-адрес изображения статьи
|
mainImageUrl | string |
URL-адрес изображения, который будет использоваться в качестве основного образа статьи в веб-канале. |
|
|
Сводка
|
summary | string |
Сводка статьи. По умолчанию первые 500 символов html-содержимого, если они не указаны. |
|
|
Тег
|
tag | True | string |
Тег, связанный со статьей. Максимальное число символов 250 |
|
Идентификатор канала
|
channelId | integer |
В каком канале будет опубликована статья. Если осталось пустым, то для веб-канала по умолчанию будет задано значение |
|
|
Отправка push-уведомлений
|
push | boolean |
Уведомлять пользователей о статье push-уведомлениями |
|
|
Отправка SMS-уведомлений
|
sms | boolean |
Уведомлять пользователей о статье с помощью SMS-уведомлений |
|
|
Отправка уведомлений по электронной почте
|
boolean |
Уведомлять пользователей о статье уведомлениями по электронной почте |
||
|
Отправка уведомлений в приложении
|
inApp | boolean |
Уведомление пользователей о статье в уведомлениях приложений |
|
|
Отправка уведомлений Teams
|
teams | boolean |
Уведомление пользователей о статье уведомлениями Microsoft Teams |
|
|
Разрешить нравится
|
allowLikes | boolean |
Могут ли пользователи, например, статью. Значение true по умолчанию |
|
|
Разрешить комментарии
|
allowComments | boolean |
Пользователи могут комментировать статью. Значение true по умолчанию. |
|
|
Разрешить изображения в комментариях
|
allowImagesInComments | boolean |
Разрешено ли изображения в комментариях |
|
|
Закрепление из даты
|
pinFromDate | date-time |
Если статья должна быть закреплена. Если дадим дату. Обязательный, если задано время длительности пин-кода |
|
|
Закрепление часов длительности
|
pinDurationHours | integer |
Сколько часов после даты пин-кода должна оставаться закрепленной в статье. Требуется, если указан пин-код из даты. |
|
|
Время запланированной даты публикации
|
scheduledDateTime | string |
Если эта статья будет запланирована на публикацию в будущем. |
|
|
Немедленное публикация
|
publishImmediately | boolean |
Если эта статья будет опубликована сразу же |
|
|
Публикация идентификатора пользователя
|
publishAsUserId | integer |
Если пользователь не вызывает API, от имени которого он должен быть выполнен. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | integer |
Идентификатор созданной статьи |
Создание новой цели
Создает новую цель
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Компетенция
|
categoryId | True | integer |
Связанная целевая компетенция |
|
Название
|
title | True | string |
Имя новой цели. |
|
Description
|
description | True | string |
Описание новой цели. |
|
Дата начала
|
startDate | True | date-time |
От момента измерения цели |
|
Дата окончания
|
endDate | True | date-time |
Крайний срок для цели |
|
Тип значения
|
valueType | True | string |
Определяет, как измеряется цель |
|
Тег
|
tag | string |
Текстовый тег для использования в поисках и отчетах. |
|
|
Электронная почта диспетчера
|
managerEmail | string |
Электронная почта руководителя, ответственного за отслеживание цели. Автоматически по умолчанию используется менеджер "Лица" или "Отделы". Требуется, если у человека или отдела нет руководителя или цели является цель компании. Используется, если идентификатор диспетчера не указан |
|
|
Идентификатор диспетчера
|
managerId | integer |
Менеджер отвечает за отслеживание цели. Автоматически по умолчанию используется менеджер "Лица" или "Отделы". Требуется, если у человека или отдела нет руководителя или цели является цель компании. Используется, если адрес электронной почты диспетчера не указан |
|
|
Электронная почта пользователя
|
personEmail | string |
Адрес электронной почты человека, для которого предназначена цель. Требуется для создания личной цели. Если отдел или лицо не предоставлено, то предполагается, что цель является целью компании |
|
|
Идентификатор пользователя
|
personId | integer |
Идентификатор человека, для которого является цель. Требуется для создания личной цели. Если отдел или лицо не предоставлено, то предполагается, что цель является целью компании |
|
|
Название отдела
|
departmentName | string |
Имя отдела, для которого предназначена цель. Требуется для создания цели отдела. Если отдел или лицо не предоставлено, то предполагается, что цель является целью компании |
|
|
Идентификатор отдела
|
departmentId | integer |
Идентификатор отдела, для которого цель. Требуется для создания цели отдела. Если отдел или лицо не предоставлено, то предполагается, что цель является целью компании |
|
|
Идентификатор цели компании
|
companyObjectiveId | integer |
Необязательная ссылка на цель компании, к которую относится только что созданная цель |
|
|
Идентификатор цели отдела
|
departmentObjectiveId | integer |
Необязательная ссылка на цель отдела, к которому относится только что созданная цель |
|
|
Начальное значение
|
startValue | double |
Определяет, как измеряется цель |
|
|
Цель
|
target | double |
Целевое значение, которое необходимо достичь для успешного завершения цели |
|
|
Разрешить добавление хода выполнения
|
allowAddProgress | boolean |
Если значение true позволяет пользователю добавлять ход выполнения самостоятельно, в противном случае только указанный менеджер может обновить цель. По умолчанию: false. |
|
|
Тип рекурса
|
recurType | string |
Если задано, цель повторяется. Определяет единицу времени повторения. |
|
|
Интервал рекурса
|
recurInterval | integer |
Сколько дней/недель/месяцев/лет будет рекурсом цели. Требуется, если цель рекурсивна. |
|
|
Совокупный прогресс
|
cumulativeProgress | boolean |
Указывает, добавляется ли при добавлении хода выполнения внешнего интерфейса StaffCircle в качестве добавочного значения. |
|
|
Отправка push-уведомления
|
push | boolean |
Отправляет push-уведомления. |
|
|
Отправка SMS-уведомлений
|
sms | boolean |
Отправка SMS-уведомлений |
|
|
Отправка уведомления по электронной почте
|
boolean |
Отправляет обновления электронной почты |
||
|
Отправка уведомлений Teams
|
teams | boolean |
Отправляет обновления через Microsoft Teams, если интеграция команд включена |
|
|
Отправка в уведомлении о приложении
|
inApp | boolean |
Отправляет уведомления InApp |
|
|
Разрешает нравится
|
allowLikes | boolean |
Разрешить пользователям нравится комментарии по целевой цели |
|
|
Разрешить комментарии
|
allowComments | boolean |
Разрешить комментарии по цели |
|
|
Разрешить изображения в комментариях
|
allowImagesInComments | boolean |
Все изображения, которые должны быть присоединены к комментариям. |
|
|
Разрешить документы
|
allowDocuments | boolean |
Разрешить присоединению документов к комментариям |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор цели
|
id | integer |
Идентификатор цели |
Создание новой цели по шаблону
Создает новую цель с помощью шаблона цели
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Целевой шаблон
|
objectiveTemplateId | True | integer |
Создает новую цель из шаблона цели |
|
Дата начала
|
startDate | True | date-time |
От момента измерения цели |
|
Дата окончания
|
endDate | True | date-time |
Крайний срок для цели |
|
Электронная почта пользователя
|
personEmail | string |
Адрес электронной почты человека, для которого предназначена цель. Требуется для создания личной цели. Если отдел или лицо не предоставлено, то предполагается, что цель является целью компании |
|
|
Идентификатор пользователя
|
personId | integer |
Идентификатор человека, для которого является цель. Требуется для создания личной цели. Если отдел или лицо не предоставлено, то предполагается, что цель является целью компании |
|
|
Название отдела
|
departmentName | string |
Имя отдела, для которого предназначена цель. Требуется для создания цели отдела. Если отдел или лицо не предоставлено, то предполагается, что цель является целью компании |
|
|
Идентификатор отдела
|
departmentId | integer |
Идентификатор отдела, для которого цель. Требуется для создания цели отдела. Если отдел или лицо не предоставлено, то предполагается, что цель является целью компании |
|
|
Электронная почта диспетчера
|
managerEmail | string |
Электронная почта руководителя, ответственного за отслеживание цели. Автоматически по умолчанию используется менеджер "Лица" или "Отделы". Требуется, если у человека или отдела нет руководителя или цели является цель компании. Используется, если идентификатор диспетчера не указан |
|
|
Название
|
title | string |
Переопределяет имя новой цели. |
|
|
Description
|
description | string |
Переопределяет описание новой цели. |
|
|
Идентификатор диспетчера
|
managerId | integer |
Менеджер отвечает за отслеживание цели. Автоматически по умолчанию используется менеджер "Лица" или "Отделы". Требуется, если у человека или отдела нет руководителя или цели является цель компании. Используется, если адрес электронной почты диспетчера не указан |
|
|
Идентификатор цели компании
|
companyObjectiveId | integer |
Необязательная ссылка на цель компании, к которую относится только что созданная цель |
|
|
Идентификатор цели отдела
|
departmentObjectiveId | integer |
Необязательная ссылка на цель отдела, к которому относится только что созданная цель |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор цели
|
id | integer |
Идентификатор созданной цели |
Триггеры
| При добавлении нового отсутствия |
Триггеры при добавлении нового отсутствия |
| При добавлении нового пользователя |
Триггеры при добавлении нового пользователя |
| При добавлении новой задачи |
Триггеры при добавлении новой задачи |
| При добавлении новой проверки |
Триггеры при добавлении новой проверки |
| При добавлении новой цели |
Триггеры при добавлении новой цели |
| При обновлении цели |
Триггеры при обновлении цели |
| При публикации новой статьи |
Триггер при публикации новой статьи |
При добавлении нового отсутствия
Триггеры при добавлении нового отсутствия
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя
|
name | True | string |
Имя, заданное веб-перехватчику |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
URL-адрес записи
|
subjectFrontEndUrl | string |
URL-адрес записи в StaffCircle |
|
Идентификатор
|
data.id | integer |
Идентификатор отсутствия |
|
Идентификатор пользователя
|
data.requestedForPerson.PersonId | integer |
Идентификатор лица, для которого запрашивается отсутствие |
|
Имя пользователя
|
data.requestedForPerson.FirstName | string |
Имя лица, для которого запрашивается отсутствие |
|
Имя семьи человека
|
data.requestedForPerson.FamilyName | string |
Имя семьи лица, для которого запрашивается отсутствие |
|
Электронная почта пользователя
|
data.requestedForPerson.Email | string |
Адрес электронной почты лица, для которого запрашивается отсутствие |
|
Тип единицы
|
data.unitType | string |
Тип единицы запроса на отсутствие (часы, дни) |
|
Количество часов
|
data.numberOfHours | double |
Количество часов, отключаемых |
|
Частичный день
|
data.partialDay | string |
Запрашивается ли частичный день (утро, днем) |
|
Дата начала
|
data.start | date-time |
При запуске отсутствия |
|
Дата окончания
|
data.end | date-time |
Когда отсутствие заканчивается |
|
Идентификатор типа
|
data.typeId | integer |
Идентификатор запрашиваемого типа отсутствия |
|
Тип
|
data.type | string |
Тип запрашиваемого отсутствия |
|
Идентификатор подтипа
|
data.subTypeId | integer |
Идентификатор запрашиваемого подтипа отсутствия |
|
ИД политики
|
data.policyId | integer |
Идентификатор политики отсутствия, в которую входит сотрудник |
|
Причина
|
data.reason | string |
Причина отсутствия запроса |
|
Создано
|
data.createdAt | date-time |
Когда запрос на отсутствие был сделан |
|
Создан по идентификатору
|
data.createdByPerson.PersonId | integer |
Идентификатор пользователя, создавшего запрос на отсутствие |
|
Создано по имени
|
data.createdByPerson.FirstName | string |
Первое имя пользователя, создавшего запрос на отсутствие |
|
Создано с помощью имени семейства
|
data.createdByPerson.FamilyName | string |
Имя семьи лица, создавшего запрос на отсутствие |
|
Создано по электронной почте
|
data.createdByPerson.Email | string |
Адрес электронной почты пользователя, создавшего запрос на отсутствие |
|
Статус утверждения
|
data.approvalDetails.status | string |
Состояние утверждения (ожидание, утверждение, отклонено) |
|
Утверждено
|
data.approvalDetails.approvedAt | date-time |
Когда отсутствие было утверждено |
|
Ответ на утверждение
|
data.approvalDetails.response | string |
Ответ, предоставленный утверждающего |
|
Утвержден по идентификатору
|
data.approvalDetails.approvedByPerson.PersonId | integer |
Идентификатор лица, утверждающего отсутствие |
|
Утверждено по имени
|
data.approvalDetails.approvedByPerson.FirstName | string |
Имя лица, утверждающего отсутствие |
|
Утверждено семейным именем
|
data.approvalDetails.approvedByPerson.FamilyName | string |
Имя лица, утверждающего отсутствие |
|
Утверждено по электронной почте
|
data.approvalDetails.approvedByPerson.Email | string |
Адрес электронной почты лица, утверждающего отсутствие |
|
Идентификатор диспетчера
|
data.manager.PersonId | integer |
Идентификатор руководителя, участвующий в запросе на отсутствие |
|
Имя руководителя
|
data.manager.FirstName | string |
Первое имя руководителя, связанного с запросом на отсутствие |
|
Имя семейства диспетчера
|
data.manager.FamilyName | string |
Имя семьи руководителя, связанного с запросом на отсутствие |
|
Электронная почта диспетчера
|
data.manager.Email | string |
Адрес электронной почты руководителя, участвующий в запросе на отсутствие |
При добавлении нового пользователя
Триггеры при добавлении нового пользователя
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя
|
name | True | string |
Имя, заданное веб-перехватчику |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
URL-адрес записи
|
subjectFrontEndUrl | string |
URL-адрес записи в StaffCircle |
|
Идентификатор пользователя
|
data.id | integer |
Идентификатор, представляющий пользователя |
|
Имя (Первое имя)
|
data.givenName | string |
Имя пользователя |
|
Второе имя
|
data.middleName | string |
По промежуточному имени пользователя |
|
Фамилия
|
data.familyName | string |
Имя семьи человека |
|
известный как
|
data.knownAs | string |
Имя человека, которого нравится называть |
|
Дата рождения
|
data.dateOfBirth | date |
Дата рождения человека |
|
Личная Email
|
data.contactDetails.personalEmail | string |
Личный адрес электронной почты пользователя |
|
Рабочий адрес электронной почты
|
data.contactDetails.workEmail | string |
Рабочий адрес электронной почты пользователя |
|
Work Mobile
|
data.contactDetails.workMobile | string |
Рабочий номер мобильного телефона пользователя |
|
Личное мобильное устройство
|
data.contactDetails.personalMobile | string |
Личный номер мобильного телефона пользователя |
|
Домашний телефон
|
data.contactDetails.homeTelephone | string |
Домашний номер телефона человека |
|
Рабочий телефон
|
data.contactDetails.workTelephone | string |
Рабочий номер телефона пользователя |
|
Рабочий телефон
|
data.contactDetails.workExtension | string |
Номер расширения работы пользователя |
|
Адресная строка 1
|
data.address.addressLine1 | string |
Первая строка своего домашнего адреса человека |
|
Строка адреса 2
|
data.address.addressLine2 | string |
Первая строка своего домашнего адреса человека |
|
Город
|
data.address.town | string |
Город проживания человека |
|
Почтовый индекс
|
data.address.postCode | string |
Почтовый код пользователя |
|
Имя контакта в чрезвычайных ситуациях
|
data.emergencyContact.emergencyContactName | string |
Имя экстренного контакта пользователя |
|
Телефон для экстренного реагирования
|
data.emergencyContact.emergencyContactTelephone | string |
Номер телефона экстренного контакта человека |
|
Идентификатор связи экстренного контакта
|
data.emergencyContact.emergencyRelationshipId | integer |
Связь между экстренным контактом и человеком |
|
Согласие для экстренного контакта
|
data.emergencyContact.emergencyContactConsent | boolean |
Имеет ли контакт экстренного реагирования согласие на сохранение своих сведений |
|
Адрес экстренного контакта
|
data.emergencyContact.emergencyAddress | string |
Адрес экстренного контакта с лицами |
|
Медицинские заметки
|
data.emergencyContact.emergencyMedicalNotes | string |
Любые важные медицинские заметки, связанные с человеком |
|
Следующее имя Kin
|
data.nextOfKin.Name | string |
Ближайший родственник человека |
|
Рядом с Kin Телефон
|
data.nextOfKin.Telephone | string |
Рядом с телефонным номером человека |
|
Следующий идентификатор связи Kin
|
data.nextOfKin.RelationshipId | string |
Отношения между ближайшим родственником и человеком |
|
Заметки о занятости
|
data.employeeDetails.employmentNotes | string |
Заметки о занятости, касающиеся лица |
|
Тег
|
data.employeeDetails.tag | string |
Тег, который можно использовать для ссылки на пользователя на платформе StaffCircle |
|
Дата начала
|
data.employeeDetails.startDate | string |
Когда началось трудоустройство человека |
|
Идентификатор сайта
|
data.employeeDetails.siteId | integer |
Идентификатор сайта, к которому принадлежит пользователь |
|
Идентификатор группы
|
data.employeeDetails.groupId | integer |
Группа, к которой принадлежит пользователь |
|
Идентификатор отдела
|
data.employeeDetails.departmentId | integer |
Отдел, которому принадлежит человек |
|
Идентификатор диспетчера
|
data.employeeDetails.manager.PersonId | integer |
Идентификатор руководителя парсона |
|
Имя руководителя
|
data.employeeDetails.manager.FirstName | string |
Имя руководителя пользователя |
|
Имя семьи руководителя
|
data.employeeDetails.manager.FamilyName | string |
Имя семьи руководителя человека |
|
Электронная почта диспетчера
|
data.employeeDetails.manager.Email | string |
Адрес электронной почты руководителя пользователя |
|
Состояние учетной записи
|
data.accountStatus | integer |
Состояние учетной записи StaffCircle пользователя |
При добавлении новой задачи
Триггеры при добавлении новой задачи
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя
|
name | True | string |
Имя, заданное веб-перехватчику |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
URL-адрес записи
|
subjectFrontEndUrl | string |
URL-адрес записи в StaffCircle |
|
Идентификатор
|
data.id | integer |
Идентификатор задачи |
|
Название
|
data.title | string |
Заголовок задачи |
|
Description
|
data.description | string |
Описание задачи |
|
Priority
|
data.priority | string |
Приоритет задачи |
|
Идентификатор группы задач
|
data.groupId | integer |
Идентификатор группы задач |
|
Название группы задач
|
data.groupTitle | string |
Название группы задач |
|
Айдок
|
data.isAdhoc | boolean |
Является ли это задачей аадхок |
|
Создан идентификатором пользователя
|
data.createdByPerson.PersonId | integer |
Идентификатор пользователя, создавшего задачу |
|
Создано по имени
|
data.createdByPerson.FirstName | string |
Имя пользователя, создавшего задачу |
|
Создано с помощью имени семейства
|
data.createdByPerson.FamilyName | string |
Имя семьи пользователя, создавшего задачу |
|
Создано по электронной почте
|
data.createdByPerson.Email | string |
Сообщение электронной почты пользователя, создавшего задачу |
|
Идентификатор пользователя
|
data.person.PersonId | integer |
Идентификатор пользователя, для которого выполняется задача |
|
Имя пользователя
|
data.person.FirstName | string |
Первое имя пользователя, для которого выполняется задача |
|
Имя семьи человека
|
data.person.FamilyName | string |
Имя семьи человека, для которого выполняется задача |
|
Электронная почта пользователя
|
data.person.Email | string |
Электронная почта пользователя, для которого выполняется задача |
|
Идентификатор диспетчера
|
data.manager.PersonId | integer |
Идентификатор руководителя задачи |
|
Имя руководителя
|
data.manager.FirstName | string |
Имя руководителя задачи |
|
Имя семейства диспетчера
|
data.manager.FamilyName | string |
Имя семейства руководителя задачи |
|
Электронная почта диспетчера
|
data.manager.Email | string |
Электронная почта руководителя задачи |
|
Срок
|
data.dueDate | date |
Когда задача должна быть вызвана |
|
Создано
|
data.createdOn | date-time |
При создании задачи |
|
Идентификатор формы
|
data.form.id | integer |
Идентификатор формы, используемой для заполнения задачи |
|
Название формы
|
data.form.title | string |
Заголовок формы, используемой для заполнения задачи |
|
Push-уведомления
|
data.notificationSettings.push | boolean |
Будет ли отправляться push-уведомления для задачи |
|
SMS-уведомления
|
data.notificationSettings.sms | boolean |
Будет ли отправляться sms-уведомления для задачи |
|
Уведомления по электронной почте
|
data.notificationSettings.email | boolean |
Будет ли отправлено уведомление по электронной почте для задачи |
|
Уведомления Microsoft Teams
|
data.notificationSettings.microsoftTeams | boolean |
Будут ли отправляться уведомления в Microsoft Teams для задачи |
|
В уведомлениях приложений
|
data.notificationSettings.inApp | boolean |
Будет ли отправлено уведомление о том, будут ли отправляться уведомления приложения для задачи |
|
Разрешить нравится
|
data.contentSettings.allowLikes | boolean |
Разрешает ли задача нравится |
|
Разрешить комментарии
|
data.contentSettings.allowComments | boolean |
Разрешает ли задача примечания |
|
Разрешить изображения в комментариях
|
data.contentSettings.allowImagesInComments | boolean |
Разрешает ли задача изображения в комментариях |
|
Разрешить документы
|
data.contentSettings.allowDocuments | boolean |
Разрешает ли задача документы |
При добавлении новой проверки
Триггеры при добавлении новой проверки
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя
|
name | True | string |
Имя, заданное веб-перехватчику |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
URL-адрес записи
|
subjectFrontEndUrl | string |
URL-адрес записи в StaffCircle |
|
Идентификатор
|
data.id | integer |
Идентификатор проверки |
|
Предыдущий идентификатор проверки
|
data.previousReviewId | integer |
Идентификатор предыдущей проверки для этого проверяющего |
|
Идентификатор диспетчера
|
data.manager.PersonId | integer |
Идентификатор руководителя, связанного с проверкой |
|
Имя руководителя
|
data.manager.FirstName | string |
Имя руководителя, связанного с проверкой |
|
Имя семейства диспетчера
|
data.manager.FamilyName | string |
Имя семьи руководителя, связанного с обзором |
|
Электронная почта диспетчера
|
data.manager.Email | string |
Адрес электронной почты руководителя, связанного с проверкой |
|
internalReviewerPersonIds
|
data.internalReviewerPersonIds | array of integer |
internalReviewerPersonIds |
|
Идентификатор проверяемого пользователя
|
data.person.PersonId | integer |
Идентификатор проверяющего участника |
|
Имя проверяемого пользователя
|
data.person.FirstName | string |
Первое имя проверяющего участника |
|
Имя семейства reviewee
|
data.person.FamilyName | string |
Имя семьи проверяющего |
|
Рецензирование электронной почты
|
data.person.Email | string |
Адрес электронной почты проверяющего |
|
Название
|
data.title | string |
Заголовок, предоставленный обзору |
|
Description
|
data.description | string |
Описание, указанное в обзоре |
|
Тип проверки
|
data.reviewType | string |
Тип проверки |
|
Из-за
|
data.dueOn | date-time |
Когда проверка должна быть вызвана |
|
attachedDocumentIds
|
data.attachedDocumentIds | array of integer |
attachedDocumentIds |
|
linkedObjectives
|
data.linkedObjectives | array of integer |
linkedObjectives |
|
Идентификатор шаблона оценки
|
data.appraisalSummary.personAppraisalTemplateId | integer |
Шаблон оценки, используемый для создания оценки |
|
Текущая оценка
|
data.scores.currentScore | double |
Текущая оценка отзывов |
|
Создано
|
data.createdAt | date-time |
После создания проверки |
|
Создан по идентификатору
|
data.createdByPerson.PersonId | integer |
Идентификатор пользователя, создавшего проверку |
|
Создано по имени
|
data.createdByPerson.FirstName | string |
Имя пользователя, создавшего проверку |
|
Создано с помощью имени семейства
|
data.createdByPerson.FamilyName | string |
Имя семьи лица, создавшего проверку |
|
Создано по электронной почте
|
data.createdByPerson.Email | string |
Адрес электронной почты пользователя, создавшего проверку |
|
Разрешить нравится
|
data.contentSettings.allowLikes | boolean |
Разрешено ли нравится |
|
Разрешить комментарии
|
data.contentSettings.allowComments | boolean |
Разрешено ли примечания к обзору |
|
Разрешить изображения в комментариях
|
data.contentSettings.allowImagesInComments | boolean |
Разрешено ли изображения в комментариях |
|
Разрешить документы
|
data.contentSettings.allowDocuments | boolean |
Может ли документы быть присоединены к проверке |
|
Push-уведомления
|
data.notificationSettings.push | boolean |
Отправка push-уведомлений |
|
SMS-уведомления
|
data.notificationSettings.sms | boolean |
Отправка sms-уведомлений |
|
Уведомление по электронной почте
|
data.notificationSettings.email | boolean |
Отправка уведомлений по электронной почте |
|
Уведомления Microsoft Teams
|
data.notificationSettings.microsoftTeams | boolean |
Отправка уведомлений Microsoft Teams |
|
В уведомлениях приложений
|
data.notificationSettings.inApp | boolean |
Отправка уведомлений о приложении |
При добавлении новой цели
Триггеры при добавлении новой цели
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя
|
name | True | string |
Имя, заданное веб-перехватчику |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
URL-адрес записи
|
subjectFrontEndUrl | string |
URL-адрес записи в StaffCircle |
|
Идентификатор цели
|
data.id | integer |
Идентификатор цели |
|
Целевой шаблон
|
data.templateId | integer |
Создает новую цель из шаблона цели |
|
Идентификатор диспетчера
|
data.manager.PersonId | integer |
Идентификатор руководителя пользователя |
|
Имя руководителя
|
data.manager.FirstName | string |
Имя руководителя пользователя |
|
Имя семейства диспетчера
|
data.manager.FamilyName | string |
Имя семьи руководителя человека |
|
Электронная почта диспетчера
|
data.manager.Email | string |
Адрес электронной почты руководителя пользователя |
|
Идентификатор пользователя
|
data.person.PersonId | integer |
Идентификатор человека, связанный с целью |
|
Имя пользователя
|
data.person.FirstName | string |
Имя человека, связанное с целью |
|
Имя семьи человека
|
data.person.FamilyName | string |
Имя семьи человека, связанное с целью |
|
Электронная почта пользователя
|
data.person.Email | string |
Адрес электронной почты пользователя, связанный с целью |
|
Название
|
data.title | string |
Имя новой цели |
|
Description
|
data.description | string |
Описание новой цели |
|
Тип значения
|
data.valueType | string |
Определяет, как измеряется цель |
|
Тег
|
data.tag | string |
Текстовый тег для использования в поисках и отчетах |
|
Категория
|
data.category | string |
Идентификатор категории целей |
|
Дата начала
|
data.startDate | date-time |
От момента измерения цели |
|
Дата окончания
|
data.endDate | string |
Крайний срок для цели |
|
Дата последнего хода выполнения
|
data.lastProgressDate | date-time |
Дата достижения цели |
|
закрытый
|
data.closed | boolean |
закрытый |
|
Разрешить добавление хода выполнения
|
data.allowAddProgress | boolean |
Если значение true позволяет пользователю добавлять ход выполнения самостоятельно, в противном случае только указанный менеджер может обновить цель. |
|
Push-уведомление
|
data.notificationSettings.push | boolean |
Отправляет push-уведомления. |
|
SMS-уведомление
|
data.notificationSettings.sms | boolean |
Отправка SMS-уведомлений |
|
Уведомление по электронной почте
|
data.notificationSettings.email | boolean |
Отправляет обновления электронной почты |
|
Уведомление Teams
|
data.notificationSettings.microsoftTeams | boolean |
Отправляет обновления через Microsoft Teams, если интеграция команд включена |
|
В уведомлении приложения
|
data.notificationSettings.inApp | boolean |
Отправляет уведомления InApp |
|
Разрешает нравится
|
data.contentSettings.allowLikes | boolean |
Разрешить пользователям нравится комментарии по целевой цели |
|
Разрешить комментарии
|
data.contentSettings.allowComments | boolean |
Разрешить комментарии по цели |
|
Разрешить изображения в комментариях
|
data.contentSettings.allowImagesInComments | boolean |
Все изображения, которые должны быть присоединены к комментариям. |
|
Разрешить документы
|
data.contentSettings.allowDocuments | boolean |
Разрешить присоединению документов к комментариям |
|
Создано в
|
data.createdAt | date-time |
Когда цель создана |
|
Создан идентификатором пользователя
|
data.createdByPerson.PersonId | integer |
Идентификатор пользователя, создавшего цель |
|
Создание имени пользователя
|
data.createdByPerson.FirstName | string |
Первое имя пользователя, создавшего цель |
|
Создано именем семьи пользователя
|
data.createdByPerson.FamilyName | string |
Имя семьи человека, создавшего цель |
|
Создано по электронной почте пользователя
|
data.createdByPerson.Email | string |
Адрес электронной почты пользователя, создавшего цель |
|
Текущий ход выполнения
|
data.currentProgress | double |
Текущий прогресс по цели |
|
Начальное значение
|
data.startValue | double |
Определяет, как измеряется цель |
|
Цель
|
data.targetValue | double |
Целевое значение, которое необходимо достичь для успешного завершения цели |
При обновлении цели
Триггеры при обновлении цели
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя
|
name | True | string |
Имя, заданное веб-перехватчику |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
URL-адрес записи
|
subjectFrontEndUrl | string |
URL-адрес записи в StaffCircle |
|
Идентификатор
|
data.id | integer |
Идентификатор целевой записи хода выполнения |
|
Идентификатор цели
|
data.objectiveId | integer |
Цель, с которую связана эта запись хода выполнения |
|
Ценность
|
data.value | double |
Общее значение хода выполнения объекта |
|
Description
|
data.description | string |
Описание, добавленное в целевую запись хода выполнения |
|
Создано
|
data.createdAt | date-time |
При создании записи хода выполнения |
|
Создан идентификатором пользователя
|
data.createdByPerson.PersonId | integer |
Идентификатор пользователя, создавшего целевую запись хода выполнения |
|
Создано по имени
|
data.createdByPerson.FirstName | string |
Первое имя пользователя, создавшего целевую запись хода выполнения |
|
Создано с помощью имени семейства
|
data.createdByPerson.FamilyName | string |
Имя семьи человека, создавшего целевую запись хода выполнения |
|
Создано по электронной почте
|
data.createdByPerson.Email | string |
Адрес электронной почты пользователя, создавшего целевую запись хода выполнения |
|
Отправка уведомлений
|
data.sendNotifications | boolean |
Указывает, отправляются ли уведомления |
При публикации новой статьи
Триггер при публикации новой статьи
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
имя
|
name | string |
имя |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
URL-адрес статьи
|
subjectFrontEndUrl | string |
URL-адрес статьи |
|
Идентификатор
|
data.Id | integer |
Идентификатор статьи |
|
Название
|
data.Title | string |
Название, заданное статье |
|
Сводка
|
data.Summary | string |
Сводка статьи |
|
Тег
|
data.Tag | string |
Тег, связанный с статьей |
|
Имя приоритета
|
data.PriorityName | string |
Приоритет статьи |
|
Создано
|
data.CreatedAt | date-time |
Дата создания статьи |
|
Все
|
data.AudienceDto.Everyone | boolean |
Будет ли опубликована статья всем |
|
Лиц
|
data.AudienceDto.Persons | array of object | |
|
Тег пользователя
|
data.AudienceDto.Persons.Tag | string |
Тег целевого пользователя |
|
Идентификатор
|
data.AudienceDto.Persons.Id | integer |
Идентификатор тега |
|
Sites
|
data.AudienceDto.Sites | array of object | |
|
Тег сайта
|
data.AudienceDto.Sites.Tag | string |
Тег целевого сайта |
|
Идентификатор
|
data.AudienceDto.Sites.Id | integer |
Идентификатор тега |
|
Departments
|
data.AudienceDto.Departments | array of object | |
|
Тег отдела
|
data.AudienceDto.Departments.Tag | string |
Тег целевого отдела |
|
Идентификатор
|
data.AudienceDto.Departments.Id | integer |
Идентификатор тега |
|
Создан по идентификатору
|
data.CreatedByPerson.PersonId | integer |
Идентификатор пользователя, создавшего статью |
|
Создано по имени
|
data.CreatedByPerson.FirstName | string |
Имя пользователя, создавшего статью |
|
Создано с помощью имени семейства
|
data.CreatedByPerson.FamilyName | string |
Имя семьи человека, создавшего статью |
|
Создано по электронной почте
|
data.CreatedByPerson.Email | string |
Адрес электронной почты пользователя, создавшего статью |
|
Изменено
|
data.ModifiedAt | date-time |
После последнего изменения статьи |
|
Изменен по идентификатору
|
data.ModifiedByPerson.PersonId | integer |
Идентификатор пользователя, который последний раз изменил статью |
|
Изменено по имени
|
data.ModifiedByPerson.FirstName | string |
Имя человека, который последний раз изменил статью |
|
Изменено по имени семейства
|
data.ModifiedByPerson.FamilyName | string |
Имя семьи человека, который последний раз изменил статью |
|
Изменено по электронной почте
|
data.ModifiedByPerson.Email | string |
Адрес электронной почты пользователя, который последний раз изменил статью |
|
Дата публикации
|
data.PublishedDate | date-time |
Когда статья была опубликована |
|
Содержимое статьи
|
data.ArticleContent | string |
HTML-содержимое статьи |
|
Текст содержимого статьи
|
data.ArticleContentText | string |
Содержимое статьи обычного текста |
|
Идентификатор основного изображения
|
data.MainImageId | integer |
Идентификатор изображения, который будет использоваться в качестве основного образа статьи в веб-канале. |