Retrieving Custom Button Settings

The get-custombutton operation is used to retrieve custom button settings.

In this chapter:

Request Packet Structure

Response Packet Structure

Samples

 

Request Packet Structure

A request XML packet retrieving a custom button settings includes the get-custombutton operation node:

<packet>
<ui>
   <get-custombutton>
...
   </get-custombutton>
</ui>
</packet>

 

The get-custombutton graphical representation is as follows:

Note: The interactive schema navigator for all request packets is available here: http://plesk.github.io/api-schemas/1.6.8.0/agent_input.svg.

  • The filter node is required. It specifies the filtering rule. For more information, refer to the Available Filters section. Data type: customButtonFilter (ui_input.xsd).
 

Response Packet Structure

The get-custombutton node of the output XML packet is structured as follows:

Note: The interactive schema navigator for all response packets is available here: http://plesk.github.io/api-schemas/1.6.8.0/agent_output.svg.

  • The result node is required. It wraps the response retrieved from the server. Data type: resultType (common.xsd).
  • The status node is required. It specifies the execution status of the operation. Data type: string. Allowed values: ok | error.
  • The errcode node is optional. Is returns the error code if the operation fails. Data type: integer.
  • The errtext node is optional. It returns the error message if the operation fails. Data type: string.
  • The id node is optional. If the operation succeeds, it returns the ID of the custom button. Data type: integer.
  • The owner node is required. It specifies users who can manage the custom button. For more information, refer to the Owner section. Data type: CBOwner (plesk_custom_button.xsd).
  • The properties node is required. It specifies behavior of the button. For details, refer to the Properties section. Data type: CBProps (plesk_custom_button.xsd).

Note: When you retrieve details on the custom button that links to a Web application, and you have not specified values for all required properties nodes, the validation error occurs.

  • The uri-components node is optional. It specifies parameters that are sent via the GET method to external web applications when clicking the button. Data type: CBUrlComponents (plesk_custom_button.xsd).
 

Samples

The following packet retrieves settings of custom buttons of the customer with ID 1.

<packet version="1.6.3.0">
<ui>
   <get-custombutton>
   <filter>

      <owner>
            <customer-id>1</customer-id>
      </owner>

   </filter>

   </get-custombutton>
</ui>
</packet>

 

The following packet retrieves settings of custom button with ID 1.

<packet version="1.5.1.0">
<ui>
   <get-custombutton>
   <filter>

      <custombutton-id>1</custombutton-id>

   </filter>

   </get-custombutton>
</ui>
</packet>
 

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.