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

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

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

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

GET /api/users{?skip,take}

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

チャンク

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

範囲設定

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

要求の例:

GET http://<hostname>/api/users
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": 196,
"properties": {
"Username": "M.Builtin.Creator",
"Email": null,
"Token": null,
"FullName": null
},
"relations": {
"UserGroupToUser": {
"href": "http://m.local/api/entities/196/relations/UserGroupToUser"
},
"UserToUserAgreement": {
"href": "http://m.local/api/entities/196/relations/UserToUserAgreement"
},
"UserToSavedSearch": {
"href": "http://m.local/api/entities/196/relations/UserToSavedSearch"
},
"myuploads": {
"href": "http://m.local/api/entities/196/relations/myuploads"
},
"AssetSelectionToUser": {
"href": "http://m.local/api/entities/196/relations/AssetSelectionToUser"
}
},
"created_by": {
"href": "http://m.local/api/users/3",
"title": "The user who created the entity"
},
"created_on": "2014-03-23T13:47:37.4501099Z",
"modified_by": {
"href": "http://m.local/api/users/3",
"title": "The user who last modified the entity"
},
"modified_on": "2014-03-23T13:47:37.4501099Z",
"entitydefinition": {
"href": "http://m.local/api/entitydefinitions/User",
"title": "The entity definition for this entity"
},
"copy": {
"href": "http://m.local/api/users/196/copy",
"title": "Copy this entity"
},
"permissions": {
"href": "http://m.local/api/users/196/permissions",
"title": "The permissions on this entity"
},
"lifecycle": {
"href": "http://m.local/api/users/196/lifecycle",
"title": "The lifecycle action for this entity."
},
"policy": {
"href": "http://m.local/api/users/196/policy",
"title": "The policy that applies to this user."
},
"self": {
"href": "http://m.local/api/users/196",
"title": "This entity"
}
},
...
],
"total_items":38,
"returned_items":25,
"self":{
"href":"http://<hostname>/api/users"
},
"next":{
"href":"http://<hostname>/api/users?skip=25"
}
}
この記事を改善するための提案がある場合は、 お知らせください!