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

日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

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

サポートされている方法: GET

GET /api/ユーザーグループ{?スキップ、取得}

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

チャンキング

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"
    }
}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"
  }
}

この記事を改善するための提案がある場合は、お知らせください!