Available methods

Description

Methods to retrieve information about the Packages contained within the Red Hat Network.

Namespace: packages

Method: findByNvrea

Description:
Lookup the details for the package with the given name, version, release, architecture label, and (optionally) epoch.

Parameters:

string sessionKey
string name
string version
string release
string epoch - If set to something other than empty string (""), strict matching will be used and the epoch string must be correct. If set to an empty string, if the epoch is null or there is only one NVRA combination, it will be returned. (Empty string is recommended.)
string archLabel

Returns: struct (package)

 string "id"
 string "name"
 string "version"
 string "release"
 string "epoch"
 string "arch_label"

Method: getDetails

Description:
Retrieve details for the package with the ID.

Parameters:

string sessionKey
int packageId

Returns: struct (package)

 int "id"
 string "name"
 string "epoch"
 string "version"
 string "release"
 string "arch_label"
 array "providing_channels"  string label - Channel label providing this package.
 
 
 string "build_host"
 string "description"
 string "md5sum"
 string "vendor"
 string "summary"
 string "cookie"
 string "license"
 string "file"
 string "build_date"
 string "last_modified_date"
 string "size"
 string "payload_size"
 int "package_id" (deprecated)
 string "package_name" (deprecated)
 string "package_epoch" (deprecated)
 string "package_version" (deprecated)
 string "package_release" (deprecated)
 string "package_arch_label" (deprecated)
 string "package_build_host" (deprecated)
 string "package_description" (deprecated)
 string "package_md5sum" (deprecated)
 string "package_vendor" (deprecated)
 string "package_summary" (deprecated)
 string "package_cookie" (deprecated)
 string "package_license" (deprecated)
 string "package_file" (deprecated)
 string "package_build_date" (deprecated)
 string "package_last_modified_date" (deprecated)
 string "package_size" (deprecated)
 string "package_payload_size" (deprecated)

Method: listChangelog

Description:
List the change log for a package.

Parameters:

string sessionKey
int packageId

Returns: array

 struct (changelog entry)
  string "author"
 string "date"
 string "text"
 string "entry_author" (deprecated)
 string "entry_date" (deprecated)
 string "entry_text" (deprecated)

Method: listDependencies

Description:
List the dependencies for a package.

Parameters:

string sessionKey
int packageId

Returns: array

 struct (dependency)
  string "dependency"
 string "dependency_type" - One of the following:
  requires
 conflicts
 obsoletes
 provides
 
 string "dependency_modifier"

Method: listFiles

Description:
List the files associated with a package.

Parameters:

string sessionKey
int packageId

Returns: array

 struct (file info)
  string "path"
 string "type"
 string "last_modified_date"
 string "md5sum"
 string "size"
 string "linkto"
 string "file_path" (deprecated)
 string "file_type" (deprecated)
 string "file_last_modified_date" (deprecated)
 string "file_md5sum" (deprecated)
 string "file_size" (deprecated)
 string "file_linkto" (deprecated)

Method: listProvidingChannels

Description:
List the channels that provide the a package.

Parameters:

string sessionKey
int packageId

Returns: array

 struct (channel)
  string "label"
 string "parent_label"
 string "name"
 string "channel_label" (deprecated)
 string "channel_parent_label" (deprecated)
 string "channel_name" (deprecated)

Method: listProvidingErrata

Description:
List the errata providing the a package.

Parameters:

string sessionKey
int packageId

Returns: array

 struct (errata)
  string "advisory"
 string "issue_date"
 string "last_modified_date"
 string "update_date"
 string "synopsis"
 string "type"
 string "errata_advisory" (deprecated)
 string "errata_issue_date" (deprecated)
 string "errata_last_modified_date" (deprecated)
 string "errata_update_date" (deprecated)
 string "errata_synopsis" (deprecated)
 string "errata_type" (deprecated)

Method: removePackage

Description:
Remove a package from the satellite.

Parameters:

string sessionKey
int packageId

Returns: int - 1 on success.