logo
logo

Usergroup Collection Object

A Usergroup Collection Object is a Collection Object containing zero or more Usergroup Objects. It contains no additional properties.

Example

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

Can we improve this article ? Provide feedback