动态信号（预览版）
Dynamic Signal 是员工沟通和参与平台，组织信任这些平台来连接、协调和吸引员工。 连接到 Dynamic Signal 以创建和管理帖子和用户。
此连接器在以下产品和区域中可用：
| 服务 | Class | 区域 |
|---|---|---|
| Copilot Studio | 高级 | 除以下各项外的所有 Power Automate 区域 ： - 美国政府 （GCC） - 美国政府 （GCC High） - 由世纪互联运营的中国云 - 美国国防部（DoD） |
| 逻辑应用程序 | 标准 | 除以下各项外的所有 逻辑应用区域 ： - Azure 政府区域 - Azure 中国区域 - 美国国防部（DoD） |
| Power Apps | 高级 | 除以下各项外的所有 Power Apps 区域 ： - 美国政府 （GCC） - 美国政府 （GCC High） - 由世纪互联运营的中国云 - 美国国防部（DoD） |
| Power Automate | 高级 | 除以下各项外的所有 Power Automate 区域 ： - 美国政府 （GCC） - 美国政府 （GCC High） - 由世纪互联运营的中国云 - 美国国防部（DoD） |
| 连接器元数据 | |
|---|---|
| 发布者 | 动态信号 |
正在创建连接
连接器支持以下身份验证类型：
| 默认 | 用于创建连接的参数。 | 所有区域 | 不可共享 |
违约
适用：所有区域
用于创建连接的参数。
这是不可共享的连接。 如果 Power App 与另一个用户共享，系统会提示其他用户显式创建新连接。
| Name | 类型 | Description | 必选 |
|---|---|---|---|
| 持有者令牌 | securestring | 此 API 的持有者令牌 | True |
| 动态信号 URL | 字符串 | 访问动态信号的 URL。 | True |
限制
| 名称 | 调用 | 续订期 |
|---|---|---|
| 每个连接的 API 调用数 | 100 | 60 秒 |
操作
| 上传图像 |
通过二进制上传上传上传图像 |
| 创建帖子 |
创建帖子。 |
| 将文档上传到帖子 |
通过二进制上传将文档上传到帖子 |
| 更新帖子 |
编辑现有文章。 |
| 管理帖子 |
允许经过服务器身份验证的调用在单个请求中更新多个帖子的属性 |
| 获取帖子 |
按 ID 获取特定帖子 |
| 获取帖子标记 |
获取系统中定义的帖子标记 |
| 获取用户标记 |
获取系统中定义的用户标记列表 |
| 获取目标 |
获取社区的目标和目标定义的列表 |
| 获取类别 |
获取对经过身份验证的用户可见的类别列表 |
| 获取部门 |
获取除法列表 |
| 通过 URL 将图像添加到帖子 |
通过 URL 设置帖子图像。 |
| 通过上传将图像添加到帖子 |
通过二进制上传设置帖子图像。 |
| 通过电子邮件获取用户 |
按其电子邮件地址检索用户 |
| 预注册用户 |
在预注册状态下创建新用户 |
上传图像
通过二进制上传上传上传图像
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
文件
|
File | True | binary |
要上传的文件 |
|
内容类型，如 image/jpg、image/pjpeg、image/png、image/x-png、image/gif
|
Content-Type | True | string |
上传文件的内容类型 |
返回
- response
- uploadImageResponse
创建帖子
创建帖子。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Description
|
description | string |
文章的简短说明 |
|
|
标记行
|
tagLine | string |
帖子的标记行 |
|
|
Content
|
content | string |
帖子的正文 |
|
|
创建者注释
|
creatorComments | string |
与帖子关联的消息 |
|
|
Perma 链接
|
permaLink | string |
帖子引用的外部 URL |
|
|
已启用内部讨论
|
internalDiscussionsEnabled | boolean |
是否允许成员在内部执行类似作并添加帖子评论 |
|
|
Title
|
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
|
name | string |
标记名称 |
|
|
语言
|
language | string |
帖子内容的语言 |
|
|
文档
|
documents | array of uuid |
要附加到此文章的文档 ID 列表 |
|
|
创建者 ID
|
creatorId | integer |
正在创建帖子的用户;此属性目前仅适用于经过服务器身份验证的请求。 所有其他帖子都会自动设置为经过身份验证的用户。 |
|
|
显示创建者
|
displayCreator | boolean |
控制创建者信息是否与帖子一起显示;此属性目前仅适用于经过服务器身份验证的请求。 |
|
|
类别 ID
|
categoryIds | array of integer |
已分配给帖子的类别 ID 的列表 |
|
|
目标 ID
|
targetIds | array of integer |
已分配给帖子的目标 ID 的列表 |
返回
帖子
- response
- postResponse
将文档上传到帖子
通过二进制上传将文档上传到帖子
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
文件名
|
fileName | True | string |
文档的首选文件名（带扩展名） |
|
ID
|
id | True | uuid |
帖子 ID |
|
文件
|
File | True | binary |
要上传的文件 |
|
内容类型，如 image/jpg、image/pjpeg、image/png、image/x-png、image/gif
|
Content-Type | True | string |
上传文件的内容类型 |
返回
与附加文档相关的信息
- response
- documentInfoResponse
更新帖子
编辑现有文章。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
ID
|
id | True | uuid |
帖子 ID |
|
Title
|
title | string |
文章的标题 |
|
|
Description
|
description | string |
文章的简短说明 |
|
|
标记行
|
tagLine | string |
帖子的标记行 |
|
|
Content
|
content | string |
帖子的正文 |
|
|
创建者注释
|
creatorComments | string |
与帖子关联的消息 |
|
|
Perma 链接
|
permaLink | string |
帖子引用的外部 URL |
|
|
已启用内部讨论
|
internalDiscussionsEnabled | boolean |
是否允许成员在内部执行类似作并添加帖子评论 |
返回
帖子
- response
- postResponse
管理帖子
允许经过服务器身份验证的调用在单个请求中更新多个帖子的属性
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
发布 ID
|
postIds | True | array of uuid |
正在修改的帖子 |
|
标记
|
tags | array of string |
可应用于帖子的标记名称的集合 |
|
|
分区 ID
|
divisionIds | array of integer |
帖子所属的分区 ID |
|
|
类别 ID
|
categoryIds | array of integer |
文章所属的类别 ID |
|
|
目标 ID
|
targetIds | array of integer |
文章所属的目标 ID |
|
|
审批状态
|
approvalState | string |
帖子的审批状态（这不受 DELETE 请求的影响） |
返回
指示作已成功执行的简单响应
- response
- successResponse
获取帖子
按 ID 获取特定帖子
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
ID
|
id | True | uuid |
The post ID.;这是帖子的唯一标识符。 |
|
用户 ID
|
userId | integer |
正在查看帖子的用户。 如果未指定 ID，将使用已登录的用户 |
返回
帖子
- response
- postResponse
获取帖子标记
获取用户标记
获取目标
获取类别
获取部门
通过 URL 将图像添加到帖子
通过 URL 设置帖子图像。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
ID
|
id | True | uuid |
post ID，必需：true |
|
网址
|
url | True | string |
HTTP 或 HTTPS URL |
返回
指示作已成功执行的简单响应
- response
- successResponse
通过上传将图像添加到帖子
通过二进制上传设置帖子图像。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
ID
|
id | True | uuid |
帖子 ID |
|
文件
|
File | True | binary |
要上传的文件 |
|
内容类型，如 image/jpg、image/pjpeg、image/png、image/x-png、image/gif
|
Content-Type | True | string |
上传文件的内容类型 |
返回
指示作已成功执行的简单响应
- response
- successResponse
通过电子邮件获取用户
按其电子邮件地址检索用户
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Email
|
True | string |
用户的电子邮件 |
|
|
包括
|
include | array of string |
指定要与用户一起返回的可选数据。 |
返回
- response
- userRequestResponse
预注册用户
在预注册状态下创建新用户
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Email
|
string |
用户的电子邮件地址 |
||
|
外部 Sso 用户 ID
|
externalSsoUserId | string |
SSO 标识提供者管理的外部系统上的用户 ID |
|
|
处理
|
handle | string |
用户的句柄 |
|
|
名字
|
firstName | string |
用户的名字。 |
|
|
姓氏
|
lastName | string |
用户的姓氏。 |
|
|
分区 ID
|
divisionIds | array of integer |
将向其分配用户的分区列表。 |
|
|
目标 ID
|
targetIds | array of integer |
要分配给用户的目标列表。 |
|
|
Name
|
name | string |
标记或属性名称 |
|
|
价值
|
value | string |
可选值 |
|
|
发送邀请电子邮件
|
sendInvitationEmail | boolean |
确定是否向用户发送邀请电子邮件。 |
|
|
邀请消息
|
invitationMessage | string |
要包含在邀请电子邮件中的可选纯文本消息。 |
|
|
通知默认值
|
notificationsDefault | string |
设置可控制用户何时开始接收电子邮件通知。 |
|
|
可以共享帖子
|
canSharePosts | boolean |
指示用户是否能够共享帖子 |
|
|
可以评论帖子
|
canCommentPosts | boolean |
指示用户是否能够评论和喜欢帖子 |
|
|
可以提交帖子
|
canSubmitPosts | boolean |
指示用户是否能够提交帖子 |
|
|
可以管理组织
|
canManageOrganization | boolean |
指示用户是否能够与社区内的直接和间接报告进行通信 |
返回
- response
- userRequestResponse
定义
successResponse
指示作已成功执行的简单响应
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Code
|
code | string |
值为“success”表示作成功 |
targetDefinitionsInfoResponse
社区的目标定义和关联目标的列表。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
definitions
|
definitions | array of targetDefinitionInfoResponse |
targetDefinitionInfoResponse
特定目标定义及其关联的目标的详细信息
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
ID
|
id | integer |
目标定义的 ID |
|
Name
|
name | string |
目标定义的名称 |
|
获取用户确认
|
getUserConfirmation | boolean |
确定是否要求用户确认/选择其首选项 |
|
允许多个选择
|
allowMultipleSelections | boolean |
确定是否可以选择多个目标 |
|
所需选择
|
selectionRequired | boolean |
确定此定义中的选择是否是必需的 |
|
目标选择提示
|
targetSelectionPrompt | string |
自定义标签，提示用户选择其首选项 |
|
childTargets
|
childTargets | array of targetInfoResponse |
targetInfoResponse
特定目标的详细信息。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
ID
|
id | integer |
目标 ID |
|
Name
|
name | string |
目标的名称 |
|
Description
|
description | string |
目标 descritption |
|
定义 ID
|
definitionId | integer |
目标所属的目标定义的 ID |
|
父 ID
|
parentId | integer |
目标父级的 ID（如果有） |
|
是否已订阅
|
isSubscribed | boolean |
用户是否订阅特定目标 |
|
childTargets
|
childTargets | array of targetInfoResponse1 |
managePostTagsResponse
系统中定义的帖子标记列表
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
tags
|
tags | array of managePostTagResponse |
managePostTagResponse
特定帖子标记的详细信息
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
ID
|
id | integer |
标记 ID |
|
Name
|
name | string |
标记名称 |
|
可供成员使用
|
isAvailableToMembers | boolean |
确定标记是否可用于面向成员的帖子提交页面（如果已启用） |
manageUserTagsResponse
系统中定义的用户标记列表
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
tags
|
tags | array of manageUserTagResponse |
manageUserTagResponse
特定用户标记的详细信息
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
ID
|
id | integer |
标记 ID |
|
Name
|
name | string |
标记名称 |
|
类型
|
type | string | |
|
acceptedValues
|
acceptedValues | array of string |
categoriesResponse
与类别相关的详细信息
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
categories
|
categories | array of categoryResponse | |
|
订阅提示
|
subscriptionPrompt | string |
提示成员选择类别订阅的标签 |
|
启用类别订阅
|
enableCategorySubscription | boolean |
是否允许成员修改其类别订阅 |
|
需要选择订阅
|
requireSubscriptionSelection | boolean |
成员是否需要在载入期间选择类别订阅 |
|
登陆页面默认类别
|
landingPageDefaultCategory | integer |
加载新闻源信息时要显示的默认内容 |
categoryResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
ID
|
id | integer |
类别 ID |
|
Name
|
name | string |
类别名称 |
|
Description
|
description | string |
类别说明 |
|
显示顺序
|
displayOrder | integer |
显示类别的顺序 |
|
固定
|
isPinned | boolean |
类别是否已由管理员固定 |
|
强制
|
isForced | boolean |
经过身份验证的用户是否强制订阅给定类别 |
|
是否已订阅
|
isSubscribed | boolean |
Wther 已对经过身份验证的用户订阅给定类别 |
|
已隐藏
|
isHidden | boolean |
该类别是否由管理员隐藏 |
|
用户是否可选择
|
isUserSelectable | boolean |
是否允许用户为提交的文章选择类别 |
|
父类别 ID
|
parentCategoryId | integer |
父类别 ID |
|
childCategories
|
childCategories | array of categoryResponse1 |
postResponse
帖子
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
发布 ID
|
postId | uuid |
帖子 ID |
|
发布源 ID
|
postSourceId | integer |
源 ID |
|
Title
|
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 |
permalink （不包括有问题的空格和换行符） |
|
postType
|
postType | string | |
|
postSourceType
|
postSourceType | string | |
|
postBylineType
|
postBylineType | string | |
|
Provider
|
provider | string |
帖子的来源社交提供商（例如 Facebook、Twitter）。 |
|
approvalState
|
approvalState | string | |
|
displayMode
|
displayMode | string | |
|
状态
|
status | string | |
|
用户可编辑
|
userEditable | boolean | |
|
用户可共享
|
userShareable | boolean |
指示当前用户是否可以共享帖子。 如果没有当前用户，则默认为 true。 |
|
用户可批注
|
userCommentable | boolean |
指示当前用户是否可以参与帖子中的脑震荡。 如果没有当前用户，则默认为 false。 |
|
共享
|
sharable | boolean |
平台和小组件是否允许共享帖子 |
|
播出
|
broadcasted | boolean |
帖子是否已广播给用户进行共享 |
|
Pinned
|
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 |
当某人单击帖子的共享链接时获得的积分数 |
|
提供程序发布 ID
|
providerPostId | string |
提供商网络上帖子的原始 ID |
|
Url Slug
|
urlSlug | string |
要放入帖子的公共链接的 SEO 文本 |
|
Classification
|
classification | string |
提供程序网络上的帖子类型。 |
|
与图像共享
|
shareWithImages | boolean |
控制共享到短消息服务（如 Twitter）的帖子是否共享了图像 |
|
仅共享映像
|
shareImagesOnly | boolean |
控制是否将共享到某些服务的帖子视为仅图像/照片更新 |
|
行动
|
actions | string |
包含帖子和 URL 的作项列表的 JSON Blob |
|
提及
|
mentions | string |
这些提及（用户、哈希标记等）存储为 JSON Blob。 |
|
|
statistics | postStatisticsResponse | |
|
|
userShareInfo | postUserShareInfoResponse | |
|
|
author | postAuthorRequestResponse | |
|
链接
|
links | array of postLinkRequestResponse | |
|
tags
|
tags | array of postTagRequestResponse | |
|
介质
|
media | array of postMediaRequestResponse | |
|
图像
|
images | object | |
|
candidateImages
|
candidateImages | array of postCandidateImageResponse | |
|
可见
|
visible | boolean |
帖子当前是否可见 |
|
shareDisclosures
|
shareDisclosures | array of postShareDisclosureResponse | |
|
shareCommentRules
|
shareCommentRules | array of postShareCommentRulesResponse | |
|
语言
|
language | string |
帖子内容的语言 |
|
用户隐藏
|
userHidden | boolean |
用户是否从一个或多个流中隐藏了帖子 |
|
由用户查看
|
isViewedByUser | boolean |
帖子是否已由当前用户查看。 |
|
用户正在查看讨论
|
isDiscussionViewedByUser | boolean |
帖子讨论线程是否已由当前用户查看 |
|
被用户喜欢
|
isLikedByUser | boolean |
当前用户是否在内部喜欢帖子。 |
|
由用户注释
|
isCommentedByUser | boolean |
该帖子是否已由当前用户评论。 |
|
由用户共享
|
isSharedByUser | boolean |
帖子是否以前由当前用户共享 |
|
目标
|
targets | array of targetOverviewResponse | |
|
categories
|
categories | array of categoryOverviewResponse | |
|
当前时间
|
currentTime | date-time |
服务器上的当前时间。 |
categoryOverviewResponse
基本类别信息
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
ID
|
id | integer |
类别 ID |
|
Name
|
name | string |
类别名称 |
|
父类别 ID
|
parentCategoryId | integer |
父类别 ID |
targetOverviewResponse
由目标名称、ID 及其所属的目标定义的 ID 组成的轻型目标响应
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Name
|
name | string |
目标名称 |
|
ID
|
id | integer |
目标 ID |
|
定义 ID
|
definitionId | integer |
目标所属的目标定义的 ID |
postShareCommentRulesResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
提供商
|
provider | string | |
|
共享最大字符限制
|
shareMaxCharacterLimit | integer |
此提供程序上的共享中用户注释的最大长度。 |
postShareDisclosureResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
提供商
|
provider | string | |
|
提供程序显示名称
|
providerDisplayName | string |
提供程序显示名称 |
|
共享披露文本
|
shareDisclosureText | string |
追加到每个共享的披露文本 |
postCandidateImageResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
网址
|
url | string |
图像 URL |
|
宽度
|
width | integer |
图像宽度 |
|
高度
|
height | integer |
图像高度 |
|
Mime 类型
|
mimeType | string |
图像 MIME 类型 |
|
Ssl Url
|
sslUrl | string |
图像安全 URL |
postMediaRequestResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Name
|
name | string |
媒体对象的名称 |
|
宽度
|
width | integer |
媒体对象的宽度（以像素为单位） |
|
高度
|
height | integer |
媒体对象的高度（以像素为单位） |
|
Mime 类型
|
mimeType | string |
媒体对象的 MIME 类型 |
|
Html
|
html | string |
可用于呈现媒体对象的 HTML |
|
网址
|
url | string |
媒体对象的 URL |
|
Origin
|
origin | string |
如果可用，请指定媒体对象的原始位置 |
|
Provider
|
provider | string |
社交提供程序名称 |
|
角色
|
role | string |
媒体类型（如果确定） |
|
持续时间
|
duration | integer |
视频持续时间（以毫秒为单位） |
|
Description
|
description | string |
视频格式说明 |
|
具有视频 URL
|
hasVideoUrl | boolean |
指示此媒体具有必须使用“WatchVideo”包括进行签名的视频 URL |
postTagRequestResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Name
|
name | string |
标记名称 |
postLinkRequestResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
网址
|
url | string |
帖子 URL |
|
展开的 URL
|
expandedUrl | string |
展开的 URL（如果存在） |
|
Title
|
title | string |
帖子标题 |
|
域名
|
domain | string |
链接域 |
|
Favicon Url
|
faviconUrl | string |
链接的 favicon URL |
|
Name
|
name | string |
社交提供商分配的链接的名称 |
|
标题
|
caption | string |
链接的简短标题（即链接下的文本） |
|
Description
|
description | string |
链接的说明（即标题下的较长文本） |
|
修改日期
|
modifiedDate | date-time | |
|
创建日期
|
createdDate | date-time |
postAuthorRequestResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
作者
|
author | string |
要显示为作者的存储文本。 |
|
配置文件图像 URL
|
profileImageUrl | string |
作者个人资料图片在社交网络 |
|
提供程序用户 ID
|
providerUserId | string |
社交网络上的作者 ID |
|
提供程序用户名
|
providerUserName | string |
社交网络上的作者名称 |
|
配置文件 URL
|
profileUrl | string |
社交网络上的作者个人资料 URL |
|
发布源名称
|
postSourceName | string |
帖子源的名称。 |
|
发布源网站
|
postSourceSite | string |
发布来源的网站 |
postUserShareInfoResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
赚取的积分
|
pointsEarned | integer |
用户为共享赚取的积分数 |
|
共享计数
|
shareCount | integer |
用户共享的次数 |
|
最新共享日期
|
mostRecentShareDate | date-time |
此帖子中用户最近共享的日期 |
postStatisticsResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
应用共享计数中的总计
|
totalInAppShareCount | integer |
ShareCount 的同义词 |
|
跟踪 ID
|
trackingId | string | |
|
共享计数
|
shareCount | integer |
在应用中启动的已验证为已成功共享的共享计数 |
|
反应计数
|
reactionCount | integer |
股票的反应计数（如、转推等） |
|
印象计数
|
impressionCount | integer |
共享者好友和关注者发布帖子的潜在视图 |
|
查看计数
|
viewedCount | integer |
登录用户访问帖子的次数 |
|
单击计数
|
clickCount | integer |
来自共享的帖子链接的点击次数 |
|
Like Count
|
likeCount | integer |
帖子中的内部赞数 |
|
注释计数
|
commentCount | integer |
帖子中的内部评论计数 |
|
批注赞计数
|
commentLikeCount | integer |
帖子中所有内部评论中所有赞的总和 |
userOverviewResponse
有关用户的摘要信息
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
用户 ID
|
userId | integer |
用户的 ID |
|
显示名称
|
displayName | string |
用户的显示名称 |
|
profilePictureImages
|
profilePictureImages | object | |
|
处于活动状态
|
isActive | boolean |
用户是否仍然是社区的活动成员 |
uploadImageResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
图像标识符
|
imageIdentifier | string |
已上传图像的标识符 |
userRequestResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
ID
|
id | integer |
用户内部 ID |
|
Email
|
string |
用户电子邮件地址 |
|
|
处理
|
handle | string |
用户句柄（“用户名”） |
|
显示名称
|
displayName | string |
用户首选显示名称 |
|
完整姓名
|
fullName | string |
用户的名字和姓氏 |
|
名字
|
firstName | string |
用户名字 |
|
姓氏
|
lastName | string |
用户姓氏 |
|
displayNameFormat
|
displayNameFormat | string | |
|
状态
|
status | string | |
|
配置文件已完成
|
profileCompleted | boolean |
用户个人资料是否已在载入过程中完成 |
|
上次活动日期
|
lastActivityDate | date-time |
用户上次与系统交互的时间。 |
|
Title
|
title | string |
用户标题 |
|
位置
|
location | string |
用户自我描述的位置（可能不是实际地理位置） |
|
外部 API 用户 ID
|
externalApiUserId | string |
此 API 调用方管理的外部系统上的用户 ID |
|
管理器用户 ID
|
managerUserId | integer |
用户管理器的 ID（适用于组织层次结构功能） |
|
时区
|
timeZone | string |
由 IANA 设置的用户时区表示为 tz 数据库时区名称。 示例：“America/Los_Angeles”。 |
|
所选时区
|
selectedTimeZone | string |
用户选择的时区表示为 IANA 设置的 tz 数据库时区名称。 示例：“America/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 |
用户是否设置为使用 SSO 进行身份验证 |
|
|
permissions | userPermissionsResponse |
管理员权限 |
|
|
privileges | userPrivilegesResponse |
用户特权 |
|
标识符
|
identifiers | array of allowlistIdentifiersResponse | |
|
目标
|
targets | array of targetOverviewResponse | |
|
|
defaults | userDefaultsRequestResponse |
用户默认值的集合 |
|
欢迎横幅已消除
|
welcomeBannerDismissed | boolean |
用户是否已取消欢迎横幅 |
userDefaultsRequestResponse
用户默认值的集合
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
defaultPostState
|
defaultPostState | string | |
|
defaultPostApprovalState
|
defaultPostApprovalState | string | |
|
默认帖子显示内部讨论
|
defaultPostShowInternalDiscussions | boolean |
创建帖子时，用户默认发布内部讨论状态 |
|
默认发布发布创建者信息
|
defaultPostShowCreatorInfo | boolean |
创建有关显示创建者名称和照片的帖子时，用户默认状态 |
allowlistIdentifiersResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
ID
|
id | integer |
允许列表定义 ID |
|
价值
|
value | string |
给定允许列表定义的用户响应 |
userPrivilegesResponse
用户特权
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
可以提交帖子
|
canSubmitPosts | boolean |
指示用户是否能够根据他们的特权和社区设置提交帖子 |
|
可以共享帖子
|
canSharePosts | boolean |
指示用户是否能够根据其特权和社区设置共享帖子 |
|
可以评论帖子
|
canCommentPosts | boolean |
根据用户的权限和社区设置，指示用户是否能够评论和喜欢帖子 |
|
可以管理社区
|
canManageCommunity | boolean |
指示用户是否是社区中的经理，具体取决于其特权和社区设置 |
|
可以管理组织
|
canManageOrganization | boolean |
指示用户是否能够根据用户的特权和社区设置与社区内的直接和间接报告进行通信 |
|
可以设置发布可共享
|
canSetPostShareable | boolean |
提交帖子时用户是否可以设置可共享状态 |
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
用户通道。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
用户频道 ID
|
userChannelId | integer |
内部用户通道 ID |
|
用户 ID
|
userId | integer |
内部用户 ID |
|
提供商
|
provider | string | |
|
Name
|
name | string |
社交提供商上的用户名称 |
|
显示名称
|
displayName | string |
用户在社交提供商上显示名称 |
|
提供程序用户 ID
|
providerUserId | string |
提供程序用户 ID |
|
状态
|
status | string | |
|
网址
|
url | string |
通道的 URL |
|
朋友
|
friends | integer |
用户在频道上拥有的朋友数 |
|
关注者
|
followers | integer |
用户在频道上拥有的追随者数 |
|
关注
|
following | integer |
用户在频道上关注的人数 |
|
职位
|
posts | integer |
用户在频道上发布的帖子数。 |
|
Views
|
views | integer |
用户在频道上拥有的视图数 |
|
点平衡
|
pointBalance | integer |
通道上用户的点平衡 |
|
源显示名称
|
sourceDisplayName | string |
用作内容源时用户通道的显示名称 |
|
Reach
|
reach | integer |
用户在频道上访问 |
|
共享
|
sharable | boolean |
通道是否支持共享 |
|
共享默认值
|
sharingDefault | boolean |
是否预选频道进行共享 |
|
需要身份验证
|
authRequired | boolean |
是否需要续订通道凭据 |
|
|
statistics | postStatisticsResponse | |
|
profilePictureImages
|
profilePictureImages | object |
divisionResponse
除法定义
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
分区 ID
|
divisionId | integer |
除法 ID |
|
Name
|
name | string |
除号名称 |
|
父分区 ID
|
parentDivisionId | integer |
此除法父级的 ID |
userAffiliationResponse
用户关联
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
|
question | affiliationQuestionResponse |
附属问题 |
|
|
answer | affiliationAnswerResponse |
附属答案 |
affiliationAnswerResponse
附属答案
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
答案 ID
|
answerId | integer |
答案 ID |
|
答案
|
answer | string |
答案 |
|
得分
|
score | double |
分数（如果提供） |
|
自由文本
|
freeText | string |
包含 FreeText 问题类型的问题的文本 |
|
拒绝回答
|
declineToAnswer | boolean |
如果已设置，则表示用户拒绝回答问题的答案。 |
|
Position
|
position | integer |
答案排序位置 |
affiliationQuestionResponse
附属问题
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
问题 ID
|
questionId | integer |
问题 ID |
|
Name
|
name | string |
问题 |
|
评分位置
|
scorePosition | integer |
问题排序位置 |
|
Description
|
description | string |
问题说明 |
|
questionType
|
questionType | string | |
|
必选
|
required | boolean |
是否必须回答问题进行注册 |
|
公开可见
|
isPubliclyVisible | boolean |
documentInfoResponse
与附加文档相关的信息
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
ID
|
id | uuid |
文档 ID |
|
文件名
|
fileName | string |
文档文件名（带扩展名） |
|
Extension
|
extension | string |
文档文件扩展名 |
|
Mime 类型
|
mimeType | string |
文档 MIME 类型 |
divisionsResponse
系统中定义的部门
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
部门
|
divisions | array of divisionResponse | |
|
Prompt
|
prompt | string |
提示成员选择分区的标签 |
|
显示用户划分选择
|
showUserDivisionSelection | boolean |
注册成员是否可以更改自己的部门 |
|
在载入期间显示用户划分选择
|
showUserDivisionSelectionDuringOnboarding | boolean |
新成员是否应在注册期间选择自己的部门 |
|
需要用户划分选择
|
requireUserDivisionSelection | boolean |
成员是否必须选择自己的分区。 |
|
允许多个除法
|
allowMultipleDivisions | boolean |
是允许成员选择多个还是只选择一个除法 |
categoryResponse1
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
ID
|
id | integer |
类别 ID |
|
Name
|
name | string |
类别名称 |
|
Description
|
description | string |
类别说明 |
|
显示顺序
|
displayOrder | integer |
显示类别的顺序 |
|
固定
|
isPinned | boolean |
类别是否已由管理员固定 |
|
强制
|
isForced | boolean |
经过身份验证的用户是否强制订阅给定类别 |
|
是否已订阅
|
isSubscribed | boolean |
Wther 已对经过身份验证的用户订阅给定类别 |
|
已隐藏
|
isHidden | boolean |
该类别是否由管理员隐藏 |
|
用户是否可选择
|
isUserSelectable | boolean |
是否允许用户为提交的文章选择类别 |
|
父类别 ID
|
parentCategoryId | integer |
父类别 ID |
targetInfoResponse1
特定目标的详细信息。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
ID
|
id | integer |
目标 ID |
|
Name
|
name | string |
目标的名称 |
|
Description
|
description | string |
目标 descritption |
|
定义 ID
|
definitionId | integer |
目标所属的目标定义的 ID |
|
父 ID
|
parentId | integer |
目标父级的 ID（如果有） |
|
是否已订阅
|
isSubscribed | boolean |
用户是否订阅特定目标 |
|
childTargets
|
childTargets | array of targetInfoResponse2 |
targetInfoResponse2
特定目标的详细信息。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
ID
|
id | integer |
目标 ID |
|
Name
|
name | string |
目标的名称 |
|
Description
|
description | string |
目标 descritption |
|
定义 ID
|
definitionId | integer |
目标所属的目标定义的 ID |
|
父 ID
|
parentId | integer |
目标父级的 ID（如果有） |
|
是否已订阅
|
isSubscribed | boolean |
用户是否订阅特定目标 |
|
childTargets
|
childTargets | array of targetInfoResponse3 |
targetInfoResponse3
特定目标的详细信息。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
ID
|
id | integer |
目标 ID |
|
Name
|
name | string |
目标的名称 |
|
Description
|
description | string |
目标 descritption |
|
定义 ID
|
definitionId | integer |
目标所属的目标定义的 ID |
|
父 ID
|
parentId | integer |
目标父级的 ID（如果有） |
|
是否已订阅
|
isSubscribed | boolean |
用户是否订阅特定目标 |