Previous page

Next page

Locate page in Contents

Print this page

Search Description Arguments

Search descriptions define arguments that can be added to a feed to narrow a search results.

The following table lists arguments that can be added to feed requests.

Argument

Description

Type

Match

Example

admin-privilege

Filters packages by requirement of administrative privilege for their provisioning

enum: yes/no

exact

yes

pageSize

Number of entries per feed page

integer. Default value: 10

No

12

page

Feed page number

integer. Default value: 1

No

3

order

Comma-separated list of keys according to which feed entries within a feed must be ordered. “-” (dash) prefix specifies the descending order.

enum:

  • name: Package name;
  • packager: Packager name;
  • vendor: Vendor name;
  • updated: Last modification date.
  • rating: Package rating
  • featured: Featured rating of application

Default value: -updated

No

vendor,-name

latest

Limits the feed contents to the latest version of the package.

enum: 1

exact

1

latest_in_version

Latest version of the package for each of the APS versions. Unlike latest, this argument may return multiple packages - one for each version of the APS Specification (if such packages exist).

enum: 1

exact

1

cert

Certification level. If this argument is present in a feed request, APS Catalog returns details on packages of the specified certification level.

enum:

  • None;
  • Silver;
  • Gold.

greater or equal

Silver

vendor

Vendor ID

string

exact

www.phpbb.org

vendorSubstring

Limits the feed contents to those packages which vendor name starts with the given value.

string

substring

phpbb

category

APS Category ID.

string

exact

Web/Wiki

categorySubstring

Limits the feed contents to those packages which category name starts with the given value. Conventional category names are listed in the http://www.apsstandard.com/r/doc/aps--application-categories.pdf document, but a client should accept other category names.

string

substring

Web

name

Case-insensitive package commercial name. It is allowed to use more then one name argument in feed URL.

string

substring

PHPbb

packager

Packager name

string

exact

www.example.com

obsolete

A package is considered obsolete if there is another package in the same catalog which upgrades the package.

By specifying “hide” for this parameter you exclude obsolete packages from the requested feed.

string

exact

hide

arch

Target architecture

enum:

  • undefined;
  • x86;
  • x86_64.

Default value: undefined.

exact

x86

package_type

Package type.

enum:

  • aps;
  • pvc.

Default value: aps

exact

aps

platform

Case-insensitive target platform

enum:

  • undefined;
  • linux;
  • windows;
  • freebsd;
  • macos.

Default value: undefined.

exact

linux

os

Case-insensitive target operating system

enum. Default value: undefined

exact

undefined

framework

Case-insensitive application envelope

enum:

  • php;
  • asp.net;
  • perl;
  • python;
  • java;
  • apache;
  • iis;
  • web;
  • dll;
  • virtual-container.

exact

php

service

Case-insensitive application network service

enum:

  • imap;
  • pop3;
  • smtp;
  • dns;
  • mysql;
  • postgresql;
  • microsoft:sqlserver.

exact

imap

nameMatch

Limits the feed contents to those packages which name matches with the given value. Wildcards usage is allowed.

string

substring

*trend*

vendorMatch

Limits the feed contents to those packages which vendor name matches the given value. Wildcards usage is allowed.

string

substring

*search

tag

Limits the feed contents to those packages marked with the specified tag.

string

exact

commercial

Restrictions

Comparison rules

The Match column defines comparison rules which APS Catalog uses to identify that there is a match between an argument value and entry data. In case of match, the entry is returned. The rules are as follows:

Examples

See Also

Search Descriptions

Search Description URLs

Please send us your feedback on this help page