doc/api/methods/groups.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: API Methods
   5 title: "groups"
   6
   7 ...
   8
   9
  10
  11 Required arguments are displayed in %{background:#ccffcc}green%.
  12
  13
  14 h2. create
  15
  16 Create a new Group.
  17
  18 Arguments:
  19
  20 table(table table-bordered table-condensed).
  21 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  22 |group|object||query||
  23
  24 h2. delete
  25
  26 Delete an existing Group.
  27
  28 Arguments:
  29
  30 table(table table-bordered table-condensed).
  31 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  32 {background:#ccffcc}.|uuid|string|The UUID of the Group in question.|path||
  33
  34 h2. destroy
  35
  36 destroy groups
  37
  38 Arguments:
  39
  40 table(table table-bordered table-condensed).
  41 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  42 {background:#ccffcc}.|uuid|string||path||
  43
  44 h2. get
  45
  46 Gets a Group's metadata by UUID.
  47
  48 Arguments:
  49
  50 table(table table-bordered table-condensed).
  51 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  52 {background:#ccffcc}.|uuid|string|The UUID of the Group in question.|path||
  53
  54 h2. index
  55
  56 index groups
  57
  58 Arguments:
  59
  60 table(table table-bordered table-condensed).
  61 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  62 |order|string||query||
  63 |where|object||query||
  64
  65 h2. list
  66
  67 List groups.
  68
  69 Arguments:
  70
  71 table(table table-bordered table-condensed).
  72 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  73 |limit|integer (default 100)|Maximum number of groups to return.|query||
  74 |order|string|Order in which to return matching groups.|query||
  75 |pageToken|string|Page token.|query||
  76 |q|string|Query string for searching groups.|query||
  77 |where|object|Conditions for filtering groups.|query||
  78
  79 h2. owned_items
  80
  81 Retrieve a list of items which are owned by the given group.
  82
  83 Arguments:
  84
  85 table(table table-bordered table-condensed).
  86 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  87 {background:#ccffcc}.|uuid|string|The UUID of the group in question.|path||
  88 |include_indirect|boolean|If true, results will include items on which the given group has _can_manage_ permission, although they are owned by different users/groups.|path|{white-space:nowrap}. @false@ (default)
  89 @true@|
  90
  91 h2. show
  92
  93 show groups
  94
  95 Arguments:
  96
  97 table(table table-bordered table-condensed).
  98 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  99 {background:#ccffcc}.|uuid|string||path||
 100
 101 h2. update
 102
 103 Update attributes of an existing Group.
 104
 105 Arguments:
 106
 107 table(table table-bordered table-condensed).
 108 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 109 {background:#ccffcc}.|uuid|string|The UUID of the Group in question.|path||
 110 |group|object||query||