Configuring Package Properties
Use the set-package-properties operation to display or hide a package from customers and resellers when they view Applications Catalog.
Request Packet Structure
A request XML package that retrieves the status of an application package download task should include the set-package-properties operation node:
<packet> <aps> <set-package-properties> ... </set-package-properties> </aps> </packet>
The set-package-properties node is structured as follows:
Note: The interactive schema navigator for all request packets is available here: http://plesk.github.io/api-schemas/184.108.40.206/agent_input.svg.
This node sets a filtering rule to match particular packages. Data type: none.
If it is defined with an empty value, than all packages will be matched.
Specifies the ID of package on the server from which an application should be installed. Data type: id_type (
Aggregates the package properties. Data type: complex.
Defines whether to display this package to customers and resellers among other packages in Application Catalog. Data type: boolean.
Important: When creating request packets, put nodes and elements in the order they follow in the packet structure.
Response Packet Structure
The set-package-properties 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/220.127.116.11/agent_output.svg.
Wraps the response retrieved from the server. Data type: resultType (
Specifies the execution status of the operation. Data type: string. Allowed values: ok | error.
errcode, required if the operation fails
Returns the error code. Data type: integer.
errtext, required if the operation fails
Returns the error message. Data type: string.
filter-id, required if the operation succeeds
Returns the package ID by which the operation was filtered. Data type: any.
Hiding particular packages
This packet requests status to hide packages with IDs 10, 11 and 12.
<packet version="18.104.22.168"> <aps> <set-package-properties> <filter> <package-id>10</package-id> <package-id>11</package-id> <package-id>12</package-id> </filter> <properties> <visible>0</visible> </properties> </set-package-properties> </aps> </packet>
<packet version="22.214.171.124"> <aps> <set-package-properties> <result> <status>ok</status> <filter-id>1</filter-id> </result> </set-package-properties> </aps> </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.