GroupResource Resource

Resource to get groups

GET /group/load

Load the groups the user may see

Response Body
media type data type description
application/json GroupsResponse (JSON) response containing groups

Example

Request
GET /group/load
Accept: application/json
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "groups" : [ {
    "id" : 12345,
    "name" : "...",
    "description" : "...",
    "children" : [ { }, { } ]
  }, {
    "id" : 12345,
    "name" : "...",
    "description" : "...",
    "children" : [ { }, { } ]
  } ],
  "messages" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "CRITICAL",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "CRITICAL",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "AUTHREQUIRED",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /group/list

Get a list of groups, optionally filtered sorted and paged.

Request Parameters
name type description default constraints multivalued
children query   int yes
folder query   int yes
id query id of the group to return (filter)   int yes
maxItems query maximum number of groups returned (paging) -1 int no
memberid query id of the group member for the group(s) to return (filter)   int yes
memberlogin query login name of the group member for the group(s) to return (filter)     yes
name query name or name pattern of the group(s) to return (filter)     yes
privileges query   "assignpermissions" or "createfile" or "createfolder" or "createpage" or "createtemplate" or "deletefile" or "deletefolder" or "deletepage" or "deletetemplate" or "importpage" or "inheritance" or "linktemplate" or "linkworkflow" or "publishpage" or "synchronizechannel" or "translatepage" or "updatefile" or "updatefolder" or "updatepage" or "updatetagtypes" or "updatetemplate" or "viewfile" or "viewfolder" or "viewpage" or "viewtemplate" or "wastebin" yes
reduce query   "child" or "parent" no
skipCount query number of groups skipped in the list (paging) 0 int no
sortby query name of the sorted attribute (sorting)   "id" or "name" no
sortorder query sortorder (sorting) asc "ASC" or "DESC" or "NONE" or "asc" or "desc" or "none" no
Response Body
media type data type description
application/json GroupsResponse (JSON) response containing the groups

Example

Request
GET /group/list
Accept: application/json
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "groups" : [ {
    "id" : 12345,
    "name" : "...",
    "description" : "...",
    "children" : [ { }, { } ]
  }, {
    "id" : 12345,
    "name" : "...",
    "description" : "...",
    "children" : [ { }, { } ]
  } ],
  "messages" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "WARNING",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "WARNING",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "INVALIDDATA",
    "responseMessage" : "...",
    "property" : "..."
  }
}