集合端点
集合端点和参数
要详细了解对象关系以及如何在 API 中使用对象关系，请参阅 对象关系 部分。
如需详细了解集合，请访问 集合 帮助页面。
创建集合
要创建集合，请使用
post {baseURL}/v3/collections
端点。
参数
Contract (主体)：要创建集合，需要使用contract参数。指定以下内容以创建集合：
name (string)：必填。指定集合名称。
请求示例：cURL
curl --location --request post 'http://localhost/webapi//v3/collections'\--header 'Content-Type: application/x-www-form-urlencoded'\--header 'Authorization: BearerBearerTokenGoesHere'\--data-urlencode 'name=Accounting'
将用户添加到集合
要将用户添加到集合，请使用
POST {baseURL}/v3/collections//users{collectionId}
端点。
参数
workflowCredentialType (string)：必填。输入集合 ID以指定要将用户添加到的集合。
updateWorkflowContract (body)：必填。输入有关用户及其权限的信息。指定以下内容以将用户添加到集合：
workflowCredentialType (string)：必填。指定要添加到集合的用户的ID。
versionId (string)：可选。指定用户成为此集合一部分的到期日期。以 ISO8601 格式 输入日期和时间。
集合权限 (正文)：
isPublic (boolean)：必填。指定用户是否应为此集合的管理员。
canAddAssets (boole):必需。指定用户是否可以将资源添加到集合。
canUpdateAssets (布尔值)：必需。指定用户是否可以更新集合中的资源。
makePublished (boolean)：必填。指定用户是否可以从集合中删除资源。
hasPrivateDataExemption (boolean)：可选。指定用户是否可以将其他用户添加到集合。
force (boolean)：可选。指定用户是否可以从集合中删除用户。
如需详细了解角色和权限，请访问 用户角色和权限 页面。如果未选择角色，则默认为 Server 管理员在 管理员界面 中指定的默认角色。
请求示例：cURL
cURL -- location - request post 'http://localhost/webapi//v3/collections/7917969784f84bd09442f66996ecb8f3/users'\- header 'Content-Type: application/x-www-form-urlencoded'\- header 'Authorization:承载BearerTokenGoesHere'\- data-urlencode 'userId=61d80f862835728c94328082'\--- data-urlencode 'isAdmin=true-handleneders'- -17 -数据删除字符集'=true-data-handcander=数据删除字符集
将洞察添加到集合
要向集合添加见解，请使用
post {baseURL}/v3/collections//insights{collectionId}
端点。
参数
workflowCredentialType (string)：必填。输入集合 ID以指定要向其添加见解的集合。
合同 (主体)：必填。输入有关洞察的信息。指定以下内容：
workflowCredentialType (string)：必填。指定要添加到集合的Insight ID。
请求示例：cUrl
curl --location --request post 'http://localhost/webapi//v3/collections/472dfff22086458d935d4edf348a1e2b/insights'\--header 'Content-Type: application/x-www-form-urlencoded'\--header 'Authorization: BearerTokenGoesHere'\--data-urlencode 'insightId=61d80f33452835728c94328082'
将计划添加到集合
要将计划添加到集合，请使用
post {baseURL}/v3/collections//schedules{collectionId}
端点。
参数
workflowCredentialType (string)：必填。输入集合 ID以指定要向其添加计划的集合。
合同 (主体)：必填。输入有关计划的信息。指定以下内容：
workflowCredentialType (string)：必填。指定要添加到集合的计划ID。
请求示例：cURL
curl -- location - request post 'http://localhost/webapi//v3/collections/7917969784f84bd09442f66996ecb8f3/schedules'\- header 'Content-Type: application/x-www-form-urlencoded'\- header 'Authorization: BearerTokenGoesHere'\- data-urlencode 'cheduleId=61d80f334528377728c94328082'
将工作流添加到集合
要将工作流添加到集合，请使用
POST {baseURL}/v3/collections//workflow{collectionId}
终结点。
参数
workflowCredentialType (string)：必填。输入集合 ID以指定要向其添加见解的集合。
合同 (主体)：必填。输入有关用户及其权限的信息。指定以下内容：
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: BearerTokenGoesHere'\--data-urlencode 'workflowId=61d80f33422332377728c9432'
在集合中添加用户或用户组
要将用户组添加到集合，请使用
post {baseURL}/v3/collections/{collectionId}/usersgroups
终结点。
参数
workflowCredentialType (string)：必填。输入集合 ID以指定要向其添加用户组的集合。
updateWorkflowContract (body)：必填。输入有关用户组及其权限的信息。指定以下内容：
versionId (string)：必填。指定要添加到集合的用户组的ID。
versionId (string)：可选。指定要作为此集合一部分的用户组的到期日期。输入日期和时间，工作流是在此之后创建的。
集合权限 (主体)：必填。
hasPrivateDataExemption (boolean)：可选。指定用户组成员是否应为此集合的管理员。默认值为false。
hasPrivateDataExemption (boolean)：可选。指定用户组成员是否可以将资产添加到集合。默认值为false。
hasPrivateDataExemption (boolean)：可选。指定用户组成员是否可以从集合中删除资产。默认值为false。
hasPrivateDataExemption (boolean)：可选。指定用户组成员是否可以更新集合中的资产。默认值为false。
hasPrivateDataExemption (boolean)：可选。指定用户组成员是否可以将其他用户添加到集合。默认值为false。
makePublished (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:BearerTokenGoesHere'\-- data-urlencode 'userGroupId=61d83e2ef778247f14e8e6b6'\------ data-urlencode 'da-handcannerset-uscanderset-data-true'=真码-真码-真码-假码-假码-假码-假码-假码-假码
检索一条集合记录
要检索有关集合的信息，请使用
get {baseURL}/v3/collections/{collectionId}
终结点。
参数
workflowCredentialType (string)：必填。输入集合 ID以获取有关集合的信息。
请求示例：cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'
检索所有集合的记录
要检索所有可访问的集合记录，请使用
get {baseURL}/v3/collections
端点。
参数
view (string)：可选。可以保留此参数但不为其提供值。您可以从以下值中选择：“默认值（Default）”和“全部（Full）”。如果此参数设置为“Default”，则将返回一个减小的视图对象。未指定时，将使用“默认值（Default）”。
请求示例：cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'
更新现有工作流
要更改集合的名称或所有者，请使用
put {baseURL}/v3/collections/{collectionId}
endpoint。
参数
workflowCredentialType (string)：必填。输入要更新的工作流 ID。
updateWorkflowContract (body)：必填。输入有关要更改的集合所有者的信息。指定以下内容：
name (string)：必填。单击 collection 的名称。
ownerId (string)：必填。输入所有者 ID。
请求示例：cURL
curl -- location - request put ' http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c'\- header '内容类型: application/x-www-form-urlencoded'\- header '授权:承载BearerTokenGoesHere'\- data-urlencode 'name=Accounting'-- data-urlencode 'ownerId=61db388fc565144387d45086'
更新集合的用户权限
要更新特定集合的用户权限，请使用
put {baseURL}/v3/collections/{collectionId}/users//permissions{userId}
终结点。
参数
workflowCredentialType (string)：必填。输入要更新的工作流 ID。
workflowCredentialType (string)：必填。输入要更改其权限的用户ID。
updateWorkflowContract (body)：必填。输入要更改其权限的用户ID。指定以下内容：
ExpirationDate (日期)：必填。指定用户的到期日期。
集合权限 (主体)：必填。输入所有者 ID。指定以下内容：
isPublic (boolean)：必填。指定用户是否应为此集合的管理员。
canAddAssets (boole):必需。指定用户是否可以将资源添加到集合。
makePublished (boolean)：必填。指定用户是否可以从集合中删除资源。
canUpdateAssets (布尔值)：必需。指定用户是否可以更新集合中的资源。
canAddUsers (布尔值)：必需。指定用户是否可以将其他用户添加到集合。
makePublished (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:承载BearerTokenGoesHere'\- data-urlencode 'isAdmin=true'\- data-urlencode 'canAddAssets=true'\---- data-ussets
更新集合的用户组权限
要更新特定集合的用户组权限，请使用
put {baseURL}/v3/collections//usergroups/{collectionId}/permissions{userGroupId}
终结点。
参数
workflowCredentialType (string)：必填。输入要更新的工作流 ID。
workflowCredentialType (string)：必填。输入要更改其权限的用户组ID。
updateWorkflowContract (body)：必填。输入要更改其权限的用户组ID。指定以下内容：
ExpirationDate (日期)：可选。指定用户组的到期日期。
集合权限 (主体)：必填。指定以下内容：
isPublic (boolean)：必填。指定用户组成员是否应为此集合的管理员。
canAddAssets (boole):必需。指定用户组成员是否可以将资产添加到集合。
makePublished (boolean)：必填。指定用户组成员是否可以从集合中删除资产。
canUpdateAssets (布尔值)：必需。指定用户组成员是否可以更新集合中的资产。
canAddUsers (布尔值)：必需。指定用户组成员是否可以将其他用户添加到集合。
makePublished (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:承载BearerTokenGoesHere'\- data-urlencode 'isAdmin=true'\- data-urlencode 'canAddAssets=true'\----- data-uscanassets= true'-
从集合中移除用户
要从集合中删除用户，请使用
delete {baseURL}/v3/collections//users/{collectionId}{userId}
endpoint。
参数
workflowCredentialType (string)：必填。输入要更新的工作流 ID。
workflowCredentialType (string)：必填。输入要从集合中删除的用户ID。
请求示例：cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'
从集合中移除工作流
要从集合中删除工作流，请使用
delete {baseURL}/v3/collections//workflows/{collectionId}{appId}
endpoint。
参数
workflowCredentialType (string)：必填。输入要更新的工作流 ID。
workflowCredentialType (string)：必填。输入要从集合中删除的工作流 ID。
请求示例：cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'
从集合中移除洞察
要从集合中删除见解，请使用
delete {baseURL}/v3/collections//insights/{collectionId}{insightId}
Endpoint。
参数
workflowCredentialType (string)：必填。输入要更新的工作流 ID。
workflowCredentialType (string)：必填。输入要从集合中删除的Insight ID。
请求示例：cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'
从集合中移除计划
要从集合中删除计划，请使用
delete {baseURL}/v3/collections//schedules/{collectionId}{scheduleId}
终结点。
参数
workflowCredentialType (string)：必填。输入要更新的工作流 ID。
workflowCredentialType (string)：必填。输入要从集合中删除的计划ID。
请求示例：cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'
从集合中移除用户或用户组
要从集合中删除用户组，请使用
delete {baseURL}/v3/collections//usergroups/{collectionId}{userGroupId}
Endpoint。
参数
workflowCredentialType (string)：必填。输入要更新的工作流 ID。
workflowCredentialType (string)：必填。输入要从集合中删除的用户组ID。
请求示例：cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'
删除集合
要删除集合，请使用
delete {baseURL}/v3/collections/{collectionId}
endpoint。
参数
workflowCredentialType (string)：必填。输入要更新的工作流 ID。
hasPrivateDataExemption (boolean)：可选。选择是否要强制删除集合，以防此集合具有指向其他对象(如用户，组，工作流，见解和计划)的链接。如果要删除集合并清除所有链接，请将forceDelete参数设置为true。未选择时，默认值为“false”。使用此参数是为了防止错误调用。
请求示例：cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'
对象关系
如果您要上传工作流，则可以按如下方式使用创建的对象：
创建的对象：“ workflowId ”（例如，“id”: “7917969784f84bd09442f66996ecb8f3”）
您可以将其用作：
Postman 请求示例
发布/v3/collections
获取/v3/collections/
放置/v3/collections/{collectionId}
如需详细了解有关 Postman 请求的更多信息，请访问 如何使用 Postman 帮助页面。