集合端点
集合端点和参数
要详细了解对象关系以及如何在 API 中使用对象关系，请转至 对象关系 部分。
如需详细了解集合，请访问 集合 帮助页面。
创建新的集合
要创建集合，请使用
POST {baseURL}/v3/collections
端点。
注意
只有管理员可以使用此 API 端点。经过身份验证的 API 用户必须具有“创建集合”权限才能使用此端点，否则将返回 401 未授权错误。
参数
contract (body)：要创建集合，必须指定 contract 参数。指定以下参数以创建集合：
name (string)：必填。指定集合名称。
请求示例：cURL
curl --location --request POST 'http://localhost/webapi//v3/collections' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'name=Accounting'
将用户添加到集合
要将用户添加到现有集合，请使用
POST {baseURL}/v3/collections/{collectionId}/users
端点。
注意
只有管理员可以使用此 API 端点。
参数
collectionId (string)：必填。输入集合 ID 以指定要向其中添加用户的集合。
addUsersContract (body)：必填。输入有关用户及其权限的信息。指定以下参数以将用户添加到集合：
userId (string)：必填。指定要添加到集合中的用户的 ID。
expirationDate (string)：可选。指定用户成为此集合一部分的截至日期。以 ISO8601 格式 输入日期和时间。
collectionsPermissions (body)：
isAdmin (boolean)：必填。指定用户是否应该是此集合的管理员。
canAddAssets (boolean)：必填。指定用户是否可以将资产添加到集合。
canUpdateAssets (boolean)：必填。指定用户是否可以更新集合中的资产。
canRemoveAssets (boolean)：必填。指定用户是否可以从集合中移除资产。
canAddUsers (boolean)：可选。指定用户是否可以将其他用户添加到集合。
canRemoveUsers (boolean)：可选。指定用户是否可以从集合中移除用户。
如需详细了解角色和权限，请访问 用户角色和权限 页面。如果未选择角色，则默认为 Server 管理员在 管理员界面 中指定的默认角色。
请求示例：cURL
curl --location --request POST 'http://localhost/webapi//v3/collections/7917969784f84bd09442f66996ecb8f3/users' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'userId=61d80f862835728c94328082' \ --data-urlencode 'isAdmin=true' \ --data-urlencode 'canAddAssets=true' \ --data-urlencode 'canRemoveAssets=true' \ --data-urlencode 'canUpdateAssets=true' \ --data-urlencode 'canAddUsers=true' \ --data-urlencode 'canRemoveUsers=true' \ --data-urlencode 'expirationDate=2007-08-17T19:18:11.924Z'
将计划添加到集合
要将计划添加到现有集合，请使用
POST {baseURL}/v3/collections/{collectionId}/schedules
端点。
注意
只有管理员可以使用此 API 端点。
参数
collectionId (string)：必填。输入集合 ID 以指定要向其中添加计划的集合。
contract (body)：必填。输入有关计划的信息。请指定以下参数：
scheduleId (string)：必填。指定要添加到集合中的计划 ID。
请求示例：cURL
curl --location --request POST 'http://localhost/webapi//v3/collections/7917969784f84bd09442f66996ecb8f3/schedules' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'scheduleId=61d80f334528377728c94328082'
将工作流添加到集合
要将工作流添加到现有集合，请使用
POST {baseURL}/v3/collections/{collectionId}/workflows
端点。
注意
只有管理员可以使用此 API 端点。
参数
collectionId (string)：必填。输入集合 ID 以指定要向其中添加洞察的集合。
contract (body)：必填。输入有关用户及其权限的信息。请指定以下参数：
workflowId (string)：必填。指定要添加到集合中的工作流 ID。
请求示例：cURL
curl --location --request POST 'http://localhost/webapi//v3/collections/7917969784f84bd09442f66996ecb8f3/workflows' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'workflowId=61d80f334223377728c9432'
将用户组添加到集合
要将用户组添加到现有集合，请使用
POST {baseURL}/v3/collections/{collectionId}/userGroups
端点。
注意
只有管理员可以使用此 API 端点。
参数
collectionId (string)：必填。输入集合 ID 以指定要向其中添加用户组的集合。
addUserGroupsContract (body)：必填。输入有关用户组及其权限的信息。请指定以下参数：
userGroupId (string)：必填。指定要添加到集合中的用户组的 ID。
expirationDate (string)：可选。指定用户组成为此集合一部分的截至日期。以 ISO8601 格式 输入日期和时间，用户是在此之后创建的。
collectionsPermissions (body)：必填。
isAdmin (boolean)：可选。指定用户组成员是否应该是此集合的管理员。默认值为 false。
canAddAssets (boolean)：可选。指定用户组成员是否可以将资产添加到集合。默认值为 false。
canRemoveAssets (boolean)：可选。指定用户组成员是否可以从集合中移除资产。默认值为 false。
canUpdateAssets (boolean)：可选。指定用户组成员是否可以更新集合中的资产。默认值为 false。
canAddUsers (boolean)：可选。指定用户组成员是否可以将其他用户添加到集合。默认值为 false。
canRemoveUsers (boolean)：必填。指定用户组成员是否可以从集合中移除其他用户。默认值为 false。
如需详细了解角色和权限，请访问 用户角色和权限 页面。如果未选择角色，则默认为 Server 管理员在 管理员界面 中指定的默认角色。
请求示例：cURL
curl --location --request POST 'http://localhost/webapi//v3/collections/7917969784f84bd09442f66996ecb8f3/userGroups?addUserGroupsContract' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'userGroupId=61d83e2ef778247f14e8e6b6' \ --data-urlencode 'isAdmin=true' \ --data-urlencode 'canAddAssets=false' \ --data-urlencode 'canRemoveAssets=true' \ --data-urlencode 'canUpdateAssets=false' \ --data-urlencode 'canAddUsers=true' \ --data-urlencode 'canRemoveUsers=true'
检索集合记录
要检索有关现有集合的详细信息，请使用
GET {baseURL}/v3/collections/{collectionId}
端点。
注意
只有管理员可以使用此 API 端点。
参数
collectionId (string)：必填。输入集合 ID 以获取有关集合的信息。
请求示例：cURL
curl --location --request GET 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c' \ --header 'Authorization: Bearer BearerTokenGoesHere'
检索所有集合的记录
要检索所有可访问的集合记录，请使用
GET {baseURL}/v3/collections
端点。
注意
只有管理员可以使用此 API 端点。
参数
view (string)：可选。可以保留此参数但不为其提供值。您可以从以下值中选择：“默认值”和“全部”。如果此参数设置为“Default”，则将返回一个减小的视图对象。未指定时，将使用“默认值（Default）”。
请求示例：cURL
curl --location --request GET 'http://localhost/webapi/v3/collections?view=Full' \ --header 'Authorization: Bearer BearerTokenGoesHere'
更新现有集合
要更新现有集合的名称和/或所有者，请使用
PUT {baseURL}/v3/collections/{collectionId}
端点。
注意
只有管理员可以使用此 API 端点。
参数
collectionId (string)：必填。输入集合 ID 以指定要更新的集合。
updateCollectionContract (body)：必填。输入有关要更改的集合所有者的信息。请指定以下参数：
name (string)：必填。输入集合的新名称。
ownerId (string)：必填。输入新所有者的 ID。
请求示例：cURL
curl --location --request PUT 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'name=Accounting' \ --data-urlencode 'ownerId=61db388fc565144387d45086'
更新集合的用户权限
要更新现有集合中的用户权限，请使用
PUT {baseURL}/v3/collections/{collectionId}/users/{userId}/permissions
端点。
注意
只有管理员可以使用此 API 端点。对于配置了 Windows 身份验证的 Server 实例，请为 userId 参数提供 Active Directory Sid。
参数
collectionId (string)：必填。输入集合 ID 以指定要更新的集合。
userId (string)：必填。输入要更改其权限的用户 ID。
updatePermissionsContract (body)：必填。输入要更改其权限的用户 ID。请指定以下参数：
expirationDate (date)：必填。指定用户的截至日期。
collectionsPermissions (body)：必填。输入新所有者的用户 ID。请指定以下参数：
isAdmin (boolean)：必填。指定用户是否应该是此集合的管理员。
canAddAssets (boolean)：必填。指定用户是否可以将资产添加到集合。
canRemoveAssets (boolean)：必填。指定用户是否可以从集合中移除资产。
canUpdateAssets (boolean)：必填。指定用户是否可以更新集合中的资产。
canAddUsers (boolean)：必填。指定用户是否可以将其他用户添加到集合。
canRemoveUsers (boolean)：必填。指定用户是否可以从集合中移除其他用户。
如需详细了解角色和权限，请访问 用户角色和权限 页面。如果未选择角色，则默认为 Server 管理员在 管理员界面 中指定的默认角色。
请求示例：cURL
curl --location --request PUT 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c/users/61db388fc565144387d45086/permissions' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'isAdmin=true' \ --data-urlencode 'canAddAssets=true' \ --data-urlencode 'canRemoveAssets=true' \ --data-urlencode 'canUpdateAssets=true' \ --data-urlencode 'canAddUsers=true' \ --data-urlencode 'canRemoveUsers=true'
更新集合的用户组权限
要更新现有集合中的用户组权限，请使用
PUT {baseURL}/v3/collections/{collectionId}/userGroups/{userGroupId}/permissions
端点。
注意
只有管理员可以使用此 API 端点。
参数
collectionId (string)：必填。输入集合 ID 以指定要更新的集合。
userGroupId (string)：必填。输入要更改其权限的用户组 ID。
updatePermissionsContract (body)：必填。输入要更改其权限的用户组 ID。请指定以下参数：
expirationDate (date)：可选。指定用户组的截至日期。
collectionsPermissions (body)：必填。请指定以下参数：
isAdmin (boolean)：必填。指定用户组成员是否应该是此集合的管理员。
canAddAssets (boolean)：必填。指定用户组成员是否可以将资产添加到集合。
canRemoveAssets (boolean)：必填。指定用户组成员是否可以从集合中移除资产。
canUpdateAssets (boolean)：必填。指定用户组成员是否可以更新集合中的资产。
canAddUsers (boolean)：必填。指定用户组成员是否可以将其他用户添加到集合。
canRemoveUsers (boolean)：必填。指定用户组成员是否可以从集合中移除用户。
如需详细了解角色和权限，请访问 用户角色和权限 页面。如果未选择角色，则默认为 Server 管理员在 管理员界面 中指定的默认角色。
请求示例：cURL
curl --location --request PUT 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c/userGroups/61db38834tssrdrs4cc65144387d4508/permissions' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'isAdmin=true' \ --data-urlencode 'canAddAssets=true' \ --data-urlencode 'canRemoveAssets=false' \ --data-urlencode 'canUpdateAssets=true' \ --data-urlencode 'canAddUsers=true' \ --data-urlencode 'canRemoveUsers=true'
从集合中移除用户
要从现有集合中移除用户，请使用
DELETE {baseURL}/v3/collections/{collectionId}/users/{userId}
端点。
注意
只有管理员可以使用此 API 端点。
参数
collectionId (string)：必填。输入集合 ID 以指定要更新的集合。
userId (string)：必填。输入要从集合中移除的用户 ID。
请求示例：cURL
curl --location --request DELETE 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c/users/61db388fc565144387d45086' \ --header 'Authorization: Bearer BearerTokenGoesHere'
从集合中移除工作流
要从现有集合中移除工作流，请使用
DELETE {baseURL}/v3/collections/{collectionId}/workflows/{appId}
端点。
注意
只有管理员可以使用此 API 端点。
参数
collectionId (string)：必填。输入集合 ID 以指定要更新的集合。
appId (string)：必填。输入要从集合中移除的工作流 ID。
请求示例：cURL
curl --location --request DELETE 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c/workflows/61db388fc565144387d45086' \ --header 'Authorization: Bearer BearerTokenGoesHere'
从集合中移除计划
要从现有集合中移除计划，请使用
DELETE {baseURL}/v3/collections/{collectionId}/schedules/{scheduleId}
端点。
注意
只有管理员可以使用此 API 端点。
参数
collectionId (string)：必填。输入集合 ID 以指定要更新的集合。
scheduleId (string)：必填。输入要从集合中移除的计划 ID。
请求示例：cURL
curl --location --request DELETE 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c/schedules/61db3777c565144387d450867' \ --header 'Authorization: Bearer BearerTokenGoesHere'
从集合中移除用户组
要从现有集合中移除用户组，请使用
DELETE {baseURL}/v3/collections/{collectionId}/userGroups/{userGroupId}
端点。
注意
只有管理员可以使用此 API 端点。
参数
collectionId (string)：必填。输入集合 ID 以指定要更新的集合。
userGroupId (string)：必填。输入要从集合中移除的用户组 ID。
请求示例：cURL
curl --location --request DELETE 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c/userGroups/61dc063d9938fe43b5e8fc80' \ --header 'Authorization: Bearer BearerTokenGoesHere'
删除集合
要删除集合，请使用
DELETE {baseURL}/v3/collections/{collectionId}
端点。
注意
只有管理员可以使用此 API 端点。
参数
collectionId (string)：必填。输入集合 ID 以指定要更新的集合。
forceDelete (boolean)：可选。选择是否要强制删除某个集合，以防该集合具有指向其他对象（例如用户、组、工作流、洞察和计划）的链接。如果您想要删除集合并清除所有链接，请将 forceDelete 参数设置为 true。如果未选择，则默认值为 false。使用此参数是为了防范错误调用。
请求示例：cURL
curl --location --request DELETE 'http://localhost/webapi/v3/collections/253fcf0b10204dc085f07bdf1b40e759?forceDelete=true' \ --header 'Authorization: Bearer BearerTokenGoesHere'
对象关系
如果您要创建集合，则可以按如下方式使用创建的对象：
创建的对象：“ id ”（例如：“id”: “7917969784f84bd09442f66996ecb8f3”）
您可以将其用作：
Postman 请求示例
POST /v3/collections
GET /v3/collections/
PUT /v3/collections/{collectionId}
如需详细了解有关 Postman 请求的更多信息，请访问 如何使用 Postman 帮助页面。