Configuring Package Properties

Use the set-package-properties operation to display or hide a package from customers and resellers when they view Applications Catalog.

In this chapter:

Request Packet Structure

Response Packet Structure

Samples

 

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:

aps-set-package-properties-rps

  • filter, required

    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.

  • package-id, optional

    Specifies the ID of package on the server from which an application should be installed. Data type: id_type (common.xsd).

  • properties, required

    Aggregates the package properties. Data type: complex.

  • visible, required

    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:

  • result, required

    Wraps the response retrieved from the server. Data type: resultType (common.xsd).

  • status, required

    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.

  • id, optional.

    Not returned.

 

Samples

Hiding particular packages

This packet requests status to hide packages with IDs 10, 11 and 12.

<packet version="1.6.3.0">
  <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>

Response:

<packet version="1.6.3.0">
  <aps>
    <set-package-properties>
      <result>
        <status>ok</status>
        <filter-id>1</filter-id>
      </result>
    </set-package-properties>
  </aps>
</packet>
 

Leave your comments on this page

Leave your feedback or question on this documentation topic below. For technical assistance, contact your hosting service provider or submit a request to Plesk support. Suggest new features for Plesk here. Discuss general questions on the Plesk forum. All offtopic comments will be removed.