Change Tracking - Get Feed Changes

Service:

Artifacts

API Version:

7.1

Query to determine which feeds have changed since the last call, tracked through the provided continuationToken. Only changes to a feed itself are returned and impact the continuationToken, not additions or alterations to packages within the feeds.

If the project parameter is present, gets all feed changes in the given project. If omitted, gets all feed changes in the organization.

GET https://feeds.dev.azure.com/{organization}/{project}/_apis/packaging/feedchanges?api-version=7.1

With optional parameters:

GET https://feeds.dev.azure.com/{organization}/{project}/_apis/packaging/feedchanges?includeDeleted={includeDeleted}&continuationToken={continuationToken}&batchSize={batchSize}&api-version=7.1

URI Parameters

Name	In	Required	Type	Description
organization	path	True	string	The name of the Azure DevOps organization.
project	path		string	Project ID or project name
api-version	query	True	string	Version of the API to use. This should be set to '7.1' to use this version of the api.
batchSize	query		integer (int32)	Number of package changes to fetch. The default value is 1000. The maximum value is 2000.
continuationToken	query		integer (int64)	A continuation token which acts as a bookmark to a previously retrieved change. This token allows the user to continue retrieving changes in batches, picking up where the previous batch left off. If specified, all the changes that occur strictly after the token will be returned. If not specified or 0, iteration will start with the first change.
includeDeleted	query		boolean	If true, get changes for all feeds including deleted feeds. The default value is false.

Responses

Name	Type	Description
200 OK	FeedChangesResponse	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. Also grants the ability to search packages.

Definitions

Name	Description
ChangeType	The type of operation.
Feed	A container for artifacts.
FeedCapabilities	Supported capabilities of a feed.
FeedChange	A container that encapsulates the state of the feed after a create, update, or delete.
FeedChangesResponse	A result set containing the feed changes for the range that was requested.
FeedPermission	Permissions for a feed.
FeedRole	The role for this identity on a feed.
FeedView	A view on top of a feed.
FeedViewType	Type of view.
FeedVisibility	Visibility status of the view.
IdentityDescriptor	An Identity descriptor is a wrapper for the identity type (Windows SID, Passport) along with a unique identifier such as the SID or PUID.
ProjectReference
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.
UpstreamStatus	Specifies the status of the upstream.
UpstreamStatusDetail

ChangeType

Enumeration

The type of operation.

Value	Description
addOrUpdate	A package version was added or updated.
delete	A package version was deleted.
permanentDelete	A feed was permanently deleted. This is not used for package version.

Feed

Object

A container for artifacts.

Name	Type	Description
_links	ReferenceLinks	Related REST links.
badgesEnabled	boolean	If set, this feed supports generation of package badges.
capabilities	FeedCapabilities	Supported capabilities of a feed.
defaultViewId	string (uuid)	The view that the feed administrator has indicated is the default experience for readers.
deletedDate	string (date-time)	The date that this feed was deleted.
description	string	A description for the feed. Descriptions must not exceed 255 characters.
fullyQualifiedId	string	This will either be the feed GUID or the feed GUID and view GUID depending on how the feed was accessed.
fullyQualifiedName	string	Full name of the view, in feed@view format.
hideDeletedPackageVersions	boolean	If set, the feed will hide all deleted/unpublished versions
id	string (uuid)	A GUID that uniquely identifies this feed.
isReadOnly	boolean	If set, all packages in the feed are immutable. It is important to note that feed views are immutable; therefore, this flag will always be set for views.
name	string	A name for the feed. feed names must follow these rules: <list type="bullet"><item><description> Must not exceed 64 characters </description></item><item><description> Must not contain whitespaces </description></item><item><description> Must not start with an underscore or a period </description></item><item><description> Must not end with a period </description></item><item><description> Must not contain any of the following illegal characters: , |, /, \\, ?, :, &, $, *, \", #, [, ] ]]></description></item></list>
permanentDeletedDate	string (date-time)	The date that this feed was permanently deleted.
permissions	FeedPermission[]	Explicit permissions for the feed.
project	ProjectReference	The project that this feed is associated with.
scheduledPermanentDeleteDate	string (date-time)	The date that this feed is scheduled to be permanently deleted.
upstreamEnabled	boolean	This should always be true. Setting to false will override all sources in UpstreamSources.
upstreamEnabledChangedDate	string (date-time)	If set, time that the UpstreamEnabled property was changed. Will be null if UpstreamEnabled was never changed after Feed creation.
upstreamSources	UpstreamSource[]	A list of sources that this feed will fetch packages from. An empty list indicates that this feed will not search any additional sources for packages.
url	string	The URL of the base feed in GUID form.
view	FeedView	Definition of the view.
viewId	string (uuid)	View Id.
viewName	string	View name.

FeedCapabilities

Enumeration

Supported capabilities of a feed.

Value	Description
defaultCapabilities	The capabilities given to a newly created feed
none	No flags exist for this feed
underMaintenance	This feed is currently under maintenance and may have reduced functionality
upstreamV2	This feed can serve packages from upstream sources Upstream packages must be manually promoted to views

FeedChange

Object

A container that encapsulates the state of the feed after a create, update, or delete.

Name	Type	Description
changeType	ChangeType	The type of operation.
feed	Feed	The state of the feed after a after a create, update, or delete operation completed.
feedContinuationToken	integer (int64)	A token that identifies the next change in the log of changes.
latestPackageContinuationToken	integer (int64)	A token that identifies the latest package change for this feed. This can be used to quickly determine if there have been any changes to packages in a specific feed.

FeedChangesResponse

Object

A result set containing the feed changes for the range that was requested.

Name	Type	Description
_links	ReferenceLinks	The class to represent a collection of REST reference links.
count	integer (int32)	The number of changes in this set.
feedChanges	FeedChange[]	A container that encapsulates the state of the feed after a create, update, or delete.
nextFeedContinuationToken	integer (int64)	When iterating through the log of changes this value indicates the value that should be used for the next continuation token.

FeedPermission

Object

Permissions for a feed.

Name	Type	Description
displayName	string	Display name for the identity.
identityDescriptor	IdentityDescriptor	Identity associated with this role.
identityId	string (uuid)	Id of the identity associated with this role.
isInheritedRole	boolean	Boolean indicating whether the role is inherited or set directly.
role	FeedRole	The role for this identity on a feed.

FeedRole

Enumeration

The role for this identity on a feed.

Value	Description
administrator	Administrators have total control over the feed.
collaborator	Collaborators have the same permissions as readers, but can also ingest packages from configured upstream sources.
contributor	Contributors can do anything to packages in the feed including adding new packages, but they may not modify feed settings.
custom	Unsupported.
none	Unsupported.
reader	Readers can only read packages and view settings.

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
aadTenant	Feed is accessible by all the valid users present in the Azure Active Directory tenant.
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.

IdentityDescriptor

Object

An Identity descriptor is a wrapper for the identity type (Windows SID, Passport) along with a unique identifier such as the SID or PUID.

Name	Type	Description
identifier	string	The unique identifier for this identity, not exceeding 256 chars, which will be persisted.
identityType	string	Type of descriptor (for example, Windows, Passport, etc.).

ProjectReference

Object

Name	Type	Description
id	string (uuid)	Gets or sets id of the project.
name	string	Gets or sets name of the project.
visibility	string	Gets or sets visibility of the project.

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.
displayLocation	string	Locator for connecting to the upstream source in a user friendly format, that may potentially change over time
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.
internalUpstreamProjectId	string (uuid)	For an internal upstream type, track the project of the feed being referenced.
internalUpstreamViewId	string (uuid)	For an internal upstream type, track the view of the feed being referenced.
location	string	Consistent locator for connecting to the upstream source.
name	string	Display name.
protocol	string	Package type associated with the upstream source.
serviceEndpointId	string (uuid)	The identity of the service endpoint that holds credentials to use when accessing the upstream.
serviceEndpointProjectId	string (uuid)	Specifies the projectId of the Service Endpoint.
status	UpstreamStatus	Specifies the status of the upstream.
statusDetails	UpstreamStatusDetail[]	Provides a human-readable reason for the status of the upstream.
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.

UpstreamStatus

Enumeration

Specifies the status of the upstream.

Value	Description
disabled	Upstream source is disabled.
ok	Upstream source is ok.

UpstreamStatusDetail

Object

Name	Type	Description
reason	string	Provides a human-readable reason for the status of the upstream.