rt/share/html/REST/1.0/Forms/group/customfields

   1 %# BEGIN BPS TAGGED BLOCK {{{
   2 %#
   3 %# COPYRIGHT:
   4 %#
   5 %# This software is Copyright (c) 1996-2017 Best Practical Solutions, LLC
   6 %#                                          <sales@bestpractical.com>
   7 %#
   8 %# (Except where explicitly superseded by other copyright notices)
   9 %#
  10 %#
  11 %# LICENSE:
  12 %#
  13 %# This work is made available to you under the terms of Version 2 of
  14 %# the GNU General Public License. A copy of that license should have
  15 %# been provided with this software, but in any event can be snarfed
  16 %# from www.gnu.org.
  17 %#
  18 %# This work is distributed in the hope that it will be useful, but
  19 %# WITHOUT ANY WARRANTY; without even the implied warranty of
  20 %# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  21 %# General Public License for more details.
  22 %#
  23 %# You should have received a copy of the GNU General Public License
  24 %# along with this program; if not, write to the Free Software
  25 %# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  26 %# 02110-1301 or visit their web page on the internet at
  27 %# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
  28 %#
  29 %#
  30 %# CONTRIBUTION SUBMISSION POLICY:
  31 %#
  32 %# (The following paragraph is not intended to limit the rights granted
  33 %# to you to modify and distribute this software under the terms of
  34 %# the GNU General Public License and is only of importance to you if
  35 %# you choose to contribute your changes and enhancements to the
  36 %# community by submitting them to Best Practical Solutions, LLC.)
  37 %#
  38 %# By intentionally submitting any modifications, corrections or
  39 %# derivatives to this work, or any other work intended for use with
  40 %# Request Tracker, to Best Practical Solutions, LLC, you confirm that
  41 %# you are the copyright holder for those contributions and you grant
  42 %# Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
  43 %# royalty-free, perpetual, license to use, copy, create derivative
  44 %# works based on those contributions, and sublicense and distribute
  45 %# those contributions and any derivatives thereof.
  46 %#
  47 %# END BPS TAGGED BLOCK }}}
  48 %# REST/1.0/Forms/group/customfields
  49 %#
  50 <%ARGS>
  51 $id
  52 $format => 's'
  53 $changes => {}
  54 </%ARGS>
  55 <%perl>
  56 my @comments;
  57 my ($c, $o, $k, $e) = ("", [], {}, 0);
  58 my $group = RT::Group->new($session{CurrentUser});
  59
  60 $group->Load($id);
  61 if (!$group->Id) {
  62     return [ "# Group $id does not exist.", [], {}, 1 ];
  63 }
  64
  65 if (%$changes) {
  66     $e = 1;
  67     $c = "Cannot modify Group CF definitions via REST";
  68     goto DONE;
  69 }
  70
  71 my @data;
  72
  73 push @data, [ id => "group/" . $group->Id ];
  74 my $gcfs = $group->CustomFields;
  75 while ( my $gcf = $gcfs->Next() ) {
  76     if ( $format eq "l" ) {
  77         my $cfadmin
  78             = ( $gcf->SingleValue ? 'SingleValue' : 'MultiValue' )
  79             . $gcf->Type
  80             . ( $gcf->Pattern ? ( ' ' . $gcf->FriendlyPattern ) : '' );
  81
  82         push @data,
  83             [ $gcf->Name . ' (' . $gcf->Description . ')' => $cfadmin ];
  84     } else {
  85         push @data, [ $gcf->Name => "" ];
  86     }
  87 }
  88
  89 my %k = map {@$_} @data;
  90 $o = [ map { $_->[0] } @data ];
  91 $k = \%k;
  92
  93 DONE:
  94 $c ||= join("\n", @comments) if @comments;
  95 return [ $c, $o, $k, $e ];
  96 </%perl>