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.72
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       disabled
54         Queue is disabled
55
56       admin_cc_addresses
57         Admin CC Addresses (comma delimited).
58
59       cc_addresses
60         CC Addresses (comma delimited).
61
62       sla_disabled
63         Queue SLA is disabled
64
65       cf
66         Access custom fields. Inherited from RT::Client::REST::Object, where
67         you can read more details.
68
69         Trivial example:
70
71          my $queue = RT::Client::REST::Queue->new(
72            rt => $rt,
73            id => $queue_id
74          )->retrieve();
75          my @customfields = $queue->cf();
76          for my $f (@customfields) {
77            my $v = $queue->cf($f);
78            say "field: $f";
79            say "value: $v";
80          }
81

DB METHODS

83       For full explanation of these, please see "DB METHODS" in
84       RT::Client::REST::Object documentation.
85
86       retrieve
87         Retrieve queue from database.
88
89       store
90         Create or update the queue.
91
92       search
93         Currently RT does not allow REST clients to search queues.
94

QUEUE-SPECIFIC METHODS

96       tickets
97         Get tickets that are in this queue (note: this may be a lot of
98         tickets).  Note: tickets with status "deleted" will not be shown.
99         Object of type RT::Client::REST::SearchResult is returned which then
100         can be used to get to objects of type RT::Client::REST::Ticket.
101

INTERNAL METHODS

103       rt_type
104         Returns 'queue'.
105

SEE ALSO

107       RT::Client::REST, RT::Client::REST::Object,
108       RT::Client::REST::SearchResult, RT::Client::REST::Ticket.
109

AUTHOR

111       Dean Hamstead <dean@fragfest.com.au>
112

114       This software is copyright (c) 2023, 2020 by Dmitri Tikhonov.
115
116       This is free software; you can redistribute it and/or modify it under
117       the same terms as the Perl 5 programming language system itself.
118
119
120
121perl v5.38.0                      2023-07-21        RT::Client::REST::Queue(3)
Impressum