|
|
Restlet 1.1.0 (Testing branch)
10-28-2008
|
|
RT::Client::REST::Transaction(3pm) User Contributed Perl Documentation RT::Client::REST::Transaction(3pm) NAME
RT::Client::REST::Transaction -- this object represents a transaction. SYNOPSIS
my $transactions = $ticket->transactions; my $count = $transactions->count; print "There are $count transactions. "; my $iterator = $transactions->get_iterator; while (my $tr = &$iterator) { print "Id: ", $tr->id, "; Type: ", $tr->type, " "; } DESCRIPTION
A transaction is a second-class citizen, as it does not exist (at least from the current REST protocol implementation) by itself. At the moment, it is always associated with a ticket (see parent_id attribute). Thus, you will rarely retrieve a transaction by itself; instead, you should use "transactions()" method of RT::Client::REST::Ticket object to get an iterator for all (or some) transactions for that ticket. ATTRIBUTES
id Numeric ID of the transaction. creator Username of the user who created the transaction. parent_id Numeric ID of the object the transaction is associated with. type Type of the transactions. Please referer to RT::Client::REST documentation for the list of transaction types you can expect this field to contain. Note that there may be some transaction types not (dis)covered yet. old_value Old value. new_value New value. field Name of the field the transaction is describing (if any). attachments I have never seen it set to anything yet. (I will some day investigate this). created Time when the transaction was created. content Actual content of the transaction. description Human-readable description of the transaction as provided by RT. data Not sure what this is yet. METHODS
RT::Client::REST::Transaction is a read-only object, so you cannot "store()" it. Also, because it is a second-class citizen, you cannot "search()" or "count()" it -- use "transactions()" method provided by RT::Client::REST::Ticket. retrieve To retrieve a transaction, attributes id and parent_id must be set. INTERNAL METHODS
rt_type Returns 'transaction'. SEE ALSO
RT::Client::REST, RT::Client::REST::Ticket, RT::Client::REST::SearchResult. AUTHOR
Dmitri Tikhonov <dtikhonov@yahoo.com> LICENSE
Perl license with the exception of RT::Client::REST, which is GPLed. perl v5.14.2 2011-12-27 RT::Client::REST::Transaction(3pm)