Динамический сигнал (предварительная версия)
Dynamic Signal — это платформа взаимодействия сотрудников и взаимодействия, доверенные организациями для подключения, выравнивания и привлечения сотрудников. Подключитесь к Dynamic Signal для создания записей и пользователей и управления ими.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | 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) |
| Метаданные соединителя | |
|---|---|
| Publisher | Динамический сигнал |
Создание подключения
Соединитель поддерживает следующие типы проверки подлинности:
| По умолчанию | Параметры для создания подключения. | Все регионы | Недоступен для совместного использования |
По умолчанию
Применимо: все регионы
Параметры для создания подключения.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| Маркер носителя | securestring | Маркер носителя для этого API | True |
| URL-адрес динамического сигнала | струна | URL-адрес, в котором вы обращаетесь к Dynamic Signal. | True |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Добавление изображения в запись по URL-адресу |
Задает изображение записи по URL-адресу. |
| Добавление изображения в запись с помощью отправки |
Задает изображение записи с помощью двоичной отправки. |
| Обновление записи |
Редактирует существующую запись. |
| Отправка документа в публикацию |
Отправка документа в запись с помощью двоичной отправки |
| Отправка образа |
Отправка изображения с помощью двоичной отправки |
| Получение записи |
Возвращает определенную запись по идентификатору |
| Получение категорий |
Возвращает список категорий, видимых пользователю, прошедшим проверку подлинности. |
| Получение пользователя по электронной почте |
Извлекает пользователя по адресу электронной почты |
| Получение разделов |
Возвращает список разделов |
| Получение тегов пользователей |
Возвращает список тегов пользователей, определенных в системе |
| Получение тегов публикации |
Возвращает теги публикации, определенные в системе |
| Получение целевых объектов |
Возвращает список целевых объектов сообщества и определений целевых объектов |
| Предварительная регистрация пользователя |
Создает нового пользователя в предварительно зарегистрированном состоянии |
| Создание записи |
Создает запись. |
| Управление записями |
Разрешает вызовы, прошедшие проверку подлинности сервера, для обновления свойств для нескольких записей в одном запросе |
Добавление изображения в запись по URL-адресу
Задает изображение записи по URL-адресу.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор
|
id | True | uuid |
Идентификатор записи, обязательный: true |
|
URL-адрес
|
url | True | string |
URL-адрес HTTP или HTTPS |
Возвращаемое значение
Простой ответ, указывающий на успешное выполнение действия
- response
- successResponse
Добавление изображения в запись с помощью отправки
Задает изображение записи с помощью двоичной отправки.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор
|
id | True | uuid |
Идентификатор записи |
|
Файл
|
File | True | binary |
Отправка файла |
|
Тип содержимого, например image/jpg, image/pjpeg, image/png, image/x-png, image/gif
|
Content-Type | True | string |
Тип содержимого отправленного файла |
Возвращаемое значение
Простой ответ, указывающий на успешное выполнение действия
- response
- successResponse
Обновление записи
Редактирует существующую запись.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор
|
id | True | uuid |
Идентификатор записи |
|
Название
|
title | string |
Название записи |
|
|
Description
|
description | string |
Краткое описание записи |
|
|
Строка тега
|
tagLine | string |
Строка тега записи |
|
|
Content
|
content | string |
Текст поста |
|
|
Комментарии создателя
|
creatorComments | string |
Сообщение, связанное с записью |
|
|
Ссылка на Perma
|
permaLink | string |
Внешний URL-адрес, на который ссылается запись |
|
|
Включенные внутренние обсуждения
|
internalDiscussionsEnabled | boolean |
Разрешено ли членам выполнять такие действия и добавлять примечания к записям внутри |
Возвращаемое значение
Запись
- response
- postResponse
Отправка документа в публикацию
Отправка документа в запись с помощью двоичной отправки
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя файла
|
fileName | True | string |
Предпочтительное имя файла документа (с расширением) |
|
Идентификатор
|
id | True | uuid |
Идентификатор записи |
|
Файл
|
File | True | binary |
Отправка файла |
|
Тип содержимого, например image/jpg, image/pjpeg, image/png, image/x-png, image/gif
|
Content-Type | True | string |
Тип содержимого отправленного файла |
Возвращаемое значение
Сведения, относящиеся к присоединенному документу
- response
- documentInfoResponse
Отправка образа
Отправка изображения с помощью двоичной отправки
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Файл
|
File | True | binary |
Отправка файла |
|
Тип содержимого, например image/jpg, image/pjpeg, image/png, image/x-png, image/gif
|
Content-Type | True | string |
Тип содержимого отправленного файла |
Возвращаемое значение
- response
- uploadImageResponse
Получение записи
Возвращает определенную запись по идентификатору
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор
|
id | True | uuid |
Идентификатор записи; Это уникальный идентификатор записи. |
|
Идентификатор пользователя
|
userId | integer |
Пользователь, просматривающий запись. Пользователь, вошедший в систему, будет использоваться, если идентификатор не указан |
Возвращаемое значение
Запись
- response
- postResponse
Получение категорий
Возвращает список категорий, видимых пользователю, прошедшим проверку подлинности.
Возвращаемое значение
Подробные сведения, связанные с категориями
- response
- categoriesResponse
Получение пользователя по электронной почте
Извлекает пользователя по адресу электронной почты
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Адрес электронной почты
|
True | string |
Электронная почта пользователя |
|
|
Include
|
include | array of string |
Указывает необязательные данные, возвращаемые пользователем. |
Возвращаемое значение
- response
- userRequestResponse
Получение разделов
Возвращает список разделов
Возвращаемое значение
Деления, определенные в системе
- response
- divisionsResponse
Получение тегов пользователей
Возвращает список тегов пользователей, определенных в системе
Возвращаемое значение
Список тегов пользователей, определенных в системе
- response
- manageUserTagsResponse
Получение тегов публикации
Возвращает теги публикации, определенные в системе
Возвращаемое значение
Список тегов публикации, определенных в системе
- response
- managePostTagsResponse
Получение целевых объектов
Возвращает список целевых объектов сообщества и определений целевых объектов
Возвращаемое значение
Список определений целевых объектов и связанных целевых объектов для сообщества.
- response
- targetDefinitionsInfoResponse
Предварительная регистрация пользователя
Создает нового пользователя в предварительно зарегистрированном состоянии
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Адрес электронной почты
|
string |
Адрес электронной почты пользователя |
||
|
Внешний идентификатор пользователя единого входа
|
externalSsoUserId | string |
Идентификатор пользователя во внешней системе, управляемой поставщиком удостоверений единого входа |
|
|
Ручка
|
handle | string |
Дескриптор пользователя |
|
|
Имя (Первое имя)
|
firstName | string |
Имя пользователя. |
|
|
Фамилия
|
lastName | string |
Фамилия пользователя. |
|
|
Идентификаторы деления
|
divisionIds | array of integer |
Список разделов, которым будет назначен пользователь. |
|
|
Целевые идентификаторы
|
targetIds | array of integer |
Список целевых объектов для назначения пользователю. |
|
|
Имя
|
name | string |
Имя тега или атрибута |
|
|
Ценность
|
value | string |
Необязательное значение |
|
|
Отправка приглашения по электронной почте
|
sendInvitationEmail | boolean |
Определяет, следует ли отправлять пользователю приглашение по электронной почте. |
|
|
Сообщение приглашения
|
invitationMessage | string |
Необязательное текстовое сообщение для включения в сообщение электронной почты приглашения. |
|
|
Уведомления по умолчанию
|
notificationsDefault | string |
Настройка, которая определяет, когда пользователи начнут получать уведомления по электронной почте. |
|
|
Может предоставлять общий доступ к записям
|
canSharePosts | boolean |
Указывает, имеет ли пользователь возможность совместного использования записей |
|
|
Может закомментировать записи
|
canCommentPosts | boolean |
Указывает, имеет ли пользователь возможность комментировать и как записи |
|
|
Может отправлять записи
|
canSubmitPosts | boolean |
Указывает, имеет ли пользователь возможность отправлять записи |
|
|
Может управлять организацией
|
canManageOrganization | boolean |
Указывает, имеет ли пользователь возможность взаимодействовать с прямыми и косвенными отчетами в сообществе. |
Возвращаемое значение
- response
- userRequestResponse
Создание записи
Создает запись.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Description
|
description | string |
Краткое описание записи |
|
|
Строка тега
|
tagLine | string |
Строка тега записи |
|
|
Content
|
content | string |
Текст поста |
|
|
Комментарии создателя
|
creatorComments | string |
Сообщение, связанное с записью |
|
|
Ссылка на Perma
|
permaLink | string |
Внешний URL-адрес, на который ссылается запись |
|
|
Включенные внутренние обсуждения
|
internalDiscussionsEnabled | boolean |
Разрешено ли членам выполнять такие действия и добавлять примечания к записям внутри |
|
|
Название
|
title | True | string |
Название записи |
|
URL-адрес видео участника
|
memberVideoUrl | string |
URL-адрес видео, на который ссылается запись |
|
|
Тип публикации
|
postType | string |
Базовый тип записи |
|
|
Состояние утверждения
|
approvalState | string |
Состояние утверждения должности. По умолчанию используется параметр состояния проверки автора. |
|
|
Режим отображения
|
displayMode | string |
Указывает перенаправление записи в внутреннее или внешнее расположение. |
|
|
Шарабельное
|
sharable | boolean |
Позволяет ли платформа VoiceStorm и мини-приложения предоставлять общий доступ к публикации. |
|
|
Дата начала
|
startDate | date-time |
Дата, после которой запись доступна для просмотра |
|
|
Дата окончания
|
endDate | date-time |
Дата, после которой запись больше не будет доступна для просмотра |
|
|
Предлагаемый текст общего ресурса
|
suggestedShareText | string |
Предлагаемый текст для публикации |
|
|
Короткий предлагаемый текст общего ресурса
|
shortSuggestedShareText | string |
Предлагаемый текст для публикации для поставщиков коротких сообщений |
|
|
Общий доступ к точкам
|
sharePoints | integer |
Количество баллов, полученных при совместном использовании пользователем публикации |
|
|
Щелкните "Точки"
|
clickPoints | integer |
Количество баллов, полученных при щелчке ссылки на общую ссылку на публикацию |
|
|
Общий доступ к изображениям
|
shareWithImages | boolean |
Управляет, если сообщения, к которым предоставлен общий доступ к службам коротких сообщений (например, Twitter), имеют общий доступ к изображениям |
|
|
Общий доступ только к изображениям
|
shareImagesOnly | boolean |
Управляет, если записи, к которым предоставлен общий доступ к определенным службам, рассматриваются как обновления только изображений и фотографий |
|
|
Имя
|
name | string |
Имя тега |
|
|
Language
|
language | string |
Язык содержимого публикации |
|
|
Documents
|
documents | array of uuid |
Список идентификаторов документов для присоединения к этой записи |
|
|
Идентификатор создателя
|
creatorId | integer |
Пользователь, создающий запись; Это свойство доступно только для запросов, прошедших проверку подлинности сервера, в настоящее время. Все остальные записи автоматически задаются для пользователя, прошедшего проверку подлинности. |
|
|
Создатель отображения
|
displayCreator | boolean |
Определяет, должна ли информация о создателе отображаться в записи или нет; Это свойство доступно только для запросов, прошедших проверку подлинности сервера, в настоящее время. |
|
|
Идентификаторы категорий
|
categoryIds | array of integer |
Список идентификаторов категорий, назначенных записи |
|
|
Целевые идентификаторы
|
targetIds | array of integer |
Список целевых идентификаторов, назначенных записи |
Возвращаемое значение
Запись
- response
- postResponse
Управление записями
Разрешает вызовы, прошедшие проверку подлинности сервера, для обновления свойств для нескольких записей в одном запросе
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификаторы публикации
|
postIds | True | array of uuid |
Измененные записи |
|
Метки
|
tags | array of string |
Коллекция имен тегов, которые можно применить к записям |
|
|
Идентификаторы деления
|
divisionIds | array of integer |
Идентификаторы деления, к которым принадлежат записи |
|
|
Идентификаторы категорий
|
categoryIds | array of integer |
Идентификатор категории, к которому относятся записи |
|
|
Целевые идентификаторы
|
targetIds | array of integer |
Идентификатор целевого объекта, к которому принадлежат записи |
|
|
Состояние утверждения
|
approvalState | string |
Состояние утверждения для записей (это не влияет на запросы DELETE) |
Возвращаемое значение
Простой ответ, указывающий на успешное выполнение действия
- response
- successResponse
Определения
successResponse
Простой ответ, указывающий на успешное выполнение действия
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Code
|
code | string |
Значение "success" указывает на успешную операцию |
targetDefinitionsInfoResponse
Список определений целевых объектов и связанных целевых объектов для сообщества.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
definitions
|
definitions | array of targetDefinitionInfoResponse |
targetDefinitionInfoResponse
Подробные сведения для определенного определения целевого объекта и связанных с ним целевых объектов
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | integer |
Идентификатор определения целевого объекта |
|
Имя
|
name | string |
Имя определения целевого объекта |
|
Получение подтверждения пользователя
|
getUserConfirmation | boolean |
Определяет, запрашивается ли пользователь подтвердить или выбрать свое предпочтение. |
|
Разрешить несколько выделений
|
allowMultipleSelections | boolean |
Определяет, можно ли выбрать несколько целевых объектов. |
|
Обязательный выбор
|
selectionRequired | boolean |
Определяет, требуется ли выбор в этом определении |
|
Запрос выбора целевого объекта
|
targetSelectionPrompt | string |
Настраиваемая метка для запроса пользователей выбрать свои предпочтения |
|
childTargets
|
childTargets | array of targetInfoResponse |
targetInfoResponse
Подробные сведения для конкретного целевого объекта.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | integer |
Идентификатор целевого объекта |
|
Имя
|
name | string |
Имя целевого объекта |
|
Description
|
description | string |
Цели расшифровки |
|
Идентификатор определения
|
definitionId | integer |
Идентификатор определения целевого объекта, к которому принадлежит целевой объект |
|
Родительский идентификатор
|
parentId | integer |
Идентификатор родительского объекта, если он имеет один |
|
Подписка
|
isSubscribed | boolean |
Указывает, подписан ли пользователь на определенный целевой объект |
|
childTargets
|
childTargets | array of targetInfoResponse1 |
managePostTagsResponse
Список тегов публикации, определенных в системе
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
tags
|
tags | array of managePostTagResponse |
managePostTagResponse
Подробные сведения для определенного тега публикации
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | integer |
Идентификатор тега |
|
Имя
|
name | string |
Имя тега |
|
Доступно участникам
|
isAvailableToMembers | boolean |
Определяет, можно ли использовать тег на страницах отправки после отправки для членов (если он включен) |
manageUserTagsResponse
Список тегов пользователей, определенных в системе
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
tags
|
tags | array of manageUserTagResponse |
manageUserTagResponse
Подробные сведения для определенного тега пользователя
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | integer |
Идентификатор тега |
|
Имя
|
name | string |
Имя тега |
|
type
|
type | string | |
|
acceptedValues
|
acceptedValues | array of string |
КатегорииResponse
Подробные сведения, связанные с категориями
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
categories
|
categories | array of categoryResponse | |
|
Запрос подписки
|
subscriptionPrompt | string |
Метка для запроса участников выбрать подписки категории |
|
Включение подписки категории
|
enableCategorySubscription | boolean |
Разрешено ли членам изменять подписки на категории |
|
Требовать выбор подписки
|
requireSubscriptionSelection | boolean |
Должны ли члены выбирать подписки категории во время подключения |
|
Категория по умолчанию целевой страницы
|
landingPageDefaultCategory | integer |
Содержимое по умолчанию для отображения при загрузке сведений о веб-канале новостей |
categoryResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | integer |
Идентификатор категории |
|
Имя
|
name | string |
Название категории |
|
Description
|
description | string |
Описание категории |
|
Порядок отображения
|
displayOrder | integer |
Порядок отображения категории |
|
Закреплено
|
isPinned | boolean |
Закреплена ли категория администратором |
|
Принудительно
|
isForced | boolean |
Указывает ли пользователь, прошедший проверку подлинности, принудительно подписан на данную категорию. |
|
Подписка
|
isSubscribed | boolean |
Wther прошедший проверку подлинности пользователь подписан на указанную категорию. |
|
Скрыт
|
isHidden | boolean |
Скрыта ли категория администратором |
|
Доступен ли выбор пользователей
|
isUserSelectable | boolean |
Разрешено ли пользователям выбирать категории для отправленных записей |
|
Идентификатор родительской категории
|
parentCategoryId | integer |
Идентификатор родительской категории |
|
дочерние категории
|
childCategories | array of categoryResponse1 |
postResponse
Запись
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор публикации
|
postId | uuid |
Идентификатор записи |
|
Идентификатор источника публикации
|
postSourceId | integer |
Исходный идентификатор |
|
Название
|
title | string |
Название записи |
|
Description
|
description | string |
Краткое описание записи |
|
Строка тега
|
tagLine | string |
Строка тега записи |
|
Content
|
content | string |
Текст поста |
|
Необработанное содержимое
|
rawContent | string |
Текст публикации, включая весь HTML-код (при включении содержимого и rawContent) |
|
Комментарии создателя
|
creatorComments | string |
Сообщение, связанное с записью |
|
|
creatorInfo | userOverviewResponse |
Сводка сведений о пользователе |
|
Местоположение
|
location | string |
Географическое расположение, связанное с записью |
|
Свойства
|
properties | object |
Другие свойства записи. Недоступно для всех типов постов |
|
Ссылка на Perma
|
permaLink | string |
Внешний URL-адрес, на который ссылается запись |
|
Очистка ссылки на Perma
|
cleanPermaLink | string |
Перемыкание (за исключением проблемных пробелов и новых линий) |
|
postType
|
postType | string | |
|
postSourceType
|
postSourceType | string | |
|
postBylineType
|
postBylineType | string | |
|
Provider
|
provider | string |
Социальный поставщик, из которого возникла публикация (например, Facebook, Twitter). |
|
утверждениеState
|
approvalState | string | |
|
displayMode
|
displayMode | string | |
|
статус
|
status | string | |
|
Редактируемый пользователем
|
userEditable | boolean | |
|
Доступ к совместному доступу пользователей
|
userShareable | boolean |
Указывает, может ли текущий пользователь предоставить общий доступ к записи. Если текущий пользователь не используется, по умолчанию используется значение true. |
|
Примечание пользователя
|
userCommentable | boolean |
Указывает, может ли текущий пользователь участвовать в дикуссиях на публикации. Если текущий пользователь не используется, по умолчанию используется значение false. |
|
Шарабельное
|
sharable | boolean |
Позволяет ли платформа и мини-приложения предоставлять общий доступ к публикации. |
|
Транслироваться
|
broadcasted | boolean |
Трансляция публикации пользователям для совместного доступа |
|
Закреплено
|
pinned | boolean |
Задана ли запись для отображения приоритета в потоках |
|
Дата публикации
|
publishDate | date-time |
Для отправленного пользователем содержимого— дата отправки после отправки; для содержимого, импортированного из внешнего источника, дата публикации в соответствии с источником |
|
Дата начала
|
startDate | date-time |
Дата, после которой запись доступна для просмотра |
|
Дата окончания
|
endDate | date-time |
Дата, после которой запись больше не будет доступна для просмотра |
|
Дата начала события
|
eventStartDate | date-time |
Дата начала события (для записей типа события) |
|
Дата окончания события
|
eventEndDate | date-time |
Дата окончания события (для записей типа события) |
|
Метка времени поставщика
|
providerTimeStamp | date-time |
Дата публикации с точки зрения поставщиков, т. е. когда она была первоначально размещена в социальном поставщике |
|
Полученные точки публикации
|
receivedPublishPoints | boolean |
Указывает, был ли пользователь, отправивший сообщение, получил баллы при публикации публикации. |
|
Предлагаемый текст общего ресурса
|
suggestedShareText | string |
Предлагаемый текст для публикации |
|
Короткий предлагаемый текст общего ресурса
|
shortSuggestedShareText | string |
Предлагаемый текст для публикации для поставщиков коротких сообщений |
|
suggestedShareTextList
|
suggestedShareTextList | array of string | |
|
shortSuggestedShareTextList
|
shortSuggestedShareTextList | array of string | |
|
Общий доступ к точкам
|
sharePoints | integer |
Количество баллов, полученных при совместном использовании пользователем публикации |
|
Щелкните "Точки"
|
clickPoints | integer |
Количество баллов, полученных при щелчке ссылки на общую ссылку на публикацию |
|
Идентификатор публикации поставщика
|
providerPostId | string |
Исходный идентификатор записи в сети поставщиков |
|
Url-адрес Slug
|
urlSlug | string |
Текст SEO для размещения в общедоступных ссылках на публикацию |
|
Classification
|
classification | string |
Тип записи в сети поставщиков. |
|
Общий доступ к изображениям
|
shareWithImages | boolean |
Управляет, если сообщения, к которым предоставлен общий доступ к службам коротких сообщений (например, Twitter), имеют общий доступ к изображениям |
|
Общий доступ только к изображениям
|
shareImagesOnly | boolean |
Управляет, если записи, к которым предоставлен общий доступ к определенным службам, рассматриваются как обновления только изображений и фотографий |
|
Действия
|
actions | string |
БОЛЬШОЙ двоичный объект JSON, содержащий список элементов действий для записи и URL-адресов |
|
Упоминания
|
mentions | string |
Упоминания (пользователи, хэш-теги и т. д.), хранящиеся в виде БОЛЬШОго двоичного объекта JSON. |
|
|
statistics | postStatisticsResponse | |
|
|
userShareInfo | postUserShareInfoResponse | |
|
|
author | postAuthorRequestResponse | |
|
links
|
links | array of postLinkRequestResponse | |
|
tags
|
tags | array of postTagRequestResponse | |
|
мультимедиа
|
media | array of postMediaRequestResponse | |
|
images
|
images | object | |
|
candidateImages
|
candidateImages | array of postCandidateImageResponse | |
|
Видимо
|
visible | boolean |
Отображается ли запись в настоящее время |
|
shareDisclosures
|
shareDisclosures | array of postShareDisclosureResponse | |
|
shareCommentRules
|
shareCommentRules | array of postShareCommentRulesResponse | |
|
Language
|
language | string |
Язык содержимого публикации |
|
Скрытый пользователь
|
userHidden | boolean |
Скрыта ли запись пользователя из одного или нескольких потоков |
|
Просматривается пользователем
|
isViewedByUser | boolean |
Просматривается ли запись текущим пользователем. |
|
Просмотр обсуждения пользователем
|
isDiscussionViewedByUser | boolean |
Просмотр потока обсуждения записей текущим пользователем |
|
Нравится пользователю
|
isLikedByUser | boolean |
Нравится ли запись текущему пользователю. |
|
Закомментирован пользователем
|
isCommentedByUser | boolean |
Указывает, была ли запись закомментирована текущим пользователем. |
|
Предоставляется пользователю общий доступ
|
isSharedByUser | boolean |
Указывает, предоставлена ли запись текущему пользователю ранее |
|
targets
|
targets | array of targetOverviewResponse | |
|
categories
|
categories | array of categoryOverviewResponse | |
|
Текущее время
|
currentTime | date-time |
Текущее время на сервере. |
categoryOverviewResponse
Основные сведения о категории
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | integer |
Идентификатор категории |
|
Имя
|
name | string |
Название категории |
|
Идентификатор родительской категории
|
parentCategoryId | integer |
Идентификатор родительской категории |
targetOverviewResponse
Упрощенный целевой ответ, состоящий из имени целевых объектов, идентификатора и идентификатора определения целевого объекта, к которому он принадлежит.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Имя
|
name | string |
Имя целевых объектов |
|
Идентификатор
|
id | integer |
Идентификатор целевых объектов |
|
Идентификатор определения
|
definitionId | integer |
Идентификатор определения целевого объекта, к которому принадлежит целевой объект |
postShareCommentRulesResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
provider
|
provider | string | |
|
Общий доступ к максимальному ограничению символов
|
shareMaxCharacterLimit | integer |
Максимальная длина комментария пользователей в общей папке для этого поставщика. |
postShareDisclosureResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
provider
|
provider | string | |
|
Отображаемое имя поставщика
|
providerDisplayName | string |
Отображаемое имя поставщиков |
|
Общий доступ к тексту раскрытия
|
shareDisclosureText | string |
Текст раскрытия, добавленный к каждой общей папке |
postCandidateImageResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
URL-адрес
|
url | string |
URL-адрес изображений |
|
Ширина
|
width | integer |
Ширина изображений |
|
Высота
|
height | integer |
Высота изображений |
|
Тип Mime
|
mimeType | string |
Тип MIME изображений |
|
URL-адрес SSL
|
sslUrl | string |
Безопасный URL-адрес изображений |
postMediaRequestResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Имя
|
name | string |
Имя объекта мультимедиа |
|
Ширина
|
width | integer |
Ширина объекта мультимедиа в пикселях |
|
Высота
|
height | integer |
Высота объекта мультимедиа в пикселях |
|
Тип Mime
|
mimeType | string |
Тип MIME объекта мультимедиа |
|
Html
|
html | string |
HTML, который можно использовать для отрисовки объекта мультимедиа |
|
URL-адрес
|
url | string |
URL-адрес объекта мультимедиа |
|
Происхождение
|
origin | string |
Если доступно, указывает исходное расположение объекта мультимедиа |
|
Provider
|
provider | string |
Имя поставщика социальных сетей |
|
Role
|
role | string |
Тип носителя (если определено) |
|
Продолжительность
|
duration | integer |
Длительность видео в миллисекундах |
|
Description
|
description | string |
Описание формата видео |
|
Имеет URL-адрес видео
|
hasVideoUrl | boolean |
Указывает, что этот носитель имеет URL-адрес видео, который должен быть подписан с помощью включения WatchVideo |
postTagRequestResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Имя
|
name | string |
Имя тега |
postLinkRequestResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
URL-адрес
|
url | string |
URL-адрес записи |
|
Развернутый URL-адрес
|
expandedUrl | string |
Развернутый URL-адрес (если он существует) |
|
Название
|
title | string |
Заголовок записей |
|
Домен
|
domain | string |
Домен ссылок |
|
URL-адрес Favicon
|
faviconUrl | string |
URL-адрес favicon ссылки |
|
Имя
|
name | string |
Имя ссылки, назначенной поставщиком социальных сетей |
|
Заголовок
|
caption | string |
Короткий заголовок ссылки (т. е. текст под ссылкой) |
|
Description
|
description | string |
Описание ссылки (т. е. более длинный текст под подписью) |
|
Дата изменения
|
modifiedDate | date-time | |
|
Дата создания
|
createdDate | date-time |
postAuthorRequestResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Author
|
author | string |
Сохраненный текст, отображаемый как автор. |
|
URL-адрес изображения профиля
|
profileImageUrl | string |
Изображение профиля авторов в социальной сети |
|
Идентификатор пользователя поставщика
|
providerUserId | string |
Идентификатор авторов в социальной сети |
|
Имя пользователя поставщика
|
providerUserName | string |
Имя авторов в социальной сети |
|
URL-адрес профиля
|
profileUrl | string |
URL-адрес профиля авторов в социальной сети |
|
Имя источника после публикации
|
postSourceName | string |
Имя источника записи. |
|
Исходный сайт после публикации
|
postSourceSite | string |
Веб-сайт, на котором возникла публикация |
postUserShareInfoResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Заработанные баллы
|
pointsEarned | integer |
Количество баллов, полученных пользователем для предоставления общего доступа |
|
Количество общих данных
|
shareCount | integer |
Количество общих пользователей |
|
Дата последней общей папки
|
mostRecentShareDate | date-time |
Дата последней общей папки пользователей этой публикации |
postStatisticsResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Общее число общих приложений
|
totalInAppShareCount | integer |
Синоним для ShareCount |
|
Идентификатор отслеживания
|
trackingId | string | |
|
Количество общих данных
|
shareCount | integer |
Количество общих папок, инициированных в приложении, которое было проверено успешно. |
|
Счетчик реакций
|
reactionCount | integer |
Количество реакций (например, retweets и т. д.) для акций |
|
Количество впечатлений
|
impressionCount | integer |
Потенциальные взгляды на пост, поделиться друзьями и последователями |
|
Просмотре число
|
viewedCount | integer |
Количество посещений записи пользователями, вошедшего в систему |
|
Нажмите кнопку "Число"
|
clickCount | integer |
Количество щелчков по ссылке на записи из общих папок |
|
Например, число
|
likeCount | integer |
Количество внутренних нравится на пост |
|
Число комментариев
|
commentCount | integer |
Количество внутренних комментариев на публикации |
|
Комментарий, например число
|
commentLikeCount | integer |
Сумма всех нравится во всех внутренних комментариях на пост |
userOverviewResponse
Сводка сведений о пользователе
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор пользователя
|
userId | integer |
Идентификатор пользователя |
|
Отображаемое имя
|
displayName | string |
Отображаемое имя пользователя |
|
profilePictureImages
|
profilePictureImages | object | |
|
Активен
|
isActive | boolean |
Является ли пользователь активным членом сообщества |
uploadImageResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор изображения
|
imageIdentifier | string |
Идентификатор отправленного изображения |
userRequestResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | integer |
Внутренний идентификатор пользователей |
|
Адрес электронной почты
|
string |
Адрес электронной почты пользователей |
|
|
Ручка
|
handle | string |
Пользователи обрабатывают (имя пользователя) |
|
Отображаемое имя
|
displayName | string |
Предпочитаемое отображаемое имя пользователей |
|
Полное имя
|
fullName | string |
Имя и фамилия пользователя |
|
Имя (Первое имя)
|
firstName | string |
Имя пользователя |
|
Фамилия
|
lastName | string |
Фамилия пользователей |
|
displayNameFormat
|
displayNameFormat | string | |
|
статус
|
status | string | |
|
Заполненный профиль
|
profileCompleted | boolean |
Был ли выполнен профиль пользователей во время подключения |
|
Last Activity Date (Дата последнего действия);
|
lastActivityDate | date-time |
Последний раз, когда пользователь взаимодействовал с системой. |
|
Название
|
title | string |
Заголовок пользователей |
|
Местоположение
|
location | string |
Самоописаемое расположение пользователей (возможно, не является фактическим географическим расположением). |
|
Идентификатор пользователя внешнего API
|
externalApiUserId | string |
Идентификатор пользователей во внешней системе, управляемой вызывающим этим API |
|
Идентификатор пользователя Manager
|
managerUserId | integer |
Идентификатор диспетчера пользователей (для функций иерархии организации) |
|
Часовой пояс
|
timeZone | string |
Часовой пояс пользователя, представленный как имя часового пояса базы данных tz, заданное IANA. Пример: "Америка/Los_Angeles". |
|
Выбранный часовой пояс
|
selectedTimeZone | string |
Пользователи выбрали часовой пояс, представленный как имя часового пояса базы данных tz, заданное IANA. Пример: "Америка/Los_Angeles". |
|
Баланс точек
|
pointBalance | integer |
Общее количество баллов, заработанных на сегодняшний день |
|
Нередимированные точки
|
unredeemedPoints | integer |
Точки, доступные в настоящее время для активации |
|
Активированные точки
|
redeemedPoints | integer |
Количество точек, активированных за время существования пользователей |
|
Сведения об API
|
apiInfo | string |
Контейнер свойств для конкретного API |
|
Имеет пароль
|
hasPassword | boolean |
Имеет ли пользователь пароль, связанный с учетной записью. |
|
Необходимо изменить пароль
|
mustChangePassword | boolean |
Должен ли пользователь изменить пароль на основе параметров сообщества. |
|
Проверка учетной записи
|
isAccountVerified | boolean |
Указывает, проверил ли пользователь свой адрес электронной почты |
|
|
statistics | postStatisticsResponse | |
|
tags
|
tags | object | |
|
Значки
|
badges | object | |
|
Принадлежности
|
affiliations | array of userAffiliationResponse | |
|
Подразделений
|
divisions | array of divisionResponse | |
|
channels
|
channels | array of userChannelResponse | |
|
profilePictureImages
|
profilePictureImages | object | |
|
Языки
|
languages | array of string | |
|
Основной язык
|
primaryLanguage | string |
Основной язык интерфейса пользователей |
|
|
scheduleSettings | userScheduleSettingsResponse |
Параметры общего доступа, запланированные пользователями |
|
Is Sso
|
isSso | boolean |
Указывает, настроен ли пользователь для проверки подлинности с помощью единого входа |
|
|
permissions | userPermissionsResponse |
Разрешения руководителей |
|
|
privileges | userPrivilegesResponse |
Привилегии пользователей |
|
Идентификаторы
|
identifiers | array of allowlistIdentifiersResponse | |
|
targets
|
targets | array of targetOverviewResponse | |
|
|
defaults | userDefaultsRequestResponse |
Коллекция пользователей по умолчанию |
|
Приветственный баннер отклонен
|
welcomeBannerDismissed | boolean |
Уволен ли пользователь баннер приветствия |
userDefaultsRequestResponse
Коллекция пользователей по умолчанию
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
defaultPostState
|
defaultPostState | string | |
|
defaultPostApprovalState
|
defaultPostApprovalState | string | |
|
Публикация по умолчанию показывает внутренние обсуждения
|
defaultPostShowInternalDiscussions | boolean |
Пользователи по умолчанию публикуют состояние внутренних обсуждений при создании записи |
|
Сведения о создателе записи по умолчанию
|
defaultPostShowCreatorInfo | boolean |
Состояние пользователей по умолчанию при создании записи относительно отображения имени создателя и фотографии |
allowlistIdentifiersResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | integer |
Идентификатор определения списка разрешений |
|
Ценность
|
value | string |
Ответ пользователей для заданного определения списка разрешений |
userPrivilegesResponse
Привилегии пользователей
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Может отправлять записи
|
canSubmitPosts | boolean |
Указывает, имеет ли пользователь возможность отправлять записи на основе своих привилегий и параметров сообщества. |
|
Может предоставлять общий доступ к записям
|
canSharePosts | boolean |
Указывает, имеет ли пользователь возможность совместного использования записей на основе своих привилегий и параметров сообщества. |
|
Может закомментировать записи
|
canCommentPosts | boolean |
Указывает, имеет ли пользователь возможность комментировать и например записи на основе своих привилегий и параметров сообщества. |
|
Может управлять сообществом
|
canManageCommunity | boolean |
Указывает, является ли пользователь менеджером в сообществе на основе своих привилегий и параметров сообщества. |
|
Может управлять организацией
|
canManageOrganization | boolean |
Указывает, имеет ли пользователь возможность взаимодействовать с прямыми и косвенными отчетами в сообществе на основе своих привилегий и параметров сообщества. |
|
Может задать общий доступ к публикации
|
canSetPostShareable | boolean |
Может ли пользователь задать состояние Shareable при отправке записи |
userPermissionsResponse
Разрешения руководителей
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Просмотр трансляции
|
viewBroadcast | boolean |
Позволяет руководителю просматривать трансляции |
|
Вывод списка широковещательных трансляций
|
listBroadcast | boolean |
Позволяет руководителю просматривать списки широковещательных трансляций |
|
Изменение трансляции
|
editBroadcast | boolean |
Позволяет руководителю создавать и изменять широковещательные трансляции |
|
Просмотр статистики трансляции
|
viewBroadcastStats | boolean |
Позволяет руководителю просматривать статистику трансляции |
|
Просмотр записи
|
viewPost | boolean |
Позволяет руководителю просматривать записи |
|
Вывод списка
|
listPost | boolean |
Позволяет руководителю просматривать списки записей |
|
Изменение записи
|
editPost | boolean |
Позволяет руководителю создавать и изменять записи |
|
Просмотр статистики после публикации
|
viewPostStats | boolean |
Позволяет руководителю просматривать статистику после публикации |
|
Просмотр опроса
|
viewSurvey | boolean |
Позволяет руководителю просматривать опросы |
|
Список опросов
|
listSurvey | boolean |
Позволяет руководителю просматривать списки опросов |
|
Изменение опроса
|
editSurvey | boolean |
Позволяет руководителю создавать и изменять опросы |
|
Параметры сообщества
|
communitySettings | boolean |
Позволяет руководителю просматривать и изменять параметры сообщества |
userScheduleSettingsResponse
Параметры общего доступа, запланированные пользователями
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Дни
|
days | string | |
|
раз
|
times | array of string |
userChannelResponse
Канал пользователя.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор канала пользователя
|
userChannelId | integer |
Идентификатор внутреннего канала пользователя |
|
Идентификатор пользователя
|
userId | integer |
Внутренний идентификатор пользователя |
|
provider
|
provider | string | |
|
Имя
|
name | string |
Имя пользователя в поставщике социальных сетей |
|
Отображаемое имя
|
displayName | string |
Отображаемое имя пользователей в поставщике социальных сетей |
|
Идентификатор пользователя поставщика
|
providerUserId | string |
Идентификатор пользователя поставщика |
|
статус
|
status | string | |
|
URL-адрес
|
url | string |
URL-адрес канала |
|
Друзья
|
friends | integer |
Количество друзей у пользователя на канале |
|
Подписчики
|
followers | integer |
Количество подписчиков, которые пользователь имеет на канале |
|
Подписки
|
following | integer |
Количество пользователей, которые пользователь следует на канале |
|
Posts
|
posts | integer |
Количество записей, сделанных пользователем на канале. |
|
Views
|
views | integer |
Количество представлений, которые пользователь имеет на канале |
|
Баланс точек
|
pointBalance | integer |
Баланс точки пользователя на канале |
|
Отображаемое имя источника
|
sourceDisplayName | string |
Отображаемое имя канала пользователя при использовании в качестве источника контента |
|
Охват
|
reach | integer |
Пользователи обращаются к каналу |
|
Шарабельное
|
sharable | boolean |
Поддерживает ли канал общий доступ |
|
Общий доступ по умолчанию
|
sharingDefault | boolean |
Выбор канала для общего доступа |
|
Требуется проверка подлинности
|
authRequired | boolean |
Требуется ли продление учетных данных каналов |
|
|
statistics | postStatisticsResponse | |
|
profilePictureImages
|
profilePictureImages | object |
divisionResponse
Определение деления
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор деления
|
divisionId | integer |
Идентификатор деления |
|
Имя
|
name | string |
Имя деления |
|
Идентификатор родительского деления
|
parentDivisionId | integer |
Идентификатор родительского элемента деления |
userAffiliationResponse
Принадлежность пользователя
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
|
question | affiliationQuestionResponse |
Вопрос о принадлежности |
|
|
answer | affiliationAnswerResponse |
Ответ на принадлежность |
affiliationAnswerResponse
Ответ на принадлежность
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор ответа
|
answerId | integer |
Идентификатор ответа |
|
Ответ
|
answer | string |
Ответ |
|
Балл
|
score | double |
Оценка, если она указана |
|
Бесплатный текст
|
freeText | string |
Текст для вопросов с типом вопроса FreeText |
|
Отклонение ответа
|
declineToAnswer | boolean |
Если задано, это ответ, указывающий, что пользователь отказался ответить на этот вопрос. |
|
Position
|
position | integer |
Позиция сортировки ответов |
affiliationQuestionResponse
Вопрос о принадлежности
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор вопроса
|
questionId | integer |
Идентификатор вопроса |
|
Имя
|
name | string |
Вопрос |
|
Позиция оценки
|
scorePosition | integer |
Позиция сортировки вопросов |
|
Description
|
description | string |
Описание вопросов |
|
questionType
|
questionType | string | |
|
Обязательно
|
required | boolean |
Следует ли ответить на вопрос, чтобы зарегистрировать |
|
Общедоступная видимость
|
isPubliclyVisible | boolean |
documentInfoResponse
Сведения, относящиеся к присоединенному документу
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | uuid |
Идентификатор документов |
|
Имя файла
|
fileName | string |
Имя файла документов (с расширением) |
|
Extension
|
extension | string |
Расширение файла документов |
|
Тип Mime
|
mimeType | string |
Тип MIME документов |
divisionsResponse
Деления, определенные в системе
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Подразделений
|
divisions | array of divisionResponse | |
|
Подсказка
|
prompt | string |
Метка для запроса участников выбрать деление |
|
Показать выбор деления пользователей
|
showUserDivisionSelection | boolean |
Могут ли зарегистрированные члены изменить свой собственный отдел |
|
Отображение выделения отделов пользователей во время подключения
|
showUserDivisionSelectionDuringOnboarding | boolean |
Должен ли новый член выбрать свое подразделение во время регистрации |
|
Требовать выбор разделения пользователей
|
requireUserDivisionSelection | boolean |
Должны ли члены выбрать свое подразделение. |
|
Разрешить несколько разделов
|
allowMultipleDivisions | boolean |
Разрешено ли выбрать несколько или только одно деление |
categoryResponse1
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | integer |
Идентификатор категории |
|
Имя
|
name | string |
Название категории |
|
Description
|
description | string |
Описание категории |
|
Порядок отображения
|
displayOrder | integer |
Порядок отображения категории |
|
Закреплено
|
isPinned | boolean |
Закреплена ли категория администратором |
|
Принудительно
|
isForced | boolean |
Указывает ли пользователь, прошедший проверку подлинности, принудительно подписан на данную категорию. |
|
Подписка
|
isSubscribed | boolean |
Wther прошедший проверку подлинности пользователь подписан на указанную категорию. |
|
Скрыт
|
isHidden | boolean |
Скрыта ли категория администратором |
|
Доступен ли выбор пользователей
|
isUserSelectable | boolean |
Разрешено ли пользователям выбирать категории для отправленных записей |
|
Идентификатор родительской категории
|
parentCategoryId | integer |
Идентификатор родительской категории |
targetInfoResponse1
Подробные сведения для конкретного целевого объекта.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | integer |
Идентификатор целевого объекта |
|
Имя
|
name | string |
Имя целевого объекта |
|
Description
|
description | string |
Цели расшифровки |
|
Идентификатор определения
|
definitionId | integer |
Идентификатор определения целевого объекта, к которому принадлежит целевой объект |
|
Родительский идентификатор
|
parentId | integer |
Идентификатор родительского объекта, если он имеет один |
|
Подписка
|
isSubscribed | boolean |
Указывает, подписан ли пользователь на определенный целевой объект |
|
childTargets
|
childTargets | array of targetInfoResponse2 |
targetInfoResponse2
Подробные сведения для конкретного целевого объекта.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | integer |
Идентификатор целевого объекта |
|
Имя
|
name | string |
Имя целевого объекта |
|
Description
|
description | string |
Цели расшифровки |
|
Идентификатор определения
|
definitionId | integer |
Идентификатор определения целевого объекта, к которому принадлежит целевой объект |
|
Родительский идентификатор
|
parentId | integer |
Идентификатор родительского объекта, если он имеет один |
|
Подписка
|
isSubscribed | boolean |
Указывает, подписан ли пользователь на определенный целевой объект |
|
childTargets
|
childTargets | array of targetInfoResponse3 |
targetInfoResponse3
Подробные сведения для конкретного целевого объекта.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | integer |
Идентификатор целевого объекта |
|
Имя
|
name | string |
Имя целевого объекта |
|
Description
|
description | string |
Цели расшифровки |
|
Идентификатор определения
|
definitionId | integer |
Идентификатор определения целевого объекта, к которому принадлежит целевой объект |
|
Родительский идентификатор
|
parentId | integer |
Идентификатор родительского объекта, если он имеет один |
|
Подписка
|
isSubscribed | boolean |
Указывает, подписан ли пользователь на определенный целевой объект |