1. ユーザー グループ コレクション リソース

ユーザー グループ コレクション リソース

ユーザー グループ コレクション リソースには、システムに存在するすべてのユーザー グループが含まれています。

サポートされているメソッド: GET

GET /api/usergroups{?skip,take}

ユーザー グループのコレクションを取得します。応答には、ユーザー グループ コレクション オブジェクトが含まれています。

チャンク

1 つのチャンクに収まらないほど多くのユーザー グループがある場合は、次のチャンクを取得するためのリンクが記述されます。

範囲設定

take パラメーターを指定すると、返されるユーザー グループの数はそのパラメーター値 (最大で 100) に制限されます。skip パラメーターを使用して、返されるユーザー グループの範囲を詳しく指定することもできます。

要求の例:

GET http://<hostname>/api/usergroups
Host: hostname
Accept: application/json

応答の例:

HTTP/1.1 200 OK
Content-Length: content length
Content-Type: application/json; charset=utf-8
ETag: "hash string"

{
"items":[
{
"id": 2,
"properties": {
"GroupName": "Everyone"
},
"relations": {
"UserGroupToUser": {
"href": "http://m.local/api/entities/2/relations/UserGroupToUser"
}
},
"created_by": {
"href": "http://m.local/api/users/0",
"title": "The user who created the entity"
},
"created_on": "2014-03-23T13:47:29.8058106Z",
"modified_by": {
"href": "http://m.local/api/users/0",
"title": "The user who last modified the entity"
},
"modified_on": "2014-03-23T13:47:29.8058106Z",
"entitydefinition": {
"href": "http://m.local/api/entitydefinitions/UserGroup",
"title": "The entity definition for this entity"
},
"copy": {
"href": "http://m.local/api/usergroups/2/copy",
"title": "Copy this entity"
},
"permissions": {
"href": "http://m.local/api/usergroups/2/permissions",
"title": "The permissions on this entity"
},
"lifecycle": {
"href": "http://m.local/api/usergroups/2/lifecycle",
"title": "The lifecycle action for this entity."
},
"policy": {
"href": "http://m.local/api/usergroups/2/policy",
"title": "The policy that applies to this user group."
},
"self": {
"href": "http://m.local/api/usergroups/2",
"title": "This entity"
}
},
...
],
"total_items":38,
"returned_items":25,
"self":{
"href":"http://<hostname>/api/usergroups"
},
"next":{
"href":"http://<hostname>/api/usergroups?skip=25"
}
}
この記事を改善するための提案がある場合は、 お知らせください!