Package org.azd.work

Class WorkApi

java.lang.Object

org.azd.utils.AzDAsyncApi<WorkApi>

org.azd.work.WorkApi

All Implemented Interfaces:

WorkDetails

public class WorkApi
extends AzDAsyncApi<WorkApi>
implements WorkDetails

Work class to manage work API

Constructor Summary

Constructors

Constructor	Description
WorkApi(Connection connection)	Pass the connection object to work with Work Api

Method Summary

Modifier and Type	Method	Description
Void	deleteTeamSettingsIteration(String teamName, String iterationId)	Delete a team's iteration by iterationId
IterationWorkItems	getTeamIterationWorkItems(String teamName, String iterationId)	Get work items for iteration
TeamMemberCapacityIdentityRef	getTeamMemberCapacity(String iterationId, String teamName, String teamMemberId)	Get a team member's capacity
TeamSettingsIteration	getTeamSettingsIteration(String teamName, String iterationId)	Get team's iteration by iterationId
TeamSettingsIterations	getTeamSettingsIterations(String teamName)	Get a team's iterations
TeamSettingsIterations	getTeamSettingsIterations(String teamName, IterationsTimeFrame timeFrame)	Get a team's iterations using timeframe filter
TeamCapacity	getTotalTeamCapacity(String iterationId, String teamName)	Get a team's capacity including total capacity and days off
TeamMemberCapacityIdentityRef	updateTeamMemberCapacity(String iterationId, String teamName, String teamMemberId, TeamMemberCapacityIdentityRef teamMemberCapacity)	Update a team member's capacity
TeamMemberCapacityIdentityRefs	updateTeamMembersCapacity(String iterationId, String teamName, List<TeamMemberCapacityIdentityRef> teamMembersCapacity)	Replace a team's capacity

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

WorkApi

public WorkApi(Connection connection)

Pass the connection object to work with Work Api

Parameters:

connection - Connection object

Method Details

getTeamSettingsIterations

public TeamSettingsIterations getTeamSettingsIterations(String teamName)
                                                 throws AzDException

Get a team's iterations

Specified by:

getTeamSettingsIterations in interface WorkDetails

Parameters:

teamName - Team ID or team name

Returns:

TeamSettingsIterations

Throws:

AzDException - Default Api Exception handler.

getTeamSettingsIterations

public TeamSettingsIterations getTeamSettingsIterations(String teamName,
 IterationsTimeFrame timeFrame)
                                                 throws AzDException

Get a team's iterations using timeframe filter

Specified by:

getTeamSettingsIterations in interface WorkDetails

Parameters:

teamName - Team ID or team name

timeFrame - A filter for which iterations are returned based on relative time. Only 'Current' is supported currently. IterationsTimeFrame

Returns:

TeamSettingsIterations

Throws:

AzDException - Default Api Exception handler.

getTeamIterationWorkItems

public IterationWorkItems getTeamIterationWorkItems(String teamName,
 String iterationId)
                                             throws AzDException

Get work items for iteration

Specified by:

getTeamIterationWorkItems in interface WorkDetails

Parameters:

teamName - Team ID or team name

iterationId - ID of the iteration

Returns:

TeamSettingsIterations

Throws:

AzDException - Default Api Exception handler.

getTeamSettingsIteration

public TeamSettingsIteration getTeamSettingsIteration(String teamName,
 String iterationId)
                                               throws AzDException

Get team's iteration by iterationId

Specified by:

getTeamSettingsIteration in interface WorkDetails

Parameters:

teamName - ID of the iteration

iterationId - Team ID or team name

Returns:

TeamSettingsIterations

Throws:

AzDException - Default Api Exception handler.

deleteTeamSettingsIteration

public Void deleteTeamSettingsIteration(String teamName,
 String iterationId)
                                 throws AzDException

Delete a team's iteration by iterationId

Specified by:

deleteTeamSettingsIteration in interface WorkDetails

Parameters:

teamName - Team ID or team name

iterationId - ID of the iteration

Throws:

AzDException - Default Api Exception handler.

getTotalTeamCapacity

public TeamCapacity getTotalTeamCapacity(String iterationId,
 String teamName)
                                  throws AzDException

Get a team's capacity including total capacity and days off

Specified by:

getTotalTeamCapacity in interface WorkDetails

Parameters:

iterationId - Pass the iteration id.

teamName - The name of the Azure DevOps organization.

Returns:

TeamCapacity Object TeamCapacity

Throws:

AzDException - Default Api Exception handler.

getTeamMemberCapacity

public TeamMemberCapacityIdentityRef getTeamMemberCapacity(String iterationId,
 String teamName,
 String teamMemberId)
                                                    throws AzDException

Get a team member's capacity

Specified by:

getTeamMemberCapacity in interface WorkDetails

Parameters:

iterationId - Pass the team iteration id.

teamName - Name of Azure DevOps team.

teamMemberId - Id of the team member.

Returns:

TeamMemberCapacityIdentityRef Object TeamMemberCapacityIdentityRef

Throws:

AzDException - Default Api Exception handler.

updateTeamMembersCapacity

public TeamMemberCapacityIdentityRefs updateTeamMembersCapacity(String iterationId,
 String teamName,
 List<TeamMemberCapacityIdentityRef> teamMembersCapacity)
                                                         throws AzDException

Replace a team's capacity

Specified by:

updateTeamMembersCapacity in interface WorkDetails

Parameters:

iterationId - Pass the team iteration id.

teamName - Name or id of the Azure DevOps team.

teamMembersCapacity - A list of team members capacity to update.

Returns:

TeamMemberCapacityIdentityRef Object TeamMemberCapacityIdentityRef

Throws:

AzDException - Default Api Exception handler.

updateTeamMemberCapacity

public TeamMemberCapacityIdentityRef updateTeamMemberCapacity(String iterationId,
 String teamName,
 String teamMemberId,
 TeamMemberCapacityIdentityRef teamMemberCapacity)
                                                       throws AzDException

Update a team member's capacity

Specified by:

updateTeamMemberCapacity in interface WorkDetails

Parameters:

iterationId - Pass the team iteration id.

teamName - Name of id of the Azure DevOps team.

teamMemberId - Id of the team member.

teamMemberCapacity - Team member capacity object to update. You can only pass the list of activities and optionally days off.

Returns:

TeamMemberCapacityIdentityRef Object TeamMemberCapacityIdentityRef

Throws:

AzDException - Default Api Exception handler.