跳至主要内容
文档
文档
Adaptive Planning
上次更新时间 ：2024-03-08
组

组

URL 端点

HTTPS://api.adaptiveplanning.com/api/rest/security/<version>/<tenant>/groups/{groupID}
版本：v1
种类
元数据检索
描述
返回为给定实例定义的所有组的完整列表。这包括在整个实例中全局定义的组，以及由用户定义的组。
调用所需的权限
管理员访问权限 > 用户
请求时需要的参数
凭据

支持的 HTTP VERB

HTTP 谓词
单一资源
收款资源
描述
GET
支持
支持
从 Planning 中检索组。

GET：

请求：
/groups/{groupId}
检索为给定实例定义的所有组及其用户/成员的列表。
请求 URI 示例：
HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/groups?instanceCode=globalsales&offset=2&limit=1
请求标头示例：
接受-语言：en
请求正文示例
查询参数
名称
描述
必填
groupId
要单独返回的组的编号
否
includeUsers
确定是否返回被呼叫组的用户。默认情况下，“包括用户”选项处于开启状态。
否
limit
单个响应中的最大对象数。
否
offset
每页显示一定数量的组。如果组数超过限制，则超出的组将进入下一页。要访问特定页面，您需要指定偏移值。
否
instanceCode
默认情况下，它将返回为用户指定的默认实例。通过提供值，您可以调用用户有权访问的实例，包括父级/子级实例。
否
示例回复
示例回复
 
{
   "links": {
       "next": "HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/groups?instanceCode=TENANT&offset=2&limit=1",
       "previous": "HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/groups?instanceCode=TENANT&offset=0&limit=1"
   },
   "total": 3,
   "groups": [
       {
           "id": 2,
           "name": "Admins",
           "groupType": "NATIVE",
           "users": [
               {
                   "userGuid": "randomValue",
                   "wid": "",
                   "userName": "test@email.com"
               },
               {
                   "userGuid": "randomValue",
                   "wid": "",
                   "userName": "test2@email.com"
               },
           ]
       },
       {
           "id": 1,
           "name": "Corporate and Operations",
           "groupType": "NATIVE",
           "users": []
       },
       {
           "id": 3,
           "name": "Ops and Admins",
           "groupType": "NATIVE",
           "users": [],
           "groups": [
               {
                   "id": 2,
                   "name": "Admins",
                   "groupType": "NATIVE"
               },
               {
                   "id": 1,
                   "name": "Corporate and Operations",
                   "groupType": "NATIVE"
               }
           ]
       }
   ]
}
回复元素
标记名称
回复
元素的属性
属性名称
必填？
值
示例
总计
是
组总数
3
组
是
所有组或指定组的组信息。如果某个组位于另一个组内，该组还会显示与指定组关联的组。
{
"id": 1,
"name": "Corporate and Operations",
"groupType": "NATIVE",
"users": []
}
groupType
是
显示组的类型。
外部
编号
是
组的关联编号。
1
名称
是
组的名称。
“管理员”
用户
否
如果 includeUsers = true 或 includeUsers 为默认值，则系统会为其提供用户的 GUID、WID 和用户名。否则不予退回。
"users": [
{
"userGuid": "randomValue",
"wid": "",
"userName": "test@example.com"
},
{
"userGuid": "randomValue",
"wid": "",
"userName": "test2@example.com"
}
链接
否
如果提供了限额和/或抵销，并且您需要一种方法来移至组的不同页面，则可以使用链接来回移动。
"links": {
"next": "HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/groups?instanceCode=TENANT&offset=2&limit=1",
"previous": "HTTPS://api.adaptiveinsights.com/api/rest/security/v1/default/groups?instanceCode=TENANT&offset=0&limit=1"
}
下一个
否
如果提供了限制，并且存在可用的下一页，则“链接”将与“下一页”一起显示。
"HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/groups?instanceCode=TENANT&offset=2&limit=1"
上一个
否
如果提供了限制和偏移，并且您恰好处于具有上一页和下一页的中间位置，则可以使用“上一页”。
"HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/groups?instanceCode=TENANT&offset=2&limit=1"
元素的内容
与指示的元素相关的信息。
错误响应
错误
原因
为限制和偏移指定有效参数值。
限制/偏移值的输入无效
GroupAPI：对于 getGroupByGroupId，未找到实例代码的组：{TENANT}
实例代码不存在 groupId
您没有运行此 API 的所有权限：管理全局用户组。
用户凭据没有适当的权限，无法调用 API
凭据无效
使用的凭据对于实例不正确
未找到 HTTP 404
groupId 参数无效