WorkItemTrackingHttpClientCompatBase.GetReportingLinksAsync 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
| GetReportingLinksAsync(String, IEnumerable<String>, Nullable<Int64>, Nullable<DateTime>, Object, CancellationToken) |
[Preview API] Get a batch of work item links |
| GetReportingLinksAsync(String, IEnumerable<String>, String, Nullable<DateTime>, Object, CancellationToken) |
[Preview API] Get a batch of work item links |
| GetReportingLinksAsync(Guid, IEnumerable<String>, String, Nullable<DateTime>, Object, CancellationToken) |
[Preview API] Get a batch of work item links |
| GetReportingLinksAsync(Guid, IEnumerable<String>, Nullable<Int64>, Nullable<DateTime>, Object, CancellationToken) |
[Preview API] Get a batch of work item links |
| GetReportingLinksAsync(IEnumerable<String>, String, Nullable<DateTime>, Object, CancellationToken) |
[Preview API] Get a batch of work item links |
| GetReportingLinksAsync(IEnumerable<String>, Nullable<Int64>, Nullable<DateTime>, Object, CancellationToken) |
[Preview API] Get a batch of work item links |
GetReportingLinksAsync(String, IEnumerable<String>, Nullable<Int64>, Nullable<DateTime>, Object, CancellationToken)
[Preview API] Get a batch of work item links
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingWorkItemLinksBatch> GetReportingLinksAsync(string project, System.Collections.Generic.IEnumerable<string> types, Nullable<long> watermark, Nullable<DateTime> startDateTime, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetReportingLinksAsync : string * seq<string> * Nullable<int64> * Nullable<DateTime> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingWorkItemLinksBatch>
override this.GetReportingLinksAsync : string * seq<string> * Nullable<int64> * Nullable<DateTime> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingWorkItemLinksBatch>Parameters
- project
- String
Project ID or project name
- types
- IEnumerable<String>
A list of types to filter the results to specific work item types. Omit this parameter to get work item links of all work item types.
Specifies the watermark to start the batch from. Omit this parameter to get the first batch of links.
Date/time to use as a starting point for link changes. Only link changes that occurred after that date/time will be returned. Cannot be used in conjunction with 'watermark' parameter.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetReportingLinksAsync(String, IEnumerable<String>, String, Nullable<DateTime>, Object, CancellationToken)
[Preview API] Get a batch of work item links
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingWorkItemLinksBatch> GetReportingLinksAsync(string project, System.Collections.Generic.IEnumerable<string> types = null, string continuationToken = null, Nullable<DateTime> startDateTime = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetReportingLinksAsync : string * seq<string> * string * Nullable<DateTime> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingWorkItemLinksBatch>
override this.GetReportingLinksAsync : string * seq<string> * string * Nullable<DateTime> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingWorkItemLinksBatch>Parameters
- project
- String
Project ID or project name
- types
- IEnumerable<String>
A list of types to filter the results to specific work item types. Omit this parameter to get work item links of all work item types.
- continuationToken
- String
Specifies the continuationToken to start the batch from. Omit this parameter to get the first batch of links.
Date/time to use as a starting point for link changes. Only link changes that occurred after that date/time will be returned. Cannot be used in conjunction with 'watermark' parameter.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetReportingLinksAsync(Guid, IEnumerable<String>, String, Nullable<DateTime>, Object, CancellationToken)
[Preview API] Get a batch of work item links
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingWorkItemLinksBatch> GetReportingLinksAsync(Guid project, System.Collections.Generic.IEnumerable<string> types = null, string continuationToken = null, Nullable<DateTime> startDateTime = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetReportingLinksAsync : Guid * seq<string> * string * Nullable<DateTime> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingWorkItemLinksBatch>
override this.GetReportingLinksAsync : Guid * seq<string> * string * Nullable<DateTime> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingWorkItemLinksBatch>Parameters
- project
- Guid
Project ID
- types
- IEnumerable<String>
A list of types to filter the results to specific work item types. Omit this parameter to get work item links of all work item types.
- continuationToken
- String
Specifies the continuationToken to start the batch from. Omit this parameter to get the first batch of links.
Date/time to use as a starting point for link changes. Only link changes that occurred after that date/time will be returned. Cannot be used in conjunction with 'watermark' parameter.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetReportingLinksAsync(Guid, IEnumerable<String>, Nullable<Int64>, Nullable<DateTime>, Object, CancellationToken)
[Preview API] Get a batch of work item links
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingWorkItemLinksBatch> GetReportingLinksAsync(Guid project, System.Collections.Generic.IEnumerable<string> types, Nullable<long> watermark, Nullable<DateTime> startDateTime, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetReportingLinksAsync : Guid * seq<string> * Nullable<int64> * Nullable<DateTime> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingWorkItemLinksBatch>
override this.GetReportingLinksAsync : Guid * seq<string> * Nullable<int64> * Nullable<DateTime> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingWorkItemLinksBatch>Parameters
- project
- Guid
Project ID
- types
- IEnumerable<String>
A list of types to filter the results to specific work item types. Omit this parameter to get work item links of all work item types.
Specifies the watermark to start the batch from. Omit this parameter to get the first batch of links.
Date/time to use as a starting point for link changes. Only link changes that occurred after that date/time will be returned. Cannot be used in conjunction with 'watermark' parameter.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetReportingLinksAsync(IEnumerable<String>, String, Nullable<DateTime>, Object, CancellationToken)
[Preview API] Get a batch of work item links
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingWorkItemLinksBatch> GetReportingLinksAsync(System.Collections.Generic.IEnumerable<string> types = null, string continuationToken = null, Nullable<DateTime> startDateTime = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetReportingLinksAsync : seq<string> * string * Nullable<DateTime> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingWorkItemLinksBatch>
override this.GetReportingLinksAsync : seq<string> * string * Nullable<DateTime> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingWorkItemLinksBatch>Parameters
- types
- IEnumerable<String>
A list of types to filter the results to specific work item types. Omit this parameter to get work item links of all work item types.
- continuationToken
- String
Specifies the continuationToken to start the batch from. Omit this parameter to get the first batch of links.
Date/time to use as a starting point for link changes. Only link changes that occurred after that date/time will be returned. Cannot be used in conjunction with 'watermark' parameter.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetReportingLinksAsync(IEnumerable<String>, Nullable<Int64>, Nullable<DateTime>, Object, CancellationToken)
[Preview API] Get a batch of work item links
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingWorkItemLinksBatch> GetReportingLinksAsync(System.Collections.Generic.IEnumerable<string> types, Nullable<long> watermark, Nullable<DateTime> startDateTime, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetReportingLinksAsync : seq<string> * Nullable<int64> * Nullable<DateTime> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingWorkItemLinksBatch>
override this.GetReportingLinksAsync : seq<string> * Nullable<int64> * Nullable<DateTime> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.ReportingWorkItemLinksBatch>Parameters
- types
- IEnumerable<String>
A list of types to filter the results to specific work item types. Omit this parameter to get work item links of all work item types.
Specifies the watermark to start the batch from. Omit this parameter to get the first batch of links.
Date/time to use as a starting point for link changes. Only link changes that occurred after that date/time will be returned. Cannot be used in conjunction with 'watermark' parameter.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.