catalog.apps

Retrieve apps details for label catalog.

options.cache is a boolean which when set will try to get apps details for label catalog from cache if available.

options.cache_only is a boolean which when set will force usage of cache only for retrieving catalog information. If the content for the catalog in question is not cached, no content would be returned. If options.cache is unset, this attribute has no effect.

options.retrieve_all_trains is a boolean value which when set will retrieve information for all the trains present in the catalog ( it is set by default ).

options.trains is a list of train name(s) which will allow selective filtering to retrieve only information of desired trains in a catalog. If options.retrieve_all_trains is set, it has precedence over options.train.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: catalog_apps_options

catalog_apps_options

Type: object
No Additional Properties

Cache

Type: boolean Default: true

Cache Only

Type: boolean Default: false

Retrieve All Trains

Type: boolean Default: true

Trains

Type: array of string
No Additional Items
Each item of this array must be:
Type: string

Must be at least 1 characters long

Result

Type: object

Each additional property must conform to the following schema

CatalogTrainInfo

Type: object

Each additional property must conform to the following schema

Type: object


Required roles: CATALOG_READ