Introduction
You can use additional parameters to sort UAPI output.
Sort output
UAPI sorting uses four basic parameters:
|
parameter |
Type |
Description |
Possible values |
|
api.sort |
boolean |
Whether to enable sorting. |
|
|
api.sort_column |
string |
The output parameter to sort by. |
The name of one of the function's parameters. |
|
api.sort_method |
string |
The type of sorting to use. This parameter defaults to lexicographic. Warning: You must set this parameter whenever you sort numeric values, or the function will fail. |
|
|
api.sort_reverse |
boolean |
Whether to sort data in reverse order. |
|
Examples
The following example function calls execute the Email::list_lists function and use the numeric method to sort the diskused parameter's values in reverse order.
cPanel or Webmail Session URL
/execute/Email/list_lists?api.sort=1&api.sort_column=diskused&api.sort_method=numeric&api.sort_reverse=0
LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
// List all of the mailing lists by the amount of disk they use.
$list_by_disk = $cpanel->api2(
'Email', 'list_lists',
array(
'api.sort' => '1',
'api.sort_column' => 'diskused',
'api.sort_method' => 'numeric',
'api.sort_reverse' => '0',
)
);
LiveAPI Perl Class
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
# List all of the mailing lists by the amount of disk they use.
my $list_by_disk = $cpliveapi->api2(
'Email', 'list_lists',
{
'api.sort' => '1',
'api.sort_column' => 'diskused',
'api.sort_method' => 'numeric',
'api.sort_reverse' => '0',
}
);
cPanel Template Toolkit
<!-- List all of the mailing lists by the amount of disk they use. -->
[% execute('Email', 'list_lists', { 'api.sort' => '1', 'api.sort_column' => 'diskused', 'api.sort_method' => 'numeric', 'api.sort_reverse' => '0', }) %]
Output (JSON)
{ "messages": null, "errors": null, "status": 1, "data": [ { "listid": "list1_example.com", "accesstype":"public", "desthost": "hostname.example.com", "diskused": "16040", "humandiskused": "16.04 KB", "listadmin":"user@example.com", "list": "list1@example.com", "advertised": "1", "archive_private": "1", "subscribe_policy": "1" } { "listid": "mylist_example.com", "accesstype":"public", "desthost": "hostname.example.com", "diskused": "17647", "humandiskused": "17.23 KB", "listadmin":"admin@example.com", "list": "mylist@example.com", "advertised": "0", "archive_private": "1", "subscribe_policy": "1" } { "listid": "superlist_example.com", "accesstype":"public", "desthost": "hostname.example.com", "diskused": "90120", "humandiskused": "90.12 KB", "listadmin":"charlie@example.com", "list": "superlist@example.com", "advertised": "1", "archive_private": "1", "subscribe_policy": "1" } ], "metadata": { "transformed": 1 }}
Use multiple sorts
To use multiple sorts on a single UAPI call, append an underscore (_) and a number to the end of each sort parameter.
For example, use the following parameters to pass two sets of sorting information:
- Pass the first set of sorting information to the
api.sort_method_0,api_, andsort_column_0api_parameters.sort_reverse_0 - Pass the second set of sorting information to the
api.,sort_method_1api_, andsort_column_1api_parameters.sort_reverse_1
Note:
Do not include more than one api.sort boolean parameter.
For example, the following examples sort the Email::list_lists function's output by whether they appear on the Mailman directory page and then their list name in reverse alphabetical order.
cPanel or Webmail Session URL
/execute/Email/list_lists?api.sort=1&api.sort_column_0=advertised&api.sort_method=numeric&api.sort_reverse_0=0&api.sort_column_1=list&api.sort_method_1=lexicographic&api.sort_reverse_1=1
LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
// List all of the mailing lists sorted by whether they are displayed
// on the Mailman directory, and then by name in reverse alphabetical order
$very_private_lists = $cpanel->uapi(
'Email', 'list_lists',
array(
'api.sort' => '1',
'api.sort_column_0' => 'advertised',
'api.sort_method_0' => 'numeric',
'api.sort_type_0' => '0',
'api.sort_column_1' => 'list',
'api.sort_method_1' => 'lexicographic',
'api.sort_type_1' => '1',
)
);
LiveAPI Perl Class
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
// List all of the mailing lists sorted by whether they are displayed
// on the Mailman directory, and then by name in reverse alphabetical order
my $very_private_lists = $cpliveapi->uapi(
'Email', 'list_lists',
{
'api.sort' => '1',
'api.sort_column_0' => 'advertised',
'api.sort_method_0' => 'numeric',
'api.sort_type_0' => '0',
'api.sort_column_1' => 'list',
'api.sort_method_1' => 'lexicographic',
'api.sort_type_1' => '1',
}
);
cPanel Template Toolkit
<!-- List all of the mailing lists sorted by whether they are displayed on the Mailman directory, and then by name in reverse alphabetical order. -->
[% execute('Email', 'list_lists', { 'api.sort' => '1', 'api.sort_column_0' => 'advertised', 'api.sort_method_0' => 'numeric', 'api.sort_reverse_0' => '0','api.sort_column_1' => 'list', 'api.sort_method_1' => 'lexicographic', 'api.sort_reverse_1' => '1', }) %]
Output (JSON)
{
"data":[
{
"subscribe_policy":3,
"listadmin":"user@example.com",
"humandiskused":"20.45 KB",
"desthost":"example.com",
"archive_private":1,
"accesstype":"private",
"advertised":0,
"diskused":"20942",
"list":"worldleaders@example.com",
"listid":"worldleaders_example.com"
},
{
"list":"talkshows@example.com",
"diskused":"20920",
"advertised":0,
"listid":"talkshows_example.com",
"desthost":"example.com",
"humandiskused":"20.43 KB",
"subscribe_policy":3,
"listadmin":"user@example.com",
"accesstype":"private",
"archive_private":1
},
{
"listadmin":"user@example.com",
"subscribe_policy":3,
"desthost":"example.com",
"humandiskused":"20.46 KB",
"archive_private":1,
"accesstype":"private",
"advertised":0,
"diskused":"20956",
"list":"campaigndonors@example.com",
"listid":"campaigndonors_example.com"
},
{
"archive_private":0,
"accesstype":"public",
"subscribe_policy":1,
"listadmin":"user@example.com",
"humandiskused":"20.52 KB",
"desthost":"example.com",
"listid":"statedepartment_example.com",
"advertised":1,
"diskused":"21010",
"list":"statedepartment@example.com"
},
{
"listid":"foundationemployees_example.com",
"advertised":1,
"diskused":"20990",
"list":"foundationemployees@example.com",
"archive_private":0,
"accesstype":"public",
"listadmin":"user@example.com",
"subscribe_policy":1,
"humandiskused":"20.5 KB",
"desthost":"example.com"
}
],
"metadata":{
"transformed":1
},
"messages":null,
"errors":null,
"status":1
}