/ 
RT-Client-REST-0.49
River stage one • 4 direct dependents • 4 total dependents
/ RT::Client::REST::Group

NAME

RT::Client::REST::Group -- group object representation.

SYNOPSIS

my $rt = RT::Client::REST->new(server => $ENV{RTSERVER});

my $group = RT::Client::REST::Group->new(
  rt  => $rt,
  id  => $id,
)->retrieve;

DESCRIPTION

RT::Client::REST::Group is based on RT::Client::REST::Object. The representation allows one to retrieve, edit, and create groups in RT.

Note: RT currently does not allow REST client to search groups.

ATTRIBUTES

id

For retrieval, you can specify either the numeric ID of the group or his group name. After the retrieval, however, this attribute will be set to the numeric id.

name

Name of the group

description

Description

members

List of the members of this group.

DB METHODS

For full explanation of these, please see "DB METHODS" in RT::Client::REST::Object documentation.

retrieve

Retrieve RT group from database.

store

Create or update the group.

Currently RT does not allow REST clients to search groups.

INTERNAL METHODS

rt_type

Returns 'group'.

SEE ALSO

RT::Client::REST, RT::Client::REST::Object, RT::Client::REST::SearchResult.

AUTHOR

Miquel Ruiz <mruiz@cpan.org>

LICENSE

Perl license.