Package org.azd.workitemtracking

Class WorkItemTrackingApi

java.lang.Object

org.azd.utils.AzDAsyncApi<WorkItemTrackingApi>

org.azd.workitemtracking.WorkItemTrackingApi

All Implemented Interfaces:

WorkItemTrackingDetails

public class WorkItemTrackingApi
extends AzDAsyncApi<WorkItemTrackingApi>
implements WorkItemTrackingDetails

WorkItem Tracking class to manage work items API

Constructor Summary

Constructors

Constructor	Description
WorkItemTrackingApi(Connection connection)	Pass the connection object to work with WorkItem Tracking Api

Method Summary

Modifier and Type	Method	Description
WorkItem	addHyperLinks(int workItemId, Map<String,String> hyperlinksMap)	Create hyperlinks for the given work item.
WorkItem	addWorkItemAttachment(int workItemId, Map<String,String> fieldsToUpdate)	Add an attachment to a work item.
AttachmentReference	createAttachment(String fileName, AttachmentUploadType uploadType, String teamAreaPath, InputStream contentStream)	Uploads an attachment.
AttachmentReference	createAttachment(String fileName, AttachmentUploadType uploadType, String teamAreaPath, String contents)	Deprecated. This method is deprecated as of version 5.0.0.
QueryHierarchyItem	createQuery(String query, QueryHierarchyItem queryHierarchyItem)	Creates a query, or moves a query.
WorkItem	createWorkItem(String workItemType, String title, String description, Map<String,Object> additionalFields)	Creates a single work item optionally with additional fields.
WorkItem	createWorkItem(String workItemType, WorkItemOperation operation, String title)	Creates a single work item.
WorkItem	createWorkItem(String workItemType, WorkItemOperation operation, String title, String description, String[] tags)	Creates a single work item.
WorkItemField	createWorkItemField(WorkItemField workItemField)	Create a new field.
Void	deleteQuery(String query)	Delete a query or a folder.
WorkItemDelete	deleteWorkItem(int id)	Deletes the specified work item and sends it to the Recycle Bin, so that it can be restored back, if required.
Void	deleteWorkItem(int id, boolean destroy)	Deletes the specified work item permanently if the destroy parameter has been set to true, WARNING: If the destroy parameter is set to true, work items deleted by this command will NOT go to recycle-bin and there is no way to restore/recover them after deletion.
Void	deleteWorkItemField(String fieldNameOrRefName)	Deletes the field.
String	getAttachment(String id, String fileName)	Deprecated. This method is deprecated as of version 5.0.0.
InputStream	getAttachmentAsZip(String id, String fileName, boolean download)	Downloads an attachment as a zip file.
InputStream	getAttachmentContent(String id, String fileName, boolean download)	Downloads an attachment.
WorkItemDeleteShallowReferences	getDeletedWorkItemsFromRecycleBin()	Gets a list of the IDs and the URLs of the deleted the work items in the Recycle Bin.
WorkItemDeleteReferences	getDeletedWorkItemsFromRecycleBin(int[] ids)	Gets the work items from the recycle bin, whose IDs have been specified in the parameters
AccountRecentActivityWorkItems	getMyWorkRecentActivity()
QueryHierarchyItems	getQueries()	Gets the root queries and their children
QueryHierarchyItems	getQueries(int depth, QueryExpand expand, boolean includeDeleted)	Gets the root queries and their children
QueryHierarchyItem	getQuery(String query)	Retrieves an individual query and its children
QueryHierarchyItem	getQuery(String query, int depth, QueryExpand expand, boolean includeDeleted, boolean useIsoDateFormat)	Retrieves an individual query and its children
QueryHierarchyItems	getQueryBatches(QueryErrorPolicy errorPolicy, QueryExpand expand, String[] ids)	Gets a list of queries by ids (Maximum 1000)
WorkItem	getWorkItem(int id)	Returns a single work item.
WorkItem	getWorkItem(int id, WorkItemExpand expand)	Returns a single work item.
WorkItem	getWorkItem(int id, WorkItemExpand expand, String asOf)	Returns a single work item.
WorkItem	getWorkItem(int id, WorkItemExpand expand, String[] fields)	Returns a single work item.
WorkItem	getWorkItem(int id, WorkItemExpand expand, String[] fields, String asOf)	Returns a single work item.
WorkItemField	getWorkItemField(String fieldNameOrRefName)	Gets information on a specific field.
WorkItemFieldTypes	getWorkItemFields()	Returns information for all fields.
WorkItemFieldTypes	getWorkItemFields(GetFieldsExpand expand)	Returns information for all fields.
WorkItemDeleteReference	getWorkItemFromRecycleBin(int id)	Gets a deleted work item from Recycle Bin.
WorkItem	getWorkItemRevision(int workItemId, int revisionNumber)	Returns a fully hydrated work item for the requested revision
WorkItem	getWorkItemRevision(int workItemId, int revisionNumber, WorkItemExpand expand)	Returns a fully hydrated work item for the requested revision
WorkItemList	getWorkItemRevisions(int workItemId)	Returns the list of fully hydrated work item revisions.
WorkItemList	getWorkItemRevisions(int workItemId, WorkItemExpand expand)	Returns the list of fully hydrated work item revisions.
WorkItemList	getWorkItemRevisions(int workItemId, WorkItemExpand expand, int top, int skip)	Returns the list of fully hydrated work item revisions, paged.
WorkItemList	getWorkItems(int[] ids)	Returns a list of work items (Maximum 200)
WorkItemList	getWorkItems(int[] ids, WorkItemExpand expand)	Returns a list of work items (Maximum 200)
WorkItemList	getWorkItems(int[] ids, WorkItemExpand expand, String asOf)	Returns a list of work items (Maximum 200)
WorkItemList	getWorkItems(int[] ids, WorkItemExpand expand, String[] fields)	Returns a list of work items (Maximum 200)
WorkItemList	getWorkItems(int[] ids, WorkItemExpand expand, String[] fields, String asOf, WorkItemErrorPolicy errorPolicy)	Returns a list of work items (Maximum 200)
WorkItemType	getWorkItemType(String workItemTypeName)	Returns a work item type definition.
WorkItemTypes	getWorkItemTypes()	Returns the list of work item types
ProcessMigrationResultModel	migrateProjectProcess(String processId)	Migrates a project to a different process within the same OOB type.
WorkItemQueryResult	queryByWiql(String team, String query)	Gets the results of the query given its WIQL.
WorkItemQueryResult	queryByWiql(String team, String query, int top, boolean timePrecision)	Gets the results of the query given its WIQL.
WorkItem	removeHyperLinks(int workItemId, List<String> urls)	Remove hyperlinks for the given work item.
WorkItem	removeWorkItemAttachment(int workItemId, List<String> attachmentUrl)	Removes the attachment from a work item.
Void	removeWorkItemFromRecycleBin(int id)	Destroys the specified work item permanently from the Recycle Bin.
WorkItemDeleteReference	restoreWorkItemFromRecycleBin(int id)	Restores the deleted work item from Recycle Bin.
QueryHierarchyItemsResult	searchQuery(String filter)
QueryHierarchyItemsResult	searchQuery(String filter, QueryExpand expand, boolean includeDeleted, int top)
WorkItem	updateWorkItem(int workItemId, Map<String,Object> fieldsToUpdate)	Update a single work item with the internal field names.
WorkItem	updateWorkItem(int workItemId, Map<String,Object> fieldsToUpdate, WorkItemOperation operation)	Update a single work item with the internal field names.
WorkItem	updateWorkItem(int workItemId, WorkItemExpand expand, boolean bypassRules, boolean suppressNotifications, boolean validateOnly, Map<String,Object> fieldsToUpdate)	Update a single work item with the internal field names.
WorkItem	updateWorkItem(int workItemId, WorkItemExpand expand, boolean bypassRules, boolean suppressNotifications, boolean validateOnly, Map<String,Object> fieldsToUpdate, WorkItemOperation operation)	Update a single work item with the internal field names.
WorkItemField	updateWorkItemField(String fieldNameOrRefName, boolean isDeleted)	Update a field.

Methods inherited from class org.azd.utils.AzDAsyncApi

createAsync

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

WorkItemTrackingApi

public WorkItemTrackingApi(Connection connection)

Pass the connection object to work with WorkItem Tracking Api

Parameters:

connection - Connection object

Method Details

createWorkItem

public WorkItem createWorkItem(String workItemType,
 WorkItemOperation operation,
 String title)
                        throws AzDException

Creates a single work item.

Specified by:

createWorkItem in interface WorkItemTrackingDetails

Parameters:

workItemType - The work item type of the work item to create. e.g., "user story", "bug", "task"

operation - The patch operation WorkItemOperation

title - The title for the work item

Returns:

WorkItem

Throws:

AzDException - Default Api Exception handler.

createWorkItem

public WorkItem createWorkItem(String workItemType,
 WorkItemOperation operation,
 String title,
 String description,
 String[] tags)
                        throws AzDException

Creates a single work item.

Specified by:

createWorkItem in interface WorkItemTrackingDetails

Parameters:

workItemType - The work item type of the work item to create. e.g., "user story", "bug", "task"

operation - The patch operation WorkItemOperation

title - The title for the work item

description - Description for the work item

tags - Tags for the work item

Returns:

WorkItem

Throws:

AzDException - Default Api Exception handler.

createWorkItem

public WorkItem createWorkItem(String workItemType,
 String title,
 String description,
 Map<String,Object> additionalFields)
                        throws AzDException

Creates a single work item optionally with additional fields.

Specified by:

createWorkItem in interface WorkItemTrackingDetails

Parameters:

workItemType - The work item type of the work item to create. e.g., "user story", "bug", "task"

title - The title for the work item

description - Description for the work item

additionalFields - Provide the additional fields as a HashMap to create the work item. This requires the internal fields to be specified. E.g., System.Tags, System.AreaPath, System.State, System.Reason etc.,

Returns:

WorkItem

Throws:

AzDException - Default Api Exception handler.

deleteWorkItem

public WorkItemDelete deleteWorkItem(int id)
                              throws AzDException

Deletes the specified work item and sends it to the Recycle Bin, so that it can be restored back, if required.

Specified by:

deleteWorkItem in interface WorkItemTrackingDetails

Parameters:

id - ID of the work item to be deleted

Returns:

WorkItemDelete

Throws:

AzDException - Default Api Exception handler.

deleteWorkItem

public Void deleteWorkItem(int id,
 boolean destroy)
                    throws AzDException

Deletes the specified work item permanently if the destroy parameter has been set to true, WARNING: If the destroy parameter is set to true, work items deleted by this command will NOT go to recycle-bin and there is no way to restore/recover them after deletion. It is recommended NOT to use this parameter. If you do, please use this parameter with extreme caution.

Specified by:

deleteWorkItem in interface WorkItemTrackingDetails

Parameters:

id - ID of the work item to be deleted

destroy - Optional parameter, if set to true, the work item is deleted permanently. Please note: the destroy action is PERMANENT and cannot be undone.

Throws:

AzDException - Default Api Exception handler.

getWorkItem

public WorkItem getWorkItem(int id)
                     throws AzDException

Returns a single work item.

Specified by:

getWorkItem in interface WorkItemTrackingDetails

Parameters:

id - The work item id

Returns:

WorkItem WorkItem

Throws:

AzDException - Default Api Exception handler.

getWorkItem

public WorkItem getWorkItem(int id,
 WorkItemExpand expand)
                     throws AzDException

Returns a single work item.

Specified by:

getWorkItem in interface WorkItemTrackingDetails

Parameters:

id - The work item id

expand - The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }. WorkItemExpand

Returns:

WorkItem WorkItem

Throws:

AzDException - Default Api Exception handler.

getWorkItem

public WorkItem getWorkItem(int id,
 WorkItemExpand expand,
 String asOf)
                     throws AzDException

Returns a single work item.

Specified by:

getWorkItem in interface WorkItemTrackingDetails

Parameters:

id - The work item id

expand - The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }. WorkItemExpand

asOf - AsOf UTC date time string

Returns:

WorkItem WorkItem

Throws:

AzDException - Default Api Exception handler.

getWorkItem

public WorkItem getWorkItem(int id,
 WorkItemExpand expand,
 String[] fields)
                     throws AzDException

Returns a single work item.

Specified by:

getWorkItem in interface WorkItemTrackingDetails

Parameters:

id - The work item id

expand - The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }. WorkItemExpand

fields - Comma-separated list of requested fields

Returns:

WorkItem WorkItem

Throws:

AzDException - Default Api Exception handler.

getWorkItem

public WorkItem getWorkItem(int id,
 WorkItemExpand expand,
 String[] fields,
 String asOf)
                     throws AzDException

Returns a single work item.

Specified by:

getWorkItem in interface WorkItemTrackingDetails

Parameters:

id - The work item id

expand - The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }. WorkItemExpand

fields - Comma-separated list of requested fields

asOf - AsOf UTC date time string

Returns:

WorkItem WorkItem

Throws:

AzDException - Default Api Exception handler.

getWorkItems

public WorkItemList getWorkItems(int[] ids)
                          throws AzDException

Returns a list of work items (Maximum 200)

Specified by:

getWorkItems in interface WorkItemTrackingDetails

Parameters:

ids - Integer array of requested work item ids. (Maximum 200 ids allowed).

Returns:

WorkItemList

Throws:

AzDException - Default Api Exception handler.

getWorkItems

public WorkItemList getWorkItems(int[] ids,
 WorkItemExpand expand)
                          throws AzDException

Returns a list of work items (Maximum 200)

Specified by:

getWorkItems in interface WorkItemTrackingDetails

Parameters:

ids - Integer array of requested work item ids. (Maximum 200 ids allowed).

expand - The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }. WorkItemExpand

Returns:

WorkItemList

Throws:

AzDException - Default Api Exception handler.

getWorkItems

public WorkItemList getWorkItems(int[] ids,
 WorkItemExpand expand,
 String asOf)
                          throws AzDException

Returns a list of work items (Maximum 200)

Specified by:

getWorkItems in interface WorkItemTrackingDetails

Parameters:

ids - Integer array of requested work item ids. (Maximum 200 ids allowed).

expand - The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }. WorkItemExpand

asOf - AsOf UTC date time string

Returns:

WorkItemList

Throws:

AzDException - Default Api Exception handler.

getWorkItems

public WorkItemList getWorkItems(int[] ids,
 WorkItemExpand expand,
 String[] fields)
                          throws AzDException

Returns a list of work items (Maximum 200)

Specified by:

getWorkItems in interface WorkItemTrackingDetails

Parameters:

ids - Integer array of requested work item ids. (Maximum 200 ids allowed).

expand - The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }. WorkItemExpand

fields - Comma-separated list of requested fields

Returns:

WorkItemList

Throws:

AzDException - Default Api Exception handler.

getWorkItems

public WorkItemList getWorkItems(int[] ids,
 WorkItemExpand expand,
 String[] fields,
 String asOf,
 WorkItemErrorPolicy errorPolicy)
                          throws AzDException

Returns a list of work items (Maximum 200)

Specified by:

getWorkItems in interface WorkItemTrackingDetails

Parameters:

ids - Integer array of requested work item ids. (Maximum 200 ids allowed).

expand - The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }. WorkItemExpand

fields - Comma-separated list of requested fields

asOf - AsOf UTC date time string

errorPolicy - The flag to control error policy in a bulk get work items request. Possible options are {Fail, Omit}. WorkItemErrorPolicy

Returns:

WorkItemList

Throws:

AzDException - Default Api Exception handler.

getWorkItemRevisions

public WorkItemList getWorkItemRevisions(int workItemId)
                                  throws AzDException

Returns the list of fully hydrated work item revisions.

Specified by:

getWorkItemRevisions in interface WorkItemTrackingDetails

Parameters:

workItemId - The id of the work item

Returns:

WorkItemList

Throws:

AzDException - Default Api Exception handler.

getWorkItemRevisions

public WorkItemList getWorkItemRevisions(int workItemId,
 WorkItemExpand expand)
                                  throws AzDException

Returns the list of fully hydrated work item revisions.

Specified by:

getWorkItemRevisions in interface WorkItemTrackingDetails

Parameters:

workItemId - The id of the work item

expand - The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }. WorkItemExpand

Returns:

WorkItemList

Throws:

AzDException - Default Api Exception handler.

getWorkItemRevisions

public WorkItemList getWorkItemRevisions(int workItemId,
 WorkItemExpand expand,
 int top,
 int skip)
                                  throws AzDException

Returns the list of fully hydrated work item revisions, paged.

Specified by:

getWorkItemRevisions in interface WorkItemTrackingDetails

Parameters:

workItemId - The id of the work item

expand - The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }. WorkItemExpand

top - Specify top pages to list

skip - Specify to skip pages

Returns:

WorkItemList

Throws:

AzDException - Default Api Exception handler.

getWorkItemRevision

public WorkItem getWorkItemRevision(int workItemId,
 int revisionNumber)
                             throws AzDException

Returns a fully hydrated work item for the requested revision

Specified by:

getWorkItemRevision in interface WorkItemTrackingDetails

Parameters:

workItemId - The id of the work item

revisionNumber - The work item revision number

Returns:

WorkItem

Throws:

AzDException - Default Api Exception handler.

getWorkItemRevision

public WorkItem getWorkItemRevision(int workItemId,
 int revisionNumber,
 WorkItemExpand expand)
                             throws AzDException

Returns a fully hydrated work item for the requested revision

Specified by:

getWorkItemRevision in interface WorkItemTrackingDetails

Parameters:

workItemId - The id of the work item

revisionNumber - The work item revision number

expand - The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }. WorkItemExpand

Returns:

WorkItem

Throws:

AzDException - Default Api Exception handler.

queryByWiql

public WorkItemQueryResult queryByWiql(String team,
 String query)
                                throws AzDException

Gets the results of the query given its WIQL.

Specified by:

queryByWiql in interface WorkItemTrackingDetails

Parameters:

team - Team ID or team name

query - Specify the query to list the work items. E.g., "Select * From WorkItems Where [System.WorkItemType] = 'User Story'"

Returns:

WorkItemQueryResult WorkItemQueryResult

Throws:

AzDException - Handles errors from REST API and validates passed arguments

queryByWiql

public WorkItemQueryResult queryByWiql(String team,
 String query,
 int top,
 boolean timePrecision)
                                throws AzDException

Gets the results of the query given its WIQL.

Specified by:

queryByWiql in interface WorkItemTrackingDetails

Parameters:

team - Team ID or team name

query - Specify the query to list the work items. E.g., "Select * From WorkItems Where [System.WorkItemType] = 'User Story'"

top - The max number of results to return.

timePrecision - The max number of results to return.

Returns:

WorkItemQueryResult WorkItemQueryResult

Throws:

AzDException - Handles errors from REST API and validates passed arguments

removeWorkItemFromRecycleBin

public Void removeWorkItemFromRecycleBin(int id)
                                  throws AzDException

Destroys the specified work item permanently from the Recycle Bin. This action can not be undone.

Specified by:

removeWorkItemFromRecycleBin in interface WorkItemTrackingDetails

Parameters:

id - ID of the work item to be destroyed permanently

Throws:

AzDException - Handles errors from REST API and validates passed arguments

getWorkItemFromRecycleBin

public WorkItemDeleteReference getWorkItemFromRecycleBin(int id)
                                                  throws AzDException

Gets a deleted work item from Recycle Bin.

Specified by:

getWorkItemFromRecycleBin in interface WorkItemTrackingDetails

Parameters:

id - ID of the work item to be returned

Returns:

WorkItemDeleteReference WorkItemDeleteReference

Throws:

AzDException - Handles errors from REST API and validates passed arguments

getDeletedWorkItemsFromRecycleBin

public WorkItemDeleteShallowReferences getDeletedWorkItemsFromRecycleBin()
                                                                  throws AzDException

Gets a list of the IDs and the URLs of the deleted the work items in the Recycle Bin.

Specified by:

getDeletedWorkItemsFromRecycleBin in interface WorkItemTrackingDetails

Returns:

WorkItemDeleteShallowReferences WorkItemDeleteShallowReferences

Throws:

AzDException - Handles errors from REST API and validates passed arguments

getDeletedWorkItemsFromRecycleBin

public WorkItemDeleteReferences getDeletedWorkItemsFromRecycleBin(int[] ids)
                                                           throws AzDException

Gets the work items from the recycle bin, whose IDs have been specified in the parameters

Specified by:

getDeletedWorkItemsFromRecycleBin in interface WorkItemTrackingDetails

Parameters:

ids - array of workitem ids

Returns:

WorkItemDeleteReferences WorkItemDeleteReferences

Throws:

AzDException - Handles errors from REST API and validates passed arguments

restoreWorkItemFromRecycleBin

public WorkItemDeleteReference restoreWorkItemFromRecycleBin(int id)
                                                      throws AzDException

Restores the deleted work item from Recycle Bin.

Specified by:

restoreWorkItemFromRecycleBin in interface WorkItemTrackingDetails

Parameters:

id - ID of the work item to be restored

Returns:

WorkItemDeleteReference WorkItemDeleteReference

Throws:

AzDException - Handles errors from REST API and validates passed arguments

updateWorkItem

public WorkItem updateWorkItem(int workItemId,
 Map<String,Object> fieldsToUpdate)
                        throws AzDException

Update a single work item with the internal field names.

Specified by:

updateWorkItem in interface WorkItemTrackingDetails

Parameters:

workItemId - The id of the work item to update

fieldsToUpdate - HashMap of internal field names to update. E.g., System.Title, System.Description etc and it's associated values.

Returns:

The updated WorkItem.

Throws:

AzDException - Handles errors from REST API and validates passed arguments.

updateWorkItem

public WorkItem updateWorkItem(int workItemId,
 Map<String,Object> fieldsToUpdate,
 WorkItemOperation operation)
                        throws AzDException

Update a single work item with the internal field names.

Specified by:

updateWorkItem in interface WorkItemTrackingDetails

Parameters:

workItemId - The id of the work item to update

fieldsToUpdate - HashMap of internal field names to update. E.g., System.Title, System.Description etc and it's associated values.

operation - The WorkItemOperation.

Returns:

WorkItem WorkItem

Throws:

AzDException - Handles errors from REST API and validates passed arguments.

updateWorkItem

public WorkItem updateWorkItem(int workItemId,
 WorkItemExpand expand,
 boolean bypassRules,
 boolean suppressNotifications,
 boolean validateOnly,
 Map<String,Object> fieldsToUpdate)
                        throws AzDException

Update a single work item with the internal field names. The operation type that will be used is WorkItemOperation.ADD.

Specified by:

updateWorkItem in interface WorkItemTrackingDetails

Parameters:

workItemId - The id of the work item to update

expand - The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }. WorkItemExpand

bypassRules - Do not enforce the work item type rules on this update

suppressNotifications - Do not fire any notifications for this change

validateOnly - Indicate if you only want to validate the changes without saving the work item

fieldsToUpdate - HashMap of internal field names to update. E.g., System.Title, System.Description etc and it's associated values.

Returns:

WorkItemDeleteReference WorkItemDeleteReference

Throws:

AzDException - Handles errors from REST API and validates passed arguments.

updateWorkItem

public WorkItem updateWorkItem(int workItemId,
 WorkItemExpand expand,
 boolean bypassRules,
 boolean suppressNotifications,
 boolean validateOnly,
 Map<String,Object> fieldsToUpdate,
 WorkItemOperation operation)
                        throws AzDException

Update a single work item with the internal field names.

Specified by:

updateWorkItem in interface WorkItemTrackingDetails

Parameters:

workItemId - The id of the work item to update

expand - The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }. WorkItemExpand

bypassRules - Do not enforce the work item type rules on this update

suppressNotifications - Do not fire any notifications for this change

validateOnly - Indicate if you only want to validate the changes without saving the work item

fieldsToUpdate - HashMap of internal field names to update. E.g., System.Title, System.Description etc and it's associated values.

operation - The WorkItemOperation.

Returns:

WorkItem WorkItem

Throws:

AzDException - Handles errors from REST API and validates passed arguments.

addHyperLinks

public WorkItem addHyperLinks(int workItemId,
 Map<String,String> hyperlinksMap)
                       throws AzDException

Create hyperlinks for the given work item.

Specified by:

addHyperLinks in interface WorkItemTrackingDetails

Parameters:

workItemId - The work item's ID.

hyperlinksMap - A Map that each entry represents a hyperlink. The key is the hyperlink URL and the value is its comment. If a comment is not desired then the value can either be null (if its supported by the map) or an empty string.

Returns:

The updated WorkItem.

Throws:

AzDException - Handles errors from REST API and validates passed arguments.

removeHyperLinks

public WorkItem removeHyperLinks(int workItemId,
 List<String> urls)
                          throws AzDException

Remove hyperlinks for the given work item.

Note: All hyperlinks must exist in order to be removed. Even if one doesn't then an AzDException is thrown.

Specified by:

removeHyperLinks in interface WorkItemTrackingDetails

Parameters:

workItemId - The work item's ID.

urls - A List with the URL of the hyperlinks.

Returns:

The updated WorkItem.

Throws:

AzDException - Handles errors from REST API and validates passed arguments.

getWorkItemTypes

public WorkItemTypes getWorkItemTypes()
                               throws AzDException

Returns the list of work item types

Specified by:

getWorkItemTypes in interface WorkItemTrackingDetails

Returns:

list of Work Item type WorkItemTypes

Throws:

AzDException - Handles errors from REST API and validates passed arguments

getWorkItemType

public WorkItemType getWorkItemType(String workItemTypeName)
                             throws AzDException

Returns a work item type definition.

Specified by:

getWorkItemType in interface WorkItemTrackingDetails

Parameters:

workItemTypeName - provide the work item type name. e.g., Bug or user story etc.

Returns:

work item type WorkItemType

Throws:

AzDException - Handles errors from REST API and validates passed arguments

createAttachment

@Deprecated
public AttachmentReference createAttachment(String fileName,
 AttachmentUploadType uploadType,
 String teamAreaPath,
 String contents)
                                     throws AzDException

Deprecated.

This method is deprecated as of version 5.0.0. Please use createAttachment() with content stream for working with work item attachment API.

Specified by:

createAttachment in interface WorkItemTrackingDetails

Throws:

AzDException

createAttachment

public AttachmentReference createAttachment(String fileName,
 AttachmentUploadType uploadType,
 String teamAreaPath,
 InputStream contentStream)
                                     throws AzDException

Uploads an attachment.

Specified by:

createAttachment in interface WorkItemTrackingDetails

Parameters:

fileName - The name of the file

uploadType - Attachment upload type: Simple or Chunked. AttachmentUploadType

teamAreaPath - Target project Area Path

contentStream - Stream to upload. Payload to create the attachment.

Returns:

AttachmentReference AttachmentReference

Throws:

AzDException - Handles errors from REST API and validates passed arguments

getAttachmentContent

public InputStream getAttachmentContent(String id,
 String fileName,
 boolean download)
                                 throws AzDException

Downloads an attachment.

Specified by:

getAttachmentContent in interface WorkItemTrackingDetails

Parameters:

id - Attachment ID

fileName - Name of the file

download - If set to true always download attachment

Returns:

Stream of the attachment content. Use StreamHelper to download the attachment contents to a file.

Throws:

AzDException - Handles errors from REST API and validates passed arguments

getAttachmentAsZip

public InputStream getAttachmentAsZip(String id,
 String fileName,
 boolean download)
                               throws AzDException

Downloads an attachment as a zip file.

Specified by:

getAttachmentAsZip in interface WorkItemTrackingDetails

Parameters:

id - Attachment ID

fileName - Name of the file

download - If set to true always download attachment

Returns:

Stream of the attachment content. Use StreamHelper to download the attachment contents to a file.

Throws:

AzDException - Handles errors from REST API and validates passed arguments

getAttachment

@Deprecated
public String getAttachment(String id,
 String fileName)
                     throws AzDException

Deprecated.

This method is deprecated as of version 5.0.0. Please use getAttachmentContent() or getAttachmentAsZip() for working with work item attachment API.

Specified by:

getAttachment in interface WorkItemTrackingDetails

Throws:

AzDException

addWorkItemAttachment

public WorkItem addWorkItemAttachment(int workItemId,
 Map<String,String> fieldsToUpdate)
                               throws AzDException

Add an attachment to a work item. Pass the url of the attachment and comments as a Map to add the attachment to work item. Note that the attachment should already be created using createAttachment method.

Specified by:

addWorkItemAttachment in interface WorkItemTrackingDetails

Parameters:

workItemId - Id of the work item.

fieldsToUpdate - Map of url and comments.
var attachments = new HashMap<String, Object>() {{ put("https://url/of/attachment", "This is a comment"); }};

Returns:

The work item object. WorkItem WorkItem

Throws:

AzDException - Handles errors from REST API and validates passed arguments.

removeWorkItemAttachment

public WorkItem removeWorkItemAttachment(int workItemId,
 List<String> attachmentUrl)
                                  throws AzDException

Removes the attachment from a work item. Pass the list of attachment url to be removed.

Specified by:

removeWorkItemAttachment in interface WorkItemTrackingDetails

Parameters:

workItemId - ID of the work item.

attachmentUrl - List of attachment url.

Returns:

The work item object. WorkItem WorkItem

Throws:

AzDException - Handles errors from REST API and validates passed arguments.

getMyWorkRecentActivity

public AccountRecentActivityWorkItems getMyWorkRecentActivity()
                                                       throws AzDException

Specified by:

getMyWorkRecentActivity in interface WorkItemTrackingDetails

Throws:

AzDException

getWorkItemFields

public WorkItemFieldTypes getWorkItemFields()
                                     throws AzDException

Returns information for all fields. The project ID/name parameter is optional.

Specified by:

getWorkItemFields in interface WorkItemTrackingDetails

Returns:

WorkItemField Object WorkItemFieldTypes

Throws:

AzDException - Default Api Exception handler.

getWorkItemFields

public WorkItemFieldTypes getWorkItemFields(GetFieldsExpand expand)
                                     throws AzDException

Returns information for all fields. The project ID/name parameter is optional.

Specified by:

getWorkItemFields in interface WorkItemTrackingDetails

Parameters:

expand - Use ExtensionFields to include extension fields, otherwise exclude them. Unless the feature flag for this parameter is enabled, extension fields are always included.

Returns:

WorkItemFieldTypes Object WorkItemFieldTypes

Throws:

AzDException - Default Api Exception handler.

getWorkItemField

public WorkItemField getWorkItemField(String fieldNameOrRefName)
                               throws AzDException

Gets information on a specific field.

Specified by:

getWorkItemField in interface WorkItemTrackingDetails

Parameters:

fieldNameOrRefName - Field simple name or reference name

Returns:

WorkItemField Object WorkItemField

Throws:

AzDException - Default Api Exception handler.

createWorkItemField

public WorkItemField createWorkItemField(WorkItemField workItemField)
                                  throws AzDException

Create a new field.

Specified by:

createWorkItemField in interface WorkItemTrackingDetails

Parameters:

workItemField - WorkItemField object to create a new work item

Returns:

WorkItemField Object WorkItemField

Throws:

AzDException - Default Api Exception handler.

deleteWorkItemField

public Void deleteWorkItemField(String fieldNameOrRefName)
                         throws AzDException

Deletes the field. To undelete a filed, see "Update Field" API.

Specified by:

deleteWorkItemField in interface WorkItemTrackingDetails

Parameters:

fieldNameOrRefName - Field simple name or reference name

Throws:

AzDException - Default Api Exception handler.

updateWorkItemField

public WorkItemField updateWorkItemField(String fieldNameOrRefName,
 boolean isDeleted)
                                  throws AzDException

Update a field.

Specified by:

updateWorkItemField in interface WorkItemTrackingDetails

Parameters:

fieldNameOrRefName - Name/reference name of the field to be updated

Returns:

WorkItemField Object WorkItemField

Throws:

AzDException - Default Api Exception handler.

migrateProjectProcess

public ProcessMigrationResultModel migrateProjectProcess(String processId)
                                                  throws AzDException

Migrates a project to a different process within the same OOB type. For example, you can only migrate a project from agile/custom-agile to agile/custom-agile.

Specified by:

migrateProjectProcess in interface WorkItemTrackingDetails

Returns:

ProcessMigrationResultModel Object ProcessMigrationResultModel

Throws:

AzDException - Default Api Exception handler.

createQuery

public QueryHierarchyItem createQuery(String query,
 QueryHierarchyItem queryHierarchyItem)
                               throws AzDException

Creates a query, or moves a query.

Specified by:

createQuery in interface WorkItemTrackingDetails

Parameters:

queryHierarchyItem - Query Hierarchy item object.

Returns:

QueryHierarchyItem Object QueryHierarchyItem

Throws:

AzDException - Default Api Exception handler.

getQueries

public QueryHierarchyItems getQueries()
                               throws AzDException

Gets the root queries and their children

Specified by:

getQueries in interface WorkItemTrackingDetails

Returns:

A list of QueryHierarchyItem Object QueryHierarchyItems

Throws:

AzDException - Default Api Exception handler.

getQueries

public QueryHierarchyItems getQueries(int depth,
 QueryExpand expand,
 boolean includeDeleted)
                               throws AzDException

Gets the root queries and their children

Specified by:

getQueries in interface WorkItemTrackingDetails

Parameters:

depth - In the folder of queries, return child queries and folders to this depth.

expand - Include the query string (wiql), clauses, query result columns, and sort options in the results.

includeDeleted - Include deleted queries and folders

Returns:

A list of QueryHierarchyItem Object QueryHierarchyItems

Throws:

AzDException - Default Api Exception handler.

getQuery

public QueryHierarchyItem getQuery(String query)
                            throws AzDException

Retrieves an individual query and its children

Specified by:

getQuery in interface WorkItemTrackingDetails

Parameters:

query - ID or path of the query.

Returns:

QueryHierarchyItem Object QueryHierarchyItem

Throws:

AzDException - Default Api Exception handler.

getQuery

public QueryHierarchyItem getQuery(String query,
 int depth,
 QueryExpand expand,
 boolean includeDeleted,
 boolean useIsoDateFormat)
                            throws AzDException

Retrieves an individual query and its children

Specified by:

getQuery in interface WorkItemTrackingDetails

Parameters:

query - ID or path of the query.

depth - In the folder of queries, return child queries and folders to this depth.

expand - Include the query string (wiql), clauses, query result columns, and sort options in the results.

includeDeleted - Include deleted queries and folders

useIsoDateFormat - DateTime query clauses will be formatted using a ISO 8601 compliant format

Returns:

QueryHierarchyItem Object QueryHierarchyItem

Throws:

AzDException - Default Api Exception handler.

deleteQuery

public Void deleteQuery(String query)
                 throws AzDException

Delete a query or a folder. This deletes any permission change on the deleted query or folder and any of its descendants if it is a folder. It is important to note that the deleted permission changes cannot be recovered upon undeleting the query or folder.

Specified by:

deleteQuery in interface WorkItemTrackingDetails

Parameters:

query - ID or path of the query or folder to delete.

Throws:

AzDException - Default Api Exception handler.

getQueryBatches

public QueryHierarchyItems getQueryBatches(QueryErrorPolicy errorPolicy,
 QueryExpand expand,
 String[] ids)
                                    throws AzDException

Gets a list of queries by ids (Maximum 1000)

Specified by:

getQueryBatches in interface WorkItemTrackingDetails

Parameters:

errorPolicy - The flag to control error policy in a query batch request. Possible options are { Fail, Omit }.

expand - The expand parameters for queries. Possible options are { None, Wiql, Clauses, All, Minimal }

ids - The requested query ids

Returns:

QueryHierarchyItem Object QueryHierarchyItem

Throws:

AzDException - Default Api Exception handler.

searchQuery

public QueryHierarchyItemsResult searchQuery(String filter)
                                      throws AzDException

Specified by:

searchQuery in interface WorkItemTrackingDetails

Throws:

AzDException

searchQuery

public QueryHierarchyItemsResult searchQuery(String filter,
 QueryExpand expand,
 boolean includeDeleted,
 int top)
                                      throws AzDException

Specified by:

searchQuery in interface WorkItemTrackingDetails

Throws:

AzDException