メインコンテンツにスキップ
ドキュメント
ドキュメント
Adaptive Planning
最終更新: 2024-03-08
グループ

グループ

URL エンドポイント

HTTPS://api.adaptiveplanning.com/api/rest/security/<version>/<tenant>/groups/{groupID}
バージョン: v1
カテゴリ
メタデータの取得
説明
指定されたインスタンスに対して定義されたすべてのグループの完全なリストを返します。これには、インスタンス全体でグローバルに定義されたグループと、ユーザーによって定義されたグループが含まれます。
起動に必要な権限
"管理アクセス" > "ユーザー"
リクエストに応じてパラメータが必要
認証情報

サポートされている HTTP VERB

HTTP Verb
単一リソース
回収リソース
説明
GET
サポート済
サポート済
Planning からグループを取得します。

GET:

リクエスト:
/groups/{groupId}
指定されたインスタンスに定義されたすべてのグループとそのユーザー/メンバーのリストを取得します。
リクエスト URI の例:
HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/groups?instanceCode=globalsales&offset=2&limit=1
リクエスト ヘッダーの例:
受諾言語: en
リクエスト本文の例
クエリー パラメータ
名前
説明
必須
groupId
個別に取得するグループの ID
なし
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
あり
グループのタイプを表示します。
外部
ID
あり
グループの関連付けられた ID
1
名前
あり
グループの名前。
"Admins"
ユーザー
なし
includeUsers = true または includeUsers がデフォルトの場合、ユーザーの GUID、WID、およびユーザー名が提供されます。そうしない場合、返されません。
"users": [
{
"userGuid": "randomValue",
"wid": "",
"userName": "test@example.com"
},
{
"userGuid": "randomValue",
"wid": "",
"userName": "test2@example.com"
}
リンク
なし
limit および/または offset が指定されていて、グループの異なるページに移動する手段が必要な場合は、リンクを使用して前後に移動できます。
"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"
}
next
なし
limit が指定されていて、使用可能な次のページがある場合、"リンク" に "next" が表示されます。
"HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/groups?instanceCode=TENANT&offset=2&limit=1"
前
なし
limit & offset が指定されていて、前のページとさらに先のページが使用できる途中にいる場合、"previous" が使用できます。
"HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/groups?instanceCode=TENANT&offset=2&limit=1"
エレメントの内容
示された要素に関連する情報。
エラー応答
エラー
原因
limit および offset に対して有効なパラメータ値を指定してください。
限度/オフセット値の入力が無効です
GroupAPI: getGroupByGroupId の場合、インスタンス コードのグループが見つかりません: {TENANT}
インスタンス コードの groupId が存在しません
この API を実行するすべての権限がありません: グローバル ユーザー グループの管理。
ユーザー認証情報に API コールを呼び出す適切な権限がありません
無効な認証情報です
使用された認証情報が正しくありません
HTTP 404 が見つかりません
groupId パラメータが無効です