ユーザーコレクション

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

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

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

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

GET /api/users{?スキップ、取得}

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

チャンキング

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

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