Available Filters

Filtering is the way a request XML packet indicates to which objects to apply an operation. Parameters nested in the filter node are called filtering rule.

The filter node is presented by the RoleSelectionFilter complex type (role.xsd). Its graphical representation is as follows:

role-filter.gif

  • id, optional

    It specifies a role ID. Data type: integer.

  • name, optional

    It specifies a role name. Data type: string.

  • all, optional

    If you use this filtering rule parameter, the server returns roles that are owned by the Administrator. Data type: none.

 

Examples

The following filter matches roles by ID:

   <filter>
      <id>124</id>
      <id>127</id>
   </filter>

  

The following filter matches roles by names:

   <filter>
      <name>Webmaster</name>
      <name>Accountant</name>
   </filter>

 

 

Leave your feedback on this topic here

If you have questions or need support, please visit the Plesk forum or contact your hosting provider.
The comments below are for feedback on the documentation only. No timely answers or help will be provided.