Launchpad API Reference Manual

Parameter	Value	Description
credentials	`Credentials`	The credentials used to access Launchpad.
service_root	String	The URL to the root of the web service.
cache
timeout
proxy_info

Parameter	Value	Description
consumer_name	string	The consumer name, as appropriate for the `Consumer` constructor
service_root	(optional) string	The URL to the root of the web service.
cache	(optional)
timeout	(optional)
proxy_info	(optional)
authorizer_class	(optional)
allow_access_levels	(optional) List of one or more of: UNAUTHORIZED READ_PUBLIC READ_PRIVATE WRITE_PUBLIC WRITE_PRIVATE	Access Levels to Allow This permits limiting the number of choices presented to the user to only those relevant for the application.
max_failed_attempts	(optional) int	Defaults to 3

Parameter	Value	Description
consumer_name	string	The consumer name, as appropriate for the `Consumer` constructor
token_string		the access token, as appropriate for the `AccessToken` constructor
access_secret		the access token's secret, as appropriate for the `AccessToken` constructor
service_root	(optional) string	The URL to the root of the web service.
cache	(optional)
timeout	(optional)
proxy_info	(optional)

Parameter	Value	Description
consumer_name	string	The consumer name, as appropriate for the `Consumer` constructor
service_root	(optional) string	The URL to the root of the web service. Defaults to https://api.staging.launchpad.net/beta/
launchpadlib_dir	(optional) string	The directory where the cache and credentials are stored
timeout	(optional)
proxy_info	(optional)

Parameter	Value	Description
consumer_name	string	The consumer name, as appropriate for the `Consumer` constructor
service_root	(optional) string	The URL to the root of the web service.
launchpadlib_dir	(optional) string	The directory where the cache and credentials are stored
timeout	(optional)
proxy_info	(optional)
authorizer_class	(optional)
allow_access_levels	(optional) list #TODO#
max_failed_attempts	(optional) int	Defaults to 3
credentials_file	(optional)

Parameter	Value	Description
ws.op	(required) Fixed: `getByUniqueName`	The name of the operation being invoked.
unique_name	(required)	Branch unique name

Parameter	Value	Description
ws.op	(required) Fixed: `getByUrl`	The name of the operation being invoked.
url	(required)	Branch URL

Parameter	Value	Description
ws.op	(required) Fixed: `getByUrls`	The name of the operation being invoked.
urls	(required)	A list of URLs of branches These can be URLs external to Launchpad, lp: URLs, or http://bazaar.launchpad.net/ URLs, or any mix of all these different kinds.

Parameter	Value	Description
ws.op	(required) Fixed: `getByName`	The name of the operation being invoked.
name	(required)	The bug tracker name

Parameter	Value	Description
ws.op	(required) Fixed: `queryByBaseURL`	The name of the operation being invoked.
base_url	(required)	The base URL of the bug tracker

Parameter	Value	Description
ws.op	(required) Fixed: `ensureBugTracker`	The name of the operation being invoked.
base_url	(required)	Location The top-level URL for the bug tracker, or an upstream email address. This must be accurate so that Launchpad can link to external bug reports.
bug_tracker_type	One of: `Bugzilla` `Debbugs` `Roundup` `Trac` `SourceForge or SourceForge derivative` `Mantis` `Request Tracker (RT)` `Email Address` `Savane` `PHP Project Bugtracker` `Google Code`	Bug Tracker Type
contact_details		Contact details The contact details for the external bug tracker (so that, for example, its administrators can be contacted about a security breach).
name		Name An URL-friendly name for the bug tracker, such as "mozilla-bugs".
summary		Summary A brief introduction or overview of this bug tracker instance.
title		Title A descriptive label for this tracker to show in listings.

Parameter	Value	Description
ws.op	(required) Fixed: `createBug`	The name of the operation being invoked.
description	(required)	Description A detailed description of the problem, including the steps required to reproduce it.
private		This bug report should be private Private bug reports are visible only to their subscribers.
security_related		Security Related This bug is a security vulnerability.
tags		Tags List of tag strings applied to this bug.
target	(required) Link to a bug_target.	The project, distribution or source package that has this bug.
title	(required)	Summary A one-line summary of the problem.

Parameter	Value	Description
ws.op	(required) Fixed: `getByCode`	The name of the operation being invoked.
code	(required)	Code

Parameter	Value	Description
ws.op	(required) Fixed: `getByName`	The name of the operation being invoked.
name	(required)	Name

Parameter	Value	Description
ws.op	(required) Fixed: `getAllLanguages`	The name of the operation being invoked.

Parameter	Value	Description
ws.op	(required) Fixed: `getArchiveSubscriptionURLs`

Parameter	Value	Description
ws.op	(required) Fixed: `getBranches`
modified_since		Limit the branches to those modified since this date.
status		A list of branch lifecycle statuses to filter by.

Parameter	Value	Description
ws.op	(required) Fixed: `getMembersByStatus`
status	(required) One of: `Proposed` `Approved` `Administrator` `Deactivated` `Expired` `Declined` `Invited` `Invitation declined`	The state of this membership

Parameter	Value	Description
ws.op	(required) Fixed: `getMergeProposals`
status		A list of merge proposal statuses to filter by.

Parameter	Value	Description
ws.op	(required) Fixed: `getPPAByName`
name	(required)

Parameter	Value	Description
ws.op	(required) Fixed: `getRecipe`
name	(required)

Parameter	Value	Description
ws.op	(required) Fixed: `getRequestedReviews`
status		A list of merge proposal statuses to filter by.

Parameter	Value	Description
ws.op	(required) Fixed: `acceptInvitationToBeMemberOf`
comment	(required)
team	(required) Link to a person.	Team

Parameter	Value	Description
ws.op	(required) Fixed: `declineInvitationToBeMemberOf`
comment	(required)
team	(required) Link to a person.	Team

Parameter	Value	Description
ws.op	(required) Fixed: `join`
team	(required) Link to a person.	Team

Parameter	Value	Description
ws.op	(required) Fixed: `leave`
team	(required) Link to a person.	Team

Parameter	Value	Description
ws.op	(required) Fixed: `setLocationVisibility`
visible		Is this location record visible?

Parameter	Value	Description
ws.op	(required) Fixed: `getByName`	The name of the operation being invoked.
distroseries	Link to a distro_series.	Distroseries The distribution series to which the packageset is related.
name	(required)	Package set name

Parameter	Value	Description
ws.op	(required) Fixed: `setsIncludingSource`	The name of the operation being invoked.
direct_inclusion
distroseries	Link to a distro_series.	Distribution series The distroseries to which this package set is related.
sourcepackagename	(required)	Source package name

Parameter	Value	Description
ws.op	(required) Fixed: `new`	The name of the operation being invoked.
description	(required)	Package set description
distroseries	Link to a distro_series.	Distroseries The distribution series to which the packageset is related.
name	(required)	Valid package set name
owner	(required) Link to a person.	Person The person who owns this package set.
related_set	Link to a packageset.	Related package set The new package set will share the package set group with this one.

Parameter	Value	Description
ws.op	(required) Fixed: `find`	The name of the operation being invoked.
text	(required)	Search text

Parameter	Value	Description
ws.op	(required) Fixed: `findPerson`	The name of the operation being invoked.
created_after		Created after
created_before		Created before
text	(required)	Search text

Parameter	Value	Description
ws.op	(required) Fixed: `findTeam`	The name of the operation being invoked.
text	(required)	Search text

Parameter	Value	Description
ws.op	(required) Fixed: `getByEmail`	The name of the operation being invoked.
email	(required)

Parameter	Value	Description
ws.op	(required) Fixed: `newTeam`	The name of the operation being invoked.
default_membership_period		Subscription period Number of days a new subscription lasts before expiring. You can customize the length of an individual subscription when approving it. Leave this empty or set to 0 for subscriptions to never expire.
default_renewal_period		Renewal period Number of days a subscription lasts after being renewed. You can customize the lengths of individual renewals, but this is what's used for auto-renewed and user-renewed memberships.
display_name	(required)	Display Name Your name as you would like it displayed throughout Launchpad. Most people use their full name here.
name	(required)	Name A short unique name, beginning with a lower-case letter or number, and containing only letters, numbers, dots, hyphens, or plus signs.
subscription_policy	One of: `Moderated Team` `Open Team` `Restricted Team`	Subscription policy
team_description		Team Description Details about the team's work, highlights, goals, and how to contribute. Use plain text, paragraphs are preserved and URLs are linked in pages.

Parameter	Value	Description
ws.op	(required) Fixed: `search`
limit		Maximum number of items to return. This is a hard limit: any pagination you request will happen within this limit.
text	(required)	Search text

Parameter	Value	Description
ws.op	(required) Fixed: `search`	The name of the operation being invoked.
text		Search text

Parameter	Value	Description
ws.op	(required) Fixed: `latest`	The name of the operation being invoked.

Parameter	Value	Description
ws.op	(required) Fixed: `licensing_search`	The name of the operation being invoked.
active		Is the project active
created_after		Created after date
created_before		Created before date
has_zero_licenses	True or False	Has zero licenses
license_info_is_empty		License info is empty
license_reviewed		Is the project license reviewed
licenses		Licenses
search_text		Search text
subscription_expires_after		Subscription expires after
subscription_expires_before		Subscription expired before
subscription_modified_after		Subscription modified after
subscription_modified_before		Subscription modified before

Parameter	Value	Description
ws.op	(required) Fixed: `search`	The name of the operation being invoked.
text		Search text

Parameter	Value	Description
ws.op	(required) Fixed: `new_project`	The name of the operation being invoked.
description		Description Details about the project's work, highlights, goals, and how to contribute. Use plain text, paragraphs are preserved and URLs are linked in pages. Don't repeat the Summary.
display_name	(required)	Display Name The name of the project as it would appear in a paragraph.
download_url		Download URL The full URL where downloads for this project are located, if available. Please include the http://
freshmeat_project		Freshmeat Project The Freshmeat project name for this project, if it is in freshmeat.
home_page_url		Homepage URL The project home page. Please include the http://
license_info		Description of additional licenses Description of licenses that do not appear in the list above.
license_reviewed		Project reviewed Whether or not this project has been reviewed. If you looked at the project and how it uses Launchpad, you reviewed it.
licenses		Licenses
name	(required)	Name At least one lowercase letter or number, followed by letters, numbers, dots, hyphens or pluses. Keep this name short; it is used in URLs as shown above.
programming_lang		Programming Languages A comma delimited list of programming languages used for this project.
project_group	Link to a project_group.	Part of Project group. This is an overarching initiative that includes several related projects. For example, the Mozilla Project produces Firefox, Thunderbird and Gecko. This information is used to group those projects in a coherent way. If you make this project part of a group, the group preferences and decisions around bug tracking, translation and security policy will apply to this project.
registrant	Link to a person.	Registrant This person registered the project in Launchpad.
screenshots_url		Screenshots URL The full URL for screenshots of this project, if available. Please include the http://
sourceforge_project		Sourceforge Project The SourceForge project name for this project, if it is in sourceforge.
summary	(required)	Summary A short paragraph to introduce the project's work.
title	(required)	Title The project title. Should be just a few words.
wiki_url		Wiki URL The full URL of this project's wiki, if it has one. Please include the http://

Parameter	Value	Description
ws.op	(required) Fixed: `fetch`	The name of the operation being invoked.
token	(required)	UUID

Parameter	Value	Description
ws.op	(required) Fixed: `getAllEntries`	The name of the operation being invoked.
import_status		The status of the import.

Parameter	Value	Description
ws.op	(required) Fixed: `getFirstEntryToImport`	The name of the operation being invoked.
target	Link to a object_with_translation_imports.

Parameter	Value	Description
ws.op	(required) Fixed: `getRequestTargets`	The name of the operation being invoked.
status		The status of the import.

Key	Value	Description
dependencies_collection_link	(read-only) Link to a archive_dependency collection.	Archive dependencies recorded for this archive.
description	(writeable)	Archive contents description A short description of this archive's contents.
displayname	(writeable)	Displayname Displayname for this archive.
distribution_link	(writeable) Link to a distribution.	The distribution that uses or is used by this archive.
http_etag	(read-only)	The value of the HTTP ETag for this resource.
name	(writeable)	Name The name of this archive.
owner_link	(writeable) Link to a person.	Owner The archive owner.
private	(writeable)	Private Whether the archive is private to the owner or not. This can only be changed by launchpad admins or launchpad commercial admins and only if the archive has not had any sources published.
require_virtualized	(writeable)	Require Virtualized Builder Whether this archive requires its packages to be built on a virtual builder.
resource_type_link	(read-only)	The link to the WADL description of this resource.
self_link	(read-only)	The canonical link to this resource.
signing_key_fingerprint	(writeable)	Archive signing key fingerprint A OpenPGP signing key fingerprint (40 chars) for this PPA or None if there is no signing key available.

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

getArchiveDependency

Return the IArchiveDependency object for the given dependency.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getArchiveDependency

dependency

(required)

Link to a archive.

Response contains an application/json representation of a archive_dependency.

getBuildCounters

Return a dictionary containing the build counters for an archive.

This is necessary currently because the IArchive.failed_builds etc. counters are not in use.

The returned dictionary contains the follwoing keys and values:

'total': total number of builds (includes SUPERSEDED);

'pending': number of builds in BUILDING or NEEDSBUILD state;

'failed': number of builds in FAILEDTOBUILD, MANUALDEPWAIT, CHROOTWAIT and FAILEDTOUPLOAD state;

'succeeded': number of SUCCESSFULLYBUILT builds.

'superseded': number of SUPERSEDED builds.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getBuildCounters

include_needsbuild

Include builds with state NEEDSBUILD

getBuildRecords

Return build records in the context it is implemented.

It excludes build records generated by Gina (imported from a external repository), where IBuild.datebuilt is null and IBuild.buildstate is BuildStatus.FULLYBUILT.

The result is simply not filtered if the optional filters are omitted by call sites.

Parameters

Parameter	Value	Description
ws.op	(required) Fixed: `getBuildRecords`
build_state	One of: `Needs building` `Successfully built` `Failed to build` `Dependency wait` `Chroot problem` `Build for superseded Source` `Currently building` `Failed to upload`	Build status The status of this build record
pocket	One of: `Release` `Security` `Updates` `Proposed` `Backports`	Pocket The pocket into which this entry is published
source_name		Source package name

Response contains an application/json representation of a build collection .

getBuildSummariesForSourceIds

Return a dictionary containing a summary of the build statuses.

Only information for sources belonging to the current archive will be returned. See IPublishingSet.getBuildStatusSummariesForSourceIdsAndArchive() for details.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getBuildSummariesForSourceIds

source_ids

(required)

A list of source publishing history record ids.

getComponentsForQueueAdmin

Return IArchivePermission for the person's queue admin components

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getComponentsForQueueAdmin

person

(required)

Link to a person.

Response contains an application/json representation of a archive_permission collection .

getPackagesetsForSource

All package set based permissions for the given source.

This method is meant to aid the process of "debugging" package set based archive permission since It allows the listing of permissions for the given source package in this archive (irrespective of the principal).

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getPackagesetsForSource

direct_permissions

Ignore package set hierarchy

sourcepackagename

(required)

Source package name

Response contains an application/json representation of a archive_permission collection .

getPackagesetsForSourceUploader

The package set based permissions for a given source and uploader.

Return the IArchivePermission records that

apply to this archive
relate to
- package sets that include the given source package name
- the given person

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getPackagesetsForSourceUploader

person

(required)

Link to a person.

sourcepackagename

(required)

Source package name

Response contains an application/json representation of a archive_permission collection .

getPackagesetsForUploader

The ArchivePermission records for the person's package sets.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getPackagesetsForUploader

person

(required)

Link to a person.

Response contains an application/json representation of a archive_permission collection .

getPermissionsForPerson

Return the IArchivePermission records applicable to the person.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getPermissionsForPerson

person

(required)

Link to a person.

Response contains an application/json representation of a archive_permission collection .

getPublishedBinaries

All IBinaryPackagePublishingHistory target to this archive.

Parameters

Parameter	Value	Description
ws.op	(required) Fixed: `getPublishedBinaries`
binary_name		Binary Package Name
distro_arch_series	Link to a distro_arch_series.	Distro Arch Series
exact_match		Whether or not to filter binary names by exact matching.
pocket	One of: `Release` `Security` `Updates` `Proposed` `Backports`	Pocket The pocket into which this entry is published
status	One of: `Pending` `Published` `Superseded` `Deleted` `Obsolete`	Package Publishing Status The status of this publishing record
version		Version

Response contains an application/json representation of a binary_package_publishing_history collection .

getPublishedSources

All ISourcePackagePublishingHistory target to this archive.

Parameters

Parameter	Value	Description
ws.op	(required) Fixed: `getPublishedSources`
created_since_date		Created Since Date Return entries whose date_created is greater than or equal to this date.
distro_series	Link to a distro_series.	Distroseries name
exact_match		Exact Match Whether or not to filter source names by exact matching.
pocket	One of: `Release` `Security` `Updates` `Proposed` `Backports`	Pocket The pocket into which this entry is published
source_name		Source package name
status	One of: `Pending` `Published` `Superseded` `Deleted` `Obsolete`	Package Publishing Status The status of this publishing record
version		Version

Response contains an application/json representation of a source_package_publishing_history collection .

getQueueAdminsForComponent

Return IArchivePermission records for authorised queue admins.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getQueueAdminsForComponent

component_name

(required)

Component Name

Response contains an application/json representation of a archive_permission collection .

getUploadersForComponent

Return IArchivePermission records for the component's uploaders.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getUploadersForComponent

component_name

Component Name

Response contains an application/json representation of a archive_permission collection .

getUploadersForPackage

Return IArchivePermission records for the package's uploaders.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getUploadersForPackage

source_package_name

(required)

Source Package Name

Response contains an application/json representation of a archive_permission collection .

getUploadersForPackageset

The ArchivePermission records for uploaders to the package set.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getUploadersForPackageset

direct_permissions

Ignore package set hierarchy

packageset

(required)

Link to a packageset.

Package set

Response contains an application/json representation of a archive_permission collection .

isSourceUploadAllowed

True if the person is allowed to upload the given source package.

Return True if there exists a permission that combines

this archive
a package set that includes the given source package name
the given person or a team he is a member of

If the source package name is included by any package set with an explicit permission then only such explicit permissions will be considered.

Parameters

Parameter	Value	Description
ws.op	(required) Fixed: `isSourceUploadAllowed`
distroseries	Link to a distro_series.	The distro series
person	(required) Link to a person.
sourcepackagename	(required)	Source package name

Custom POST methods

deleteComponentUploader

Revoke permission for the person to upload to the component.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: deleteComponentUploader

component_name

(required)

Component Name

person

(required)

Link to a person.

deletePackageUploader

Revoke permission for the person to upload the package.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: deletePackageUploader

person

(required)

Link to a person.

source_package_name

(required)

Source Package Name

deletePackagesetUploader

Revoke upload permissions for a person.

Parameters

Parameter	Value	Description
ws.op	(required) Fixed: `deletePackagesetUploader`
explicit		Explicit
packageset	(required) Link to a packageset.	Package set
person	(required) Link to a person.

deleteQueueAdmin

Revoke permission for the person to administer distroseries queues.

The supplied person will lose permission to administer the distroseries queue for packages in the supplied component.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: deleteQueueAdmin

component_name

(required)

Component Name

person

(required)

Link to a person.

newComponentUploader

Add permission for a person to upload to a component.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: newComponentUploader

component_name

(required)

Component Name

person

(required)

Link to a person.

On success, the response status will be 201 and the Location header will contain the link to the newly created archive_permission.

newPackageUploader

Add permisson for a person to upload a package to this archive.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: newPackageUploader

person

(required)

Link to a person.

source_package_name

(required)

Source Package Name

On success, the response status will be 201 and the Location header will contain the link to the newly created archive_permission.

newPackagesetUploader

Add a package set based permission for a person.

Parameters

Parameter	Value	Description
ws.op	(required) Fixed: `newPackagesetUploader`
explicit		Explicit
packageset	(required) Link to a packageset.	Package set
person	(required) Link to a person.

On success, the response status will be 201 and the Location header will contain the link to the newly created archive_permission.

newQueueAdmin

Add permission for a person to administer a distroseries queue.

The supplied person will gain permission to administer the distroseries queue for packages in the supplied component.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: newQueueAdmin

component_name

(required)

Component Name

person

(required)

Link to a person.

On success, the response status will be 201 and the Location header will contain the link to the newly created archive_permission.

newSubscription

Create a new subscribtion to this archive.

Create an ArchiveSubscriber record which allows an IPerson to access a private repository.

Parameters

Parameter	Value	Description
ws.op	(required) Fixed: `newSubscription`
date_expires		Date of Expiration The timestamp when the subscription will expire.
description		Description Free text describing this subscription.
subscriber	(required) Link to a person.	Subscriber The person who is subscribed.

On success, the response status will be 201 and the Location header will contain the link to the newly created archive_subscriber.

syncSource

Synchronise (copy) a single named source into this archive.

Copy a specific version of a named source to the destination archive if necessary.

Parameters

Parameter	Value	Description
ws.op	(required) Fixed: `syncSource`
from_archive	(required) Link to a archive.
include_binaries		Include Binaries Whether or not to copy binaries already built for this source
source_name	(required)	Source package name
to_pocket	(required)	Pocket name
to_series		Distroseries name
version	(required)	Version

syncSources

Synchronise (copy) named sources into this archive from another.

It will copy the most recent PUBLISHED versions of the named sources to the destination archive if necessary.

This operation will only succeeds when all requested packages are synchronised between the archives. If any of the requested copies cannot be performed, the whole operation will fail. There will be no partial changes of the destination archive.

Parameters

Parameter	Value	Description
ws.op	(required) Fixed: `syncSources`
from_archive	(required) Link to a archive.
include_binaries		Include Binaries Whether or not to copy binaries already built for this source
source_names	(required)	Source package names
to_pocket	(required)	Pocket name
to_series		Distroseries name

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

getDailyDownloadTotals

Get the daily download counts for this binary.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getDailyDownloadTotals

end_date

End date

start_date

Start date

getDownloadCount

Get the download count of this binary package in this archive.

This is currently only meaningful for PPAs.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getDownloadCount

getDownloadCounts

Get detailed download counts for this binary.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getDownloadCounts

end_date

End date

start_date

Start date

Response contains an application/json representation of a binary_package_release_download_count collection .

Custom POST methods

requestDeletion

Delete this publication.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: requestDeletion

removal_comment

Removal comment

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

canBeDeleted

Can this branch be deleted in its current state.

A branch is considered deletable if it has no revisions, is not linked to any bugs, specs, productseries, or code imports, and has no subscribers.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: canBeDeleted

composePublicURL

Return a public URL for the branch using the given protocol.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: composePublicURL

scheme

(required)

URL scheme

getMergeProposals

Returns all merge proposals of a given status.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getMergeProposals

status

A list of merge proposal statuses to filter by.

Response contains an application/json representation of a branch_merge_proposal collection .

getSubscription

Return the BranchSubscription for this person.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getSubscription

person

(required)

Link to a person.

The person to unsubscribe

Response contains an application/json representation of a branch_subscription.

isPersonTrustedReviewer

Return true if the reviewer is a trusted reviewer.

The reviewer is trusted if they are either own the branch, or are in the team that owns the branch, or they are in the review team for the branch.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: isPersonTrustedReviewer

reviewer

(required)

Link to a person.

A person for which the reviewer status is in question.

Custom POST methods

createMergeProposal

Create a new BranchMergeProposal with this branch as the source.

Both the target_branch and the prerequisite_branch, if it is there, must be branches with the same target as the source branch.

Personal branches (a.k.a. junk branches) cannot specify landing targets.

Parameters

Parameter	Value	Description
ws.op	(required) Fixed: `createMergeProposal`
commit_message		Commit message Message to use when committing this merge.
initial_comment		Initial comment Registrant's initial description of proposal.
needs_review		Needs review If True the proposal needs review.Otherwise, it will be work in progress.
prerequisite_branch	Link to a branch.
review_types
reviewers
target_branch	(required) Link to a branch.

On success, the response status will be 201 and the Location header will contain the link to the newly created branch_merge_proposal.

linkBug

Link a bug to this branch.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: linkBug

bug

(required)

Link to a bug.

linkSpecification

Link an ISpecification to a branch.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: linkSpecification

spec

(required)

Link to a specification.

requestMirror

Request that this branch be mirrored on the next run of the branch puller.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: requestMirror

setOwner

Set the owner of the branch to be new_owner.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: setOwner

new_owner

(required)

Link to a person.

The new owner of the branch.

setTarget

Set the target of the branch to be project or source_package.

Only one of project or source_package can be set, and if neither is set, the branch gets moved into the junk namespace of the branch owner.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: setTarget

project

Link to a project.

The project the branch belongs to.

source_package

Link to a source_package.

The source package the branch belongs to.

Subscribe this person to the branch.

Parameters

Parameter	Value	Description
ws.op	(required) Fixed: `subscribe`
code_review_level	(required) One of: `No email` `Status changes only` `Email about all changes`	The level of code review notification emails.
max_diff_lines	(required) One of: `Don't send diffs` `500 lines` `1000 lines` `5000 lines` `Send entire diff`	The max number of lines for diff email.
notification_level	(required) One of: `No email` `Branch attribute notifications only` `Branch revision notifications only` `Branch attribute and revision notifications`	The level of notification to subscribe to.
person	(required) Link to a person.	The person to subscribe.

Response contains an application/json representation of a branch_subscription.

unlinkBug

Unlink a bug to this branch.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: unlinkBug

bug

(required)

Link to a bug.

unlinkSpecification

Unlink an ISpecification to a branch.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: unlinkSpecification

spec

(required)

Link to a specification.

unsubscribe

Remove the person's subscription to this branch.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: unsubscribe

person

(required)

Link to a person.

The person to unsubscribe

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

getComment

Return the CodeReviewComment with the specified ID.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getComment

id

(required)

A CodeReviewComment ID.

Response contains an application/json representation of a code_review_comment.

Custom POST methods

createComment

Create an ICodeReviewComment associated with this merge proposal.

Parameters

Parameter	Value	Description
ws.op	(required) Fixed: `createComment`
content
parent	Link to a code_review_comment.
review_type
subject	(required)
vote	One of: `Approve` `Needs Fixing` `Needs Information` `Abstain` `Disapprove` `Resubmit`

On success, the response status will be 201 and the Location header will contain the link to the newly created code_review_comment.

nominateReviewer

Set the specified person as a reviewer.

If they are not already a reviewer, a vote is created. Otherwise, the details are updated.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: nominateReviewer

review_type

reviewer

(required)

Link to a person.

A reviewer.

Response contains an application/json representation of a code_review_vote_reference.

setStatus

Set the state of the merge proposal to the specified status.

Parameters

Parameter Value Description

ws.op

(required)

Fixed: setStatus

revid

An optional parameter for specifying the revision of the branch for the status change.

status

(required)

One of:

Work in progress
Needs review
Approved
Rejected
Merged
Code failed to merge
Queued
Superseded

The new status of the merge proposal.

updatePreviewDiff

Update the preview diff for this proposal.

If there is not an existing preview diff, one will be created.

Parameters

Parameter	Value	Description
ws.op	(required) Fixed: `updatePreviewDiff`
conflicts
diff_content	(required) Link to a file resource.
prerequisite_revision_id
source_revision_id	(required)
target_revision_id	(required)

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

canBeNominatedFor

Can this bug nominated for this target?

Returns True or False.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: canBeNominatedFor

target

(required)

Link to a bug_target.

Target

getHWSubmissions

Return HWDB submissions linked to this bug.

Only those submissions are returned which the user can access. Public submissions are always included; private submisisons only if the user is the owner or an admin.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getHWSubmissions

Response contains an application/json representation of a h_w_submission collection .

getNominationFor

Return the IBugNomination for the target.

If no nomination is found, a NotFoundError is raised.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getNominationFor

target

(required)

Link to a bug_target.

Target

Response contains an application/json representation of a bug_nomination.

getNominations

Return a list of all IBugNominations for this bug.

The list is ordered by IBugNominations.target.bugtargetdisplayname.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getNominations

nominations

Nominations to search through.

target

Link to a bug_target.

Target

Response contains an application/json representation of a bug_nomination collection .

Custom POST methods

addAttachment

Attach a file to this bug.

Parameters

Parameter	Value	Description
ws.op	(required) Fixed: `addAttachment`
comment	(required)
content_type
data	(required) Link to a file resource.
description
filename	(required)
is_patch

On success, the response status will be 201 and the Location header will contain the link to the newly created bug_attachment.

addNomination

Nominate a bug for an IDistroSeries or IProductSeries.

This method creates and returns a BugNomination. (See lp.bugs.model.bugnomination.BugNomination.)

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: addNomination

target

(required)

Link to a bug_target.

Target

On success, the response status will be 201 and the Location header will contain the link to the newly created bug_nomination.

addTask

Create a new bug task on this bug.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: addTask

target

(required)

Link to a bug_target.

Target

The software in which this bug should be fixed.

On success, the response status will be 201 and the Location header will contain the link to the newly created bug_task.

addWatch

Create a new watch for this bug on the given remote bug and bug tracker, owned by the person given as the owner.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: addWatch

bug_tracker

(required)

Link to a bug_tracker.

Bug System

You can register new bug trackers from the Launchpad Bugs home page.

remote_bug

(required)

Remote Bug

The bug number of this bug in the remote bug tracker.

On success, the response status will be 201 and the Location header will contain the link to the newly created bug_watch.

isUserAffected

Is :user: marked as affected by this bug?

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: isUserAffected

linkBranch

Associate a branch with this bug.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: linkBranch

branch

(required)

Link to a branch.

linkCVE

Ensure that this CVE is linked to this bug.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: linkCVE

cve

(required)

Link to a cve.

CVE

linkHWSubmission

Link a HWSubmission to this bug.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: linkHWSubmission

submission

(required)

Link to a h_w_submission.

A HWDB submission

markUserAffected

Mark :user: as affected by this bug.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: markUserAffected

affected

Does this bug affect you?

newMessage

Create a new message, and link it to this object.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: newMessage

content

(required)

Message

subject

Subject

On success, the response status will be 201 and the Location header will contain the link to the newly created message.

setCommentVisibility

Set the visible attribute on a bug comment. This is restricted to Launchpad admins, and will return a HTTP Error 401: Unauthorized error if called by non-admins.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: setCommentVisibility

comment_number

(required)

The number of the comment in the list of messages.

visible

(required)

Show this comment?

Subscribe person to the bug.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: subscribe

person

(required)

Link to a person.

Person

unlinkBranch

Unlink a branch from this bug.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: unlinkBranch

branch

(required)

Link to a branch.

unlinkCVE

Ensure that any links between this bug and the given CVE are removed.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: unlinkCVE

cve

(required)

Link to a cve.

CVE

unlinkHWSubmission

Remove a link to a HWSubmission.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: unlinkHWSubmission

submission

(required)

Link to a h_w_submission.

A HWDB submission

unsubscribe

Remove this person's subscription to this bug.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: unsubscribe

person

Link to a person.

Person

unsubscribeFromDupes

Remove this person's subscription from all dupes of this bug.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: unsubscribeFromDupes

person

Link to a person.

Person

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom POST methods

removeFromBug

Remove the attachment from the bug.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: removeFromBug

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

canApprove

Is this person allowed to approve the nomination?

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: canApprove

Custom POST methods

approve

Approve this bug for fixing in a series.

The status is set to APPROVED and the appropriate IBugTask(s) are created for the nomination target.

A nomination in any state can be approved. If the nomination is /already/ approved, this method is a noop.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: approve

decline

Decline this bug for fixing in a series.

The status is set to DECLINED.

If called on a nomination that is in APPROVED state, a BugNominationStatusError is raised. If the nomination was already DECLINED, this method is a noop.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: decline

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

canBeUnsubscribedByUser

Can the user unsubscribe the subscriber from the bug?

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: canBeUnsubscribedByUser

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

searchTasks

Search the IBugTasks reported on this entity.

Return an iterable of matching results.

Note: milestone is currently ignored for all IBugTargets except IProduct.

In order to search bugs that are related to a given hardware device, you must specify the bus, the vendor ID, the product ID of the device and set at least one of hardware_owner_is_bug_reporter, hardware_owner_is_affected_by_bug, hardware_owner_is_subscribed_to_bug, hardware_is_linked_to_bug to True.

Parameters

Parameter	Value	Description
ws.op	(required) Fixed: `searchTasks`
affected_user	Link to a person.
assignee	Link to a person.
bug_commenter	Link to a person.
bug_reporter	Link to a person.
bug_subscriber	Link to a person.
bug_supervisor	Link to a person.
component		Component Distribution package archive grouping. E.g. main, universe, multiverse.
hardware_bus	One of: `System` `PCI` `USB` `IEEE1394` `SCSI` `Parallel Port` `Serial port` `IDE` `ATA` `Floppy` `IPI` `SATA` `SAS` `PC Card (32 bit)` `PCMCIA (16 bit)`	The bus of a hardware device related to a bug.
hardware_driver_name		The driver controlling a hardware device related to a bug.
hardware_driver_package_name		The package of the driver which controls a hardware device related to a bug.
hardware_is_linked_to_bug		Search for bugs which are linked to hardware reports which contain the given device or whcih contain a devicecontrolled by the given driver.
hardware_owner_is_affected_by_bug		Search for bugs where people affected by a bug own the given device or use the given hardware driver.
hardware_owner_is_bug_reporter		Search for bugs reported by people who own the given device or who use the given hardware driver.
hardware_owner_is_subscribed_to_bug		Search for bugs where a bug subscriber owns the given device or uses the given hardware driver.
hardware_product_id		The product ID of a hardware device related to a bug. Allowed values of the product ID depend on the bus of the device. Product IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed. SCSI product IDs are strings with exactly 16 characters. Shorter names are right-padded with space (0x20) characters. IDs for other buses may be arbitrary strings.
hardware_vendor_id		The vendor ID of a hardware device related to a bug. Allowed values of the vendor ID depend on the bus of the device. Vendor IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed. SCSI vendor IDs are strings with exactly 8 characters. Shorter names are right-padded with space (0x20) characters. IDs for other buses may be arbitrary strings.
has_cve	True or False	Show only bugs associated with a CVE.
has_no_package	True or False	Exclude bugs with packages specified.
has_patch	True or False	Show only bugs with patches available.
importance		Importance Show only bugs with the given importance or list of importances.
linked_branches	One of: `Show all bugs` `Show only Bugs with linked Branches` `Show only Bugs without linked Branches`	Search for bugs that are linked to branches or for bugs that are not linked to branches.
milestone		Milestone Show only bug tasks targeted to this milestone.
milestone_assignment		Target
nominated_for	Link to a distro_series.
omit_duplicates	True or False	Omit bugs marked as duplicate,
omit_targeted	True or False	Omit bugs targeted to series
order_by		List of fields by which the results are ordered.
owner	Link to a person.
search_text		Bug ID or search text.
status		Status Show only bugs with the given status value or list of values. See bug_task for list of valid status values.
status_upstream	One of: pending_bugwatch hide_upstream resolved_upstream open_upstream	Status upstream Indicates the status of any remote watches associated with the bug.
tags		Tags String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'.
tags_combinator	One of: `Any` `All`	Tags combination Search for any or all of the tags specified.

Response contains an application/json representation of a bug_task collection .

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

findSimilarBugs

Return the list of possible duplicates for this BugTask.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: findSimilarBugs

Response contains an application/json representation of a bug collection .

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom POST methods

rescore

Change the build's score.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: rescore

score

(required)

Score

retry

Restore the build record to its initial state.

Build record loses its history, is moved to NEEDSBUILD and a new non-scored BuildQueue entry is created for it.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: retry

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom POST methods

requestImport

Request that an import be tried soon.

This method will schedule an import to happen soon for this branch.

The import must be in the Reviewed state, if not then a CodeImportNotInReviewedState error will be thrown. If using the API then a status code of 400 will result.

If the import is already running then a CodeImportAlreadyRunning error will be thrown. If using the API then a status code of 400 will result.

The two cases can be distinguished over the API by seeing if the exception names appear in the body of the response.

If used over the API and the request has already been made then this method will silently do nothing. If called internally then the error_if_already_requested parameter controls whether a CodeImportAlreadyRequested exception will be thrown in that situation.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: requestImport

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom POST methods

claimReview

Change a pending review into a review for claimant.

Pending team reviews can be claimed by members of that team. This allows reviews to be moved of the general team todo list, and onto a personal todo list.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: claimReview

reassignReview

Reassign a pending review to someone else.

Pending reviews can be reassigned to someone else.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: reassignReview

reviewer

(required)

Link to a person.

The person or team to assign to do the review.

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

getArchive

Return the distribution archive with the given name.

Only distribution archives are considered -- PPAs will not be found.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getArchive

name

(required)

Archive name

Response contains an application/json representation of a archive.

getBuildRecords

Return build records in the context it is implemented.

It excludes build records generated by Gina (imported from a external repository), where IBuild.datebuilt is null and IBuild.buildstate is BuildStatus.FULLYBUILT.

The result is simply not filtered if the optional filters are omitted by call sites.

Parameters

Parameter	Value	Description
ws.op	(required) Fixed: `getBuildRecords`
build_state	One of: `Needs building` `Successfully built` `Failed to build` `Dependency wait` `Chroot problem` `Build for superseded Source` `Currently building` `Failed to upload`	Build status The status of this build record
pocket	One of: `Release` `Security` `Updates` `Proposed` `Backports`	Pocket The pocket into which this entry is published
source_name		Source package name

Response contains an application/json representation of a build collection .

getCountryMirror

Return the country DNS mirror for a country and content type.

Parameters

Parameter Value Description

ws.op

(required)

Fixed: getCountryMirror

country

(required)

Link to a country.

Location

The country in which this mirror is based.

mirror_type

(required)

One of:

Archive
CD Image

Content

Choose "CD Image" if this mirror contains CD images of this distribution. Choose "Archive" if this is a mirror of packages for this distribution.

Response contains an application/json representation of a distribution_mirror.

getDevelopmentSeries

Return the DistroSeries which are marked as in development.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getDevelopmentSeries

Response contains an application/json representation of a distro_series collection .

getMilestone

Return a milestone with the given name for this object, or None.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getMilestone

name

(required)

Name

Response contains an application/json representation of a milestone.

getMirrorByName

Return the mirror with the given name for this distribution or None if it's not found.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getMirrorByName

name

(required)

Name

Response contains an application/json representation of a distribution_mirror.

getSeries

Return the series with the name or version given.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getSeries

name_or_version

(required)

Name or version

Response contains an application/json representation of a distro_series.

getSourcePackage

Return a DistributionSourcePackage with the given name for this distribution, or None.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getSourcePackage

name

(required)

Package name

Response contains an application/json representation of a distribution_source_package.

getSubscription

Return the subscription for person, if it exists.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getSubscription

person

(required)

Link to a person.

Response contains an application/json representation of a structural_subscription.

getSubscriptions

Return all the subscriptions with the specified levels.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getSubscriptions

Response contains an application/json representation of a structural_subscription collection .

searchSourcePackages

Search for source packages that correspond to the given text.

This method just decorates the result of searchSourcePackageCaches() to return DistributionSourcePackages.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: searchSourcePackages

source_match

(required)

Source package name substring match

Response contains an application/json representation of a distribution_source_package collection .

searchTasks

Search the IBugTasks reported on this entity.

Return an iterable of matching results.

Note: milestone is currently ignored for all IBugTargets except IProduct.

In order to search bugs that are related to a given hardware device, you must specify the bus, the vendor ID, the product ID of the device and set at least one of hardware_owner_is_bug_reporter, hardware_owner_is_affected_by_bug, hardware_owner_is_subscribed_to_bug, hardware_is_linked_to_bug to True.

Parameters

Parameter	Value	Description
ws.op	(required) Fixed: `searchTasks`
affected_user	Link to a person.
assignee	Link to a person.
bug_commenter	Link to a person.
bug_reporter	Link to a person.
bug_subscriber	Link to a person.
bug_supervisor	Link to a person.
component		Component Distribution package archive grouping. E.g. main, universe, multiverse
hardware_bus	One of: `System` `PCI` `USB` `IEEE1394` `SCSI` `Parallel Port` `Serial port` `IDE` `ATA` `Floppy` `IPI` `SATA` `SAS` `PC Card (32 bit)` `PCMCIA (16 bit)`	The bus of a hardware device related to a bug
hardware_driver_name		The driver controlling a hardware device related to a bug.
hardware_driver_package_name		The package of the driver which controls a hardware device related to a bug.
hardware_is_linked_to_bug		Search for bugs which are linked to hardware reports which contain the given device or whcih contain a devicecontrolled by the given driver.
hardware_owner_is_affected_by_bug		Search for bugs where people affected by a bug own the given device or use the given hardware driver.
hardware_owner_is_bug_reporter		Search for bugs reported by people who own the given device or who use the given hardware driver.
hardware_owner_is_subscribed_to_bug		Search for bugs where a bug subscriber owns the given device or uses the given hardware driver.
hardware_product_id		The product ID of a hardware device related to a bug. Allowed values of the product ID depend on the bus of the device. Product IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed. SCSI product IDs are strings with exactly 16 characters. Shorter names are right-padded with space (0x20) characters. IDs for other buses may be arbitrary strings.
hardware_vendor_id		The vendor ID of a hardware device related to a bug. Allowed values of the vendor ID depend on the bus of the device. Vendor IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed. SCSI vendor IDs are strings with exactly 8 characters. Shorter names are right-padded with space (0x20) characters. IDs for other buses may be arbitrary strings.
has_cve	True or False	Show only bugs associated with a CVE.
has_no_package	True or False	Exclude bugs with packages specified.
has_patch	True or False	Show only bugs with patches available.
importance		Importance Show only bugs with the given importance or list of importances.
linked_branches	One of: `Show all bugs` `Show only Bugs with linked Branches` `Show only Bugs without linked Branches`	Search for bugs that are linked to branches or for bugs that are not linked to branches.
milestone		Milestone Show only bug tasks targeted to this milestone.
milestone_assignment		Target
nominated_for	Link to a distro_series.
omit_duplicates	True or False	Omit bugs marked as duplicate,
omit_targeted	True or False	Omit bugs targeted to series
order_by		List of fields by which the results are ordered.
owner	Link to a person.
search_text		Bug ID or search text.
status
status	One of: New Incomplete Incomplete (with response) Incomplete (without response) Invalid Won't Fix Expired Confirmed Triaged In Progress Fix Committed Fix Released	Status Show only bugs with the given status value or list of values. See bug_task for list of valid status values.
status_upstream	One of: pending_bugwatch hide_upstream resolved_upstream open_upstream	Status upstream Indicates the status of any remote watches associated with the bug.
tags		Tags String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'
tags_combinator	One of: `Any` `All`	Tags combination Search for any or all of the tags specified.

Response contains an application/json representation of a bug_task collection .

Custom POST methods

addBugSubscription

Add a bug subscription for this structure.

This method is used to create a new IStructuralSubscription for the target with the bug notification level set to COMMENTS, the only level currently in use.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: addBugSubscription

subscriber

Link to a person.

Person to subscribe. If omitted, the requesting user will be subscribed.

On success, the response status will be 201 and the Location header will contain the link to the newly created structural_subscription.

addOfficialBugTag

Add tag to the official bug tags of this target.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: addOfficialBugTag

tag

(required)

The official bug tag

removeBugSubscription

Remove a subscription to bugs from this structure.

If subscription levels for other applications are set, set the subscription's bug_notification_level to NOTHING, otherwise, destroy the subscription.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: removeBugSubscription

subscriber

Link to a person.

Person to unsubscribe. If omitted, the requesting user will be unsubscribed.

removeOfficialBugTag

Remove tag from the official bug tags of this target.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: removeOfficialBugTag

tag

(required)

The official bug tag

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

canTransitionToCountryMirror

Verify if a mirror can be set as a country mirror or return False.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: canTransitionToCountryMirror

getOverallFreshness

Return this mirror's overall freshness.

For ARCHIVE mirrors, the overall freshness is the worst freshness of all of this mirror's content objects (MirrorDistroArchSeries, MirrorDistroSeriesSource or MirrorCDImageDistroSeriess).

For RELEASE mirrors, the overall freshness is either UPTODATE, if the mirror contains all ISO images that it should or UNKNOWN if it doesn't contain one or more ISO images.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getOverallFreshness

isOfficial

Return True if this is an official mirror.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: isOfficial

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

getBranches

Returns all branches with the given lifecycle status.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getBranches

modified_since

Limit the branches to those modified since this date.

status

A list of branch lifecycle statuses to filter by.

Response contains an application/json representation of a branch collection .

getBugTasks

Bug tasks on this source package, sorted newest first.

If needed, you can limit the number of bugtasks you are interested in using the quantity parameter.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getBugTasks

limit

The maximum number of bug tasks to return

Response contains an application/json representation of a bug_task collection .

getMergeProposals

Returns all merge proposals of a given status.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getMergeProposals

status

A list of merge proposal statuses to filter by.

Response contains an application/json representation of a branch_merge_proposal collection .

getSubscription

Return the subscription for person, if it exists.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getSubscription

person

(required)

Link to a person.

Response contains an application/json representation of a structural_subscription.

getSubscriptions

Return all the subscriptions with the specified levels.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getSubscriptions

Response contains an application/json representation of a structural_subscription collection .

searchTasks

Search the IBugTasks reported on this entity.

Return an iterable of matching results.

Note: milestone is currently ignored for all IBugTargets except IProduct.

In order to search bugs that are related to a given hardware device, you must specify the bus, the vendor ID, the product ID of the device and set at least one of hardware_owner_is_bug_reporter, hardware_owner_is_affected_by_bug, hardware_owner_is_subscribed_to_bug, hardware_is_linked_to_bug to True.

Parameters

Parameter	Value	Description
ws.op	(required) Fixed: `searchTasks`
affected_user	Link to a person.
assignee	Link to a person.
bug_commenter	Link to a person.
bug_reporter	Link to a person.
bug_subscriber	Link to a person.
bug_supervisor	Link to a person.
component		Component Distribution package archive grouping. E.g. main, universe, multiverse
hardware_bus	One of: `System` `PCI` `USB` `IEEE1394` `SCSI` `Parallel Port` `Serial port` `IDE` `ATA` `Floppy` `IPI` `SATA` `SAS` `PC Card (32 bit)` `PCMCIA (16 bit)`	The bus of a hardware device related to a bug
hardware_driver_name		The driver controlling a hardware device related to a bug.
hardware_driver_package_name		The package of the driver which controls a hardware device related to a bug.
hardware_is_linked_to_bug		Search for bugs which are linked to hardware reports which contain the given device or whcih contain a devicecontrolled by the given driver.
hardware_owner_is_affected_by_bug		Search for bugs where people affected by a bug own the given device or use the given hardware driver.
hardware_owner_is_bug_reporter		Search for bugs reported by people who own the given device or who use the given hardware driver.
hardware_owner_is_subscribed_to_bug		Search for bugs where a bug subscriber owns the given device or uses the given hardware driver.
hardware_product_id		The product ID of a hardware device related to a bug. Allowed values of the product ID depend on the bus of the device. Product IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed. SCSI product IDs are strings with exactly 16 characters. Shorter names are right-padded with space (0x20) characters. IDs for other buses may be arbitrary strings.
hardware_vendor_id		The vendor ID of a hardware device related to a bug. Allowed values of the vendor ID depend on the bus of the device. Vendor IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed. SCSI vendor IDs are strings with exactly 8 characters. Shorter names are right-padded with space (0x20) characters. IDs for other buses may be arbitrary strings.
has_cve	True or False	Show only bugs associated with a CVE.
has_no_package	True or False	Exclude bugs with packages specified.
has_patch	True or False	Show only bugs with patches available.
importance		Importance Show only bugs with the given importance or list of importances.
linked_branches	One of: `Show all bugs` `Show only Bugs with linked Branches` `Show only Bugs without linked Branches`	Search for bugs that are linked to branches or for bugs that are not linked to branches.
milestone		Milestone Show only bug tasks targeted to this milestone.
milestone_assignment		Target
nominated_for	Link to a distro_series.
omit_duplicates	True or False	Omit bugs marked as duplicate,
omit_targeted	True or False	Omit bugs targeted to series
order_by		List of fields by which the results are ordered.
owner	Link to a person.
search_text		Bug ID or search text.
status		Status Show only bugs with the given status value or list of values. See bug_task for list of valid status values.
status_upstream	One of: pending_bugwatch hide_upstream resolved_upstream open_upstream	Status upstream Indicates the status of any remote watches associated with the bug.
tags		Tags String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'
tags_combinator	One of: `Any` `All`	Tags combination Search for any or all of the tags specified.

Response contains an application/json representation of a bug_task collection .

Custom POST methods

addBugSubscription

Add a bug subscription for this structure.

This method is used to create a new IStructuralSubscription for the target with the bug notification level set to COMMENTS, the only level currently in use.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: addBugSubscription

subscriber

Link to a person.

Person to subscribe. If omitted, the requesting user will be subscribed.

On success, the response status will be 201 and the Location header will contain the link to the newly created structural_subscription.

removeBugSubscription

Remove a subscription to bugs from this structure.

If subscription levels for other applications are set, set the subscription's bug_notification_level to NOTHING, otherwise, destroy the subscription.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: removeBugSubscription

subscriber

Link to a person.

Person to unsubscribe. If omitted, the requesting user will be unsubscribed.

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

getBuildRecords

Return build records in the context it is implemented.

It excludes build records generated by Gina (imported from a external repository), where IBuild.datebuilt is null and IBuild.buildstate is BuildStatus.FULLYBUILT.

The result is simply not filtered if the optional filters are omitted by call sites.

Parameters

Parameter	Value	Description
ws.op	(required) Fixed: `getBuildRecords`
build_state	One of: `Needs building` `Successfully built` `Failed to build` `Dependency wait` `Chroot problem` `Build for superseded Source` `Currently building` `Failed to upload`	Build status The status of this build record
pocket	One of: `Release` `Security` `Updates` `Proposed` `Backports`	Pocket The pocket into which this entry is published
source_name		Source package name

Response contains an application/json representation of a build collection .

getDistroArchSeries

Return the distroarchseries for this distroseries with the given architecturetag.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getDistroArchSeries

archtag

(required)

The architecture tag

Response contains an application/json representation of a distro_arch_series.

getPackageUploads

Get package upload records for this distribution series.

Parameters

Parameter	Value	Description
ws.op	(required) Fixed: `getPackageUploads`
archive	Link to a archive.	Archive Return only items for this archive.
created_since_date		Created Since Timestamp Return items that are more recent than this timestamp.
custom_type	One of: `raw-installer` `raw-translations` `raw-dist-upgrader` `raw-ddtp-tarball` `raw-translations-static`	Custom Type Return only items with custom files of this type.
pocket	One of: `Release` `Security` `Updates` `Proposed` `Backports`	Pocket Return only items targeted to this pocket
status	One of: `New` `Unapproved` `Accepted` `Done` `Rejected`	Package Upload Status Return only items that have this status.

Response contains an application/json representation of a package_upload collection .

getSourcePackage

Return a source package in this distro series by name.

The name given may be a string or an ISourcePackageName-providing object. The source package may not be published in the distro series.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getSourcePackage

name

(required)

The name of the source package

Response contains an application/json representation of a source_package.

getSubscription

Return the subscription for person, if it exists.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getSubscription

person

(required)

Link to a person.

Response contains an application/json representation of a structural_subscription.

getSubscriptions

Return all the subscriptions with the specified levels.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getSubscriptions

Response contains an application/json representation of a structural_subscription collection .

searchTasks

Search the IBugTasks reported on this entity.

Return an iterable of matching results.

Note: milestone is currently ignored for all IBugTargets except IProduct.

In order to search bugs that are related to a given hardware device, you must specify the bus, the vendor ID, the product ID of the device and set at least one of hardware_owner_is_bug_reporter, hardware_owner_is_affected_by_bug, hardware_owner_is_subscribed_to_bug, hardware_is_linked_to_bug to True.

Parameters

Parameter	Value	Description
ws.op	(required) Fixed: `searchTasks`
affected_user	Link to a person.
assignee	Link to a person.
bug_commenter	Link to a person.
bug_reporter	Link to a person.
bug_subscriber	Link to a person.
bug_supervisor	Link to a person.
component		Component Distribution package archive grouping. E.g. main, universe, multiverse
hardware_bus	One of: `System` `PCI` `USB` `IEEE1394` `SCSI` `Parallel Port` `Serial port` `IDE` `ATA` `Floppy` `IPI` `SATA` `SAS` `PC Card (32 bit)` `PCMCIA (16 bit)`	The bus of a hardware device related to a bug
hardware_driver_name		The driver controlling a hardware device related to a bug.
hardware_driver_package_name		The package of the driver which controls a hardware device related to a bug.
hardware_is_linked_to_bug		Search for bugs which are linked to hardware reports which contain the given device or whcih contain a devicecontrolled by the given driver.
hardware_owner_is_affected_by_bug		Search for bugs where people affected by a bug own the given device or use the given hardware driver.
hardware_owner_is_bug_reporter		Search for bugs reported by people who own the given device or who use the given hardware driver.
hardware_owner_is_subscribed_to_bug		Search for bugs where a bug subscriber owns the given device or uses the given hardware driver.
hardware_product_id		The product ID of a hardware device related to a bug. Allowed values of the product ID depend on the bus of the device. Product IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed. SCSI product IDs are strings with exactly 16 characters. Shorter names are right-padded with space (0x20) characters. IDs for other buses may be arbitrary strings.
hardware_vendor_id		The vendor ID of a hardware device related to a bug. Allowed values of the vendor ID depend on the bus of the device. Vendor IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed. SCSI vendor IDs are strings with exactly 8 characters. Shorter names are right-padded with space (0x20) characters. IDs for other buses may be arbitrary strings.
has_cve	True or False	Show only bugs associated with a CVE.
has_no_package	True or False	Exclude bugs with packages specified.
has_patch	True or False	Show only bugs with patches available.
importance		Importance Show only bugs with the given importance or list of importances.
linked_branches	One of: `Show all bugs` `Show only Bugs with linked Branches` `Show only Bugs without linked Branches`	Search for bugs that are linked to branches or for bugs that are not linked to branches.
milestone		Milestone Show only bug tasks targeted to this milestone.
milestone_assignment		Target
nominated_for	Link to a distro_series.
omit_duplicates	True or False	Omit bugs marked as duplicate,
omit_targeted	True or False	Omit bugs targeted to series
order_by		List of fields by which the results are ordered.
owner	Link to a person.
search_text		Bug ID or search text.
status		Status Show only bugs with the given status value or list of values. See bug_task for list of valid status values.
status_upstream	One of: pending_bugwatch hide_upstream resolved_upstream open_upstream	Status upstream Indicates the status of any remote watches associated with the bug.
tags		Tags String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'
tags_combinator	One of: `Any` `All`	Tags combination Search for any or all of the tags specified.

Response contains an application/json representation of a bug_task collection .

Custom POST methods

addBugSubscription

Add a bug subscription for this structure.

This method is used to create a new IStructuralSubscription for the target with the bug notification level set to COMMENTS, the only level currently in use.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: addBugSubscription

subscriber

Link to a person.

Person to subscribe. If omitted, the requesting user will be subscribed.

On success, the response status will be 201 and the Location header will contain the link to the newly created structural_subscription.

newMilestone

Create a new milestone for this DistroSeries.

Parameters

Parameter	Value	Description
ws.op	(required) Fixed: `newMilestone`
code_name		Code name An alternative name for the milestone.
date_targeted		Date Targeted Example: 2005-11-24
name	(required)	Name Only letters, numbers, and simple punctuation are allowed.
summary		Summary A summary of the features and status of this milestone.

On success, the response status will be 201 and the Location header will contain the link to the newly created milestone.

removeBugSubscription

Remove a subscription to bugs from this structure.

If subscription levels for other applications are set, set the subscription's bug_notification_level to NOTHING, otherwise, destroy the subscription.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: removeBugSubscription

subscriber

Link to a person.

Person to unsubscribe. If omitted, the requesting user will be unsubscribed.

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

getSubmissions

List all submissions which mention this device.

Only submissions matching all given criteria are returned. Only one of :distribution: or :distroseries: may be supplied.

Parameters

Parameter	Value	Description
ws.op	(required) Fixed: `getSubmissions`
architecture		A processor architecture If specified, the result set is limited to sumbissions made for the given architecture.
distribution	Link to a distribution.	A Distribution If specified, the result set is limited to sumbissions made for the given distribution.
distroseries	Link to a distro_series.	A Distribution Series If specified, the result set is limited to sumbissions made for the given distribution series.
driver	Link to a h_w_driver.	A driver used for this device in a submission If specified, the result set is limited to sumbissions made for the given distribution, distroseries or distroarchseries.
owner	Link to a person.	The owner of this submission

Response contains an application/json representation of a h_w_submission collection .

Custom POST methods

getOrCreateDeviceClass

Return an IHWDeviceClass record or create a new one.

main_class and sub_class are integers specifying the class of the device, or, in the case of USB devices, the class of an interface.

IHWDeviceClass records must be unique; if this method is called to create a new record with data of an already existing record, the existing record is returned.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getOrCreateDeviceClass

main_class

(required)

The main class of this device

sub_class

The sub class of this device

Response contains an application/json representation of a h_w_device_class.

removeDeviceClass

Add an IHWDeviceClass record.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: removeDeviceClass

main_class

(required)

The main class of this device

sub_class

The sub class of this device

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

getSubmissions

List all submissions which mention this driver.

Only submissions matching all given criteria are returned. Only one of :distribution: or :distroseries: may be supplied.

Parameters

Parameter	Value	Description
ws.op	(required) Fixed: `getSubmissions`
architecture		A processor architecture If specified, the result set is limited to sumbissions made for the given architecture.
distribution	Link to a distribution.	A Distribution If specified, the result set is limited to sumbissions made for the given distribution.
distroseries	Link to a distro_series.	A Distribution Series If specified, the result set is limited to sumbissions made for the given distribution series.
owner	Link to a person.	The owner of this submission

Response contains an application/json representation of a h_w_submission collection .

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

searchTasks

Search the IBugTasks reported on this entity.

Return an iterable of matching results.

Note: milestone is currently ignored for all IBugTargets except IProduct.

In order to search bugs that are related to a given hardware device, you must specify the bus, the vendor ID, the product ID of the device and set at least one of hardware_owner_is_bug_reporter, hardware_owner_is_affected_by_bug, hardware_owner_is_subscribed_to_bug, hardware_is_linked_to_bug to True.

Parameters

Parameter	Value	Description
ws.op	(required) Fixed: `searchTasks`
affected_user	Link to a person.
assignee	Link to a person.
bug_commenter	Link to a person.
bug_reporter	Link to a person.
bug_subscriber	Link to a person.
bug_supervisor	Link to a person.
component		Component Distribution package archive grouping. E.g. main, universe, multiverse
hardware_bus	One of: `System` `PCI` `USB` `IEEE1394` `SCSI` `Parallel Port` `Serial port` `IDE` `ATA` `Floppy` `IPI` `SATA` `SAS` `PC Card (32 bit)` `PCMCIA (16 bit)`	The bus of a hardware device related to a bug
hardware_driver_name		The driver controlling a hardware device related to a bug.
hardware_driver_package_name		The package of the driver which controls a hardware device related to a bug.
hardware_is_linked_to_bug		Search for bugs which are linked to hardware reports which contain the given device or whcih contain a devicecontrolled by the given driver.
hardware_owner_is_affected_by_bug		Search for bugs where people affected by a bug own the given device or use the given hardware driver.
hardware_owner_is_bug_reporter		Search for bugs reported by people who own the given device or who use the given hardware driver.
hardware_owner_is_subscribed_to_bug		Search for bugs where a bug subscriber owns the given device or uses the given hardware driver.
hardware_product_id		The product ID of a hardware device related to a bug. Allowed values of the product ID depend on the bus of the device. Product IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed. SCSI product IDs are strings with exactly 16 characters. Shorter names are right-padded with space (0x20) characters. IDs for other buses may be arbitrary strings.
hardware_vendor_id		The vendor ID of a hardware device related to a bug. Allowed values of the vendor ID depend on the bus of the device. Vendor IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed. SCSI vendor IDs are strings with exactly 8 characters. Shorter names are right-padded with space (0x20) characters. IDs for other buses may be arbitrary strings.
has_cve	True or False	Show only bugs associated with a CVE.
has_no_package	True or False	Exclude bugs with packages specified.
has_patch	True or False	Show only bugs with patches available.
importance		Importance Show only bugs with the given importance or list of importances.
linked_branches	One of: `Show all bugs` `Show only Bugs with linked Branches` `Show only Bugs without linked Branches`	Search for bugs that are linked to branches or for bugs that are not linked to branches.
milestone		Milestone Show only bug tasks targeted to this milestone.
milestone_assignment		Target
nominated_for	Link to a distro_series.
omit_duplicates	True or False	Omit bugs marked as duplicate,
omit_targeted	True or False	Omit bugs targeted to series
order_by		List of fields by which the results are ordered.
owner	Link to a person.
search_text		Bug ID or search text.
status		Status Show only bugs with the given status value or list of values. See bug_task for list of valid status values.
status_upstream	One of: pending_bugwatch hide_upstream resolved_upstream open_upstream	Status upstream Indicates the status of any remote watches associated with the bug.
tags		Tags String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'
tags_combinator	One of: `Any` `All`	Tags combination Search for any or all of the tags specified.

Response contains an application/json representation of a bug_task collection .

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

deviceDriverOwnersAffectedByBugs

Return persons affected by given bugs and owning a given device.

bug_ids must be a non-empty sequence of bug IDs, or bug_tags must be a non-empty sequence of bug tags.

The parameters bus, vendor_id, product_id must not be None, or driver_name must not be None.

By default, only those persons are returned which have reported a bug matching the given bug conditions.

Owners of private submissions are returned only if user is the owner of the private submission or if user is an admin.

Parameters

Parameter	Value	Description
ws.op	(required) Fixed: `deviceDriverOwnersAffectedByBugs`
affected_by_bug		Search for users affected by a bug If true, those device owners are looked up which are affected by one of the selected bugs.
bug_ids		A set of bug IDs Search submitters, subscribers or affected users of bugs with these IDs.
bug_tags		A set of bug tags Search submitters, subscribers or affected users of bugs having one of these tags.
bus	One of: `System` `PCI` `USB` `IEEE1394` `SCSI` `Parallel Port` `Serial port` `IDE` `ATA` `Floppy` `IPI` `SATA` `SAS` `PC Card (32 bit)` `PCMCIA (16 bit)`	The device bus
driver_name		A driver name If specified, the search is limited to devices controlled by this driver.
package_name		A package name If specified, the search is limited to devices controlled by a driver from this package.
product_id		The product ID Allowed values of the product ID depend on the bus of the device. Product IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed. SCSI product IDs are strings with exactly 16 characters. Shorter names are right-padded with space (0x20) characters. IDs for other buses may be arbitrary strings.
subscribed_to_bug		Search for users who subscribed to a bug If true, those device owners are looked up which to one of the selected bugs.
vendor_id		The vendor ID Allowed values of the vendor ID depend on the bus of the device. Vendor IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed. SCSI vendor IDs are strings with exactly 8 characters. Shorter names are right-padded with space (0x20) characters. IDs for other buses may be arbitrary strings.

Response contains an application/json representation of a person collection .

devices

Return the set of devices.

Parameters

Parameter	Value	Description
ws.op	(required) Fixed: `devices`
bus	(required) One of: `System` `PCI` `USB` `IEEE1394` `SCSI` `Parallel Port` `Serial port` `IDE` `ATA` `Floppy` `IPI` `SATA` `SAS` `PC Card (32 bit)` `PCMCIA (16 bit)`	The device bus
product_id		The product ID Allowed values of the product ID depend on the bus of the device. Product IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed. SCSI product IDs are strings with exactly 16 characters. Shorter names are right-padded with space (0x20) characters. IDs for other buses may be arbitrary strings.
vendor_id	(required)	The vendor ID Allowed values of the vendor ID depend on the bus of the device. Vendor IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed. SCSI vendor IDs are strings with exactly 8 characters. Shorter names are right-padded with space (0x20) characters. IDs for other buses may be arbitrary strings.

Response contains an application/json representation of a h_w_device collection .

drivers

Return the set of drivers.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: drivers

name

The name of the driver.

If name is omitted, all driver records are returned, optionally limited to those matching the parameter package_name.

package_name

The name of the package containing the driver.

If package_name is omitted, all driver records returned, optionally limited to those matching the parameter name. If package_name is (empty string), those records are returned where package_name is or None.

Response contains an application/json representation of a h_w_driver collection .

hwInfoByBugRelatedUsers

Return a list of owners and devices related to given bugs.

Actually returns a list of tuples where the tuple is of the form, (person name, bus name, vendor id, product id).`

Parameters

Parameter	Value	Description
ws.op	(required) Fixed: `hwInfoByBugRelatedUsers`
affected_by_bug		Search for users affected by a bug If true, those device owners are looked up which are affected by one of the selected bugs.
bug_ids		A set of bug IDs Search for devices and their owners related to bugs with these IDs.
bug_tags		A set of bug tags Search for devices and their owners related to bugs having one of these tags.
subscribed_to_bug		Search for users who subscribed to a bug If true, those device owners are looked up which to one of the selected bugs.

numDevicesInSubmissions

Count how often a device or a driver appears in HWDB submissions.

You may specify at most one of the parameters distribution, distroseries or distroarchseries.

At least each of bus, vendor_id, product_id must not be None or driver_name must not be None.

Parameters

Parameter	Value	Description
ws.op	(required) Fixed: `numDevicesInSubmissions`
bus	One of: `System` `PCI` `USB` `IEEE1394` `SCSI` `Parallel Port` `Serial port` `IDE` `ATA` `Floppy` `IPI` `SATA` `SAS` `PC Card (32 bit)` `PCMCIA (16 bit)`	The device bus
distribution	Link to a distribution.	A Distribution If specified, the result set is limited to submissions made for this distribution.
distroarchseries	Link to a distro_arch_series.	A Distribution Series If specified, the result set is limited to submissions made for the given distroarchseries.
distroseries	Link to a distro_series.	A Distribution Series If specified, the result set is limited to submissions made for the given distribution series.
driver_name		A driver name If specified, the count is limited to devices controlled by this driver.
package_name		A package name If specified, the count is limited to devices controlled by a driver from this package.
product_id		The product ID Allowed values of the product ID depend on the bus of the device. Product IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed. SCSI product IDs are strings with exactly 16 characters. Shorter names are right-padded with space (0x20) characters. IDs for other buses may be arbitrary strings.
vendor_id		The vendor ID Allowed values of the vendor ID depend on the bus of the device. Vendor IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed. SCSI vendor IDs are strings with exactly 8 characters. Shorter names are right-padded with space (0x20) characters. IDs for other buses may be arbitrary strings.

numOwnersOfDevice

The number of people owning a device or using a driver.

Returns a dictionary {'owners': n1, 'all_submitters': n2} where owners is the number of people who made a HWDB submission containing the given device or driver, optionally limited to submissions made for the given distro target. all_submitters is the number of persons who made a HWDB submission, optionally limited to submission made on the given distro target installation.

You may specify at most one of the parameters distribution, distroseries or distroarchseries.

At least each of bus, vendor_id, product_id must not be None or driver_name must not be None.

Parameters

Parameter	Value	Description
ws.op	(required) Fixed: `numOwnersOfDevice`
bus	One of: `System` `PCI` `USB` `IEEE1394` `SCSI` `Parallel Port` `Serial port` `IDE` `ATA` `Floppy` `IPI` `SATA` `SAS` `PC Card (32 bit)` `PCMCIA (16 bit)`	The device bus
distribution	Link to a distribution.	A Distribution If specified, the result set is limited to submissions made for this distribution.
distroarchseries	Link to a distro_arch_series.	A Distribution Series If specified, the result set is limited to submissions made for the given distroarchseries.
distroseries	Link to a distro_series.	A Distribution Series If specified, the result set is limited to submissions made for the given distribution series.
driver_name		A driver name If specified, the count is limited to devices controlled by this driver.
package_name		A package name If specified, the count is limited to devices controlled by a driver from this package.
product_id		The product ID Allowed values of the product ID depend on the bus of the device. Product IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed. SCSI product IDs are strings with exactly 16 characters. Shorter names are right-padded with space (0x20) characters. IDs for other buses may be arbitrary strings.
vendor_id		The vendor ID Allowed values of the vendor ID depend on the bus of the device. Vendor IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed. SCSI vendor IDs are strings with exactly 8 characters. Shorter names are right-padded with space (0x20) characters. IDs for other buses may be arbitrary strings.

numSubmissionsWithDevice

Count the number of submissions mentioning a device or a driver.

Returns a dictionary {'submissions_with_device: n1, 'all_submissions': n2}, where submissions_with_device is the number of submissions having the given device or driver and matching the distro target criterion and where all_submissions is the number of submissions matching the distro target criterion.

You may specify at most one of the parameters distribution, distroseries or distroarchseries.

At least each of bus, vendor_id, product_id must not be None or driver_name must not be None.

Parameters

Parameter	Value	Description
ws.op	(required) Fixed: `numSubmissionsWithDevice`
bus	One of: `System` `PCI` `USB` `IEEE1394` `SCSI` `Parallel Port` `Serial port` `IDE` `ATA` `Floppy` `IPI` `SATA` `SAS` `PC Card (32 bit)` `PCMCIA (16 bit)`	The device bus
distribution	Link to a distribution.	A Distribution If specified, the result set is limited to submissions made for this distribution.
distroarchseries	Link to a distro_arch_series.	A Distribution Series If specified, the result set is limited to submissions made for the given distroarchseries.
distroseries	Link to a distro_series.	A Distribution Series If specified, the result set is limited to submissions made for the given distribution series.
driver_name		A driver name If specified, the count is limited to devices controlled by this driver.
package_name		A package name If specified, the count is limited to devices controlled by a driver from this package.
product_id		The product ID Allowed values of the product ID depend on the bus of the device. Product IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed. SCSI product IDs are strings with exactly 16 characters. Shorter names are right-padded with space (0x20) characters. IDs for other buses may be arbitrary strings.
vendor_id		The vendor ID Allowed values of the vendor ID depend on the bus of the device. Vendor IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed. SCSI vendor IDs are strings with exactly 8 characters. Shorter names are right-padded with space (0x20) characters. IDs for other buses may be arbitrary strings.

vendorIDs

Return the known vendor IDs for the given bus.

Parameters

Parameter Value Description

ws.op

(required)

Fixed: vendorIDs

bus

(required)

One of:

System
PCI
USB
IEEE1394
SCSI
Parallel Port
Serial port
IDE
ATA
Floppy
IPI
SATA
SAS
PC Card (32 bit)
PCMCIA (16 bit)

A Device Bus.

Response contains an application/json representation of a h_w_vendor_i_d collection .

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

getSubscription

Return the subscription for person, if it exists.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getSubscription

person

(required)

Link to a person.

Response contains an application/json representation of a structural_subscription.

getSubscriptions

Return all the subscriptions with the specified levels.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getSubscriptions

Response contains an application/json representation of a structural_subscription collection .

searchTasks

Search the IBugTasks reported on this entity.

Return an iterable of matching results.

Note: milestone is currently ignored for all IBugTargets except IProduct.

In order to search bugs that are related to a given hardware device, you must specify the bus, the vendor ID, the product ID of the device and set at least one of hardware_owner_is_bug_reporter, hardware_owner_is_affected_by_bug, hardware_owner_is_subscribed_to_bug, hardware_is_linked_to_bug to True.

Parameters

Parameter	Value	Description
ws.op	(required) Fixed: `searchTasks`
affected_user	Link to a person.
assignee	Link to a person.
bug_commenter	Link to a person.
bug_reporter	Link to a person.
bug_subscriber	Link to a person.
bug_supervisor	Link to a person.
component		Component Distribution package archive grouping. E.g. main, universe, multiverse
hardware_bus	One of: `System` `PCI` `USB` `IEEE1394` `SCSI` `Parallel Port` `Serial port` `IDE` `ATA` `Floppy` `IPI` `SATA` `SAS` `PC Card (32 bit)` `PCMCIA (16 bit)`	The bus of a hardware device related to a bug
hardware_driver_name		The driver controlling a hardware device related to a bug.
hardware_driver_package_name		The package of the driver which controls a hardware device related to a bug.
hardware_is_linked_to_bug		Search for bugs which are linked to hardware reports which contain the given device or whcih contain a devicecontrolled by the given driver.
hardware_owner_is_affected_by_bug		Search for bugs where people affected by a bug own the given device or use the given hardware driver.
hardware_owner_is_bug_reporter		Search for bugs reported by people who own the given device or who use the given hardware driver.
hardware_owner_is_subscribed_to_bug		Search for bugs where a bug subscriber owns the given device or uses the given hardware driver.
hardware_product_id		The product ID of a hardware device related to a bug. Allowed values of the product ID depend on the bus of the device. Product IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed. SCSI product IDs are strings with exactly 16 characters. Shorter names are right-padded with space (0x20) characters. IDs for other buses may be arbitrary strings.
hardware_vendor_id		The vendor ID of a hardware device related to a bug. Allowed values of the vendor ID depend on the bus of the device. Vendor IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed. SCSI vendor IDs are strings with exactly 8 characters. Shorter names are right-padded with space (0x20) characters. IDs for other buses may be arbitrary strings.
has_cve	True or False	Show only bugs associated with a CVE.
has_no_package	True or False	Exclude bugs with packages specified.
has_patch	True or False	Show only bugs with patches available.
importance		Importance Show only bugs with the given importance or list of importances.
linked_branches	One of: `Show all bugs` `Show only Bugs with linked Branches` `Show only Bugs without linked Branches`	Search for bugs that are linked to branches or for bugs that are not linked to branches.
milestone		Milestone Show only bug tasks targeted to this milestone.
milestone_assignment		Target
nominated_for	Link to a distro_series.
omit_duplicates	True or False	Omit bugs marked as duplicate,
omit_targeted	True or False	Omit bugs targeted to series
order_by		List of fields by which the results are ordered.
owner	Link to a person.
search_text		Bug ID or search text.
status		Status Show only bugs with the given status value or list of values. See bug_task for list of valid status values.
status_upstream	One of: pending_bugwatch hide_upstream resolved_upstream open_upstream	Status upstream Indicates the status of any remote watches associated with the bug.
tags		Tags String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'
tags_combinator	One of: `Any` `All`	Tags combination Search for any or all of the tags specified.

Response contains an application/json representation of a bug_task collection .

Custom POST methods

addBugSubscription

Add a bug subscription for this structure.

This method is used to create a new IStructuralSubscription for the target with the bug notification level set to COMMENTS, the only level currently in use.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: addBugSubscription

subscriber

Link to a person.

Person to subscribe. If omitted, the requesting user will be subscribed.

On success, the response status will be 201 and the Location header will contain the link to the newly created structural_subscription.

createProductRelease

Create a new ProductRelease.

Parameters

Parameter	Value	Description
ws.op	(required) Fixed: `createProductRelease`
changelog		Changelog A description of every change in the release.
date_released	(required)	Date released The date this release was published. Before release, this should have an estimated release date.
release_notes		Release notes A description of important new features (though the changelog below might repeat some of this information).

On success, the response status will be 201 and the Location header will contain the link to the newly created project_release.

removeBugSubscription

Remove a subscription to bugs from this structure.

If subscription levels for other applications are set, set the subscription's bug_notification_level to NOTHING, otherwise, destroy the subscription.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: removeBugSubscription

subscriber

Link to a person.

Person to unsubscribe. If omitted, the requesting user will be unsubscribed.

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

getSourcesIncluded

Get all source names associated with this package set.

This method returns the source package names that are directly or indirectly associated with the package set at hand. Indirect associations may be defined through package set successors.

Please note: this method was mainly introduced in order to facilitate the listing of source package names via the LP web services API. It returns string names as opposed to ISourcePackageName instances.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getSourcesIncluded

direct_inclusion

getSourcesNotSharedBy

Get source package names not included by another package set.

Which source package names included by this package are not included by the other_package_set?

Please note: this method was mainly introduced in order to facilitate the listing of source package names via the LP web services API. It returns string names as opposed to ISourcePackageName instances.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getSourcesNotSharedBy

direct_inclusion

other_package_set

(required)

Link to a packageset.

The package set we are comparing to.

getSourcesSharedBy

Get source package names also included by another package set.

What source package names does this package set have in common with the other_package_set?

Please note: this method was mainly introduced in order to facilitate the listing of source package names via the LP web services API. It returns string names as opposed to ISourcePackageName instances.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getSourcesSharedBy

direct_inclusion

other_package_set

(required)

Link to a packageset.

The package set we are comparing to.

relatedSets

Get all package sets related to this one.

Return all package sets that are related to this one.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: relatedSets

Response contains an application/json representation of a packageset collection .

setsIncluded

Get all package sets that are included by this one.

Return all package sets that are directly or indirectly included by this one.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: setsIncluded

direct_inclusion

Response contains an application/json representation of a packageset collection .

setsIncludedBy

Get all package sets that include this one.

Return all package sets that directly or indirectly include this one.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: setsIncludedBy

direct_inclusion

Response contains an application/json representation of a packageset collection .

Custom POST methods

addSources

Add the named source packages to this package set.

Any passed source package names will become directly associated with the package set at hand.

This function is idempotent in the sense that source package names that are already directly associated with a package set will be ignored.

This method facilitates the addition of source package names to package sets via the LP web services API. It takes string names as opposed to ISourcePackageName instances. Non-existing source package names will be ignored.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: addSources

names

(required)

A list of source package names.

addSubsets

Add the named package sets as subsets to this package set.

Any passed source package names will become directly associated with the package set at hand.

This function is idempotent in the sense that package subsets that are already directly associated with a package set will be ignored.

This method facilitates the addition of package subsets via the LP web services API. It takes string names as opposed to IPackageset instances.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: addSubsets

names

(required)

A list of package set names.

removeSources

Remove the named source packages from this package set.

Only source package names directly included by this package set can be removed. Any others will be ignored.

This method facilitates the removal of source package names from package sets via the LP web services API. It takes string names as opposed to ISourcePackageName instances.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: removeSources

names

(required)

A list of source package names.

removeSubsets

Remove the named package subsets from this package set.

Only package subsets directly included by this package set can be removed. Any others will be ignored.

This method facilitates the removal of package subsets via the LP web services API. It takes string names as opposed to IPackageset instances.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: removeSubsets

names

(required)

A list of package set names.

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

getBranches

Returns all branches with the given lifecycle status.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getBranches

modified_since

Limit the branches to those modified since this date.

status

A list of branch lifecycle statuses to filter by.

Response contains an application/json representation of a branch collection .

getMergeProposals

Returns all merge proposals of a given status.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getMergeProposals

status

A list of merge proposal statuses to filter by.

Response contains an application/json representation of a branch_merge_proposal collection .

getMilestone

Return a milestone with the given name for this object, or None.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getMilestone

name

(required)

Name

Response contains an application/json representation of a milestone.

getRelease

Return the release for this product that has the version given.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getRelease

version

(required)

Version

Response contains an application/json representation of a project_release.

getSeries

Return the series for this product for the given name, or None.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getSeries

name

(required)

Name

Response contains an application/json representation of a project_series.

getSubscription

Return the subscription for person, if it exists.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getSubscription

person

(required)

Link to a person.

Response contains an application/json representation of a structural_subscription.

getSubscriptions

Return all the subscriptions with the specified levels.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getSubscriptions

Response contains an application/json representation of a structural_subscription collection .

get_timeline

Return basic timeline data useful for creating a diagram.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: get_timeline

include_inactive

Include inactive

searchTasks

Search the IBugTasks reported on this entity.

Return an iterable of matching results.

Note: milestone is currently ignored for all IBugTargets except IProduct.

In order to search bugs that are related to a given hardware device, you must specify the bus, the vendor ID, the product ID of the device and set at least one of hardware_owner_is_bug_reporter, hardware_owner_is_affected_by_bug, hardware_owner_is_subscribed_to_bug, hardware_is_linked_to_bug to True.

Parameters

Parameter	Value	Description
ws.op	(required) Fixed: `searchTasks`
affected_user	Link to a person.
assignee	Link to a person.
bug_commenter	Link to a person.
bug_reporter	Link to a person.
bug_subscriber	Link to a person.
bug_supervisor	Link to a person.
component		Component Distribution package archive grouping. E.g. main, universe, multiverse
hardware_bus	One of: `System` `PCI` `USB` `IEEE1394` `SCSI` `Parallel Port` `Serial port` `IDE` `ATA` `Floppy` `IPI` `SATA` `SAS` `PC Card (32 bit)` `PCMCIA (16 bit)`	The bus of a hardware device related to a bug
hardware_driver_name		The driver controlling a hardware device related to a bug.
hardware_driver_package_name		The package of the driver which controls a hardware device related to a bug.
hardware_is_linked_to_bug		Search for bugs which are linked to hardware reports which contain the given device or whcih contain a devicecontrolled by the given driver.
hardware_owner_is_affected_by_bug		Search for bugs where people affected by a bug own the given device or use the given hardware driver.
hardware_owner_is_bug_reporter		Search for bugs reported by people who own the given device or who use the given hardware driver.
hardware_owner_is_subscribed_to_bug		Search for bugs where a bug subscriber owns the given device or uses the given hardware driver.
hardware_product_id		The product ID of a hardware device related to a bug. Allowed values of the product ID depend on the bus of the device. Product IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed. SCSI product IDs are strings with exactly 16 characters. Shorter names are right-padded with space (0x20) characters. IDs for other buses may be arbitrary strings.
hardware_vendor_id		The vendor ID of a hardware device related to a bug. Allowed values of the vendor ID depend on the bus of the device. Vendor IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed. SCSI vendor IDs are strings with exactly 8 characters. Shorter names are right-padded with space (0x20) characters. IDs for other buses may be arbitrary strings.
has_cve	True or False	Show only bugs associated with a CVE.
has_no_package	True or False	Exclude bugs with packages specified.
has_patch	True or False	Show only bugs with patches available.
importance		Importance Show only bugs with the given importance or list of importances.
linked_branches	One of: `Show all bugs` `Show only Bugs with linked Branches` `Show only Bugs without linked Branches`	Search for bugs that are linked to branches or for bugs that are not linked to branches.
milestone		Milestone Show only bug tasks targeted to this milestone.
milestone_assignment		Target
nominated_for	Link to a distro_series.
omit_duplicates	True or False	Omit bugs marked as duplicate,
omit_targeted	True or False	Omit bugs targeted to series
order_by		List of fields by which the results are ordered.
owner	Link to a person.
search_text		Bug ID or search text.
status		Status Show only bugs with the given status value or list of values. See bug_task for list of valid status values.
status_upstream	One of: pending_bugwatch hide_upstream resolved_upstream open_upstream	Status upstream Indicates the status of any remote watches associated with the bug.
tags		Tags String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'
tags_combinator	One of: `Any` `All`	Tags combination Search for any or all of the tags specified.

Response contains an application/json representation of a bug_task collection .

Custom POST methods

addBugSubscription

Add a bug subscription for this structure.

This method is used to create a new IStructuralSubscription for the target with the bug notification level set to COMMENTS, the only level currently in use.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: addBugSubscription

subscriber

Link to a person.

Person to subscribe. If omitted, the requesting user will be subscribed.

On success, the response status will be 201 and the Location header will contain the link to the newly created structural_subscription.

addOfficialBugTag

Add tag to the official bug tags of this target.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: addOfficialBugTag

tag

(required)

The official bug tag

newCodeImport

Create a new code import.

Parameters

Parameter	Value	Description
ws.op	(required) Fixed: `newCodeImport`
branch_name		Name of branch to create
cvs_module		CVS module to import
cvs_root		CVS root URL
owner	Link to a person.	Owner of the resulting branch
rcs_type	One of: `Concurrent Versions System` `Subversion via CSCVS` `Subversion via bzr-svn` `Git` `Mercurial`
url		Foreign VCS URL

On success, the response status will be 201 and the Location header will contain the link to the newly created code_import.

newSeries

Creates a new IProductSeries for this IProduct.

Parameters

Parameter	Value	Description
ws.op	(required) Fixed: `newSeries`
branch	Link to a branch.	Branch The Bazaar branch for this series. Leave blank if this series is not maintained in Bazaar.
name	(required)	Name The name of the series is a short, unique name that identifies it, being used in URLs. It must be all lowercase, with no special characters. For example, '2.0' or 'trunk'.
release_url_pattern		Release URL pattern A URL pattern that matches releases that are part of this series. Launchpad automatically scans this site to import new releases. Example: http://ftp.gnu.org/gnu/emacs/emacs-21.*.tar.gz
summary	(required)	Summary A single paragraph that explains the goals of of this series and the intended users. For example: "The 2.0 series of Apache represents the current stable series, and is recommended for all new deployments".

On success, the response status will be 201 and the Location header will contain the link to the newly created project_series.

removeBugSubscription

Remove a subscription to bugs from this structure.

If subscription levels for other applications are set, set the subscription's bug_notification_level to NOTHING, otherwise, destroy the subscription.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: removeBugSubscription

subscriber

Link to a person.

Person to unsubscribe. If omitted, the requesting user will be unsubscribed.

removeOfficialBugTag

Remove tag from the official bug tags of this target.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: removeOfficialBugTag

tag

(required)

The official bug tag

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

getBranches

Returns all branches with the given lifecycle status.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getBranches

modified_since

Limit the branches to those modified since this date.

status

A list of branch lifecycle statuses to filter by.

Response contains an application/json representation of a branch collection .

getMergeProposals

Returns all merge proposals of a given status.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getMergeProposals

status

A list of merge proposal statuses to filter by.

Response contains an application/json representation of a branch_merge_proposal collection .

getMilestone

Return a milestone with the given name for this object, or None.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getMilestone

name

(required)

Name

Response contains an application/json representation of a milestone.

getSubscription

Return the subscription for person, if it exists.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getSubscription

person

(required)

Link to a person.

Response contains an application/json representation of a structural_subscription.

getSubscriptions

Return all the subscriptions with the specified levels.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getSubscriptions

Response contains an application/json representation of a structural_subscription collection .

searchTasks

Search the IBugTasks reported on this entity.

Return an iterable of matching results.

Note: milestone is currently ignored for all IBugTargets except IProduct.

In order to search bugs that are related to a given hardware device, you must specify the bus, the vendor ID, the product ID of the device and set at least one of hardware_owner_is_bug_reporter, hardware_owner_is_affected_by_bug, hardware_owner_is_subscribed_to_bug, hardware_is_linked_to_bug to True.

Parameters

Parameter	Value	Description
ws.op	(required) Fixed: `searchTasks`
affected_user	Link to a person.
assignee	Link to a person.
bug_commenter	Link to a person.
bug_reporter	Link to a person.
bug_subscriber	Link to a person.
bug_supervisor	Link to a person.
component		Component Distribution package archive grouping. E.g. main, universe, multiverse
hardware_bus	One of: `System` `PCI` `USB` `IEEE1394` `SCSI` `Parallel Port` `Serial port` `IDE` `ATA` `Floppy` `IPI` `SATA` `SAS` `PC Card (32 bit)` `PCMCIA (16 bit)`	The bus of a hardware device related to a bug
hardware_driver_name		The driver controlling a hardware device related to a bug.
hardware_driver_package_name		The package of the driver which controls a hardware device related to a bug.
hardware_is_linked_to_bug		Search for bugs which are linked to hardware reports which contain the given device or whcih contain a devicecontrolled by the given driver.
hardware_owner_is_affected_by_bug		Search for bugs where people affected by a bug own the given device or use the given hardware driver.
hardware_owner_is_bug_reporter		Search for bugs reported by people who own the given device or who use the given hardware driver.
hardware_owner_is_subscribed_to_bug		Search for bugs where a bug subscriber owns the given device or uses the given hardware driver.
hardware_product_id		The product ID of a hardware device related to a bug. Allowed values of the product ID depend on the bus of the device. Product IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed. SCSI product IDs are strings with exactly 16 characters. Shorter names are right-padded with space (0x20) characters. IDs for other buses may be arbitrary strings.
hardware_vendor_id		The vendor ID of a hardware device related to a bug. Allowed values of the vendor ID depend on the bus of the device. Vendor IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed. SCSI vendor IDs are strings with exactly 8 characters. Shorter names are right-padded with space (0x20) characters. IDs for other buses may be arbitrary strings.
has_cve	True or False	Show only bugs associated with a CVE.
has_no_package	True or False	Exclude bugs with packages specified.
has_patch	True or False	Show only bugs with patches available.
importance		Importance Show only bugs with the given importance or list of importances.
linked_branches	One of: `Show all bugs` `Show only Bugs with linked Branches` `Show only Bugs without linked Branches`	Search for bugs that are linked to branches or for bugs that are not linked to branches.
milestone		Milestone Show only bug tasks targeted to this milestone.
milestone_assignment		Target
nominated_for	Link to a distro_series.
omit_duplicates	True or False	Omit bugs marked as duplicate,
omit_targeted	True or False	Omit bugs targeted to series
order_by		List of fields by which the results are ordered.
owner	Link to a person.
search_text		Bug ID or search text.
status		Status Show only bugs with the given status value or list of values. See bug_task for list of valid status values.
status_upstream	One of: pending_bugwatch hide_upstream resolved_upstream open_upstream	Status upstream Indicates the status of any remote watches associated with the bug.
tags		Tags String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'
tags_combinator	One of: `Any` `All`	Tags combination Search for any or all of the tags specified.

Response contains an application/json representation of a bug_task collection .

Custom POST methods

addBugSubscription

Add a bug subscription for this structure.

This method is used to create a new IStructuralSubscription for the target with the bug notification level set to COMMENTS, the only level currently in use.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: addBugSubscription

subscriber

Link to a person.

Person to subscribe. If omitted, the requesting user will be subscribed.

On success, the response status will be 201 and the Location header will contain the link to the newly created structural_subscription.

removeBugSubscription

Remove a subscription to bugs from this structure.

If subscription levels for other applications are set, set the subscription's bug_notification_level to NOTHING, otherwise, destroy the subscription.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: removeBugSubscription

subscriber

Link to a person.

Person to unsubscribe. If omitted, the requesting user will be unsubscribed.

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom POST methods

add_file

Add file to the library and link to this IProductRelease.

The signature file will also be added if available.

Parameters

Parameter	Value	Description
ws.op	(required) Fixed: `add_file`
content_type	(required)
description		Description A detailed description of the file contents
file_content	(required) Link to a file resource.
file_type	One of: `Code Release Tarball` `README File` `Release Notes` `ChangeLog File` `Installer file`	Upstream file type
filename	(required)
signature_content	Link to a file resource.
signature_filename

On success, the response status will be 201 and the Location header will contain the link to the newly created project_release_file.

delete

Delete this product release.

This method must not be used if this product release has any release files associated with it.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: delete

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom POST methods

delete

Delete the product release file.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: delete

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

getSubscription

Return the subscription for person, if it exists.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getSubscription

person

(required)

Link to a person.

Response contains an application/json representation of a structural_subscription.

getSubscriptions

Return all the subscriptions with the specified levels.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getSubscriptions

Response contains an application/json representation of a structural_subscription collection .

get_timeline

Return basic timeline data useful for creating a diagram.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: get_timeline

include_inactive

Include inactive

searchTasks

Search the IBugTasks reported on this entity.

Return an iterable of matching results.

Note: milestone is currently ignored for all IBugTargets except IProduct.

In order to search bugs that are related to a given hardware device, you must specify the bus, the vendor ID, the product ID of the device and set at least one of hardware_owner_is_bug_reporter, hardware_owner_is_affected_by_bug, hardware_owner_is_subscribed_to_bug, hardware_is_linked_to_bug to True.

Parameters

Parameter	Value	Description
ws.op	(required) Fixed: `searchTasks`
affected_user	Link to a person.
assignee	Link to a person.
bug_commenter	Link to a person.
bug_reporter	Link to a person.
bug_subscriber	Link to a person.
bug_supervisor	Link to a person.
component		Component Distribution package archive grouping. E.g. main, universe, multiverse
hardware_bus	One of: `System` `PCI` `USB` `IEEE1394` `SCSI` `Parallel Port` `Serial port` `IDE` `ATA` `Floppy` `IPI` `SATA` `SAS` `PC Card (32 bit)` `PCMCIA (16 bit)`	The bus of a hardware device related to a bug
hardware_driver_name		The driver controlling a hardware device related to a bug.
hardware_driver_package_name		The package of the driver which controls a hardware device related to a bug.
hardware_is_linked_to_bug		Search for bugs which are linked to hardware reports which contain the given device or whcih contain a devicecontrolled by the given driver.
hardware_owner_is_affected_by_bug		Search for bugs where people affected by a bug own the given device or use the given hardware driver.
hardware_owner_is_bug_reporter		Search for bugs reported by people who own the given device or who use the given hardware driver.
hardware_owner_is_subscribed_to_bug		Search for bugs where a bug subscriber owns the given device or uses the given hardware driver.
hardware_product_id		The product ID of a hardware device related to a bug. Allowed values of the product ID depend on the bus of the device. Product IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed. SCSI product IDs are strings with exactly 16 characters. Shorter names are right-padded with space (0x20) characters. IDs for other buses may be arbitrary strings.
hardware_vendor_id		The vendor ID of a hardware device related to a bug. Allowed values of the vendor ID depend on the bus of the device. Vendor IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed. SCSI vendor IDs are strings with exactly 8 characters. Shorter names are right-padded with space (0x20) characters. IDs for other buses may be arbitrary strings.
has_cve	True or False	Show only bugs associated with a CVE.
has_no_package	True or False	Exclude bugs with packages specified.
has_patch	True or False	Show only bugs with patches available.
importance		Importance Show only bugs with the given importance or list of importances.
linked_branches	One of: `Show all bugs` `Show only Bugs with linked Branches` `Show only Bugs without linked Branches`	Search for bugs that are linked to branches or for bugs that are not linked to branches.
milestone		Milestone Show only bug tasks targeted to this milestone.
milestone_assignment		Target
nominated_for	Link to a distro_series.
omit_duplicates	True or False	Omit bugs marked as duplicate,
omit_targeted	True or False	Omit bugs targeted to series
order_by		List of fields by which the results are ordered.
owner	Link to a person.
search_text		Bug ID or search text.
status		Status Show only bugs with the given status value or list of values. See bug_task for list of valid status values.
status_upstream	One of: pending_bugwatch hide_upstream resolved_upstream open_upstream	Status upstream Indicates the status of any remote watches associated with the bug.
tags		Tags String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'
tags_combinator	One of: `Any` `All`	Tags combination Search for any or all of the tags specified.

Response contains an application/json representation of a bug_task collection .

Custom POST methods

addBugSubscription

Add a bug subscription for this structure.

This method is used to create a new IStructuralSubscription for the target with the bug notification level set to COMMENTS, the only level currently in use.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: addBugSubscription

subscriber

Link to a person.

Person to subscribe. If omitted, the requesting user will be subscribed.

On success, the response status will be 201 and the Location header will contain the link to the newly created structural_subscription.

newMilestone

Create a new milestone for this ProjectSeries.

Parameters

Parameter	Value	Description
ws.op	(required) Fixed: `newMilestone`
code_name		Code name An alternative name for the milestone.
date_targeted		Date Targeted Example: 2005-11-24
name	(required)	Name Only letters, numbers, and simple punctuation are allowed.
summary		Summary A summary of the features and status of this milestone.

On success, the response status will be 201 and the Location header will contain the link to the newly created milestone.

removeBugSubscription

Remove a subscription to bugs from this structure.

If subscription levels for other applications are set, set the subscription's bug_notification_level to NOTHING, otherwise, destroy the subscription.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: removeBugSubscription

subscriber

Link to a person.

Person to unsubscribe. If omitted, the requesting user will be unsubscribed.

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

getBranch

Get the official branch for this package in the given pocket.

Parameters

Parameter Value Description

ws.op

(required)

Fixed: getBranch

pocket

(required)

One of:

Release
Security
Updates
Proposed
Backports

Pocket

Response contains an application/json representation of a branch.

getBranches

Returns all branches with the given lifecycle status.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getBranches

modified_since

Limit the branches to those modified since this date.

status

A list of branch lifecycle statuses to filter by.

Response contains an application/json representation of a branch collection .

getMergeProposals

Returns all merge proposals of a given status.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getMergeProposals

status

A list of merge proposal statuses to filter by.

Response contains an application/json representation of a branch_merge_proposal collection .

linkedBranches

Get the official branches for this package.

This operation returns a {Pocket-name : IBranch} dict.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: linkedBranches

searchTasks

Search the IBugTasks reported on this entity.

Return an iterable of matching results.

Note: milestone is currently ignored for all IBugTargets except IProduct.

In order to search bugs that are related to a given hardware device, you must specify the bus, the vendor ID, the product ID of the device and set at least one of hardware_owner_is_bug_reporter, hardware_owner_is_affected_by_bug, hardware_owner_is_subscribed_to_bug, hardware_is_linked_to_bug to True.

Parameters

Parameter	Value	Description
ws.op	(required) Fixed: `searchTasks`
affected_user	Link to a person.
assignee	Link to a person.
bug_commenter	Link to a person.
bug_reporter	Link to a person.
bug_subscriber	Link to a person.
bug_supervisor	Link to a person.
component		Component Distribution package archive grouping. E.g. main, universe, multiverse
hardware_bus	One of: `System` `PCI` `USB` `IEEE1394` `SCSI` `Parallel Port` `Serial port` `IDE` `ATA` `Floppy` `IPI` `SATA` `SAS` `PC Card (32 bit)` `PCMCIA (16 bit)`	The bus of a hardware device related to a bug
hardware_driver_name		The driver controlling a hardware device related to a bug.
hardware_driver_package_name		The package of the driver which controls a hardware device related to a bug.
hardware_is_linked_to_bug		Search for bugs which are linked to hardware reports which contain the given device or whcih contain a devicecontrolled by the given driver.
hardware_owner_is_affected_by_bug		Search for bugs where people affected by a bug own the given device or use the given hardware driver.
hardware_owner_is_bug_reporter		Search for bugs reported by people who own the given device or who use the given hardware driver.
hardware_owner_is_subscribed_to_bug		Search for bugs where a bug subscriber owns the given device or uses the given hardware driver.
hardware_product_id		The product ID of a hardware device related to a bug. Allowed values of the product ID depend on the bus of the device. Product IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed. SCSI product IDs are strings with exactly 16 characters. Shorter names are right-padded with space (0x20) characters. IDs for other buses may be arbitrary strings.
hardware_vendor_id		The vendor ID of a hardware device related to a bug. Allowed values of the vendor ID depend on the bus of the device. Vendor IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed. SCSI vendor IDs are strings with exactly 8 characters. Shorter names are right-padded with space (0x20) characters. IDs for other buses may be arbitrary strings.
has_cve	True or False	Show only bugs associated with a CVE.
has_no_package	True or False	Exclude bugs with packages specified.
has_patch	True or False	Show only bugs with patches available.
importance		Importance Show only bugs with the given importance or list of importances.
linked_branches	One of: `Show all bugs` `Show only Bugs with linked Branches` `Show only Bugs without linked Branches`	Search for bugs that are linked to branches or for bugs that are not linked to branches.
milestone		Milestone Show only bug tasks targeted to this milestone.
milestone_assignment		Target
nominated_for	Link to a distro_series.
omit_duplicates	True or False	Omit bugs marked as duplicate,
omit_targeted	True or False	Omit bugs targeted to series
order_by		List of fields by which the results are ordered.
owner	Link to a person.
search_text		Bug ID or search text.
status		Status Show only bugs with the given status value or list of values. See bug_task for list of valid status values.
status_upstream	One of: pending_bugwatch hide_upstream resolved_upstream open_upstream	Status upstream Indicates the status of any remote watches associated with the bug.
tags		Tags String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'
tags_combinator	One of: `Any` `All`	Tags combination Search for any or all of the tags specified.

Response contains an application/json representation of a bug_task collection .

Custom POST methods

newCodeImport

Create a new code import.

Parameters

Parameter	Value	Description
ws.op	(required) Fixed: `newCodeImport`
branch_name		Name of branch to create
cvs_module		CVS module to import
cvs_root		CVS root URL
owner	Link to a person.	Owner of the resulting branch
rcs_type	One of: `Concurrent Versions System` `Subversion via CSCVS` `Subversion via bzr-svn` `Git` `Mercurial`
url		Foreign VCS URL

On success, the response status will be 201 and the Location header will contain the link to the newly created code_import.

setBranch

Set the official branch for the given pocket of this package.

Parameters

Parameter Value Description

ws.op

(required)

Fixed: setBranch

branch

Link to a branch.

Branch

pocket

(required)

One of:

Release
Security
Updates
Proposed
Backports

Pocket

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

binaryFileUrls

URLs for this source publication's binary files.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: binaryFileUrls

changesFileUrl

The .changes file URL for this source publication.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: changesFileUrl

getBuilds

Return a list of IBuild objects in this publishing context.

The builds are ordered by DistroArchSeries.architecturetag.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getBuilds

Response contains an application/json representation of a build collection .

getPublishedBinaries

Return all resulted IBinaryPackagePublishingHistory.

Follow the build record and return every PUBLISHED or PENDING binary publishing record for any DistroArchSeries in this DistroSeries and in the same IArchive and Pocket, ordered by architecture tag.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getPublishedBinaries

Response contains an application/json representation of a binary_package_publishing_history collection .

sourceFileUrls

URLs for this source publication's uploaded source files.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: sourceFileUrls

Custom POST methods

requestDeletion

Delete this publication.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: requestDeletion

removal_comment

Removal comment

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom POST methods

requestBuild

Request that the recipe be built in to the specified archive.

Parameters

Parameter	Value	Description
ws.op	(required) Fixed: `requestBuild`
archive	(required) Link to a archive.
distroseries	(required) Link to a distro_series.
pocket	(required) One of: `Release` `Security` `Updates` `Proposed` `Backports`

setRecipeText

Set the text of the recipe.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: setRecipeText

recipe_text

(required)

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom POST methods

linkBranch

Associate a branch with this bug.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: linkBranch

branch

(required)

Link to a branch.

unlinkBranch

Unlink a branch from this bug.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: unlinkBranch

branch

(required)

Link to a branch.

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom POST methods

delete

Destroy this specification branch link

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: delete

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

getSubscription

Return the subscription for person, if it exists.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getSubscription

person

(required)

Link to a person.

Response contains an application/json representation of a structural_subscription.

getSubscriptions

Return all the subscriptions with the specified levels.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getSubscriptions

Response contains an application/json representation of a structural_subscription collection .

Custom POST methods

addBugSubscription

Add a bug subscription for this structure.

This method is used to create a new IStructuralSubscription for the target with the bug notification level set to COMMENTS, the only level currently in use.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: addBugSubscription

subscriber

Link to a person.

Person to subscribe. If omitted, the requesting user will be subscribed.

On success, the response status will be 201 and the Location header will contain the link to the newly created structural_subscription.

removeBugSubscription

Remove a subscription to bugs from this structure.

If subscription levels for other applications are set, set the subscription's bug_notification_level to NOTHING, otherwise, destroy the subscription.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: removeBugSubscription

subscriber

Link to a person.

Person to unsubscribe. If omitted, the requesting user will be unsubscribed.

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

getArchiveSubscriptionURLs

Return private archive URLs that this person can see.

For each of the private archives (PPAs) that this person can see, return a URL that includes the HTTP basic auth data. The URL returned is suitable for including in a sources.list file.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getArchiveSubscriptionURLs

getBranches

Returns all branches with the given lifecycle status.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getBranches

modified_since

Limit the branches to those modified since this date.

status

A list of branch lifecycle statuses to filter by.

Response contains an application/json representation of a branch collection .

getMembersByStatus

Return the people whose membership on this team match :status:.

If no orderby is provided, Person.sortingColumns is used.

Parameters

Parameter Value Description

ws.op

(required)

Fixed: getMembersByStatus

status

(required)

One of:

Proposed
Approved
Administrator
Deactivated
Expired
Declined
Invited
Invitation declined

The state of this membership

Response contains an application/json representation of a person collection .

getMergeProposals

Returns all merge proposals of a given status.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getMergeProposals

status

A list of merge proposal statuses to filter by.

Response contains an application/json representation of a branch_merge_proposal collection .

getPPAByName

Return a PPA with the given name if it exists.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getPPAByName

name

(required)

Response contains an application/json representation of a archive.

getRecipe

Return the person's recipe with the given name.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getRecipe

name

(required)

Response contains an application/json representation of a source_package_recipe.

getRequestedReviews

Returns merge proposals where a person was asked to review.

This does not include merge proposals that were requested from teams that the person is part of. If status is not passed then it will return proposals that are in the "Needs Review" state.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: getRequestedReviews

status

A list of merge proposal statuses to filter by.

Response contains an application/json representation of a branch_merge_proposal collection .

searchTasks

Search the IBugTasks reported on this entity.

Return an iterable of matching results.

Note: milestone is currently ignored for all IBugTargets except IProduct.

In order to search bugs that are related to a given hardware device, you must specify the bus, the vendor ID, the product ID of the device and set at least one of hardware_owner_is_bug_reporter, hardware_owner_is_affected_by_bug, hardware_owner_is_subscribed_to_bug, hardware_is_linked_to_bug to True.

Parameters

Parameter	Value	Description
ws.op	(required) Fixed: `searchTasks`
affected_user	Link to a person.
assignee	Link to a person.
bug_commenter	Link to a person.
bug_reporter	Link to a person.
bug_subscriber	Link to a person.
bug_supervisor	Link to a person.
component		Component Distribution package archive grouping. E.g. main, universe, multiverse
hardware_bus	One of: `System` `PCI` `USB` `IEEE1394` `SCSI` `Parallel Port` `Serial port` `IDE` `ATA` `Floppy` `IPI` `SATA` `SAS` `PC Card (32 bit)` `PCMCIA (16 bit)`	The bus of a hardware device related to a bug
hardware_driver_name		The driver controlling a hardware device related to a bug.
hardware_driver_package_name		The package of the driver which controls a hardware device related to a bug.
hardware_is_linked_to_bug		Search for bugs which are linked to hardware reports which contain the given device or whcih contain a devicecontrolled by the given driver.
hardware_owner_is_affected_by_bug		Search for bugs where people affected by a bug own the given device or use the given hardware driver.
hardware_owner_is_bug_reporter		Search for bugs reported by people who own the given device or who use the given hardware driver.
hardware_owner_is_subscribed_to_bug		Search for bugs where a bug subscriber owns the given device or uses the given hardware driver.
hardware_product_id		The product ID of a hardware device related to a bug. Allowed values of the product ID depend on the bus of the device. Product IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed. SCSI product IDs are strings with exactly 16 characters. Shorter names are right-padded with space (0x20) characters. IDs for other buses may be arbitrary strings.
hardware_vendor_id		The vendor ID of a hardware device related to a bug. Allowed values of the vendor ID depend on the bus of the device. Vendor IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed. SCSI vendor IDs are strings with exactly 8 characters. Shorter names are right-padded with space (0x20) characters. IDs for other buses may be arbitrary strings.
has_cve	True or False	Show only bugs associated with a CVE.
has_no_package	True or False	Exclude bugs with packages specified.
has_patch	True or False	Show only bugs with patches available.
importance		Importance Show only bugs with the given importance or list of importances.
linked_branches	One of: `Show all bugs` `Show only Bugs with linked Branches` `Show only Bugs without linked Branches`	Search for bugs that are linked to branches or for bugs that are not linked to branches.
milestone		Milestone Show only bug tasks targeted to this milestone.
milestone_assignment		Target
nominated_for	Link to a distro_series.
omit_duplicates	True or False	Omit bugs marked as duplicate,
omit_targeted	True or False	Omit bugs targeted to series
order_by		List of fields by which the results are ordered.
owner	Link to a person.
search_text		Bug ID or search text.
status		Status Show only bugs with the given status value or list of values. See bug_task for list of valid status values.
status_upstream	One of: pending_bugwatch hide_upstream resolved_upstream open_upstream	Status upstream Indicates the status of any remote watches associated with the bug.
tags		Tags String or list of strings for tags to search. To exclude, prepend a '-', e.g. '-unwantedtag'
tags_combinator	One of: `Any` `All`	Tags combination Search for any or all of the tags specified.

Response contains an application/json representation of a bug_task collection .

Custom POST methods

acceptInvitationToBeMemberOf

Accept an invitation to become a member of the given team.

There must be a TeamMembership for this person and the given team with the INVITED status. The status of this TeamMembership will be changed to APPROVED.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: acceptInvitationToBeMemberOf

comment

(required)

team

(required)

Link to a person.

Team

addMember

Add the given person as a member of this team.

Parameters

Parameter	Value	Description
ws.op	(required) Fixed: `addMember`
comment
person	(required) Link to a person.	Member
status	One of: `Proposed` `Approved` `Administrator` `Deactivated` `Expired` `Declined` `Invited` `Invitation declined`	The state of this membership

createRecipe

Create a SourcePackageRecipe owned by this person.

Parameters

Parameter	Value	Description
ws.op	(required) Fixed: `createRecipe`
description	(required)
distroseries	(required)
name	(required)
recipe_text	(required)
sourcepackagename	(required)

On success, the response status will be 201 and the Location header will contain the link to the newly created source_package_recipe.

declineInvitationToBeMemberOf

Decline an invitation to become a member of the given team.

There must be a TeamMembership for this person and the given team with the INVITED status. The status of this TeamMembership will be changed to INVITATION_DECLINED.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: declineInvitationToBeMemberOf

comment

(required)

team

(required)

Link to a person.

Team

join

Join the given team if its subscriptionpolicy is not RESTRICTED.

Join the given team according to the policies and defaults of that team:

If the team subscriptionpolicy is OPEN, the user is added as an APPROVED member with a NULL TeamMembership.reviewer.
If the team subscriptionpolicy is MODERATED, the user is added as a PROPOSED member and one of the team's administrators have to approve the membership.

If may_subscribe_to_list is True, then also attempt to subscribe to the team's mailing list, depending on the list status and the person's auto-subscribe settings.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: join

team

(required)

Link to a person.

Team

leave

Leave the given team.

If there's a membership entry for this person on the given team and its status is either APPROVED or ADMIN, we change the status to DEACTIVATED and remove the relevant entries in teamparticipation.

Teams cannot call this method because they're not allowed to login and thus can't 'leave' another team. Instead, they have their subscription deactivated (using the setMembershipData() method) by a team administrator.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: leave

team

(required)

Link to a person.

Team

setLocation

Specify the location and time zone of a person.

Parameters

Parameter	Value	Description
ws.op	(required) Fixed: `setLocation`
latitude	(required)	The latitude of this object.
longitude	(required)	The longitude of this object.
time_zone	(required)	The time zone of this object.

setLocationVisibility

Specify the visibility of a person's location and time zone.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: setLocationVisibility

visible

Is this location record visible?

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom POST methods

setExpirationDate

Set this membership's expiration date.

The given date must be None or in the future and the given user must be allowed to change this membership's expiration date as per the rules defined in canChangeExpirationDate().

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: setExpirationDate

date

Date expires

setStatus

Set the status of this membership.

The user and comment are stored in last_changed_by and last_change_comment and may also be stored in proposed_by (and proponent_comment), reviewed_by (and reviewer_comment) or acknowledged_by (and acknowledger_comment), depending on the state transition.

The given status must be different than the current status.

Return True if the status got changed, otherwise False.

Parameters

Parameter	Value	Description
ws.op	(required) Fixed: `setStatus`
comment		Reviewer comment
silent		Do not send notifications of status change. For use by Launchpad administrators only.
status	(required) One of: `Proposed` `Approved` `Administrator` `Deactivated` `Expired` `Declined` `Invited` `Invitation declined`	The state of this membership

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom GET methods

hasBeenProcessed

Return True if this blob has been processed.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: hasBeenProcessed

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Custom POST methods

setStatus

Transition to a new status if possible.

Parameters

Parameter

Value

Description

ws.op

(required)

Fixed: setStatus

new_status

(required)

The status of the import.

Standard methods

GET: Response contains the default application/json representation for this entry.
PATCH: Entity body should contain a represention encoded using application/json of the entry fields to update. Any fields of the default representation marked as writeable can be included.
PUT: Entity body should contain a representation encoded using application/json of the entry. All fields of the default representation should be included. Only fields marked as writeable in the default representation should be modified.

Key	Value	Description
branch_format	(read-only) One of: `!Unrecognized!` `Fake Bazaar Branch 4 marker` `Bazaar-NG Branch Reference Format 1` `Bazaar-NG branch format 5` `Bazaar Branch Format 6 (bzr 0.15)` `Bazaar Branch Format 7 (needs bzr 1.6)` `Bazaar Branch Format 8 (needs bzr 1.15)` `Bazaar-NG Loom branch format 1` `Bazaar-NG Loom branch format 6` `Bazaar-NG Loom branch format 7`	Branch Format
branch_type	(read-only) One of: `Hosted` `Mirrored` `Remote`	Branch Type
bzr_identity	(read-only)	Bazaar Identity The bzr branch path as accessed by Launchpad. If the branch is associated with a product as the primary development focus, then the result should be lp:product. If the branch is related to a series, then lp:product/series. Otherwise the result is lp:~user/product/branch-name.
code_import_link	(writeable) Link to a code_import.	The associated CodeImport, if any.
control_format	(read-only) One of: `!Unrecognized!` `Bazaar-NG branch, format 0.0.4` `Bazaar-NG branch, format 5` `Bazaar-NG branch, format 6` `Bazaar-NG meta directory, format 1`	Control Directory
date_created	(read-only)	Date Created
date_last_modified	(writeable)	Date Last Modified
dependent_branches_collection_link	(read-only) Link to a branch_merge_proposal collection.	Dependent Branches A collection of the merge proposals that are dependent on this branch.
description	(writeable)	Description A short description of the changes in this branch.
display_name	(read-only)	Display name The branch unique_name.
http_etag	(read-only)	The value of the HTTP ETag for this resource.
landing_candidates_collection_link	(read-only) Link to a branch_merge_proposal collection.	Landing Candidates A collection of the merge proposals where this branch is the target branch.
landing_targets_collection_link	(read-only) Link to a branch_merge_proposal collection.	Landing Targets A collection of the merge proposals where this branch is the source branch.
last_mirror_attempt	(read-only)	Last time a mirror of this branch was attempted.
last_mirrored	(read-only)	Last time this branch was successfully mirrored.
last_scanned	(read-only)	Last time this branch was successfully scanned.
last_scanned_id	(read-only)	Last scanned revision ID The head revision ID of the branch when last successfully scanned.
lifecycle_status	(writeable) One of: `Experimental` `Development` `Mature` `Merged` `Abandoned`	Status
linked_bugs_collection_link	(read-only) Link to a bug collection.	The bugs linked to this branch.
mirror_status_message	(read-only)	The last message we got when mirroring this branch.
name	(writeable)	Name Keep very short, unique, and descriptive, because it will be used in URLs. Examples: main, devel, release-1.0, gnome-vfs.
owner_link	(read-only) Link to a person.	Owner Either yourself or a team you are a member of. This controls who can modify the branch.
private	(writeable)	Keep branch confidential Make this branch visible only to its subscribers.
project_link	(read-only) Link to a project.	Project The project this branch belongs to.
registrant_link	(read-only) Link to a person.	The user that registered the branch.
repository_format	(read-only) One of: `!Unrecognized!` `Fake Bazaar repository 4 marker` `Fake Bazaar repository 5 marker` `Fake Bazaar repository 6 marker` `Bazaar-NG Repository format 7` `Bazaar-NG Knit Repository Format 1` `Bazaar Knit Repository Format 3 (bzr 0.15)` `Bazaar Knit Repository Format 4 (bzr 1.0)` `Bazaar pack repository format 1 (needs bzr 0.92)` `Bazaar pack repository format 1 with subtree support (needs bzr 0.92)` `Bazaar pack repository format 1 with rich root (needs bzr 1.0)` `Bazaar RepositoryFormatKnitPack5 (bzr 1.6)` `Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6)` `Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6.1)` `Bazaar RepositoryFormatKnitPack6 (bzr 1.9)` `Bazaar RepositoryFormatKnitPack6RichRoot (bzr 1.9)` `Bazaar development format 0 (needs bzr.dev from before 1.3)` `Bazaar development format 0 with subtree support (needs bzr.dev from before 1.3)` `Bazaar development format 1 (needs bzr.dev from before 1.6)` `Bazaar development format 1 with subtree support (needs bzr.dev from before 1.6)` `Bazaar development format 2 (needs bzr.dev from before 1.8)` `Bazaar development format 2 with subtree support (needs bzr.dev from before 1.8)` `Bazaar development format - group compression and chk inventory (needs bzr.dev from 1.14)` `Bazaar development format - chk repository with bencode revision serialization (needs bzr.dev from 1.16)` `Bazaar repository format 2a (needs bzr 1.16 or later)`	Repository Format
resource_type_link	(read-only)	The link to the WADL description of this resource.
reviewer_link	(writeable) Link to a person.	Review Team The reviewer of a branch is the person or team that is responsible for reviewing proposals and merging into this branch.
revision_count	(read-only)	Revision count The revision number of the tip of the branch.
self_link	(read-only)	The canonical link to this resource.
sourcepackage_link	(read-only) Link to a source_package.	The ISourcePackage that this branch belongs to. None if not a package branch.
spec_links_collection_link	(read-only) Link to a specification_branch collection.	Specification linked to this branch.
subscribers_collection_link	(read-only) Link to a person collection.	Persons subscribed to this branch.
subscriptions_collection_link	(read-only) Link to a branch_subscription collection.	BranchSubscriptions associated to this branch.
unique_name	(read-only)	Unique name Unique name of the branch, including the owner and project names.
url	(writeable)	Branch URL This is the external location where the Bazaar branch is hosted.
whiteboard	(writeable)	Whiteboard Notes on the current status of the branch.

Key	Value	Description
address	(read-only)	The email address for this proposal. Any emails sent to this address will resultin comments being added.
all_comments_collection_link	(read-only) Link to a code_review_comment collection.	All messages discussing this merge proposal
commit_message	(writeable)	Commit Message The commit message that should be used when merging the source branch.
date_created	(read-only)	Date Created
date_merged	(read-only)	Date Merged The date that the source branch was merged into the target branch
date_queued	(read-only)	Date Queued
date_review_requested	(read-only)	Date Review Requested
date_reviewed	(read-only)	Date Reviewed
description	(writeable)	Description A detailed description of the changes that are being addressed by the branch being proposed to be merged.
http_etag	(read-only)	The value of the HTTP ETag for this resource.
merge_reporter_link	(read-only) Link to a person.	Merge Reporter The user that marked the branch as merged.
merged_revno	(read-only)	Merged Revision Number The revision number on the target branch which contains the merge from the source branch.
prerequisite_branch_link	(read-only) Link to a branch.	Dependent Branch The branch that the source branch branched from. If this is the same as the target branch, then leave this field blank.
preview_diff_link	(read-only) Link to a preview_diff.	The current diff of the source branch against the target branch.
private	(read-only)	Proposal is confidential If True, this proposal is visible only to subscribers.
queue_position	(read-only)	Queue Position The position in the queue.
queue_status	(read-only) One of: `Work in progress` `Needs review` `Approved` `Rejected` `Merged` `Code failed to merge` `Queued` `Superseded`	Status The current state of the proposal.
queued_revid	(read-only)	Queued Revision ID The revision id that has been queued for landing.
queuer_link	(read-only) Link to a person.	Queuer The person that queued up the branch.
registrant_link	(read-only) Link to a person.	Person The person who registered the landing target.
resource_type_link	(read-only)	The link to the WADL description of this resource.
reviewed_revid	(writeable)	The revision id that has been approved by the reviewer.
reviewer_link	(read-only) Link to a person.	Review person or team The person that accepted (or rejected) the code for merging.
self_link	(read-only)	The canonical link to this resource.
source_branch_link	(read-only) Link to a branch.	Source Branch The branch that has code to land.
superseded_by_link	(read-only) Link to a branch_merge_proposal.	Superseded By The branch merge proposal that supersedes this one.
supersedes_link	(read-only) Link to a branch_merge_proposal.	Supersedes The branch merge proposal that this one supersedes.
target_branch_link	(read-only) Link to a branch.	Target Branch The branch that the source branch will be merged into.
votes_collection_link	(read-only) Link to a code_review_vote_reference collection.	The votes cast or expected for this proposal

Key	Value	Description
attachments_collection_link	(read-only) Link to a bug_attachment collection.	Attachments List of bug attachments.
bug_tasks_collection_link	(read-only) Link to a bug_task collection.	BugTasks on this bug, sorted upstream, then ubuntu, then other distroseriess.
bug_watches_collection_link	(read-only) Link to a bug_watch collection.	All bug watches associated with this bug.
can_expire	(read-only)	Can the Incomplete bug expire if it becomes inactive? Expiration may happen when the bug permits expiration, and a bugtask cannot be confirmed.
cves_collection_link	(read-only) Link to a cve collection.	CVE entries related to this bug.
date_created	(read-only)	Date Created The date on which this bug was created.
date_last_message	(read-only)	Date of last bug message Date corresponds to the last comment made in launchpad or in linked bug tracker. Does not include non-comment changes to bug status.
date_last_updated	(read-only)	Date Last Updated The date when anything is changed or added to the bug or its bugtasks. This includes adding comments, adding tasks, adding watches, changing bug visibility or security, setting as duplicate, attaching files and so on. However, subscribing or unsubscribing does not change this value.
date_made_private	(read-only)	Date Made Private The date on which the bug was most recently set to private.
description	(writeable)	Description A detailed description of the problem, including the steps required to reproduce it.
duplicate_of_link	(writeable) Link to a bug.	Duplicate Of
duplicates_collection_link	(read-only) Link to a bug collection.	Duplicates All bugs which are dupes of this one.
heat	(read-only)	Heat Heat is a composite score taking into account the number of users/subscribers/ duplicates, privacy, security, and age. See https://help.launchpad.net/Bugs/BugHeat for complete information.
http_etag	(read-only)	The value of the HTTP ETag for this resource.
id	(read-only)	Bug ID
latest_patch_uploaded	(read-only)	Date when the most recent patch was uploaded.
linked_branches_collection_link	(read-only) Link to a bug_branch collection.	Linked Branches Branches associated with this bug, by convention typically branches on which this bug is being fixed.
message_count	(read-only)	Message Count The number of comments on this bug, including comments imported from a linked watch.
messages_collection_link	(read-only) Link to a message collection.	The messages related to this object, in reverse order of creation (so newest first).
name	(writeable)	Nickname A short and unique name. Add one only if you often need to retype the URL but have trouble remembering the bug number.
number_of_duplicates	(read-only)	Number of Duplicates The number of bugs marked as duplicates of this bug.
owner_link	(read-only) Link to a person.	Owner The reporter of the bug. May return None in some cases, such as if the account has been removed.
private	(writeable)	This bug report should be private Private bug reports are visible only to their subscribers.
resource_type_link	(read-only)	The link to the WADL description of this resource.
security_related	(writeable)	Security Related This bug is a security vulnerability
self_link	(read-only)	The canonical link to this resource.
subscriptions_collection_link	(read-only) Link to a bug_subscription collection.	Subscriptions List of persons directly subscribed to the bug.
tags	(writeable)	Tags Separated by whitespace.
title	(writeable)	Summary A one-line summary of the problem.
users_affected_collection_link	(read-only) Link to a person collection.	Users affected (not including duplicates)
users_affected_count	(read-only)	Users Affected Count The number of users affected by this bug (not including duplicates)
users_affected_count_with_dupes	(read-only)	The number of users affected by this bug (including duplicates)
users_affected_with_dupes_collection_link	(read-only) Link to a person collection.	Users affected (including duplicates)
users_unaffected_collection_link	(read-only) Link to a person collection.	Users explicitly marked as unaffected (not including duplicates)
users_unaffected_count	(read-only)	The number of users unaffected by this bug
who_made_private_link	(read-only) Link to a person.	Who Made Private The person who most recently set this bug private.

Key	Value	Description
assignee_link	(writeable) Link to a person.	Assigned to
bug_link	(read-only) Link to a bug.	Bug
bug_target_display_name	(read-only)	The short, descriptive name of the target.
bug_target_name	(read-only)	The target as presented in mail notifications.
bug_watch_link	(writeable) Link to a bug_watch.	Remote Bug Details Select the bug watch that represents this task in the relevant bug tracker. If none of the bug watches represents this particular bug task, leave it as (None). Linking the remote bug watch with the task in this way means that a change in the remote bug status will change the status of this bug task in Launchpad.
date_assigned	(read-only)	Date Assigned The date on which this task was assigned to someone.
date_closed	(read-only)	Date Closed The date on which this task was marked either Won't Fix, Invalid, Expired or Fix Released.
date_confirmed	(read-only)	Date Confirmed The date on which this task was marked Confirmed.
date_created	(read-only)	Date Created The date on which this task was created.
date_fix_committed	(read-only)	Date Fix Committed The date on which this task was marked Fix Committed.
date_fix_released	(read-only)	Date Fix Released The date on which this task was marked Fix Released.
date_in_progress	(read-only)	Date In Progress The date on which this task was marked In Progress.
date_left_closed	(read-only)	Date left closed The date on which this task was last reopened.
date_left_new	(read-only)	Date left new The date on which this task was marked with a status higher than New.
date_triaged	(read-only)	Date Triaged The date on which this task was marked Triaged.
http_etag	(read-only)	The value of the HTTP ETag for this resource.
importance	(writeable) One of: `Unknown` `Critical` `High` `Medium` `Low` `Wishlist` `Undecided`	Importance
is_complete	(read-only) True or False	Is Complete? Whether this bug task is in a closed status (Fix Released, Invalid, Won't Fix, Expired.)
milestone_link	(writeable) Link to a milestone.	Milestone
owner_link	(read-only) Link to a person.	The owner
related_tasks_collection_link	(read-only) Link to a bug_task collection.	IBugTasks related to this one, namely other IBugTasks on the same IBug.
resource_type_link	(read-only)	The link to the WADL description of this resource.
self_link	(read-only)	The canonical link to this resource.
status	(writeable) One of: `New` `Incomplete` `Invalid` `Won't Fix` `Expired` `Confirmed` `Triaged` `In Progress` `Fix Committed` `Fix Released` `Unknown`	Status
target_link	(writeable) Link to a bug_target.	Target The software in which this bug should be fixed.
title	(read-only)	The title of the bug related to this bugtask

Key	Value	Description
archive_link	(read-only) Link to a archive.	Target archive The archive affected by this dependecy.
component_name	(read-only)	Component name
date_created	(read-only)	Instant when the dependency was created.
dependency_link	(read-only) Link to a archive.	The archive set as a dependency.
http_etag	(read-only)	The value of the HTTP ETag for this resource.
pocket	(read-only) One of: `Release` `Security` `Updates` `Proposed` `Backports`	Pocket
resource_type_link	(read-only)	The link to the WADL description of this resource.
self_link	(read-only)	The canonical link to this resource.
title	(read-only)	Archive dependency title.

Key	Value	Description
archive_link	(writeable) Link to a archive.	Archive The archive that this permission is for.
component_name	(writeable)	Component Name
date_created	(writeable)	Date Created The timestamp when the permission was created.
distro_series_name	(writeable)	The name of the distro series associated with the package set.
explicit	(writeable)	Explicit Set this flag for package sets with high-profile packages requiring specialist skills for proper handling.
http_etag	(read-only)	The value of the HTTP ETag for this resource.
package_set_name	(writeable)	Package set name
permission	(writeable)	The permission type being granted.
person_link	(writeable) Link to a person.	Person The person or team being granted the permission.
resource_type_link	(read-only)	The link to the WADL description of this resource.
self_link	(read-only)	The canonical link to this resource.
source_package_name	(writeable)	Source Package Name

Key	Value	Description
archive_link	(read-only) Link to a archive.	Archive The archive for this subscription.
date_created	(read-only)	Date Created The timestamp when the subscription was created.
date_expires	(writeable)	Date of Expiration The timestamp when the subscription will expire.
description	(writeable)	Description Free text describing this subscription.
http_etag	(read-only)	The value of the HTTP ETag for this resource.
registrant_link	(read-only) Link to a person.	Registrant The person who registered this subscription.
resource_type_link	(read-only)	The link to the WADL description of this resource.
self_link	(read-only)	The canonical link to this resource.
status	(writeable) One of: `Active` `Expired` `Cancelled`	Status The status of this subscription.
subscriber_link	(read-only) Link to a person.	Subscriber The person who is subscribed.

Key	Value	Description
archive_link	(read-only) Link to a archive.	Archive The context archive for this publication.
binary_package_name	(read-only)	Binary Package Name
binary_package_version	(read-only)	Binary Package Version
component_name	(read-only)	Component Name
date_created	(writeable)	Date Created The date on which this record was created
date_made_pending	(writeable)	Date Made Pending The date on which this record was set as pending removal
date_published	(writeable)	Date Published The date on which this record was published
date_removed	(writeable)	Date Removed The date on which this record was removed from the published set
date_superseded	(writeable)	Date Superseded The date on which this record was marked superseded
display_name	(writeable)	Display Name Text representation of the current record.
distro_arch_series_link	(writeable) Link to a distro_arch_series.	Distro Arch Series The distroarchseries being published into
http_etag	(read-only)	The value of the HTTP ETag for this resource.
pocket	(read-only) One of: `Release` `Security` `Updates` `Proposed` `Backports`	Pocket The pocket into which this entry is published
priority_name	(read-only)	Priority Name
removal_comment	(writeable)	Removal Comment Reason why this publication is going to be removed.
removed_by_link	(writeable) Link to a person.	Removed By The Person responsible for the removal
resource_type_link	(read-only)	The link to the WADL description of this resource.
scheduled_deletion_date	(writeable)	Scheduled Deletion Date The date on which this record is scheduled for deletion
section_name	(read-only)	Section Name
self_link	(read-only)	The canonical link to this resource.
status	(writeable) One of: `Pending` `Published` `Superseded` `Deleted` `Obsolete`	Status The status of this publishing record

Key	Value	Description
archive_link	(read-only) Link to a archive.	Archive
binary_package_name	(read-only)	Binary package name
binary_package_version	(read-only)	Binary package version
count	(read-only)	Number of downloads
country_link	(read-only) Link to a country.	Country
day	(read-only)	Day of the downloads
http_etag	(read-only)	The value of the HTTP ETag for this resource.
resource_type_link	(read-only)	The link to the WADL description of this resource.
self_link	(read-only)	The canonical link to this resource.

Key	Value	Description
branch_link	(read-only) Link to a branch.	Branch ID
http_etag	(read-only)	The value of the HTTP ETag for this resource.
max_diff_lines	(writeable) One of: `Don't send diffs` `500 lines` `1000 lines` `5000 lines` `Send entire diff`	Generated Diff Size Limit Diffs greater than the specified number of lines will not be sent to the subscriber. The subscriber will still receive an email with the new revision details even if the diff is larger than the specified number of lines.
notification_level	(writeable) One of: `No email` `Branch attribute notifications only` `Branch revision notifications only` `Branch attribute and revision notifications`	Notification Level Attribute notifications are sent when branch details are changed such as lifecycle status and name. Revision notifications are generated when new branch revisions are found due to the branch being updated through either pushes to the hosted branches or the mirrored branches being updated.
person_link	(read-only) Link to a person.	Person Enter the launchpad id, or email address of the person you wish to subscribe to this branch. If you are unsure, use the "Choose..." option to find the person in Launchpad. You can only subscribe someone who is a registered user of the system.
resource_type_link	(read-only)	The link to the WADL description of this resource.
review_level	(writeable) One of: `No email` `Status changes only` `Email about all changes`	Code review Level Control the kind of review activity that triggers notifications.
self_link	(read-only)	The canonical link to this resource.

Key	Value	Description
bug_link	(writeable) Link to a bug.	The bug the attachment belongs to.
data_link	(read-only) Link to a file resource in the Librarian.	A file object for accessing the attachment contents.
http_etag	(read-only)	The value of the HTTP ETag for this resource.
message_link	(writeable) Link to a message.	The message that was created when we added this attachment.
resource_type_link	(read-only)	The link to the WADL description of this resource.
self_link	(read-only)	The canonical link to this resource.
title	(writeable)	Title A short and descriptive description of the attachment
type	(writeable) One of: `Patch` `Unspecified`	Attachment Type The type of the attachment, for example Patch or Unspecified.

Key	Value	Description
branch_link	(writeable) Link to a branch.	Branch
bug_link	(read-only) Link to a bug.	Bug #
http_etag	(read-only)	The value of the HTTP ETag for this resource.
resource_type_link	(read-only)	The link to the WADL description of this resource.
self_link	(read-only)	The canonical link to this resource.

Key	Value	Description
bug_reporting_guidelines	(writeable)	If I’m reporting a bug, I should include, if possible These guidelines will be shown to anyone reporting a bug.
http_etag	(read-only)	The value of the HTTP ETag for this resource.
resource_type_link	(read-only)	The link to the WADL description of this resource.
self_link	(read-only)	The canonical link to this resource.

Key	Value	Description
active	(writeable)	Updates for this bug tracker are enabled
base_url	(writeable)	Location The top-level URL for the bug tracker, or an upstream email address. This must be accurate so that Launchpad can link to external bug reports.
base_url_aliases	(writeable)	Location aliases A list of URLs or email addresses that all lead to the same bug tracker, or commonly seen typos, separated by whitespace.
bug_tracker_type	(writeable) One of: `Bugzilla` `Debbugs` `Roundup` `Trac` `SourceForge or SourceForge derivative` `Mantis` `Request Tracker (RT)` `Email Address` `Savane` `PHP Project Bugtracker` `Google Code`	Bug Tracker Type
contact_details	(writeable)	Contact details The contact details for the external bug tracker (so that, for example, its administrators can be contacted about a security breach).
has_lp_plugin	(writeable) True or False	This bug tracker has a Launchpad plugin installed.
http_etag	(read-only)	The value of the HTTP ETag for this resource.
name	(writeable)	Name An URL-friendly name for the bug tracker, such as "mozilla-bugs".
registrant_link	(writeable) Link to a person.	Owner
resource_type_link	(read-only)	The link to the WADL description of this resource.
self_link	(read-only)	The canonical link to this resource.
summary	(writeable)	Summary A brief introduction or overview of this bug tracker instance.
title	(writeable)	Title A descriptive label for this tracker to show in listings.
watches_collection_link	(read-only) Link to a bug_watch collection.	The remote watches on this bug tracker.

Key	Value	Description
arch_tag	(writeable)	Architecture tag
archive_link	(read-only) Link to a archive.	Archive The Archive context for this build.
build_log_url	(writeable)	Build Log URL A URL for the build log. None if there is no log available.
buildstate	(writeable) One of: `Needs building` `Successfully built` `Failed to build` `Dependency wait` `Chroot problem` `Build for superseded Source` `Currently building` `Failed to upload`	State The current build state.
can_be_rescored	(read-only)	Can Be Rescored Whether or not this build record can be rescored manually.
can_be_retried	(read-only)	Can Be Retried Whether or not this build record can be retried.
current_source_publication_link	(read-only) Link to a source_package_publishing_history.	Source publication The current source publication for this build.
date_first_dispatched	(writeable)	Date first dispatched The actual build start time. Set when the build is dispatched the first time and not changed in subsequent build attempts.
datebuilt	(writeable)	Date built The time when the build result got collected.
datecreated	(read-only)	Date created The time when the build request was created.
dependencies	(writeable)	Dependencies Debian-like dependency line that must be satisfied before attempting to build this request.
distribution_link	(writeable) Link to a distribution.	Distribution Shortcut for its distribution.
http_etag	(read-only)	The value of the HTTP ETag for this resource.
pocket	(writeable) One of: `Release` `Security` `Updates` `Proposed` `Backports`	Pocket The build targeted pocket.
resource_type_link	(read-only)	The link to the WADL description of this resource.
self_link	(read-only)	The canonical link to this resource.
title	(writeable)	Title
upload_log_url	(writeable)	Upload Log URL A URL for failed upload logs.Will be None if there was no failure.

Key	Value	Description
branch_link	(read-only) Link to a branch.	Branch The Bazaar branch produced by the import system.
cvs_module	(read-only)	Module The path to import within the repository. Usually, it is the name of the project.
cvs_root	(read-only)	Repository The CVSROOT. Example: :pserver:anonymous@anoncvs.gnome.org:/cvs/gnome
date_last_successful	(read-only)	Last successful
http_etag	(read-only)	The value of the HTTP ETag for this resource.
rcs_type	(read-only) One of: `Concurrent Versions System` `Subversion via CSCVS` `Subversion via bzr-svn` `Git` `Mercurial`	Type of RCS The version control system to import from. Can be CVS or Subversion.
resource_type_link	(read-only)	The link to the WADL description of this resource.
review_status	(read-only) One of: `Pending Review` `Invalid` `Reviewed` `Suspended` `Failed`	Review Status Before a code import is performed, it is reviewed. Only reviewed imports are processed.
self_link	(read-only)	The canonical link to this resource.
url	(read-only)	URL The URL of the VCS branch.

Key	Value	Description
as_quoted_email	(read-only)	The message as quoted in email.
author_link	(read-only) Link to a person.	Comment Author
branch_merge_proposal_link	(read-only) Link to a branch_merge_proposal.	The branch merge proposal
date_created	(read-only)	Date Created
http_etag	(read-only)	The value of the HTTP ETag for this resource.
id	(read-only)	DB ID The tracking number for this comment.
message_body	(read-only)	The body of the code review message.
resource_type_link	(read-only)	The link to the WADL description of this resource.
self_link	(read-only)	The canonical link to this resource.
title	(writeable)	The title of the comment
vote	(writeable) One of: `Approve` `Needs Fixing` `Needs Information` `Abstain` `Disapprove` `Resubmit`	Review
vote_tag	(writeable)	Vote tag

Key	Value	Description
branch_merge_proposal_link	(writeable) Link to a branch_merge_proposal.	The merge proposal that is the subject of this vote
comment_link	(writeable) Link to a code_review_comment.	The code review comment that contains the most recent vote.
date_created	(read-only)	Date Created
http_etag	(read-only)	The value of the HTTP ETag for this resource.
is_pending	(read-only) True or False	Is the pending?
registrant_link	(writeable) Link to a person.	The person who originally registered this vote
resource_type_link	(read-only)	The link to the WADL description of this resource.
review_type	(writeable)	Review type Lowercase keywords describing the type of review.
reviewer_link	(writeable) Link to a person.	Reviewer A person who you want to review this.
self_link	(read-only)	The canonical link to this resource.

Key	Value	Description
date_created	(read-only)	Date Created The date the first subscription was applied.
date_expires	(writeable)	Expiration Date The expiration date of the subscription.
date_last_modified	(writeable)	Date Modified The date the subscription was modified.
date_starts	(writeable)	Beginning of Subscription The date the subscription starts.
http_etag	(read-only)	The value of the HTTP ETag for this resource.
is_active	(read-only) True or False	Active Whether this subscription is active.
product_link	(read-only) Link to a project.	Product which has commercial subscription Project for which this commercial subscription is applied.
purchaser_link	(read-only) Link to a person.	Purchaser Person who purchased the voucher.
registrant_link	(read-only) Link to a person.	Registrant Person who redeemed the voucher.
resource_type_link	(read-only)	The link to the WADL description of this resource.
self_link	(read-only)	The canonical link to this resource.

Key	Value	Description
bugs_collection_link	(read-only) Link to a bug collection.	Bugs related to this CVE entry.
date_created	(read-only)	Date Created
date_modified	(writeable)	Date Modified
description	(writeable)	Title A description of the CVE issue. This will be updated regularly from the CVE database.
display_name	(writeable)	Display Name A very brief name describing the ref and state.
http_etag	(read-only)	The value of the HTTP ETag for this resource.
resource_type_link	(read-only)	The link to the WADL description of this resource.
self_link	(read-only)	The canonical link to this resource.
sequence	(writeable)	CVE Sequence Number Should take the form XXXX-XXXX, all digits.
status	(writeable) One of: `Candidate` `Entry` `Deprecated`	Current CVE State Whether or not the vulnerability has been reviewed and assigned a full CVE number, or is still considered a Candidate, or is deprecated.
title	(writeable)	Title A title for the CVE
url	(writeable)	URL Returns a URL to the site that has the CVE data for this CVE reference.

Key	Value	Description
active	(writeable)	Active Whether or not this item is active.
active_milestones_collection_link	(read-only) Link to a milestone collection.	The visible and active milestones associated with this object, ordered by date expected.
all_milestones_collection_link	(read-only) Link to a milestone collection.	All milestones associated with this object, ordered by date expected.
archive_mirrors_collection_link	(read-only) Link to a distribution_mirror collection.	All enabled and official ARCHIVE mirrors of this Distribution.
archives_collection_link	(read-only) Link to a archive collection.	A sequence of the distribution's non-PPA Archives.
bug_reporting_guidelines	(writeable)	If I’m reporting a bug, I should include, if possible These guidelines will be shown to anyone reporting a bug.
bug_supervisor_link	(writeable) Link to a person.	Bug Supervisor The person or team responsible for bug management.
cdimage_mirrors_collection_link	(read-only) Link to a distribution_mirror collection.	All enabled and official RELEASE mirrors of this Distribution.
current_series_link	(writeable) Link to a distro_series.	Current series The current development series of this distribution. Note that all maintainerships refer to the current series. When people ask about the state of packages in the distribution, we should interpret that query in the context of the currentseries.
date_created	(writeable)	Date created The date this distribution was registered.
description	(writeable)	Description Details about the distributions's work, highlights, goals, and how to contribute. Use plain text, paragraphs are preserved and URLs are linked in pages. Don't repeat the Summary.
display_name	(writeable)	Display Name The displayable name of the distribution.
domain_name	(writeable)	Domain name The distro's domain name.
driver_link	(writeable) Link to a person.	Driver The person or team responsible for decisions about features and bugs that will be targeted for any series in this distribution. Note that you can also specify a driver on each series who's permissions will be limited to that specific series.
homepage_content	(writeable)	Homepage Content The content of this distribution's home page. Edit this and it will be displayed for all the world to see. It is NOT a wiki so you cannot undo changes.
http_etag	(read-only)	The value of the HTTP ETag for this resource.
icon_link	(writeable) Link to a file resource.	Icon A small image of exactly 14x14 pixels and at most 5kb in size, that can be used to identify this distribution. The icon will be displayed everywhere we list the distribution and link to it.
logo_link	(writeable) Link to a file resource.	Logo An image of exactly 64x64 pixels that will be displayed in the heading of all pages related to this distribution. It should be no bigger than 50kb in size.
main_archive_link	(read-only) Link to a archive.	Distribution Main Archive.
mirror_admin_link	(writeable) Link to a person.	Mirror Administrator The person or team that has the rights to review and mark this distribution's mirrors as official.
mugshot_link	(writeable) Link to a file resource.	Brand A large image of exactly 192x192 pixels, that will be displayed on this distribution's home page in Launchpad. It should be no bigger than 100kb in size.
name	(writeable)	Name The distro's name.
official_bug_tags	(writeable)	Official Bug Tags The list of bug tags defined as official.
owner_link	(writeable) Link to a person.	Owner The distro's owner.
resource_type_link	(read-only)	The link to the WADL description of this resource.
security_contact_link	(writeable) Link to a person.	Security Contact The person or team who handles security-related bug reports
self_link	(read-only)	The canonical link to this resource.
series_collection_link	(read-only) Link to a distro_series collection.	DistroSeries inside this Distribution
summary	(writeable)	Summary A short paragraph to introduce the the goals and highlights of the distribution.
title	(writeable)	Title The distro's title.

Key	Value	Description
content	(writeable) One of: `Archive` `CD Image`	Content Choose "CD Image" if this mirror contains CD images of this distribution. Choose "Archive" if this is a mirror of packages for this distribution.
country_dns_mirror	(writeable)	Country DNS Mirror Whether this is a country mirror in DNS.
country_link	(writeable) Link to a country.	Location The country in which this mirror is based.
date_created	(read-only)	Date Created The date on which this mirror was registered.
date_reviewed	(read-only)	Date reviewed The date on which this mirror was last reviewed by a mirror admin.
description	(writeable)	Description
displayname	(writeable)	Organisation The name of the organization hosting this mirror.
distribution_link	(read-only) Link to a distribution.	Distribution The distribution that is mirrored
enabled	(read-only)	This mirror was probed successfully.
ftp_base_url	(writeable)	FTP URL e.g.: ftp://archive.ubuntu.com/ubuntu/
http_base_url	(writeable)	HTTP URL e.g.: http://archive.ubuntu.com/ubuntu/
http_etag	(read-only)	The value of the HTTP ETag for this resource.
name	(writeable)	Name A short and unique name for this mirror.
official_candidate	(writeable)	Apply to be an official mirror of this distribution
owner_link	(writeable) Link to a person.	Owner The person who is set as the current administrator of this mirror.
resource_type_link	(read-only)	The link to the WADL description of this resource.
reviewer_link	(read-only) Link to a person.	Reviewer The person who last reviewed this mirror.
rsync_base_url	(writeable)	Rsync URL e.g.: rsync://archive.ubuntu.com/ubuntu/
self_link	(read-only)	The canonical link to this resource.
speed	(writeable) One of: `128 Kbps` `256 Kbps` `512 Kbps` `1 Mbps` `2 Mbps` `10 Mbps` `45 Mbps` `100 Mbps` `1 Gbps` `2 Gbps` `4 Gbps` `10 Gbps` `20 Gbps`	Link Speed
status	(writeable) One of: `Pending review` `Unofficial` `Official`	Status The current status of a mirror's registration.
whiteboard	(writeable)	Whiteboard Notes on the current status of the mirror (only visible to admins and the mirror's registrant).

Key	Value	Description
architecture_tag	(writeable)	Architecture Tag The architecture tag, or short piece of text that identifies this architecture. All binary packages in the archive will use this tag in their filename. Please get it correct. It should really never be changed!
chroot_url	(read-only)	Build chroot URL The URL to the current build chroot for this distroarchseries.
display_name	(writeable)	Display name The display name of this distroarchseries.
distroseries_link	(writeable) Link to a distro_series.	The context distroseries
http_etag	(read-only)	The value of the HTTP ETag for this resource.
is_nominated_arch_indep	(writeable) True or False	Is Nominated Arch Independent True if this distroarchseries is the NominatedArchIndep one.
main_archive_link	(writeable) Link to a archive.	Main Archive The main archive of the distroarchseries.
official	(writeable)	Official Support Indicate whether or not this port has official support from the vendor of the distribution.
owner_link	(writeable) Link to a person.	The person who registered this port.
package_count	(writeable)	Package Count A cache of the number of packages published in the RELEASE pocket of this port.
resource_type_link	(read-only)	The link to the WADL description of this resource.
self_link	(read-only)	The canonical link to this resource.
supports_virtualized	(writeable)	PPA support available Indicate whether or not this port has support for building PPA packages.
title	(writeable)	Title The title of this distroarchseries.

Key	Value	Description
active	(writeable)	Active Whether or not this series is stable and supported, or under current development. This excludes series which are experimental or obsolete.
active_milestones_collection_link	(read-only) Link to a milestone collection.	The visible and active milestones associated with this object, ordered by date expected.
all_milestones_collection_link	(read-only) Link to a milestone collection.	All milestones associated with this object, ordered by date expected.
bug_reporting_guidelines	(writeable)	If I’m reporting a bug, I should include, if possible These guidelines will be shown to anyone reporting a bug.
changeslist	(writeable)	E-mail changes to The mailing list or other e-mail address that Launchpad should notify about new uploads.
date_created	(writeable)	The date this series was registered.
datereleased	(writeable)	Date released
description	(writeable)	Description A detailed description of this series, with information on the architectures covered, the availability of security updates and any other relevant information.
displayname	(writeable)	Display name The series displayname.
distribution_link	(writeable) Link to a distribution.	Distribution The distribution for which this is a series.
driver_link	(writeable) Link to a person.	Driver The person or team responsible for decisions about features and bugs that will be targeted to this series of the distribution.
drivers_collection_link	(read-only) Link to a person collection.	A list of the people or teams who are drivers for this series. This list is made up of any drivers or owners from this series and the parent drivers.
fullseriesname	(writeable)	Series full name The series full name, e.g. Ubuntu Warty
http_etag	(read-only)	The value of the HTTP ETag for this resource.
main_archive_link	(writeable) Link to a archive.	Distribution Main Archive
name	(writeable)	Name The name of this series.
official_bug_tags	(read-only)	Official Bug Tags The list of bug tags defined as official.
owner_link	(writeable) Link to a person.	Owner
parent_series_link	(writeable) Link to a distro_series.	Parent series The series from which this one was branched.
resource_type_link	(read-only)	The link to the WADL description of this resource.
self_link	(read-only)	The canonical link to this resource.
status	(writeable) One of: `Experimental` `Active Development` `Pre-release Freeze` `Current Stable Release` `Supported` `Obsolete` `Future`	Status
summary	(writeable)	Summary A single paragraph that explains the goals of of this series and the intended users. For example: "The 2.0 series of Apache represents the current stable series, and is recommended for all new deployments".
supported	(writeable)	Supported Whether or not this series is currently supported.
title	(writeable)	Title The title of this series. It should be distinctive and designed to look good at the top of a page.
version	(writeable)	Version The version string for this series.

Launchpad API Reference Manual

Table of Contents

Root objects

Top-level collections

Entry types

Root objects

launchpad

__init__

Parameters

get_token_and_login

Parameters

login

Parameters

login_anonymously

Parameters

login_with

Parameters

Examples

Log in to launchpad

Prompt user for the exact authorization needed

Turn on debugging output

Fetching an object's raw JSON

Top-level collections

branches

Standard method

Custom GET methods

getByUniqueName

Parameters

getByUrl

Parameters

getByUrls

Parameters

bug_trackers

Standard method

Custom GET methods

getByName

Parameters

queryByBaseURL

Parameters

Custom POST methods

ensureBugTracker

Parameters

bugs

Standard method

Custom POST methods

createBug

Parameters

countries

Standard method

Custom GET methods

getByCode

Parameters

getByName

Parameters

cves

Standard method

distributions

Standard method

languages

Standard method

Custom GET methods

getAllLanguages

Parameters

person

Standard method

Custom GET methods

getArchiveSubscriptionURLs

Parameters

getBranches

Parameters

getMembersByStatus

Parameters

getMergeProposals

Parameters

getPPAByName

Parameters

getRecipe

Parameters

getRequestedReviews

Parameters

init

Key	Value	Description
email	(read-only)	Email Address
http_etag	(read-only)	The value of the HTTP ETag for this resource.
person_link	(writeable) Link to a person.	Person
resource_type_link	(read-only)	The link to the WADL description of this resource.
self_link	(read-only)	The canonical link to this resource.

Key	Value	Description
fingerprint	(read-only)	User Fingerprint
http_etag	(read-only)	The value of the HTTP ETag for this resource.
keyid	(read-only)	OpenPGP key ID
resource_type_link	(read-only)	The link to the WADL description of this resource.
self_link	(read-only)	The canonical link to this resource.

Key	Value	Description
bus	(read-only) One of: `System` `PCI` `USB` `IEEE1394` `SCSI` `Parallel Port` `Serial port` `IDE` `ATA` `Floppy` `IPI` `SATA` `SAS` `PC Card (32 bit)` `PCMCIA (16 bit)`	The bus of the device.
bus_product_id	(writeable)	The product identifier of the device Allowed values of the product ID depend on the bus of the device. Product IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed. SCSI product IDs are strings with exactly 16 characters. Shorter names are right-padded with space (0x20) characters. IDs for other buses may be arbitrary strings.
classes_collection_link	(read-only) Link to a h_w_device_class collection.	The device classes this device belongs to.
drivers_collection_link	(read-only) Link to a h_w_driver collection.	The IHWDriver records related to this device.
http_etag	(read-only)	The value of the HTTP ETag for this resource.
id	(read-only)	Device ID
name	(writeable)	The human readable name of the device.
resource_type_link	(read-only)	The link to the WADL description of this resource.
self_link	(read-only)	The canonical link to this resource.
variant	(writeable)	A string that distiguishes different devices with identical vendor/product IDs
vendor_id	(read-only)	The vendor iD. Allowed values of the vendor ID depend on the bus of the device. Vendor IDs of PCI, PCCard and USB devices are hexadecimal string representations of 16 bit integers in the format '0x01ab': The prefix '0x', followed by exactly 4 digits; where a digit is one of the characters 0..9, a..f. The characters A..F are not allowed. SCSI vendor IDs are strings with exactly 8 characters. Shorter names are right-padded with space (0x20) characters. IDs for other buses may be arbitrary strings.
vendor_name	(read-only)	The vendor name.

Key	Value	Description
contactable	(read-only)	Contactable
date_created	(read-only)	Date Created
date_submitted	(read-only)	Date Submitted
devices_collection_link	(read-only) Link to a h_w_submission_device collection.	The HWSubmissionDevice records for this submission.
format	(read-only) One of: `Version 1`	Format Version
http_etag	(read-only)	The value of the HTTP ETag for this resource.
owner_link	(read-only) Link to a person.	The owner of this submission
private	(writeable)	Private Submission
raw_submission_link	(read-only) Link to a file resource.	The raw submission data
resource_type_link	(read-only)	The link to the WADL description of this resource.
self_link	(read-only)	The canonical link to this resource.
status	(read-only) One of: `Invalid submission` `Submitted` `Processed`	Submission Status
submission_key	(read-only)	Unique Submission ID

Key	Value	Description
device_link	(writeable) Link to a h_w_device.	The device
driver_link	(writeable) Link to a h_w_driver.	The driver used for this device in this submission
hal_device_id	(writeable)	The ID of the HAL node of this device in the submitted data
http_etag	(read-only)	The value of the HTTP ETag for this resource.
id	(read-only)	HWSubmissionDevice ID
parent_link	(writeable) Link to a h_w_submission_device.
resource_type_link	(read-only)	The link to the WADL description of this resource.
self_link	(read-only)	The canonical link to this resource.

Key	Value	Description
bus	(writeable) One of: `System` `PCI` `USB` `IEEE1394` `SCSI` `Parallel Port` `Serial port` `IDE` `ATA` `Floppy` `IPI` `SATA` `SAS` `PC Card (32 bit)` `PCMCIA (16 bit)`	The bus that connects a device to a computer
http_etag	(read-only)	The value of the HTTP ETag for this resource.
id	(read-only)	The Database ID
resource_type_link	(read-only)	The link to the WADL description of this resource.
self_link	(read-only)	The canonical link to this resource.
vendor_id	(writeable)	Vendor ID

Key	Value	Description
driver_names_collection_link	(read-only) Link to a h_w_driver_name collection.	Driver Names All known distinct driver names appearing in HWDriver
http_etag	(read-only)	The value of the HTTP ETag for this resource.
package_names_collection_link	(read-only) Link to a h_w_driver_package_name collection.	Package Names All known distinct package names appearing in HWDriver.
resource_type_link	(read-only)	The link to the WADL description of this resource.
self_link	(read-only)	The canonical link to this resource.

Key	Value	Description
code	(writeable)	The ISO 639 code
english_name	(writeable)	The English name
http_etag	(read-only)	The value of the HTTP ETag for this resource.
plural_expression	(writeable)	Plural form expression The expression that relates a number of items to the appropriate plural form.
plural_forms	(writeable)	Number of plural forms The number of plural forms this language has.
resource_type_link	(read-only)	The link to the WADL description of this resource.
self_link	(read-only)	The canonical link to this resource.
text_direction	(writeable) One of: `Left to Right` `Right to Left`	Text direction The direction of text in this language.
translators_count	(read-only)	Total number of translators for this language.
visible	(writeable)	Visible Whether this language is visible by default.

Key	Value	Description
bug_attachments_collection_link	(read-only) Link to a bug_attachment collection.	A list of BugAttachments connected to this message.
content	(writeable)	All the text/plain chunks joined together as a unicode string.
date_created	(read-only)	Date Created
http_etag	(read-only)	The value of the HTTP ETag for this resource.
owner_link	(read-only) Link to a person.	Person
parent_link	(read-only) Link to a message.	Parent
resource_type_link	(read-only)	The link to the WADL description of this resource.
self_link	(read-only)	The canonical link to this resource.
subject	(read-only)	Subject

Key	Value	Description
archive_link	(read-only) Link to a archive.	Archive The archive for this upload.
custom_file_urls	(read-only)	Custom File URLs Librarian URLs for all the custom files attached to this upload.
date_created	(writeable)	Date created The date this package upload was done.
display_arches	(read-only)	Architectures related to this item
display_name	(read-only)	Generic displayname for a queue item
display_version	(read-only)	The source package version for this item
distroseries_link	(writeable) Link to a distro_series.	Series The distroseries targeted by this upload.
http_etag	(read-only)	The value of the HTTP ETag for this resource.
pocket	(writeable) One of: `Release` `Security` `Updates` `Proposed` `Backports`	The pocket The pocket targeted by this upload.
resource_type_link	(read-only)	The link to the WADL description of this resource.
self_link	(read-only)	The canonical link to this resource.
status	(read-only) One of: `New` `Unapproved` `Accepted` `Done` `Rejected`	Queue status The status of this upload.