Module_streams

>>>

GET /katello/api/module_streams
List module_streams

GET /katello/api/content_views/:content_view_id/filters/:filter_id/module_streams
List module_streams

GET /katello/api/content_view_filters/:content_view_filter_id/module_streams
List module_streams

GET /katello/api/repositories/:repository_id/module_streams
List module_streams

Examples

GET /katello/api/module_streams
200
{
  "total": 3,
  "subtotal": 3,
  "selectable": 3,
  "page": 1,
  "per_page": 20,
  "error": null,
  "search": null,
  "sort": {
    "by": "name",
    "order": "asc"
  },
  "results": [
    {
      "id": 904095534,
      "name": "Ohio",
      "pulp_id": "thatriver",
      "version": "one",
      "context": "buckeye",
      "stream": "noitsariver",
      "arch": "bridge",
      "description": null,
      "summary": null,
      "module_spec": "Ohio:noitsariver:one:buckeye:bridge",
      "uuid": "thatriver"
    },
    {
      "id": 980190962,
      "name": "one",
      "pulp_id": "one",
      "version": "one",
      "context": "buckeye",
      "stream": "noitsariver",
      "arch": "bridge",
      "description": null,
      "summary": null,
      "module_spec": "one:noitsariver:one:buckeye:bridge",
      "uuid": "one"
    },
    {
      "id": 298486374,
      "name": "two",
      "pulp_id": "two",
      "version": "one",
      "context": "buckeye",
      "stream": "noitsariver",
      "arch": "bridge",
      "description": null,
      "summary": null,
      "module_spec": "two:noitsariver:one:buckeye:bridge",
      "uuid": "two"
    }
  ]
}

Params

Param name Description
organization_id
optional

organization identifier

Validations:

  • Must be a number.
content_view_version_id
optional

content view version identifier

Validations:

  • Must be a number.
content_view_filter_id
optional

content view filter identifier

Validations:

  • Must be a number.
content_view_filter_rule_id
optional

content view filter rule identifier

Validations:

  • Must be a number.
repository_id
optional

repository identifier

Validations:

  • Must be a number.
environment_id
optional

environment identifier

Validations:

  • Must be a number.
ids
optional

ids to filter content by

Validations:

  • Must be an array of any type
include_filter_ids
optional

Includes associated content view filter ids in response

Validations:

  • Must be one of: true, false, 1, 0.
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
host_ids
optional

List of host id to list available module streams for

Validations:

  • Must be an array of any type
name_stream_only
optional

Return name and stream information only)

Validations:

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

GET /katello/api/module_streams/:id
Show a module stream

GET /katello/api/repositories/:repository_id/module_streams/:id
Show a module stream

Examples

GET /katello/api/module_streams/thatriver
200
{
  "id": 904095534,
  "name": "Ohio",
  "pulp_id": "thatriver",
  "version": "one",
  "context": "buckeye",
  "stream": "noitsariver",
  "arch": "bridge",
  "description": null,
  "summary": null,
  "module_spec": "Ohio:noitsariver:one:buckeye:bridge",
  "uuid": "thatriver",
  "artifacts": [
    {
      "id": 409895757,
      "name": "boat-1.9.3-3.noarch"
    }
  ],
  "profiles": [
    {
      "id": 378248307,
      "name": "Dawson's creek",
      "rpms": [
        {
          "id": 115240563,
          "name": "canoe"
        }
      ]
    }
  ],
  "repositories": [
    {
      "id": 367202338,
      "name": "Fedora 17 x86_64",
      "product_id": 785257261,
      "product_name": "Fedora"
    }
  ]
}

Params

Param name Description
repository_id
optional

repository identifier

Validations:

  • Must be a number.
organization_id
optional

organization identifier

Validations:

  • Must be a number.
id
required

a module stream identifier

Validations:

  • String
>>>

GET /katello/api/module_streams/compare
List module_streams

Params

Param name Description
content_view_version_ids
optional

content view versions to compare

Validations:

  • Must be an array of any type
repository_id
optional

Library repository id to restrict comparisons to

Validations:

  • Must be a number.
restrict_comparison
optional

Return same, different or all results

Validations:

  • String