Skip to main content

集合端点

集合端点和参数

创建集合

将用户添加到集合

将洞察添加到集合

将计划添加到集合

将工作流添加到集合

将用户组添加到集合

检索集合记录

检索所有集合的记录

更新现有集合

更新集合的用户权限

更新集合的用户组权限

从集合中移除用户

从集合中移除工作流

从集合中移除洞察

从集合中移除计划

从集合中移除用户组

删除集合

要详细了解对象关系以及如何在 API 中使用对象关系,请转至对象关系部分。

如需详细了解集合,请访问集合帮助页面。

创建集合

要创建集合,请使用 POST {baseURL}/v3/collections 端点。

参数

  • 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 端点。

082A8515AB7ADDAAD5B04255CF2AE567.png

参数

  • 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}/insights 端点。

参数

  • collectionId (string):必填。输入集合 ID 以指定要向其中添加洞察的集合。

  • contract (body):必填。输入有关洞察的信息。请指定以下参数:

    • insightId (string):必填。指定要添加到集合中的洞察 ID。

请求示例:cUrl

curl --location --request POST 'http://localhost/webapi//v3/collections/472dfff22086458d935d4edf348a1e2b/insights' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'insightId=61d80f33452835728c94328082'

将计划添加到集合

要将计划添加到集合,请使用 POST {baseURL}/v3/collections/{collectionId}/schedules 端点。

参数

  • 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 端点。

参数

  • 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 端点。

参数

  • 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} 端点。

参数

  • collectionId (string):必填。输入集合 ID 以获取有关集合的信息。

请求示例:cURL

curl --location --request GET 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c' \ --header 'Authorization: Bearer BearerTokenGoesHere'

检索所有集合的记录

要检索所有可访问的集合记录,请使用 GET {baseURL}/v3/collections 端点。

参数

  • 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} 端点。

参数

  • 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 端点。

参数

  • 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 端点。

参数

  • 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} 端点。

参数

  • 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} 端点。

参数

  • 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}/insights/{insightId} 端点。

参数

  • collectionId (string):必填。输入集合 ID 以指定要更新的集合。

  • insightId (string):必填。输入要从集合中移除的洞察 ID。

请求示例:cURL

curl --location --request DELETE 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c/insights/61db388fc565144387d450867' \ --header 'Authorization: Bearer BearerTokenGoesHere'

从集合中移除计划

要从集合中移除计划,请使用 DELETE {baseURL}/v3/collections/{collectionId}/schedules/{scheduleId} 端点。

参数

  • 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} 端点。

参数

  • 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} 端点。

参数

  • 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

Use POST /v3/collections endpoint.

GET /v3/collections/

Use GET /v3/collections endpoint.

PUT /v3/collections/{collectionId}

Use PUT /v3/collections/{collectionId} endpoint.

如需详细了解有关 Postman 请求的更多信息,请访问如何使用 Postman 帮助页面。