WorkItemTrackingHttpClientBase.ReadReportingRevisionsGetAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
ReadReportingRevisionsGetAsync(String, IEnumerable<String>, IEnumerable<String>, String, Nullable<DateTime>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<ReportingRevisionsExpand>, Nullable<Boolean>, Nullable<Int32>, Object, CancellationToken)
[Preview API] Get a batch of work item revisions with the option of including deleted items
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingWorkItemRevisionsBatch> ReadReportingRevisionsGetAsync (string project, System.Collections.Generic.IEnumerable<string> fields = null, System.Collections.Generic.IEnumerable<string> types = null, string continuationToken = null, Nullable<DateTime> startDateTime = null, Nullable<bool> includeIdentityRef = null, Nullable<bool> includeDeleted = null, Nullable<bool> includeTagRef = null, Nullable<bool> includeLatestOnly = null, Nullable<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingRevisionsExpand> expand = null, Nullable<bool> includeDiscussionChangesOnly = null, Nullable<int> maxPageSize = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);override this.ReadReportingRevisionsGetAsync : string * seq<string> * seq<string> * string * Nullable<DateTime> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingRevisionsExpand> * Nullable<bool> * Nullable<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingWorkItemRevisionsBatch>Parameters
- project
- String
Project ID or project name
- fields
- IEnumerable<String>
A list of fields to return in work item revisions. Omit this parameter to get all reportable fields.
- types
- IEnumerable<String>
A list of types to filter the results to specific work item types. Omit this parameter to get work item revisions of all work item types.
- continuationToken
- String
Specifies the watermark to start the batch from. Omit this parameter to get the first batch of revisions.
Date/time to use as a starting point for revisions, all revisions will occur after this date/time. Cannot be used in conjunction with 'watermark' parameter.
Return an identity reference instead of a string value for identity fields.
Specify if the tag objects should be returned for System.Tags field.
Return only the latest revisions of work items, skipping all historical revisions
- expand
- Nullable<ReportingRevisionsExpand>
Return all the fields in work item revisions, including long text fields which are not returned by default
Return only the those revisions of work items, where only history field was changed
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
ReadReportingRevisionsGetAsync(Guid, IEnumerable<String>, IEnumerable<String>, String, Nullable<DateTime>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<ReportingRevisionsExpand>, Nullable<Boolean>, Nullable<Int32>, Object, CancellationToken)
[Preview API] Get a batch of work item revisions with the option of including deleted items
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingWorkItemRevisionsBatch> ReadReportingRevisionsGetAsync (Guid project, System.Collections.Generic.IEnumerable<string> fields = null, System.Collections.Generic.IEnumerable<string> types = null, string continuationToken = null, Nullable<DateTime> startDateTime = null, Nullable<bool> includeIdentityRef = null, Nullable<bool> includeDeleted = null, Nullable<bool> includeTagRef = null, Nullable<bool> includeLatestOnly = null, Nullable<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingRevisionsExpand> expand = null, Nullable<bool> includeDiscussionChangesOnly = null, Nullable<int> maxPageSize = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);override this.ReadReportingRevisionsGetAsync : Guid * seq<string> * seq<string> * string * Nullable<DateTime> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingRevisionsExpand> * Nullable<bool> * Nullable<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingWorkItemRevisionsBatch>Parameters
- project
- Guid
Project ID
- fields
- IEnumerable<String>
A list of fields to return in work item revisions. Omit this parameter to get all reportable fields.
- types
- IEnumerable<String>
A list of types to filter the results to specific work item types. Omit this parameter to get work item revisions of all work item types.
- continuationToken
- String
Specifies the watermark to start the batch from. Omit this parameter to get the first batch of revisions.
Date/time to use as a starting point for revisions, all revisions will occur after this date/time. Cannot be used in conjunction with 'watermark' parameter.
Return an identity reference instead of a string value for identity fields.
Specify if the tag objects should be returned for System.Tags field.
Return only the latest revisions of work items, skipping all historical revisions
- expand
- Nullable<ReportingRevisionsExpand>
Return all the fields in work item revisions, including long text fields which are not returned by default
Return only the those revisions of work items, where only history field was changed
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
ReadReportingRevisionsGetAsync(IEnumerable<String>, IEnumerable<String>, String, Nullable<DateTime>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<ReportingRevisionsExpand>, Nullable<Boolean>, Nullable<Int32>, Object, CancellationToken)
[Preview API] Get a batch of work item revisions with the option of including deleted items
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingWorkItemRevisionsBatch> ReadReportingRevisionsGetAsync (System.Collections.Generic.IEnumerable<string> fields = null, System.Collections.Generic.IEnumerable<string> types = null, string continuationToken = null, Nullable<DateTime> startDateTime = null, Nullable<bool> includeIdentityRef = null, Nullable<bool> includeDeleted = null, Nullable<bool> includeTagRef = null, Nullable<bool> includeLatestOnly = null, Nullable<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingRevisionsExpand> expand = null, Nullable<bool> includeDiscussionChangesOnly = null, Nullable<int> maxPageSize = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);override this.ReadReportingRevisionsGetAsync : seq<string> * seq<string> * string * Nullable<DateTime> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingRevisionsExpand> * Nullable<bool> * Nullable<int> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingWorkItemRevisionsBatch>Parameters
- fields
- IEnumerable<String>
A list of fields to return in work item revisions. Omit this parameter to get all reportable fields.
- types
- IEnumerable<String>
A list of types to filter the results to specific work item types. Omit this parameter to get work item revisions of all work item types.
- continuationToken
- String
Specifies the watermark to start the batch from. Omit this parameter to get the first batch of revisions.
Date/time to use as a starting point for revisions, all revisions will occur after this date/time. Cannot be used in conjunction with 'watermark' parameter.
Return an identity reference instead of a string value for identity fields.
Specify if the tag objects should be returned for System.Tags field.
Return only the latest revisions of work items, skipping all historical revisions
- expand
- Nullable<ReportingRevisionsExpand>
Return all the fields in work item revisions, including long text fields which are not returned by default
Return only the those revisions of work items, where only history field was changed
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for