Artifact Details - Get Package

Reference

Service:: Artifacts

API Version:: 5.0-preview.1

Get details about a specific package.

GET https://feeds.dev.azure.com/{organization}/_apis/packaging/Feeds/{feedId}/packages/{packageId}?api-version=5.0-preview.1

With optional parameters:

GET https://feeds.dev.azure.com/{organization}/_apis/packaging/Feeds/{feedId}/packages/{packageId}?includeAllVersions={includeAllVersions}&includeUrls={includeUrls}&isListed={isListed}&isRelease={isRelease}&includeDeleted={includeDeleted}&includeDescription={includeDescription}&api-version=5.0-preview.1

URI Parameters

Name	In	Required	Type	Description
feedId	path	True	string	Name or Id of the feed.
organization	path	True	string	The name of the Azure DevOps organization.
packageId	path	True	string	The package Id (GUID Id, not the package name).
api-version	query	True	string	Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.
includeAllVersions	query		boolean	True to return all versions of the package in the response. Default is false (latest version only).
includeDeleted	query		boolean	Return deleted or unpublished versions of packages in the response. Default is False.
includeDescription	query		boolean	Return the description for every version of each package in the response. Default is False.
includeUrls	query		boolean	True to return REST Urls with the response. Default is True.
isListed	query		boolean	Only applicable for NuGet packages, setting it for other package types will result in a 404. If false, delisted package versions will be returned. Use this to filter the response when includeAllVersions is set to true. Default is unset (do not return delisted packages).
isRelease	query		boolean	Only applicable for Nuget packages. Use this to filter the response when includeAllVersions is set to true. Default is True (only return packages without prerelease versioning).

Responses

Name	Type	Description
200 OK	Package	successful operation

Security

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

Name	Description
vso.packaging	Grants the ability to read feeds and packages.

Definitions

Name	Description
FeedView	A view on top of a feed.
FeedViewType	Type of view.
FeedVisibility	Visibility status of the view.
MinimalPackageVersion	Core data about any package, including its id and version information and basic state.
Package	A package, which is a container for one or more package versions.
ReferenceLinks	The class to represent a collection of REST reference links.

FeedView

A view on top of a feed.

Name	Type	Description
_links	ReferenceLinks	Related REST links.
id	string	Id of the view.
name	string	Name of the view.
type	FeedViewType	Type of view.
url	string	Url of the view.
visibility	FeedVisibility	Visibility status of the view.

FeedViewType

Type of view.

Name	Type	Description
implicit	string	Internal view type that is automatically created and managed by the system.
none	string	Default, unspecified view type.
release	string	View used as a promotion destination to classify released artifacts.

FeedVisibility

Visibility status of the view.

Name	Type	Description
collection	string	Feed is accessible by all the valid users present in the organization where the feed resides (for example across organization 'myorg' at 'dev.azure.com/myorg')
organization	string	Feed is accessible by all the valid users present in the enterprise where the feed resides. Note that legacy naming and back compat leaves the name of this value out of sync with its new meaning.
private	string	Only accessible by the permissions explicitly set by the feed administrator.

MinimalPackageVersion

Core data about any package, including its id and version information and basic state.

Name	Type	Description
directUpstreamSourceId	string	Upstream source this package was ingested from.
id	string	Id for the package.
isCachedVersion	boolean	[Obsolete] Used for legacy scenarios and may be removed in future versions.
isDeleted	boolean	True if this package has been deleted.
isLatest	boolean	True if this is the latest version of the package by package type sort order.
isListed	boolean	(NuGet Only) True if this package is listed.
normalizedVersion	string	Normalized version using normalization rules specific to a package type.
packageDescription	string	Package description.
publishDate	string	UTC Date the package was published to the service.
storageId	string	Internal storage id.
version	string	Display version.
views	FeedView[]	List of views containing this package version.

Package

A package, which is a container for one or more package versions.

Name	Type	Description
_links	ReferenceLinks	Related REST links.
id	string	Id of the package.
isCached	boolean	Used for legacy scenarios and may be removed in future versions.
name	string	The display name of the package.
normalizedName	string	The normalized name representing the identity of this package within its package type.
protocolType	string	Type of the package.
starCount	integer	[Obsolete] - this field is unused and will be removed in a future release.
url	string	Url for this package.
versions	MinimalPackageVersion[]	All versions for this package within its feed.

ReferenceLinks

The class to represent a collection of REST reference links.

Name	Type	Description
links	object	The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.

Share via