1RT::Client::REST::QueueU(s3e)r Contributed Perl DocumentaRtTi:o:nClient::REST::Queue(3)
2
3
4

NAME

6       RT::Client::REST::Queue - queue object representation.
7

VERSION

9       version 0.60
10

SYNOPSIS

12         my $rt = RT::Client::REST->new(server => $ENV{RTSERVER});
13
14         my $queue = RT::Client::REST::Queue->new(
15           rt  => $rt,
16           id  => 'General',
17         )->retrieve;
18

DESCRIPTION

20       RT::Client::REST::Queue is based on RT::Client::REST::Object.  The
21       representation allows one to retrieve, edit, comment on, and create
22       queue in RT.
23
24       Note: RT currently does not allow REST client to search queues.
25

ATTRIBUTES

27       id
28         For retrieval, you can specify either the numeric ID of the queue or
29         its name (case-sensitive).  After the retrieval, however, this
30         attribute will be set to the numeric id.
31
32       name
33         This is the name of the queue.
34
35       description
36         Queue description.
37
38       correspond_address
39         Correspond address.
40
41       comment_address
42         Comment address.
43
44       initial_priority
45         Initial priority.
46
47       final_priority
48         Final priority.
49
50       default_due_in
51         Default due in.
52
53       cc_addresses
54         CC Addresses (comma delimited).
55
56       admin_cc_addresses
57         Admin CC Addresses (comma delimited).
58
59       cf
60         Access custom fields. Inherited from RT::Client::REST::Object, where
61         you can read more details.
62
63         Trivial example:
64
65          my $queue = RT::Client::REST::Queue->new(
66            rt => $rt, id => $queue_id
67          )->retrieve();
68          my @customfields = $queue->cf();
69          for my $f (@customfields) {
70            my $v = $queue->cf($f);
71            say "field: $f";
72            say "value: $v";
73          }
74

DB METHODS

76       For full explanation of these, please see "DB METHODS" in
77       RT::Client::REST::Object documentation.
78
79       retrieve
80         Retrieve queue from database.
81
82       store
83         Create or update the queue.
84
85       search
86         Currently RT does not allow REST clients to search queues.
87

QUEUE-SPECIFIC METHODS

89       tickets
90         Get tickets that are in this queue (note: this may be a lot of
91         tickets).  Note: tickets with status "deleted" will not be shown.
92         Object of type RT::Client::REST::SearchResult is returned which then
93         can be used to get to objects of type RT::Client::REST::Ticket.
94

INTERNAL METHODS

96       rt_type
97         Returns 'queue'.
98

SEE ALSO

100       RT::Client::REST, RT::Client::REST::Object,
101       RT::Client::REST::SearchResult, RT::Client::REST::Ticket.
102

AUTHOR

104       Dmitri Tikhonov
105

107       This software is copyright (c) 2020, 2018 by Dmitri Tikhonov.
108
109       This is free software; you can redistribute it and/or modify it under
110       the same terms as the Perl 5 programming language system itself.
111
112
113
114perl v5.32.1                      2021-01-27        RT::Client::REST::Queue(3)
Impressum