Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ProductListByServiceOptionalParams

Package version

Optional parameters.

Hierarchy

  • any
    • ProductListByServiceOptionalParams

Index

Properties

Optional expandGroups

expandGroups: undefined | false | true

When set to true, the response contains an array of groups that have visibility to the product. The default is false.

Optional filter

filter: undefined | string

| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| terms | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
| groups | expand | | |

Optional skip

skip: undefined | number

Number of records to skip.

Optional tags

tags: undefined | string

Products which are part of a specific tag.

Optional top

top: undefined | number

Number of records to return.

Generated using TypeDoc