| RT-Client-REST documentation | Contained in the RT-Client-REST distribution. |
RT::Client::REST::Ticket -- this object represents a ticket.
my $rt = RT::Client::REST->new(server => $ENV{RTSERVER});
# Create a new ticket:
my $ticket = RT::Client::REST::Ticket->new(
rt => $rt,
queue => "General",
subject => $subject,
)->store(text => "This is the initial text of the ticket");
print "Created a new ticket, ID ", $ticket->id, "\n";
# Update
my $ticket = RT::Client::REST::Ticket->new(
rt => $rt,
id => $id,
priority => 10,
)->store;
# Retrieve
my $ticket => RT::Client::REST::Ticket->new(
rt => $rt,
id => $id,
)->retrieve;
unless ($ticket->owner eq $me) {
$ticket->steal; # Give me more work!
}
RT::Client::REST::Ticket is based on RT::Client::REST::Object. The representation allows to retrieve, edit, comment on, and create tickets in RT.
This is the numeric ID of the ticket.
This is the name of the queue (not numeric id).
Username of the owner.
Username of RT user who created the ticket.
Subject of the ticket.
The status is usually one of the following: "new", "open", "resolved", "stalled", "rejected", and "deleted". However, custom RT installations sometimes add their own statuses.
Ticket priority. Usually a numeric value.
This is a list attribute (for explanation of list attributes, see LIST ATTRIBUTE PROPERTIES in RT::Client::REST::Object). Contains e-mail addresses of the requestors.
A list of e-mail addresses used to notify people of 'correspond' actions.
A list of e-mail addresses used to notify people of all actions performed on a ticket.
Time at which ticket was created.
For full explanation of these, please see "DB METHODS" in RT::Client::REST::Object documentation.
Retrieve RT ticket from database.
Create or update the ticket. When creating a new ticket, optional 'text' parameter can be supplied to set the initial text of the ticket.
Search for tickets that meet specific conditions.
Comment on this ticket with message $message. %opts is a list of
key-value pairs as follows:
List of filenames (an array reference) that should be attached to the ticket along with the comment.
List of e-mail addresses to send carbon copies to (an array reference).
List of e-mail addresses to send blind carbon copies to (an array reference).
Add correspondence to the ticket. Takes exactly the same arguments as the comment method above.
Get attachments associated with this ticket. What is returned is an object of type RT::Client::REST::SearchResult which can then be used to get at objects of type RT::Client::REST::Attachment.
Get transactions associated with this ticket. Optionally, you can specify exactly what types of transactions you want listed, for example:
my $result = $ticket->transactions(type => [qw(Comment Correspond)]);
Please reference RT::Client::REST documentation for the full list of valid transaction types.
Return value is an object of type RT::Client::REST::SearchResult which can then be used to iterate over transaction objects (RT::Client::REST::Transaction).
Take this ticket.
If you already the owner of this ticket,
RT::Client::REST::Object::NoopOperationException will be thrown.
Untake this ticket.
If Nobody is already the owner of this ticket,
RT::Client::REST::Object::NoopOperationException will be thrown.
Steal this ticket.
If you already the owner of this ticket,
RT::Client::REST::Object::NoopOperationException will be thrown.
This class inherits 'cf' method from RT::Client::REST::Object. To create a ticket with a bunch of custom fields, use the following approach:
RT::Client::REST::Ticket->new(
rt => $rt,
# blah blah
cf => {
'field one' => $value1,
'field two' => $another_value,
},
)->store;
Some more examples:
# Update a custom field value:
$ticket->cf('field one' => $value1);
$ticket->store;
# Get a custom field value:
my $another value = $ticket->cf('field two');
# Get a list of ticket's custom field names:
my @custom_fields = $ticket->cf;
Returns 'ticket'.
RT::Client::REST, RT::Client::REST::Object, RT::Client::REST::Attachment, RT::Client::REST::SearchResult, RT::Client::REST::Transaction.
Dmitri Tikhonov <dtikhonov@yahoo.com>
Perl license with the exception of RT::Client::REST, which is GPLed.
| RT-Client-REST documentation | Contained in the RT-Client-REST distribution. |
# $Id: Ticket.pm 28 2008-08-16 00:23:30Z dtikhonov $ # # RT::Client::REST::Ticket -- ticket object representation. package RT::Client::REST::Ticket; use strict; use warnings; use vars qw($VERSION); $VERSION = '0.09'; use Error qw(:try); use Params::Validate qw(:types); use RT::Client::REST 0.18; use RT::Client::REST::Attachment; use RT::Client::REST::Object 0.01; use RT::Client::REST::Object::Exception 0.04; use RT::Client::REST::SearchResult 0.02; use RT::Client::REST::Transaction; use base 'RT::Client::REST::Object';
sub _attributes {{ id => { validation => { type => SCALAR, regex => qr/^\d+$/, }, form2value => sub { shift =~ m~^ticket/(\d+)$~i; return $1; }, value2form => sub { return 'ticket/' . shift; }, }, queue => { validation => { type => SCALAR, }, }, owner => { validation => { type => SCALAR, }, }, creator => { validation => { type => SCALAR, }, }, subject => { validation => { type => SCALAR, }, }, status => { validation => { # That's it for validation... People can create their own # custom statuses. type => SCALAR, }, }, priority => { validation => { type => SCALAR, }, }, initial_priority => { validation => { type => SCALAR, }, rest_name => 'InitialPriority', }, final_priority => { validation => { type => SCALAR, }, rest_name => 'FinalPriority', }, requestors => { validation => { type => ARRAYREF, }, list => 1, }, cc => { validation => { type => ARRAYREF, }, list => 1, }, admin_cc => { validation => { type => ARRAYREF, }, list => 1, rest_name => 'AdminCc', }, created => { validation => { type => SCALAR, }, }, starts => { validation => { type => SCALAR|UNDEF, }, }, started => { validation => { type => SCALAR|UNDEF, }, }, due => { validation => { type => SCALAR|UNDEF, }, }, resolved => { validation => { type => SCALAR|UNDEF, }, }, told => { validation => { type => SCALAR|UNDEF, }, }, time_estimated => { validation => { type => SCALAR, }, rest_name => 'TimeEstimated', }, time_worked => { validation => { type => SCALAR, }, rest_name => 'TimeWorked', }, time_left => { validation => { type => SCALAR, }, rest_name => 'TimeLeft', }, last_updated => { validation => { type => SCALAR, }, rest_name => 'LastUpdated', }, }}
# comment and correspond are really the same method, so we save ourselves # some duplication here. for my $method (qw(comment correspond)) { no strict 'refs'; *$method = sub { my $self = shift; if (@_ & 1) { RT::Client::REST::Object::OddNumberOfArgumentsException->throw; } $self->_assert_rt_and_id($method); my %opts = @_; unless (defined($opts{message})) { RT::Client::REST::Object::InvalidValueException->throw( "No message was provided", ); } $self->rt->$method( ticket_id => $self->id, %opts, ); return; }; }
sub attachments { my $self = shift; $self->_assert_rt_and_id; RT::Client::REST::SearchResult->new( ids => [ $self->rt->get_attachment_ids(id => $self->id) ], object => sub { RT::Client::REST::Attachment->new( id => shift, parent_id => $self->id, rt => $self->rt, ); }, ); }
sub transactions { my $self = shift; if (@_ & 1) { RT::Client::REST::Object::OddNumberOfArgumentsException->throw; } $self->_assert_rt_and_id; my %opts = @_; my %params = ( parent_id => $self->id, ); if (defined(my $type = delete($opts{type}))) { $params{transaction_type} = $type; } RT::Client::REST::SearchResult->new( ids => [ $self->rt->get_transaction_ids(%params) ], object => sub { RT::Client::REST::Transaction->new( id => shift, parent_id => $self->id, rt => $self->rt, ); }, ); }
for my $method (qw(take untake steal)) { no strict 'refs'; *$method = sub { my $self = shift; $self->_assert_rt_and_id($method); try { $self->rt->$method(id => $self->id); } catch RT::Client::REST::AlreadyTicketOwnerException with { # Rename the exception. RT::Client::REST::Object::NoopOperationException ->throw(shift->message); }; return; }; }
sub rt_type { 'ticket' }
__PACKAGE__->_generate_methods; 1;