Content_view_filters

>>>

get /katello/api/content_views/:content_view_id/filters
list filters

get /katello/api/content_view_filters
list filters

Params

Param name Description
search
optional

Search string

Validations:

  • String
page
optional

Page number, starting at 1

Validations:

  • Must be a number.
per_page
optional

Number of results per page to return

Validations:

  • Must be a number.
order
optional

Sort field and order, eg. 'id DESC'

Validations:

  • String
full_result
optional

Whether or not to show all results

Validations:

  • Must be one of: true, false, 1, 0.
sort_by
optional

Field to sort the results on

Validations:

  • String
sort_order
optional

How to order the sorted results (e.g. ASC for ascending)

Validations:

  • String
content_view_id
required

content view identifier

Validations:

  • Must be a number.
name
optional

filter content view filters by name

Validations:

  • String
types
optional

types of filters

Validations:

  • Must be an array of any type

Search fields

Field name Type Possible values
content_type rpm, deb, package_group, erratum, docker, modulemd
inclusion_type include, exclude
name string
>>>

post /katello/api/content_views/:content_view_id/filters
create a filter for a content view

post /katello/api/content_view_filters
create a filter for a content view

Params

Param name Description
content_view_id
required

content view identifier

Validations:

  • Must be a number.
name
required

name of the filter

Validations:

  • String
type
required

type of filter (e.g. deb, rpm, package_group, erratum, erratum_id, erratum_date, docker, modulemd)

Validations:

  • String
original_packages
optional

add all packages without errata to the included/excluded list. (package filter only)

Validations:

  • Must be one of: true, false, 1, 0.
original_module_streams
optional

add all module streams without errata to the included/excluded list. (module stream filter only)

Validations:

  • Must be one of: true, false, 1, 0.
inclusion
optional

specifies if content should be included or excluded, default: inclusion=false

Validations:

  • Must be one of: true, false, 1, 0.
repository_ids
optional

list of repository ids

Validations:

  • Must be an array of any type
description
optional

description of the filter

Validations:

  • String
>>>

get /katello/api/content_views/:content_view_id/filters/:id
show filter info

get /katello/api/content_view_filters/:id
show filter info

Params

Param name Description
content_view_id
optional

content view identifier

Validations:

  • Must be a number.
id
required

filter identifier

Validations:

  • Must be a number.
>>>

put /katello/api/content_views/:content_view_id/filters/:id
update a filter

put /katello/api/content_view_filters/:id
update a filter

Params

Param name Description
content_view_id
optional

content view identifier

Validations:

  • Must be a number.
id
required

filter identifier

Validations:

  • Must be a number.
name
optional

new name for the filter

Validations:

  • String
original_packages
optional

add all packages without errata to the included/excluded list. (package filter only)

Validations:

  • Must be one of: true, false, 1, 0.
original_module_streams
optional

add all module streams without errata to the included/excluded list. (module stream filter only)

Validations:

  • Must be one of: true, false, 1, 0.
inclusion
optional

specifies if content should be included or excluded, default: inclusion=false

Validations:

  • Must be one of: true, false, 1, 0.
repository_ids
optional

list of repository ids

Validations:

  • Must be an array of any type
description
optional

description of the filter

Validations:

  • String
>>>

delete /katello/api/content_views/:content_view_id/filters/:id
delete a filter

delete /katello/api/content_view_filters/:id
delete a filter

Params

Param name Description
content_view_id
optional

content view identifier

Validations:

  • Must be a number.
id
required

filter identifier

Validations:

  • Must be a number.
>>>

put /katello/api/content_views/:content_view_id/filters/:id/remove_filter_rules
bulk delete filter rules

put /katello/api/content_view_filters/:id/remove_filter_rules
bulk delete filter rules

Params

Param name Description
content_view_id
optional

content view identifier

Validations:

  • Must be a number.
id
required

filter identifier

Validations:

  • Must be a number.
rule_ids
required

filter identifiers

Validations:

  • Must be an array of number
>>>

put /katello/api/content_views/:content_view_id/filters/:id/add_filter_rules
bulk add filter rules

put /katello/api/content_view_filters/:id/add_filter_rules
bulk add filter rules

Params

Param name Description
content_view_id
optional

content view identifier

Validations:

  • Must be a number.
id
required

filter identifier

Validations:

  • Must be a number.
rules_params
optional

Rules to be added

Validations:

  • Must be an Array of nested elements
rules_params[name]
optional

package, package group, or docker tag names

Validations:

  • Must be an array of [String]
rules_params[uuid]
optional

package group: uuid

Validations:

  • String
rules_params[version]
optional

package: version

Validations:

  • String
rules_params[architecture]
optional

package: architecture

Validations:

  • String
rules_params[min_version]
optional

package: minimum version

Validations:

  • String
rules_params[max_version]
optional

package: maximum version

Validations:

  • String
rules_params[errata_id]
optional

erratum: id

Validations:

  • String
rules_params[errata_ids]
optional

erratum: IDs or a select all object

Validations:

  • Must be an array of any type
rules_params[start_date]
optional

erratum: start date (YYYY-MM-DD)

Validations:

  • String
rules_params[end_date]
optional

erratum: end date (YYYY-MM-DD)

Validations:

  • String
rules_params[types]
optional

erratum: types (enhancement, bugfix, security)

Validations:

  • Must be an array of any type
rules_params[date_type]
optional

erratum: search using the 'Issued On' or 'Updated On' column of the errata. Values are 'issued'/'updated'

Validations:

  • String
rules_params[module_stream_ids]
optional

module stream ids

Validations:

  • Must be an array of any type