Artifact Details - Get Package Version

Service:

Artifacts

API Version:

5.0-preview.1

Get details about a specific package version.

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

With optional parameters:

GET https://feeds.dev.azure.com/{organization}/_apis/packaging/Feeds/{feedId}/Packages/{packageId}/versions/{packageVersionId}?includeUrls={includeUrls}&isListed={isListed}&isDeleted={isDeleted}&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	Id of the package (GUID Id, not name).
packageVersionId	path	True	string	Id of the package version (GUID Id, not 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.
includeUrls	query		boolean	True to include urls for each version. Default is true.
isDeleted	query		boolean	Return deleted or unpublished versions of packages in the response. Default is unset (do not return deleted versions).
isListed	query		boolean	Only applicable for NuGet packages. If false, delisted package versions will be returned.

Responses

Name	Type	Description
200 OK	PackageVersion	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.
PackageDependency	A dependency on another package version.
PackageFile	A package file for a specific package version, only relevant to package types that contain multiple files per version.
PackageVersion	A specific version of a package.
ProtocolMetadata	Extended metadata for a specific package type.
ReferenceLinks	The class to represent a collection of REST reference links.
UpstreamSource	Upstream source definition, including its Identity, package type, and other associated information.
UpstreamSourceType	Source type, such as Public or Internal.

FeedView

Object

A view on top of a feed.

Name	Type	Description
_links	ReferenceLinks	Related REST links.
id	string (uuid)	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

Enumeration

Type of view.

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

FeedVisibility

Enumeration

Visibility status of the view.

Value	Description
collection	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	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	Only accessible by the permissions explicitly set by the feed administrator.

MinimalPackageVersion

Object

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

Name	Type	Description
directUpstreamSourceId	string (uuid)	Upstream source this package was ingested from.
id	string (uuid)	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 (date-time)	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.

PackageDependency

Object

A dependency on another package version.

Name	Type	Description
group	string	Dependency package group (an optional classification within some package types).
packageName	string	Dependency package name.
versionRange	string	Dependency package version range.

PackageFile

Object

A package file for a specific package version, only relevant to package types that contain multiple files per version.

Name	Type	Description
children	PackageFile[]	Hierarchical representation of files.
name	string	File name.
protocolMetadata	ProtocolMetadata	Extended data unique to a specific package type.

PackageVersion

Object

A specific version of a package.

Name	Type	Description
_links	ReferenceLinks	Related links
author	string	Package version author.
deletedDate	string (date-time)	UTC date that this package version was deleted.
dependencies	PackageDependency[]	List of dependencies for this package version.
description	string	Package version description.
directUpstreamSourceId	string (uuid)	Upstream source this package was ingested from.
files	PackageFile[]	Files associated with this package version, only relevant for multi-file package types.
id	string (uuid)	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.
otherVersions	MinimalPackageVersion[]	Other versions of this package.
packageDescription	string	Package description.
protocolMetadata	ProtocolMetadata	Extended data specific to a package type.
publishDate	string (date-time)	UTC Date the package was published to the service.
sourceChain	UpstreamSource[]	List of upstream sources through which a package version moved to land in this feed.
storageId	string	Internal storage id.
summary	string	Package version summary.
tags	string[]	Package version tags.
url	string	Package version url.
version	string	Display version.
views	FeedView[]	List of views containing this package version.

ProtocolMetadata

Object

Extended metadata for a specific package type.

Name	Type	Description
data	object	Extended metadata for a specific package type, formatted to the associated schema version definition.
schemaVersion	integer (int32)	Schema version.

ReferenceLinks

Object

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.

UpstreamSource

Object

Upstream source definition, including its Identity, package type, and other associated information.

Name	Type	Description
deletedDate	string (date-time)	UTC date that this upstream was deleted.
id	string (uuid)	Identity of the upstream source.
internalUpstreamCollectionId	string (uuid)	For an internal upstream type, track the Azure DevOps organization that contains it.
internalUpstreamFeedId	string (uuid)	For an internal upstream type, track the feed id being referenced.
internalUpstreamViewId	string (uuid)	For an internal upstream type, track the view of the feed being referenced.
location	string	Locator for connecting to the upstream source.
name	string	Display name.
protocol	string	Package type associated with the upstream source.
upstreamSourceType	UpstreamSourceType	Source type, such as Public or Internal.

UpstreamSourceType

Enumeration

Source type, such as Public or Internal.

Value	Description
internal	Azure DevOps upstream source.
public	Publicly available source.