contentmanagement

Available methods

Description

Provides methods to access and modify Content Lifecycle Management related entities (Projects, Environments, Filters, Sources).

Namespace:

contentmanagement

Method: attachFilter

HTTP POST

Description:

Attach a Filter to a Project

Parameters:

  • string sessionKey

  • string projectLabel - Project label

  • int filterId - filter ID to attach

Returns:

  • * struct content filter information

    • int "id"

    • string "name"

    • int "orgId"

    • entityType "entity type (e.g. 'package')"

    • rule "rule (e.g. 'deny')"

    • struct criteria

      • string "matcher" - the matcher type of the filter (e.g. 'contains')

      • string "field" - the entity field to match (e.g. 'name'

      • string "value" - the field value to match (e.g. 'kernel')

Method: attachSource

HTTP POST

Description:

Attach a Source to a Project

Parameters:

  • string sessionKey

  • string projectLabel - Content Project label

  • string sourceType - Project Source type, e.g. 'software'

  • string sourceLabel - Project Source label

  • int sourcePosition - Project Source position

Returns:

  • * struct content project source information

    • string "contentProjectLabel"

    • string "type"

    • string "state"

    • string "channelLabel" - (if type is SW_CHANNEL) the label of channel associated with the source

Method: attachSource

HTTP POST

Description:

Attach a Source to a Project

Parameters:

  • string sessionKey

  • string projectLabel - Content Project label

  • string sourceType - Project Source type, e.g. 'software'

  • string sourceLabel - Project Source label

Returns:

  • * struct content project source information

    • string "contentProjectLabel"

    • string "type"

    • string "state"

    • string "channelLabel" - (if type is SW_CHANNEL) the label of channel associated with the source

Method: buildProject

HTTP POST

Description:

Build a Project

Parameters:

  • string sessionKey

  • string projectLabel - Project label

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: buildProject

HTTP POST

Description:

Build a Project

Parameters:

  • string sessionKey

  • string projectLabel - Project label

  • string message - log message to be assigned to the build

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: createAppStreamFilters

HTTP POST

Description:

Create Filters for AppStream Modular Channel and attach them to CLM Project

Parameters:

  • string sessionKey

  • string prefix - Filter name prefix

  • string channelLabel - Modular Channel label

  • string projectLabel - Project label

Returns:

  • array :

  • struct content filter information

    • int "id"

    • string "name"

    • int "orgId"

    • entityType "entity type (e.g. 'package')"

    • rule "rule (e.g. 'deny')"

    • struct criteria

      • string "matcher" - the matcher type of the filter (e.g. 'contains')

      • string "field" - the entity field to match (e.g. 'name'

      • string "value" - the field value to match (e.g. 'kernel')

Method: createEnvironment

HTTP POST

Description:

Create a Content Environment and appends it behind given Content Environment

Parameters:

  • string sessionKey

  • string projectLabel - Content Project label

  • string predecessorLabel - Predecessor Environment label

  • string envLabel - new Content Environment label

  • string name - new Content Environment name

  • string description - new Content Environment description

Returns:

  • * struct content environment information

    • int "id"

    • string "label"

    • string "name"

    • string "description"

    • int "version"

    • string "status"

    • dateTime.iso8601 "lastBuildDate" - last build/promote date

    • string "contentProjectLabel"

    • string "previousEnvironmentLabel"

    • string "nextEnvironmentLabel"

Method: createFilter

HTTP POST

Description:

Create a Content Filter #paragraph_end() #paragraph() The following filters are available (you can get the list in machine-readable format using the listFilterCriteria() endpoint): #paragraph_end() #paragraph() Package filtering: #itemlist() #item("by name - field: name; matchers: contains or matches") #item("by name, epoch, version, release and architecture - field: nevr or nevra; matcher: equals") #itemlist_end() #paragraph_end() #paragraph() Errata/Patch filtering: #itemlist() #item("by advisory name - field: advisory_name; matcher: equals or matches") #item("by type - field: advisory_type (e.g. 'Security Advisory'); matcher: equals") #item("by synopsis - field: synopsis; matcher: equals, contains or matches") #item("by keyword - field: keyword; matcher: contains") #item("by date - field: issue_date; matcher: greater or greatereq; value needs to be in ISO format e.g 2022-12-10T12:00:00Z") #item("by affected package name - field: package_name; matcher: contains_pkg_name or matches_pkg_name") #item("by affected package with version - field: package_nevr; matcher: contains_pkg_lt_evr, contains_pkg_le_evr, contains_pkg_eq_evr, contains_pkg_ge_evr or contains_pkg_gt_evr") #itemlist_end() #paragraph_end() #paragraph() Appstream module/stream filtering: #itemlist() #item("by module name, stream - field: module_stream; matcher: equals; value: modulaneme:stream") #itemlist_end() Note: Only 'allow' rule is supported for appstream filters. #paragraph_end() #paragraph() Note: The 'matches' matcher works on Java regular expressions.

Parameters:

  • string sessionKey

  • string name - Filter name

  • string rule - Filter rule ('deny' or 'allow')

  • string entityType - Filter entityType ('package' or 'erratum')

  • struct criteria

    • string "matcher" - The matcher type of the filter (e.g. 'contains')

    • string "field" - The entity field to match (e.g. 'name'

    • string "value" - The field value to match (e.g. 'kernel')

Returns:

  • * struct content filter information

    • int "id"

    • string "name"

    • int "orgId"

    • entityType "entity type (e.g. 'package')"

    • rule "rule (e.g. 'deny')"

    • struct criteria

      • string "matcher" - the matcher type of the filter (e.g. 'contains')

      • string "field" - the entity field to match (e.g. 'name'

      • string "value" - the field value to match (e.g. 'kernel')

Method: createProject

HTTP POST

Description:

Create Content Project

Parameters:

  • string sessionKey

  • string projectLabel - Content Project label

  • string name - Content Project name

  • string description - Content Project description

Returns:

  • * struct content project information

    • int "id"

    • string "label"

    • string "name"

    • string "description"

    • dateTime.iso8601 "lastBuildDate"

    • int "orgId"

    • string "firstEnvironment"

Method: detachFilter

HTTP POST

Description:

Detach a Filter from a Project

Parameters:

  • string sessionKey

  • string projectLabel - Project label

  • int filterId - filter ID to detach

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: detachSource

HTTP POST

Description:

Detach a Source from a Project

Parameters:

  • string sessionKey

  • string projectLabel - Content Project label

  • string sourceType - Project Source type, e.g. 'software'

  • string sourceLabel - Project Source label

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: listFilterCriteria

HTTP GET

Description:

List of available filter criteria

Parameters:

  • string sessionKey

Returns:

  • array :

    • struct Filter Criteria

      • string "type"

      • string "matcher"

      • string "field"

Method: listFilters

HTTP GET

Description:

List all Content Filters visible to given user

Parameters:

  • string sessionKey

Returns:

  • array :

  • struct content filter information

    • int "id"

    • string "name"

    • int "orgId"

    • entityType "entity type (e.g. 'package')"

    • rule "rule (e.g. 'deny')"

    • struct criteria

      • string "matcher" - the matcher type of the filter (e.g. 'contains')

      • string "field" - the entity field to match (e.g. 'name'

      • string "value" - the field value to match (e.g. 'kernel')

Method: listProjectEnvironments

HTTP GET

Description:

List Environments in a Content Project with the respect to their ordering

Parameters:

  • string sessionKey

  • string projectLabel - Content Project label

Returns:

  • array :

  • struct content environment information

    • int "id"

    • string "label"

    • string "name"

    • string "description"

    • int "version"

    • string "status"

    • dateTime.iso8601 "lastBuildDate" - last build/promote date

    • string "contentProjectLabel"

    • string "previousEnvironmentLabel"

    • string "nextEnvironmentLabel"

Method: listProjectFilters

HTTP GET

Description:

List all Filters associated with a Project

Parameters:

  • string sessionKey

  • string projectLabel - Project label

Returns:

  • array :

  • struct assigned content filter information

    • string "state"

  • struct content filter information

    • int "id"

    • string "name"

    • int "orgId"

    • entityType "entity type (e.g. 'package')"

    • rule "rule (e.g. 'deny')"

    • struct criteria

      • string "matcher" - the matcher type of the filter (e.g. 'contains')

      • string "field" - the entity field to match (e.g. 'name'

      • string "value" - the field value to match (e.g. 'kernel')

Method: listProjectSources

HTTP GET

Description:

List Content Project Sources

Parameters:

  • string sessionKey

  • string projectLabel - Content Project label

Returns:

  • array :

  • struct content project source information

    • string "contentProjectLabel"

    • string "type"

    • string "state"

    • string "channelLabel" - (if type is SW_CHANNEL) the label of channel associated with the source

Method: listProjects

HTTP GET

Description:

List Content Projects visible to user

Parameters:

  • string sessionKey

Returns:

  • array :

  • struct content project information

    • int "id"

    • string "label"

    • string "name"

    • string "description"

    • dateTime.iso8601 "lastBuildDate"

    • int "orgId"

    • string "firstEnvironment"

Method: lookupEnvironment

HTTP GET

Description:

Look up Content Environment based on Content Project and Content Environment label

Parameters:

  • string sessionKey

  • string projectLabel - Content Project label

  • string envLabel - Content Environment label

Returns:

  • * struct content environment information

    • int "id"

    • string "label"

    • string "name"

    • string "description"

    • int "version"

    • string "status"

    • dateTime.iso8601 "lastBuildDate" - last build/promote date

    • string "contentProjectLabel"

    • string "previousEnvironmentLabel"

    • string "nextEnvironmentLabel"

Method: lookupFilter

HTTP GET

Description:

Lookup a Content Filter by ID

Parameters:

  • string sessionKey

  • int filterId - Filter ID

Returns:

  • * struct content filter information

    • int "id"

    • string "name"

    • int "orgId"

    • entityType "entity type (e.g. 'package')"

    • rule "rule (e.g. 'deny')"

    • struct criteria

      • string "matcher" - the matcher type of the filter (e.g. 'contains')

      • string "field" - the entity field to match (e.g. 'name'

      • string "value" - the field value to match (e.g. 'kernel')

Method: lookupProject

HTTP GET

Description:

Look up Content Project with given label

Parameters:

  • string sessionKey

  • string projectLabel - Content Project label

Returns:

  • * struct content project information

    • int "id"

    • string "label"

    • string "name"

    • string "description"

    • dateTime.iso8601 "lastBuildDate"

    • int "orgId"

    • string "firstEnvironment"

Method: lookupSource

HTTP GET

Description:

Look up Content Project Source

Parameters:

  • string sessionKey

  • string projectLabel - Content Project label

  • string sourceType - Project Source type, e.g. 'software'

  • string sourceLabel - Project Source label

Returns:

  • * struct content project source information

    • string "contentProjectLabel"

    • string "type"

    • string "state"

    • string "channelLabel" - (if type is SW_CHANNEL) the label of channel associated with the source

Method: promoteProject

HTTP POST

Description:

Promote an Environment in a Project

Parameters:

  • string sessionKey

  • string projectLabel - Project label

  • string envLabel - Environment label

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: removeEnvironment

HTTP POST

Description:

Remove a Content Environment

Parameters:

  • string sessionKey

  • string projectLabel - Content Project label

  • string envLabel - Content Environment label

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: removeFilter

HTTP POST

Description:

Remove a Content Filter

Parameters:

  • string sessionKey

  • int filterId - Filter ID

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: removeProject

HTTP POST

Description:

Remove Content Project

Parameters:

  • string sessionKey

  • string projectLabel - Content Project label

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: updateEnvironment

HTTP POST

Description:

Update Content Environment with given label

Parameters:

  • string sessionKey

  • string projectLabel - Content Project label

  • string envLabel - Content Environment label

  • struct props

    • string "name" - Content Environment name

    • string "description" - Content Environment description

Returns:

  • * struct content environment information

    • int "id"

    • string "label"

    • string "name"

    • string "description"

    • int "version"

    • string "status"

    • dateTime.iso8601 "lastBuildDate" - last build/promote date

    • string "contentProjectLabel"

    • string "previousEnvironmentLabel"

    • string "nextEnvironmentLabel"

Method: updateFilter

HTTP POST

Description:

Update a Content Filter #paragraph_end() #paragraph() See also: createFilter(), listFilterCriteria()

Parameters:

  • string sessionKey

  • int filterId - Filter ID

  • string name - New filter name

  • string rule - New filter rule ('deny' or 'allow')

  • struct criteria

    • string "matcher" - The matcher type of the filter (e.g. 'contains')

    • string "field" - The entity field to match (e.g. 'name'

    • string "value" - The field value to match (e.g. 'kernel')

Returns:

  • * struct content filter information

    • int "id"

    • string "name"

    • int "orgId"

    • entityType "entity type (e.g. 'package')"

    • rule "rule (e.g. 'deny')"

    • struct criteria

      • string "matcher" - the matcher type of the filter (e.g. 'contains')

      • string "field" - the entity field to match (e.g. 'name'

      • string "value" - the field value to match (e.g. 'kernel')

Method: updateProject

HTTP POST

Description:

Update Content Project with given label

Parameters:

  • string sessionKey

  • string projectLabel - Content Project label

  • struct props

    • string "name" - Content Project name

    • string "description" - Content Project description

Returns:

  • * struct content project information

    • int "id"

    • string "label"

    • string "name"

    • string "description"

    • dateTime.iso8601 "lastBuildDate"

    • int "orgId"

    • string "firstEnvironment"