work

package
v1.0.0-b5 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 23, 2020 License: MIT Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var BacklogTypeValues = backlogTypeValuesType{

	Portfolio: "portfolio",

	Requirement: "requirement",

	Task: "task",
}
View Source 
var BoardBadgeColumnOptionsValues = boardBadgeColumnOptionsValuesType{

	InProgressColumns: "inProgressColumns",

	AllColumns: "allColumns",

	CustomColumns: "customColumns",
}
View Source 
var BoardColumnTypeValues = boardColumnTypeValuesType{
	Incoming:   "incoming",
	InProgress: "inProgress",
	Outgoing:   "outgoing",
}
View Source 
var BugsBehaviorValues = bugsBehaviorValuesType{
	Off:            "off",
	AsRequirements: "asRequirements",
	AsTasks:        "asTasks",
}
View Source 
var FieldTypeValues = fieldTypeValuesType{
	String:    "string",
	PlainText: "plainText",
	Integer:   "integer",
	DateTime:  "dateTime",
	TreePath:  "treePath",
	Boolean:   "boolean",
	Double:    "double",
}
View Source 
var IdentityDisplayFormatValues = identityDisplayFormatValuesType{

	AvatarOnly: "avatarOnly",

	FullName: "fullName",

	AvatarAndFullName: "avatarAndFullName",
}
View Source 
var PlanTypeValues = planTypeValuesType{
	DeliveryTimelineView: "deliveryTimelineView",
}
View Source 
var PlanUserPermissionsValues = planUserPermissionsValuesType{

	None: "none",

	View: "view",

	Edit: "edit",

	Delete: "delete",

	Manage: "manage",

	AllPermissions: "allPermissions",
}
View Source 
var ResourceAreaId, _ = uuid.Parse("1d4f49f9-02b9-4e26-b826-2cdb6195f2a9")
View Source 
var TimeFrameValues = timeFrameValuesType{
	Past:    "past",
	Current: "current",
	Future:  "future",
}
View Source 
var TimelineCriteriaStatusCodeValues = timelineCriteriaStatusCodeValuesType{

	Ok: "ok",

	InvalidFilterClause: "invalidFilterClause",

	Unknown: "unknown",
}
View Source 
var TimelineIterationStatusCodeValues = timelineIterationStatusCodeValuesType{

	Ok: "ok",

	IsOverlapping: "isOverlapping",
}
View Source 
var TimelineTeamStatusCodeValues = timelineTeamStatusCodeValuesType{

	Ok: "ok",

	DoesntExistOrAccessDenied: "doesntExistOrAccessDenied",

	MaxTeamsExceeded: "maxTeamsExceeded",

	MaxTeamFieldsExceeded: "maxTeamFieldsExceeded",

	BacklogInError: "backlogInError",

	MissingTeamFieldValue: "missingTeamFieldValue",

	NoIterationsExist: "noIterationsExist",
}

Functions

This section is empty.

Types

type Activity 

type Activity struct {
	CapacityPerDay *float32 `json:"capacityPerDay,omitempty"`
	Name           *string  `json:"name,omitempty"`
}

type BacklogColumn 

type BacklogColumn struct {
	ColumnFieldReference *workitemtracking.WorkItemFieldReference `json:"columnFieldReference,omitempty"`
	Width                *int                                     `json:"width,omitempty"`
}

type BacklogConfiguration 

type BacklogConfiguration struct {
	// Behavior/type field mapping
	BacklogFields *BacklogFields `json:"backlogFields,omitempty"`
	// Bugs behavior
	BugsBehavior *BugsBehavior `json:"bugsBehavior,omitempty"`
	// Hidden Backlog
	HiddenBacklogs *[]string `json:"hiddenBacklogs,omitempty"`
	// Is BugsBehavior Configured in the process
	IsBugsBehaviorConfigured *bool `json:"isBugsBehaviorConfigured,omitempty"`
	// Portfolio backlog descriptors
	PortfolioBacklogs *[]BacklogLevelConfiguration `json:"portfolioBacklogs,omitempty"`
	// Requirement backlog
	RequirementBacklog *BacklogLevelConfiguration `json:"requirementBacklog,omitempty"`
	// Task backlog
	TaskBacklog *BacklogLevelConfiguration `json:"taskBacklog,omitempty"`
	Url         *string                    `json:"url,omitempty"`
	// Mapped states for work item types
	WorkItemTypeMappedStates *[]WorkItemTypeStateInfo `json:"workItemTypeMappedStates,omitempty"`
}

type BacklogFields 

type BacklogFields struct {
	// Field Type (e.g. Order, Activity) to Field Reference Name map
	TypeFields *map[string]string `json:"typeFields,omitempty"`
}

type BacklogLevel 

type BacklogLevel struct {
	// Reference name of the corresponding WIT category
	CategoryReferenceName *string `json:"categoryReferenceName,omitempty"`
	// Plural name for the backlog level
	PluralName *string `json:"pluralName,omitempty"`
	// Collection of work item states that are included in the plan. The server will filter to only these work item types.
	WorkItemStates *[]string `json:"workItemStates,omitempty"`
	// Collection of valid workitem type names for the given backlog level
	WorkItemTypes *[]string `json:"workItemTypes,omitempty"`
}

Contract representing a backlog level

type BacklogLevelConfiguration 

type BacklogLevelConfiguration struct {
	// List of fields to include in Add Panel
	AddPanelFields *[]workitemtracking.WorkItemFieldReference `json:"addPanelFields,omitempty"`
	// Color for the backlog level
	Color *string `json:"color,omitempty"`
	// Default list of columns for the backlog
	ColumnFields *[]BacklogColumn `json:"columnFields,omitempty"`
	// Default Work Item Type for the backlog
	DefaultWorkItemType *workitemtracking.WorkItemTypeReference `json:"defaultWorkItemType,omitempty"`
	// Backlog Id (for Legacy Backlog Level from process config it can be categoryref name)
	Id *string `json:"id,omitempty"`
	// Indicates whether the backlog level is hidden
	IsHidden *bool `json:"isHidden,omitempty"`
	// Backlog Name
	Name *string `json:"name,omitempty"`
	// Backlog Rank (Taskbacklog is 0)
	Rank *int `json:"rank,omitempty"`
	// The type of this backlog level
	Type *BacklogType `json:"type,omitempty"`
	// Max number of work items to show in the given backlog
	WorkItemCountLimit *int `json:"workItemCountLimit,omitempty"`
	// Work Item types participating in this backlog as known by the project/Process, can be overridden by team settings for bugs
	WorkItemTypes *[]workitemtracking.WorkItemTypeReference `json:"workItemTypes,omitempty"`
}

type BacklogLevelWorkItems 

type BacklogLevelWorkItems struct {
	// A list of work items within a backlog level
	WorkItems *[]workitemtracking.WorkItemLink `json:"workItems,omitempty"`
}

Represents work items in a backlog level

type BacklogType 

type BacklogType string

Definition of the type of backlog level

type Board 

type Board struct {
	// Id of the resource
	Id *uuid.UUID `json:"id,omitempty"`
	// Name of the resource
	Name *string `json:"name,omitempty"`
	// Full http link to the resource
	Url             *string                         `json:"url,omitempty"`
	Links           interface{}                     `json:"_links,omitempty"`
	AllowedMappings *map[string]map[string][]string `json:"allowedMappings,omitempty"`
	CanEdit         *bool                           `json:"canEdit,omitempty"`
	Columns         *[]BoardColumn                  `json:"columns,omitempty"`
	Fields          *BoardFields                    `json:"fields,omitempty"`
	IsValid         *bool                           `json:"isValid,omitempty"`
	Revision        *int                            `json:"revision,omitempty"`
	Rows            *[]BoardRow                     `json:"rows,omitempty"`
}

type BoardBadge 

type BoardBadge struct {
	// The ID of the board represented by this badge.
	BoardId *uuid.UUID `json:"boardId,omitempty"`
	// A link to the SVG resource.
	ImageUrl *string `json:"imageUrl,omitempty"`
}

Represents a board badge.

type BoardBadgeColumnOptions 

type BoardBadgeColumnOptions string

Determines what columns to include on the board badge

type BoardCardRuleSettings 

type BoardCardRuleSettings struct {
	Links interface{}        `json:"_links,omitempty"`
	Rules *map[string][]Rule `json:"rules,omitempty"`
	Url   *string            `json:"url,omitempty"`
}

type BoardCardSettings 

type BoardCardSettings struct {
	Cards *map[string][]FieldSetting `json:"cards,omitempty"`
}

type BoardChart 

type BoardChart struct {
	// Name of the resource
	Name *string `json:"name,omitempty"`
	// Full http link to the resource
	Url *string `json:"url,omitempty"`
	// The links for the resource
	Links interface{} `json:"_links,omitempty"`
	// The settings for the resource
	Settings *map[string]interface{} `json:"settings,omitempty"`
}

type BoardChartReference 

type BoardChartReference struct {
	// Name of the resource
	Name *string `json:"name,omitempty"`
	// Full http link to the resource
	Url *string `json:"url,omitempty"`
}

type BoardColumn 

type BoardColumn struct {
	ColumnType    *BoardColumnType   `json:"columnType,omitempty"`
	Description   *string            `json:"description,omitempty"`
	Id            *uuid.UUID         `json:"id,omitempty"`
	IsSplit       *bool              `json:"isSplit,omitempty"`
	ItemLimit     *int               `json:"itemLimit,omitempty"`
	Name          *string            `json:"name,omitempty"`
	StateMappings *map[string]string `json:"stateMappings,omitempty"`
}

type BoardColumnType 

type BoardColumnType string

type BoardFields 

type BoardFields struct {
	ColumnField *FieldReference `json:"columnField,omitempty"`
	DoneField   *FieldReference `json:"doneField,omitempty"`
	RowField    *FieldReference `json:"rowField,omitempty"`
}

type BoardReference 

type BoardReference struct {
	// Id of the resource
	Id *uuid.UUID `json:"id,omitempty"`
	// Name of the resource
	Name *string `json:"name,omitempty"`
	// Full http link to the resource
	Url *string `json:"url,omitempty"`
}

type BoardRow 

type BoardRow struct {
	Id   *uuid.UUID `json:"id,omitempty"`
	Name *string    `json:"name,omitempty"`
}

type BoardSuggestedValue 

type BoardSuggestedValue struct {
	Name *string `json:"name,omitempty"`
}

type BoardUserSettings 

type BoardUserSettings struct {
	AutoRefreshState *bool `json:"autoRefreshState,omitempty"`
}

type BugsBehavior 

type BugsBehavior string

The behavior of the work item types that are in the work item category specified in the BugWorkItems section in the Process Configuration

type CapacityContractBase 

type CapacityContractBase struct {
	// Collection of links relevant to resource
	Links interface{} `json:"_links,omitempty"`
	// Full http link to the resource
	Url *string `json:"url,omitempty"`
	// Collection of capacities associated with the team member
	Activities *[]Activity `json:"activities,omitempty"`
	// The days off associated with the team member
	DaysOff *[]DateRange `json:"daysOff,omitempty"`
}

type CapacityPatch 

type CapacityPatch struct {
	Activities *[]Activity  `json:"activities,omitempty"`
	DaysOff    *[]DateRange `json:"daysOff,omitempty"`
}

Expected data from PATCH

type CardFieldSettings 

type CardFieldSettings struct {
	// A collection of field information of additional fields on cards. The index in the collection signifies the order of the field among the additional fields. Currently unused. Should be used with User Story 691539: Card setting: additional fields
	AdditionalFields *[]FieldInfo `json:"additionalFields,omitempty"`
	// Display format for the assigned to field
	AssignedToDisplayFormat *IdentityDisplayFormat `json:"assignedToDisplayFormat,omitempty"`
	// A collection of field information of rendered core fields on cards.
	CoreFields *[]FieldInfo `json:"coreFields,omitempty"`
	// Flag indicating whether to show assigned to field on cards. When true, AssignedToDisplayFormat will determine how the field will be displayed
	ShowAssignedTo *bool `json:"showAssignedTo,omitempty"`
	// Flag indicating whether to show empty fields on cards
	ShowEmptyFields *bool `json:"showEmptyFields,omitempty"`
	// Flag indicating whether to show ID on cards
	ShowId *bool `json:"showId,omitempty"`
	// Flag indicating whether to show state field on cards
	ShowState *bool `json:"showState,omitempty"`
	// Flag indicating whether to show tags on cards
	ShowTags *bool `json:"showTags,omitempty"`
}

Card settings, such as fields and rules

type CardSettings 

type CardSettings struct {
	// A collection of settings related to rendering of fields on cards
	Fields *CardFieldSettings `json:"fields,omitempty"`
}

Card settings, such as fields and rules

type CategoryConfiguration 

type CategoryConfiguration struct {
	// Name
	Name *string `json:"name,omitempty"`
	// Category Reference Name
	ReferenceName *string `json:"referenceName,omitempty"`
	// Work item types for the backlog category
	WorkItemTypes *[]workitemtracking.WorkItemTypeReference `json:"workItemTypes,omitempty"`
}

Details about a given backlog category

type Client 

type Client interface {
	// Add a new plan for the team
	CreatePlan(context.Context, CreatePlanArgs) (*Plan, error)
	// Delete the specified plan
	DeletePlan(context.Context, DeletePlanArgs) error
	// Delete a team's iteration by iterationId
	DeleteTeamIteration(context.Context, DeleteTeamIterationArgs) error
	// [Preview API] Get a backlog level
	GetBacklog(context.Context, GetBacklogArgs) (*BacklogLevelConfiguration, error)
	// Gets backlog configuration for a team
	GetBacklogConfigurations(context.Context, GetBacklogConfigurationsArgs) (*BacklogConfiguration, error)
	// [Preview API] Get a list of work items within a backlog level
	GetBacklogLevelWorkItems(context.Context, GetBacklogLevelWorkItemsArgs) (*BacklogLevelWorkItems, error)
	// [Preview API] List all backlog levels
	GetBacklogs(context.Context, GetBacklogsArgs) (*[]BacklogLevelConfiguration, error)
	// Get board
	GetBoard(context.Context, GetBoardArgs) (*Board, error)
	// Get board card Rule settings for the board id or board by name
	GetBoardCardRuleSettings(context.Context, GetBoardCardRuleSettingsArgs) (*BoardCardRuleSettings, error)
	// Get board card settings for the board id or board by name
	GetBoardCardSettings(context.Context, GetBoardCardSettingsArgs) (*BoardCardSettings, error)
	// Get a board chart
	GetBoardChart(context.Context, GetBoardChartArgs) (*BoardChart, error)
	// Get board charts
	GetBoardCharts(context.Context, GetBoardChartsArgs) (*[]BoardChartReference, error)
	// Get columns on a board
	GetBoardColumns(context.Context, GetBoardColumnsArgs) (*[]BoardColumn, error)
	// [Preview API] Returns the list of parent field filter model for the given list of workitem ids
	GetBoardMappingParentItems(context.Context, GetBoardMappingParentItemsArgs) (*[]ParentChildWIMap, error)
	// Get rows on a board
	GetBoardRows(context.Context, GetBoardRowsArgs) (*[]BoardRow, error)
	// Get boards
	GetBoards(context.Context, GetBoardsArgs) (*[]BoardReference, error)
	// [Preview API] Get board user settings for a board id
	GetBoardUserSettings(context.Context, GetBoardUserSettingsArgs) (*BoardUserSettings, error)
	// Get a team's capacity
	GetCapacitiesWithIdentityRef(context.Context, GetCapacitiesWithIdentityRefArgs) (*[]TeamMemberCapacityIdentityRef, error)
	// Get a team member's capacity
	GetCapacityWithIdentityRef(context.Context, GetCapacityWithIdentityRefArgs) (*TeamMemberCapacityIdentityRef, error)
	// Get available board columns in a project
	GetColumnSuggestedValues(context.Context, GetColumnSuggestedValuesArgs) (*[]BoardSuggestedValue, error)
	// Get Delivery View Data
	GetDeliveryTimelineData(context.Context, GetDeliveryTimelineDataArgs) (*DeliveryViewData, error)
	// [Preview API] Get work items for iteration
	GetIterationWorkItems(context.Context, GetIterationWorkItemsArgs) (*IterationWorkItems, error)
	// Get the information for the specified plan
	GetPlan(context.Context, GetPlanArgs) (*Plan, error)
	// Get the information for all the plans configured for the given team
	GetPlans(context.Context, GetPlansArgs) (*[]Plan, error)
	// [Preview API] Get process configuration
	GetProcessConfiguration(context.Context, GetProcessConfigurationArgs) (*ProcessConfiguration, error)
	// Get available board rows in a project
	GetRowSuggestedValues(context.Context, GetRowSuggestedValuesArgs) (*[]BoardSuggestedValue, error)
	// Get team's days off for an iteration
	GetTeamDaysOff(context.Context, GetTeamDaysOffArgs) (*TeamSettingsDaysOff, error)
	// Get a collection of team field values
	GetTeamFieldValues(context.Context, GetTeamFieldValuesArgs) (*TeamFieldValues, error)
	// Get team's iteration by iterationId
	GetTeamIteration(context.Context, GetTeamIterationArgs) (*TeamSettingsIteration, error)
	// Get a team's iterations using timeframe filter
	GetTeamIterations(context.Context, GetTeamIterationsArgs) (*[]TeamSettingsIteration, error)
	// Get a team's settings
	GetTeamSettings(context.Context, GetTeamSettingsArgs) (*TeamSetting, error)
	// Add an iteration to the team
	PostTeamIteration(context.Context, PostTeamIterationArgs) (*TeamSettingsIteration, error)
	// [Preview API] Reorder Product Backlog/Boards Work Items
	ReorderBacklogWorkItems(context.Context, ReorderBacklogWorkItemsArgs) (*[]ReorderResult, error)
	// [Preview API] Reorder Sprint Backlog/Taskboard Work Items
	ReorderIterationWorkItems(context.Context, ReorderIterationWorkItemsArgs) (*[]ReorderResult, error)
	// Replace a team's capacity
	ReplaceCapacitiesWithIdentityRef(context.Context, ReplaceCapacitiesWithIdentityRefArgs) (*[]TeamMemberCapacityIdentityRef, error)
	// Update board options
	SetBoardOptions(context.Context, SetBoardOptionsArgs) (*map[string]string, error)
	// Update board card Rule settings for the board id or board by name
	UpdateBoardCardRuleSettings(context.Context, UpdateBoardCardRuleSettingsArgs) (*BoardCardRuleSettings, error)
	// Update board card settings for the board id or board by name
	UpdateBoardCardSettings(context.Context, UpdateBoardCardSettingsArgs) (*BoardCardSettings, error)
	// Update a board chart
	UpdateBoardChart(context.Context, UpdateBoardChartArgs) (*BoardChart, error)
	// Update columns on a board
	UpdateBoardColumns(context.Context, UpdateBoardColumnsArgs) (*[]BoardColumn, error)
	// Update rows on a board
	UpdateBoardRows(context.Context, UpdateBoardRowsArgs) (*[]BoardRow, error)
	// [Preview API] Update board user settings for the board id
	UpdateBoardUserSettings(context.Context, UpdateBoardUserSettingsArgs) (*BoardUserSettings, error)
	// Update a team member's capacity
	UpdateCapacityWithIdentityRef(context.Context, UpdateCapacityWithIdentityRefArgs) (*TeamMemberCapacityIdentityRef, error)
	// Update the information for the specified plan
	UpdatePlan(context.Context, UpdatePlanArgs) (*Plan, error)
	// [Preview API] Update taskboard card Rule settings
	UpdateTaskboardCardRuleSettings(context.Context, UpdateTaskboardCardRuleSettingsArgs) error
	// [Preview API] Update taskboard card settings
	UpdateTaskboardCardSettings(context.Context, UpdateTaskboardCardSettingsArgs) error
	// Set a team's days off for an iteration
	UpdateTeamDaysOff(context.Context, UpdateTeamDaysOffArgs) (*TeamSettingsDaysOff, error)
	// Update team field values
	UpdateTeamFieldValues(context.Context, UpdateTeamFieldValuesArgs) (*TeamFieldValues, error)
	// Update a team's settings
	UpdateTeamSettings(context.Context, UpdateTeamSettingsArgs) (*TeamSetting, error)
}

func NewClient 

func NewClient(ctx context.Context, connection *azuredevops.Connection) (Client, error)

type ClientImpl 

type ClientImpl struct {
	Client azuredevops.Client
}

func (*ClientImpl) CreatePlan 

func (client *ClientImpl) CreatePlan(ctx context.Context, args CreatePlanArgs) (*Plan, error)

Add a new plan for the team

func (*ClientImpl) DeletePlan 

func (client *ClientImpl) DeletePlan(ctx context.Context, args DeletePlanArgs) error

Delete the specified plan

func (*ClientImpl) DeleteTeamIteration 

func (client *ClientImpl) DeleteTeamIteration(ctx context.Context, args DeleteTeamIterationArgs) error

Delete a team's iteration by iterationId

func (*ClientImpl) GetBacklog 

func (client *ClientImpl) GetBacklog(ctx context.Context, args GetBacklogArgs) (*BacklogLevelConfiguration, error)

[Preview API] Get a backlog level

func (*ClientImpl) GetBacklogConfigurations 

func (client *ClientImpl) GetBacklogConfigurations(ctx context.Context, args GetBacklogConfigurationsArgs) (*BacklogConfiguration, error)

Gets backlog configuration for a team

func (*ClientImpl) GetBacklogLevelWorkItems 

func (client *ClientImpl) GetBacklogLevelWorkItems(ctx context.Context, args GetBacklogLevelWorkItemsArgs) (*BacklogLevelWorkItems, error)

[Preview API] Get a list of work items within a backlog level

func (*ClientImpl) GetBacklogs 

func (client *ClientImpl) GetBacklogs(ctx context.Context, args GetBacklogsArgs) (*[]BacklogLevelConfiguration, error)

[Preview API] List all backlog levels

func (*ClientImpl) GetBoard 

func (client *ClientImpl) GetBoard(ctx context.Context, args GetBoardArgs) (*Board, error)

Get board

func (*ClientImpl) GetBoardCardRuleSettings 

func (client *ClientImpl) GetBoardCardRuleSettings(ctx context.Context, args GetBoardCardRuleSettingsArgs) (*BoardCardRuleSettings, error)

Get board card Rule settings for the board id or board by name

func (*ClientImpl) GetBoardCardSettings 

func (client *ClientImpl) GetBoardCardSettings(ctx context.Context, args GetBoardCardSettingsArgs) (*BoardCardSettings, error)

Get board card settings for the board id or board by name

func (*ClientImpl) GetBoardChart 

func (client *ClientImpl) GetBoardChart(ctx context.Context, args GetBoardChartArgs) (*BoardChart, error)

Get a board chart

func (*ClientImpl) GetBoardCharts 

func (client *ClientImpl) GetBoardCharts(ctx context.Context, args GetBoardChartsArgs) (*[]BoardChartReference, error)

Get board charts

func (*ClientImpl) GetBoardColumns 

func (client *ClientImpl) GetBoardColumns(ctx context.Context, args GetBoardColumnsArgs) (*[]BoardColumn, error)

Get columns on a board

func (*ClientImpl) GetBoardMappingParentItems 

func (client *ClientImpl) GetBoardMappingParentItems(ctx context.Context, args GetBoardMappingParentItemsArgs) (*[]ParentChildWIMap, error)

[Preview API] Returns the list of parent field filter model for the given list of workitem ids

func (*ClientImpl) GetBoardRows 

func (client *ClientImpl) GetBoardRows(ctx context.Context, args GetBoardRowsArgs) (*[]BoardRow, error)

Get rows on a board

func (*ClientImpl) GetBoardUserSettings 

func (client *ClientImpl) GetBoardUserSettings(ctx context.Context, args GetBoardUserSettingsArgs) (*BoardUserSettings, error)

[Preview API] Get board user settings for a board id

func (*ClientImpl) GetBoards 

func (client *ClientImpl) GetBoards(ctx context.Context, args GetBoardsArgs) (*[]BoardReference, error)

Get boards

func (*ClientImpl) GetCapacitiesWithIdentityRef 

func (client *ClientImpl) GetCapacitiesWithIdentityRef(ctx context.Context, args GetCapacitiesWithIdentityRefArgs) (*[]TeamMemberCapacityIdentityRef, error)

Get a team's capacity

func (*ClientImpl) GetCapacityWithIdentityRef 

func (client *ClientImpl) GetCapacityWithIdentityRef(ctx context.Context, args GetCapacityWithIdentityRefArgs) (*TeamMemberCapacityIdentityRef, error)

Get a team member's capacity

func (*ClientImpl) GetColumnSuggestedValues 

func (client *ClientImpl) GetColumnSuggestedValues(ctx context.Context, args GetColumnSuggestedValuesArgs) (*[]BoardSuggestedValue, error)

Get available board columns in a project

func (*ClientImpl) GetDeliveryTimelineData 

func (client *ClientImpl) GetDeliveryTimelineData(ctx context.Context, args GetDeliveryTimelineDataArgs) (*DeliveryViewData, error)

Get Delivery View Data

func (*ClientImpl) GetIterationWorkItems 

func (client *ClientImpl) GetIterationWorkItems(ctx context.Context, args GetIterationWorkItemsArgs) (*IterationWorkItems, error)

[Preview API] Get work items for iteration

func (*ClientImpl) GetPlan 

func (client *ClientImpl) GetPlan(ctx context.Context, args GetPlanArgs) (*Plan, error)

Get the information for the specified plan

func (*ClientImpl) GetPlans 

func (client *ClientImpl) GetPlans(ctx context.Context, args GetPlansArgs) (*[]Plan, error)

Get the information for all the plans configured for the given team

func (*ClientImpl) GetProcessConfiguration 

func (client *ClientImpl) GetProcessConfiguration(ctx context.Context, args GetProcessConfigurationArgs) (*ProcessConfiguration, error)

[Preview API] Get process configuration

func (*ClientImpl) GetRowSuggestedValues 

func (client *ClientImpl) GetRowSuggestedValues(ctx context.Context, args GetRowSuggestedValuesArgs) (*[]BoardSuggestedValue, error)

Get available board rows in a project

func (*ClientImpl) GetTeamDaysOff 

func (client *ClientImpl) GetTeamDaysOff(ctx context.Context, args GetTeamDaysOffArgs) (*TeamSettingsDaysOff, error)

Get team's days off for an iteration

func (*ClientImpl) GetTeamFieldValues 

func (client *ClientImpl) GetTeamFieldValues(ctx context.Context, args GetTeamFieldValuesArgs) (*TeamFieldValues, error)

Get a collection of team field values

func (*ClientImpl) GetTeamIteration 

func (client *ClientImpl) GetTeamIteration(ctx context.Context, args GetTeamIterationArgs) (*TeamSettingsIteration, error)

Get team's iteration by iterationId

func (*ClientImpl) GetTeamIterations 

func (client *ClientImpl) GetTeamIterations(ctx context.Context, args GetTeamIterationsArgs) (*[]TeamSettingsIteration, error)

Get a team's iterations using timeframe filter

func (*ClientImpl) GetTeamSettings 

func (client *ClientImpl) GetTeamSettings(ctx context.Context, args GetTeamSettingsArgs) (*TeamSetting, error)

Get a team's settings

func (*ClientImpl) PostTeamIteration 

func (client *ClientImpl) PostTeamIteration(ctx context.Context, args PostTeamIterationArgs) (*TeamSettingsIteration, error)

Add an iteration to the team

func (*ClientImpl) ReorderBacklogWorkItems 

func (client *ClientImpl) ReorderBacklogWorkItems(ctx context.Context, args ReorderBacklogWorkItemsArgs) (*[]ReorderResult, error)

[Preview API] Reorder Product Backlog/Boards Work Items

func (*ClientImpl) ReorderIterationWorkItems 

func (client *ClientImpl) ReorderIterationWorkItems(ctx context.Context, args ReorderIterationWorkItemsArgs) (*[]ReorderResult, error)

[Preview API] Reorder Sprint Backlog/Taskboard Work Items

func (*ClientImpl) ReplaceCapacitiesWithIdentityRef 

func (client *ClientImpl) ReplaceCapacitiesWithIdentityRef(ctx context.Context, args ReplaceCapacitiesWithIdentityRefArgs) (*[]TeamMemberCapacityIdentityRef, error)

Replace a team's capacity

func (*ClientImpl) SetBoardOptions 

func (client *ClientImpl) SetBoardOptions(ctx context.Context, args SetBoardOptionsArgs) (*map[string]string, error)

Update board options

func (*ClientImpl) UpdateBoardCardRuleSettings 

func (client *ClientImpl) UpdateBoardCardRuleSettings(ctx context.Context, args UpdateBoardCardRuleSettingsArgs) (*BoardCardRuleSettings, error)

Update board card Rule settings for the board id or board by name

func (*ClientImpl) UpdateBoardCardSettings 

func (client *ClientImpl) UpdateBoardCardSettings(ctx context.Context, args UpdateBoardCardSettingsArgs) (*BoardCardSettings, error)

Update board card settings for the board id or board by name

func (*ClientImpl) UpdateBoardChart 

func (client *ClientImpl) UpdateBoardChart(ctx context.Context, args UpdateBoardChartArgs) (*BoardChart, error)

Update a board chart

func (*ClientImpl) UpdateBoardColumns 

func (client *ClientImpl) UpdateBoardColumns(ctx context.Context, args UpdateBoardColumnsArgs) (*[]BoardColumn, error)

Update columns on a board

func (*ClientImpl) UpdateBoardRows 

func (client *ClientImpl) UpdateBoardRows(ctx context.Context, args UpdateBoardRowsArgs) (*[]BoardRow, error)

Update rows on a board

func (*ClientImpl) UpdateBoardUserSettings 

func (client *ClientImpl) UpdateBoardUserSettings(ctx context.Context, args UpdateBoardUserSettingsArgs) (*BoardUserSettings, error)

[Preview API] Update board user settings for the board id

func (*ClientImpl) UpdateCapacityWithIdentityRef 

func (client *ClientImpl) UpdateCapacityWithIdentityRef(ctx context.Context, args UpdateCapacityWithIdentityRefArgs) (*TeamMemberCapacityIdentityRef, error)

Update a team member's capacity

func (*ClientImpl) UpdatePlan 

func (client *ClientImpl) UpdatePlan(ctx context.Context, args UpdatePlanArgs) (*Plan, error)

Update the information for the specified plan

func (*ClientImpl) UpdateTaskboardCardRuleSettings 

func (client *ClientImpl) UpdateTaskboardCardRuleSettings(ctx context.Context, args UpdateTaskboardCardRuleSettingsArgs) error

[Preview API] Update taskboard card Rule settings

func (*ClientImpl) UpdateTaskboardCardSettings 

func (client *ClientImpl) UpdateTaskboardCardSettings(ctx context.Context, args UpdateTaskboardCardSettingsArgs) error

[Preview API] Update taskboard card settings

func (*ClientImpl) UpdateTeamDaysOff 

func (client *ClientImpl) UpdateTeamDaysOff(ctx context.Context, args UpdateTeamDaysOffArgs) (*TeamSettingsDaysOff, error)

Set a team's days off for an iteration

func (*ClientImpl) UpdateTeamFieldValues 

func (client *ClientImpl) UpdateTeamFieldValues(ctx context.Context, args UpdateTeamFieldValuesArgs) (*TeamFieldValues, error)

Update team field values

func (*ClientImpl) UpdateTeamSettings 

func (client *ClientImpl) UpdateTeamSettings(ctx context.Context, args UpdateTeamSettingsArgs) (*TeamSetting, error)

Update a team's settings

type CreatePlan 

type CreatePlan struct {
	// Description of the plan
	Description *string `json:"description,omitempty"`
	// Name of the plan to create.
	Name *string `json:"name,omitempty"`
	// Plan properties.
	Properties interface{} `json:"properties,omitempty"`
	// Type of plan to create.
	Type *PlanType `json:"type,omitempty"`
}

type CreatePlanArgs 

type CreatePlanArgs struct {
	// (required) Plan definition
	PostedPlan *CreatePlan
	// (required) Project ID or project name
	Project *string
}

Arguments for the CreatePlan function

type DateRange 

type DateRange struct {
	// End of the date range.
	End *azuredevops.Time `json:"end,omitempty"`
	// Start of the date range.
	Start *azuredevops.Time `json:"start,omitempty"`
}

type DeletePlanArgs 

type DeletePlanArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) Identifier of the plan
	Id *string
}

Arguments for the DeletePlan function

type DeleteTeamIterationArgs 

type DeleteTeamIterationArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) ID of the iteration
	Id *uuid.UUID
	// (optional) Team ID or team name
	Team *string
}

Arguments for the DeleteTeamIteration function

type DeliveryViewData 

type DeliveryViewData struct {
	Id       *uuid.UUID `json:"id,omitempty"`
	Revision *int       `json:"revision,omitempty"`
	// Work item child id to parent id map
	ChildIdToParentIdMap *map[int]int `json:"childIdToParentIdMap,omitempty"`
	// Filter criteria status of the timeline
	CriteriaStatus *TimelineCriteriaStatus `json:"criteriaStatus,omitempty"`
	// The end date of the delivery view data
	EndDate *azuredevops.Time `json:"endDate,omitempty"`
	// Max number of teams can be configured for a delivery plan.
	MaxExpandedTeams *int `json:"maxExpandedTeams,omitempty"`
	// The start date for the delivery view data
	StartDate *azuredevops.Time `json:"startDate,omitempty"`
	// All the team data
	Teams *[]TimelineTeamData `json:"teams,omitempty"`
}

Data contract for Data of Delivery View

type DeliveryViewPropertyCollection 

type DeliveryViewPropertyCollection struct {
	// Card settings
	CardSettings *CardSettings `json:"cardSettings,omitempty"`
	// Field criteria
	Criteria *[]FilterClause `json:"criteria,omitempty"`
	// Markers. Will be missing/null if there are no markers.
	Markers *[]Marker `json:"markers,omitempty"`
	// Team backlog mappings
	TeamBacklogMappings *[]TeamBacklogMapping `json:"teamBacklogMappings,omitempty"`
}

Collection of properties, specific to the DeliveryTimelineView

type FieldInfo 

type FieldInfo struct {
	// The additional field display name
	DisplayName *string `json:"displayName,omitempty"`
	// The additional field type
	FieldType *FieldType `json:"fieldType,omitempty"`
	// Indicates if the field definition is for an identity field.
	IsIdentity *bool `json:"isIdentity,omitempty"`
	// The additional field reference name
	ReferenceName *string `json:"referenceName,omitempty"`
}

Object bag storing the set of permissions relevant to this plan

type FieldReference 

type FieldReference struct {
	// fieldRefName for the field
	ReferenceName *string `json:"referenceName,omitempty"`
	// Full http link to more information about the field
	Url *string `json:"url,omitempty"`
}

An abstracted reference to a field

type FieldSetting 

type FieldSetting struct {
}

type FieldType 

type FieldType string

type FilterClause 

type FilterClause struct {
	FieldName       *string `json:"fieldName,omitempty"`
	Index           *int    `json:"index,omitempty"`
	LogicalOperator *string `json:"logicalOperator,omitempty"`
	Operator        *string `json:"operator,omitempty"`
	Value           *string `json:"value,omitempty"`
}

type FilterGroup 

type FilterGroup struct {
	End   *int `json:"end,omitempty"`
	Level *int `json:"level,omitempty"`
	Start *int `json:"start,omitempty"`
}

type GetBacklogArgs 

type GetBacklogArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) Team ID or team name
	Team *string
	// (required) The id of the backlog level
	Id *string
}

Arguments for the GetBacklog function

type GetBacklogConfigurationsArgs 

type GetBacklogConfigurationsArgs struct {
	// (required) Project ID or project name
	Project *string
	// (optional) Team ID or team name
	Team *string
}

Arguments for the GetBacklogConfigurations function

type GetBacklogLevelWorkItemsArgs 

type GetBacklogLevelWorkItemsArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) Team ID or team name
	Team *string
	// (required)
	BacklogId *string
}

Arguments for the GetBacklogLevelWorkItems function

type GetBacklogsArgs 

type GetBacklogsArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) Team ID or team name
	Team *string
}

Arguments for the GetBacklogs function

type GetBoardArgs 

type GetBoardArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) identifier for board, either board's backlog level name (Eg:"Stories") or Id
	Id *string
	// (optional) Team ID or team name
	Team *string
}

Arguments for the GetBoard function

type GetBoardCardRuleSettingsArgs 

type GetBoardCardRuleSettingsArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required)
	Board *string
	// (optional) Team ID or team name
	Team *string
}

Arguments for the GetBoardCardRuleSettings function

type GetBoardCardSettingsArgs 

type GetBoardCardSettingsArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required)
	Board *string
	// (optional) Team ID or team name
	Team *string
}

Arguments for the GetBoardCardSettings function

type GetBoardChartArgs 

type GetBoardChartArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) Identifier for board, either board's backlog level name (Eg:"Stories") or Id
	Board *string
	// (required) The chart name
	Name *string
	// (optional) Team ID or team name
	Team *string
}

Arguments for the GetBoardChart function

type GetBoardChartsArgs 

type GetBoardChartsArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) Identifier for board, either board's backlog level name (Eg:"Stories") or Id
	Board *string
	// (optional) Team ID or team name
	Team *string
}

Arguments for the GetBoardCharts function

type GetBoardColumnsArgs 

type GetBoardColumnsArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) Name or ID of the specific board
	Board *string
	// (optional) Team ID or team name
	Team *string
}

Arguments for the GetBoardColumns function

type GetBoardMappingParentItemsArgs 

type GetBoardMappingParentItemsArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required)
	ChildBacklogContextCategoryRefName *string
	// (required)
	WorkitemIds *[]int
	// (optional) Team ID or team name
	Team *string
}

Arguments for the GetBoardMappingParentItems function

type GetBoardRowsArgs 

type GetBoardRowsArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) Name or ID of the specific board
	Board *string
	// (optional) Team ID or team name
	Team *string
}

Arguments for the GetBoardRows function

type GetBoardUserSettingsArgs 

type GetBoardUserSettingsArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) Board ID or Name
	Board *string
	// (optional) Team ID or team name
	Team *string
}

Arguments for the GetBoardUserSettings function

type GetBoardsArgs 

type GetBoardsArgs struct {
	// (required) Project ID or project name
	Project *string
	// (optional) Team ID or team name
	Team *string
}

Arguments for the GetBoards function

type GetCapacitiesWithIdentityRefArgs 

type GetCapacitiesWithIdentityRefArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) ID of the iteration
	IterationId *uuid.UUID
	// (optional) Team ID or team name
	Team *string
}

Arguments for the GetCapacitiesWithIdentityRef function

type GetCapacityWithIdentityRefArgs 

type GetCapacityWithIdentityRefArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) ID of the iteration
	IterationId *uuid.UUID
	// (required) ID of the team member
	TeamMemberId *uuid.UUID
	// (optional) Team ID or team name
	Team *string
}

Arguments for the GetCapacityWithIdentityRef function

type GetColumnSuggestedValuesArgs 

type GetColumnSuggestedValuesArgs struct {
	// (optional) Project ID or project name
	Project *string
}

Arguments for the GetColumnSuggestedValues function

type GetDeliveryTimelineDataArgs 

type GetDeliveryTimelineDataArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) Identifier for delivery view
	Id *string
	// (optional) Revision of the plan for which you want data. If the current plan is a different revision you will get an ViewRevisionMismatchException exception. If you do not supply a revision you will get data for the latest revision.
	Revision *int
	// (optional) The start date of timeline
	StartDate *azuredevops.Time
	// (optional) The end date of timeline
	EndDate *azuredevops.Time
}

Arguments for the GetDeliveryTimelineData function

type GetIterationWorkItemsArgs 

type GetIterationWorkItemsArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) ID of the iteration
	IterationId *uuid.UUID
	// (optional) Team ID or team name
	Team *string
}

Arguments for the GetIterationWorkItems function

type GetPlanArgs 

type GetPlanArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) Identifier of the plan
	Id *string
}

Arguments for the GetPlan function

type GetPlansArgs 

type GetPlansArgs struct {
	// (required) Project ID or project name
	Project *string
}

Arguments for the GetPlans function

type GetProcessConfigurationArgs 

type GetProcessConfigurationArgs struct {
	// (required) Project ID or project name
	Project *string
}

Arguments for the GetProcessConfiguration function

type GetRowSuggestedValuesArgs 

type GetRowSuggestedValuesArgs struct {
	// (optional) Project ID or project name
	Project *string
}

Arguments for the GetRowSuggestedValues function

type GetTeamDaysOffArgs 

type GetTeamDaysOffArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) ID of the iteration
	IterationId *uuid.UUID
	// (optional) Team ID or team name
	Team *string
}

Arguments for the GetTeamDaysOff function

type GetTeamFieldValuesArgs 

type GetTeamFieldValuesArgs struct {
	// (required) Project ID or project name
	Project *string
	// (optional) Team ID or team name
	Team *string
}

Arguments for the GetTeamFieldValues function

type GetTeamIterationArgs 

type GetTeamIterationArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) ID of the iteration
	Id *uuid.UUID
	// (optional) Team ID or team name
	Team *string
}

Arguments for the GetTeamIteration function

type GetTeamIterationsArgs 

type GetTeamIterationsArgs struct {
	// (required) Project ID or project name
	Project *string
	// (optional) Team ID or team name
	Team *string
	// (optional) A filter for which iterations are returned based on relative time. Only Current is supported currently.
	Timeframe *string
}

Arguments for the GetTeamIterations function

type GetTeamSettingsArgs 

type GetTeamSettingsArgs struct {
	// (required) Project ID or project name
	Project *string
	// (optional) Team ID or team name
	Team *string
}

Arguments for the GetTeamSettings function

type IdentityDisplayFormat 

type IdentityDisplayFormat string

Enum for the various modes of identity picker

type IterationWorkItems 

type IterationWorkItems struct {
	// Collection of links relevant to resource
	Links interface{} `json:"_links,omitempty"`
	// Full http link to the resource
	Url *string `json:"url,omitempty"`
	// Work item relations
	WorkItemRelations *[]workitemtracking.WorkItemLink `json:"workItemRelations,omitempty"`
}

Represents work items in an iteration backlog

type Marker 

type Marker struct {
	// Color associated with the marker.
	Color *string `json:"color,omitempty"`
	// Where the marker should be displayed on the timeline.
	Date *azuredevops.Time `json:"date,omitempty"`
	// Label/title for the marker.
	Label *string `json:"label,omitempty"`
}

Client serialization contract for Delivery Timeline Markers.

type Member 

type Member struct {
	DisplayName *string    `json:"displayName,omitempty"`
	Id          *uuid.UUID `json:"id,omitempty"`
	ImageUrl    *string    `json:"imageUrl,omitempty"`
	UniqueName  *string    `json:"uniqueName,omitempty"`
	Url         *string    `json:"url,omitempty"`
}

type ParentChildWIMap 

type ParentChildWIMap struct {
	ChildWorkItemIds *[]int  `json:"childWorkItemIds,omitempty"`
	Id               *int    `json:"id,omitempty"`
	Title            *string `json:"title,omitempty"`
}

type Plan 

type Plan struct {
	// Identity that created this plan. Defaults to null for records before upgrading to ScaledAgileViewComponent4.
	CreatedByIdentity *webapi.IdentityRef `json:"createdByIdentity,omitempty"`
	// Date when the plan was created
	CreatedDate *azuredevops.Time `json:"createdDate,omitempty"`
	// Description of the plan
	Description *string `json:"description,omitempty"`
	// Id of the plan
	Id *uuid.UUID `json:"id,omitempty"`
	// Identity that last modified this plan. Defaults to null for records before upgrading to ScaledAgileViewComponent4.
	ModifiedByIdentity *webapi.IdentityRef `json:"modifiedByIdentity,omitempty"`
	// Date when the plan was last modified. Default to CreatedDate when the plan is first created.
	ModifiedDate *azuredevops.Time `json:"modifiedDate,omitempty"`
	// Name of the plan
	Name *string `json:"name,omitempty"`
	// The PlanPropertyCollection instance associated with the plan. These are dependent on the type of the plan. For example, DeliveryTimelineView, it would be of type DeliveryViewPropertyCollection.
	Properties interface{} `json:"properties,omitempty"`
	// Revision of the plan. Used to safeguard users from overwriting each other's changes.
	Revision *int `json:"revision,omitempty"`
	// Type of the plan
	Type *PlanType `json:"type,omitempty"`
	// The resource url to locate the plan via rest api
	Url *string `json:"url,omitempty"`
	// Bit flag indicating set of permissions a user has to the plan.
	UserPermissions *PlanUserPermissions `json:"userPermissions,omitempty"`
}

Data contract for the plan definition

type PlanMetadata 

type PlanMetadata struct {
	// Identity of the creator of the plan
	CreatedByIdentity *webapi.IdentityRef `json:"createdByIdentity,omitempty"`
	// Description of plan
	Description *string `json:"description,omitempty"`
	// Last modified date of the plan
	ModifiedDate *azuredevops.Time `json:"modifiedDate,omitempty"`
	// Bit flag indicating set of permissions a user has to the plan.
	UserPermissions *PlanUserPermissions `json:"userPermissions,omitempty"`
}

Metadata about a plan definition that is stored in favorites service

type PlanType 

type PlanType string

Enum for the various types of plans

type PlanUserPermissions 

type PlanUserPermissions string

[Flags] Flag for permissions a user can have for this plan.

type PlanViewData 

type PlanViewData struct {
	Id       *uuid.UUID `json:"id,omitempty"`
	Revision *int       `json:"revision,omitempty"`
}

Base class for plan view data contracts. Anything common goes here.

type PostTeamIterationArgs 

type PostTeamIterationArgs struct {
	// (required) Iteration to add
	Iteration *TeamSettingsIteration
	// (required) Project ID or project name
	Project *string
	// (optional) Team ID or team name
	Team *string
}

Arguments for the PostTeamIteration function

type PredefinedQuery 

type PredefinedQuery struct {
	// Whether or not the query returned the complete set of data or if the data was truncated.
	HasMore *bool `json:"hasMore,omitempty"`
	// Id of the query
	Id *string `json:"id,omitempty"`
	// Localized name of the query
	Name *string `json:"name,omitempty"`
	// The results of the query.  This will be a set of WorkItem objects with only the 'id' set.  The client is responsible for paging in the data as needed.
	Results *[]workitemtracking.WorkItem `json:"results,omitempty"`
	// REST API Url to use to retrieve results for this query
	Url *string `json:"url,omitempty"`
	// Url to use to display a page in the browser with the results of this query
	WebUrl *string `json:"webUrl,omitempty"`
}

Represents a single pre-defined query.

type ProcessConfiguration 

type ProcessConfiguration struct {
	// Details about bug work items
	BugWorkItems *CategoryConfiguration `json:"bugWorkItems,omitempty"`
	// Details about portfolio backlogs
	PortfolioBacklogs *[]CategoryConfiguration `json:"portfolioBacklogs,omitempty"`
	// Details of requirement backlog
	RequirementBacklog *CategoryConfiguration `json:"requirementBacklog,omitempty"`
	// Details of task backlog
	TaskBacklog *CategoryConfiguration `json:"taskBacklog,omitempty"`
	// Type fields for the process configuration
	TypeFields *map[string]workitemtracking.WorkItemFieldReference `json:"typeFields,omitempty"`
	Url        *string                                             `json:"url,omitempty"`
}

Process Configurations for the project

type ReorderBacklogWorkItemsArgs 

type ReorderBacklogWorkItemsArgs struct {
	// (required)
	Operation *ReorderOperation
	// (required) Project ID or project name
	Project *string
	// (required) Team ID or team name
	Team *string
}

Arguments for the ReorderBacklogWorkItems function

type ReorderIterationWorkItemsArgs 

type ReorderIterationWorkItemsArgs struct {
	// (required)
	Operation *ReorderOperation
	// (required) Project ID or project name
	Project *string
	// (required) Team ID or team name
	Team *string
	// (required) The id of the iteration
	IterationId *uuid.UUID
}

Arguments for the ReorderIterationWorkItems function

type ReorderOperation 

type ReorderOperation struct {
	// IDs of the work items to be reordered.  Must be valid WorkItem Ids.
	Ids *[]int `json:"ids,omitempty"`
	// IterationPath for reorder operation. This is only used when we reorder from the Iteration Backlog
	IterationPath *string `json:"iterationPath,omitempty"`
	// ID of the work item that should be after the reordered items. Can use 0 to specify the end of the list.
	NextId *int `json:"nextId,omitempty"`
	// Parent ID for all of the work items involved in this operation. Can use 0 to indicate the items don't have a parent.
	ParentId *int `json:"parentId,omitempty"`
	// ID of the work item that should be before the reordered items. Can use 0 to specify the beginning of the list.
	PreviousId *int `json:"previousId,omitempty"`
}

Represents a reorder request for one or more work items.

type ReorderResult 

type ReorderResult struct {
	// The ID of the work item that was reordered.
	Id *int `json:"id,omitempty"`
	// The updated order value of the work item that was reordered.
	Order *float64 `json:"order,omitempty"`
}

Represents a reorder result for a work item.

type ReplaceCapacitiesWithIdentityRefArgs 

type ReplaceCapacitiesWithIdentityRefArgs struct {
	// (required) Team capacity to replace
	Capacities *[]TeamMemberCapacityIdentityRef
	// (required) Project ID or project name
	Project *string
	// (required) ID of the iteration
	IterationId *uuid.UUID
	// (optional) Team ID or team name
	Team *string
}

Arguments for the ReplaceCapacitiesWithIdentityRef function

type Rule 

type Rule struct {
	Clauses   *[]FilterClause `json:"clauses,omitempty"`
	Filter    *string         `json:"filter,omitempty"`
	IsEnabled *string         `json:"isEnabled,omitempty"`
	Name      *string         `json:"name,omitempty"`
	Settings  *attribute      `json:"settings,omitempty"`
}

type SetBoardOptionsArgs 

type SetBoardOptionsArgs struct {
	// (required) options to updated
	Options *map[string]string
	// (required) Project ID or project name
	Project *string
	// (required) identifier for board, either category plural name (Eg:"Stories") or guid
	Id *string
	// (optional) Team ID or team name
	Team *string
}

Arguments for the SetBoardOptions function

type TeamBacklogMapping 

type TeamBacklogMapping struct {
	CategoryReferenceName *string    `json:"categoryReferenceName,omitempty"`
	TeamId                *uuid.UUID `json:"teamId,omitempty"`
}

Mapping of teams to the corresponding work item category

type TeamFieldValue 

type TeamFieldValue struct {
	IncludeChildren *bool   `json:"includeChildren,omitempty"`
	Value           *string `json:"value,omitempty"`
}

Represents a single TeamFieldValue

type TeamFieldValues 

type TeamFieldValues struct {
	// Collection of links relevant to resource
	Links interface{} `json:"_links,omitempty"`
	// Full http link to the resource
	Url *string `json:"url,omitempty"`
	// The default team field value
	DefaultValue *string `json:"defaultValue,omitempty"`
	// Shallow ref to the field being used as a team field
	Field *FieldReference `json:"field,omitempty"`
	// Collection of all valid team field values
	Values *[]TeamFieldValue `json:"values,omitempty"`
}

Essentially a collection of team field values

type TeamFieldValuesPatch 

type TeamFieldValuesPatch struct {
	DefaultValue *string           `json:"defaultValue,omitempty"`
	Values       *[]TeamFieldValue `json:"values,omitempty"`
}

Expected data from PATCH

type TeamIterationAttributes 

type TeamIterationAttributes struct {
	// Finish date of the iteration. Date-only, correct unadjusted at midnight in UTC.
	FinishDate *azuredevops.Time `json:"finishDate,omitempty"`
	// Start date of the iteration. Date-only, correct unadjusted at midnight in UTC.
	StartDate *azuredevops.Time `json:"startDate,omitempty"`
	// Time frame of the iteration, such as past, current or future.
	TimeFrame *TimeFrame `json:"timeFrame,omitempty"`
}

type TeamMemberCapacity 

type TeamMemberCapacity struct {
	// Collection of links relevant to resource
	Links interface{} `json:"_links,omitempty"`
	// Full http link to the resource
	Url *string `json:"url,omitempty"`
	// Collection of capacities associated with the team member
	Activities *[]Activity `json:"activities,omitempty"`
	// The days off associated with the team member
	DaysOff *[]DateRange `json:"daysOff,omitempty"`
	// Shallow Ref to the associated team member
	TeamMember *Member `json:"teamMember,omitempty"`
}

Represents capacity for a specific team member

type TeamMemberCapacityIdentityRef 

type TeamMemberCapacityIdentityRef struct {
	// Collection of links relevant to resource
	Links interface{} `json:"_links,omitempty"`
	// Full http link to the resource
	Url *string `json:"url,omitempty"`
	// Collection of capacities associated with the team member
	Activities *[]Activity `json:"activities,omitempty"`
	// The days off associated with the team member
	DaysOff *[]DateRange `json:"daysOff,omitempty"`
	// Identity ref of the associated team member
	TeamMember *webapi.IdentityRef `json:"teamMember,omitempty"`
}

Represents capacity for a specific team member

type TeamSetting 

type TeamSetting struct {
	// Collection of links relevant to resource
	Links interface{} `json:"_links,omitempty"`
	// Full http link to the resource
	Url *string `json:"url,omitempty"`
	// Backlog Iteration
	BacklogIteration *TeamSettingsIteration `json:"backlogIteration,omitempty"`
	// Information about categories that are visible on the backlog.
	BacklogVisibilities *map[string]bool `json:"backlogVisibilities,omitempty"`
	// BugsBehavior (Off, AsTasks, AsRequirements, ...)
	BugsBehavior *BugsBehavior `json:"bugsBehavior,omitempty"`
	// Default Iteration, the iteration used when creating a new work item on the queries page.
	DefaultIteration *TeamSettingsIteration `json:"defaultIteration,omitempty"`
	// Default Iteration macro (if any)
	DefaultIterationMacro *string `json:"defaultIterationMacro,omitempty"`
	// Days that the team is working
	WorkingDays *[]string `json:"workingDays,omitempty"`
}

Data contract for TeamSettings

type TeamSettingsDataContractBase 

type TeamSettingsDataContractBase struct {
	// Collection of links relevant to resource
	Links interface{} `json:"_links,omitempty"`
	// Full http link to the resource
	Url *string `json:"url,omitempty"`
}

Base class for TeamSettings data contracts. Anything common goes here.

type TeamSettingsDaysOff 

type TeamSettingsDaysOff struct {
	// Collection of links relevant to resource
	Links interface{} `json:"_links,omitempty"`
	// Full http link to the resource
	Url     *string      `json:"url,omitempty"`
	DaysOff *[]DateRange `json:"daysOff,omitempty"`
}

type TeamSettingsDaysOffPatch 

type TeamSettingsDaysOffPatch struct {
	DaysOff *[]DateRange `json:"daysOff,omitempty"`
}

type TeamSettingsIteration 

type TeamSettingsIteration struct {
	// Collection of links relevant to resource
	Links interface{} `json:"_links,omitempty"`
	// Full http link to the resource
	Url *string `json:"url,omitempty"`
	// Attributes of the iteration such as start and end date.
	Attributes *TeamIterationAttributes `json:"attributes,omitempty"`
	// Id of the iteration.
	Id *uuid.UUID `json:"id,omitempty"`
	// Name of the iteration.
	Name *string `json:"name,omitempty"`
	// Relative path of the iteration.
	Path *string `json:"path,omitempty"`
}

Represents a shallow ref for a single iteration.

type TeamSettingsPatch 

type TeamSettingsPatch struct {
	BacklogIteration      *uuid.UUID       `json:"backlogIteration,omitempty"`
	BacklogVisibilities   *map[string]bool `json:"backlogVisibilities,omitempty"`
	BugsBehavior          *BugsBehavior    `json:"bugsBehavior,omitempty"`
	DefaultIteration      *uuid.UUID       `json:"defaultIteration,omitempty"`
	DefaultIterationMacro *string          `json:"defaultIterationMacro,omitempty"`
	WorkingDays           *[]string        `json:"workingDays,omitempty"`
}

Data contract for what we expect to receive when PATCH

type TimeFrame 

type TimeFrame string

type TimelineCriteriaStatus 

type TimelineCriteriaStatus struct {
	Message *string                     `json:"message,omitempty"`
	Type    *TimelineCriteriaStatusCode `json:"type,omitempty"`
}

type TimelineCriteriaStatusCode 

type TimelineCriteriaStatusCode string

type TimelineIterationStatus 

type TimelineIterationStatus struct {
	Message *string                      `json:"message,omitempty"`
	Type    *TimelineIterationStatusCode `json:"type,omitempty"`
}

type TimelineIterationStatusCode 

type TimelineIterationStatusCode string

type TimelineTeamData 

type TimelineTeamData struct {
	// Backlog matching the mapped backlog associated with this team.
	Backlog *BacklogLevel `json:"backlog,omitempty"`
	// The field reference names of the work item data
	FieldReferenceNames *[]string `json:"fieldReferenceNames,omitempty"`
	// The id of the team
	Id *uuid.UUID `json:"id,omitempty"`
	// Was iteration and work item data retrieved for this team. <remarks> Teams with IsExpanded false have not had their iteration, work item, and field related data queried and will never contain this data. If true then these items are queried and, if there are items in the queried range, there will be data. </remarks>
	IsExpanded *bool `json:"isExpanded,omitempty"`
	// The iteration data, including the work items, in the queried date range.
	Iterations *[]TimelineTeamIteration `json:"iterations,omitempty"`
	// The name of the team
	Name *string `json:"name,omitempty"`
	// The order by field name of this team
	OrderByField *string `json:"orderByField,omitempty"`
	// The field reference names of the partially paged work items, such as ID, WorkItemType
	PartiallyPagedFieldReferenceNames *[]string `json:"partiallyPagedFieldReferenceNames,omitempty"`
	// The project id the team belongs team
	ProjectId *uuid.UUID `json:"projectId,omitempty"`
	// Status for this team.
	Status *TimelineTeamStatus `json:"status,omitempty"`
	// The team field default value
	TeamFieldDefaultValue *string `json:"teamFieldDefaultValue,omitempty"`
	// The team field name of this team
	TeamFieldName *string `json:"teamFieldName,omitempty"`
	// The team field values
	TeamFieldValues *[]TeamFieldValue `json:"teamFieldValues,omitempty"`
	// Colors for the work item types.
	WorkItemTypeColors *[]WorkItemColor `json:"workItemTypeColors,omitempty"`
}

type TimelineTeamIteration 

type TimelineTeamIteration struct {
	// The iteration CSS Node Id
	CssNodeId *string `json:"cssNodeId,omitempty"`
	// The end date of the iteration
	FinishDate *azuredevops.Time `json:"finishDate,omitempty"`
	// The iteration name
	Name *string `json:"name,omitempty"`
	// All the partially paged workitems in this iteration.
	PartiallyPagedWorkItems *[][]interface{} `json:"partiallyPagedWorkItems,omitempty"`
	// The iteration path
	Path *string `json:"path,omitempty"`
	// The start date of the iteration
	StartDate *azuredevops.Time `json:"startDate,omitempty"`
	// The status of this iteration
	Status *TimelineIterationStatus `json:"status,omitempty"`
	// The work items that have been paged in this iteration
	WorkItems *[][]interface{} `json:"workItems,omitempty"`
}

type TimelineTeamStatus 

type TimelineTeamStatus struct {
	Message *string                 `json:"message,omitempty"`
	Type    *TimelineTeamStatusCode `json:"type,omitempty"`
}

type TimelineTeamStatusCode 

type TimelineTeamStatusCode string

type UpdateBoardCardRuleSettingsArgs 

type UpdateBoardCardRuleSettingsArgs struct {
	// (required)
	BoardCardRuleSettings *BoardCardRuleSettings
	// (required) Project ID or project name
	Project *string
	// (required)
	Board *string
	// (optional) Team ID or team name
	Team *string
}

Arguments for the UpdateBoardCardRuleSettings function

type UpdateBoardCardSettingsArgs 

type UpdateBoardCardSettingsArgs struct {
	// (required)
	BoardCardSettingsToSave *BoardCardSettings
	// (required) Project ID or project name
	Project *string
	// (required)
	Board *string
	// (optional) Team ID or team name
	Team *string
}

Arguments for the UpdateBoardCardSettings function

type UpdateBoardChartArgs 

type UpdateBoardChartArgs struct {
	// (required)
	Chart *BoardChart
	// (required) Project ID or project name
	Project *string
	// (required) Identifier for board, either board's backlog level name (Eg:"Stories") or Id
	Board *string
	// (required) The chart name
	Name *string
	// (optional) Team ID or team name
	Team *string
}

Arguments for the UpdateBoardChart function

type UpdateBoardColumnsArgs 

type UpdateBoardColumnsArgs struct {
	// (required) List of board columns to update
	BoardColumns *[]BoardColumn
	// (required) Project ID or project name
	Project *string
	// (required) Name or ID of the specific board
	Board *string
	// (optional) Team ID or team name
	Team *string
}

Arguments for the UpdateBoardColumns function

type UpdateBoardRowsArgs 

type UpdateBoardRowsArgs struct {
	// (required) List of board rows to update
	BoardRows *[]BoardRow
	// (required) Project ID or project name
	Project *string
	// (required) Name or ID of the specific board
	Board *string
	// (optional) Team ID or team name
	Team *string
}

Arguments for the UpdateBoardRows function

type UpdateBoardUserSettingsArgs 

type UpdateBoardUserSettingsArgs struct {
	// (required)
	BoardUserSettings *map[string]string
	// (required) Project ID or project name
	Project *string
	// (required)
	Board *string
	// (optional) Team ID or team name
	Team *string
}

Arguments for the UpdateBoardUserSettings function

type UpdateCapacityWithIdentityRefArgs 

type UpdateCapacityWithIdentityRefArgs struct {
	// (required) Updated capacity
	Patch *CapacityPatch
	// (required) Project ID or project name
	Project *string
	// (required) ID of the iteration
	IterationId *uuid.UUID
	// (required) ID of the team member
	TeamMemberId *uuid.UUID
	// (optional) Team ID or team name
	Team *string
}

Arguments for the UpdateCapacityWithIdentityRef function

type UpdatePlan 

type UpdatePlan struct {
	// Description of the plan
	Description *string `json:"description,omitempty"`
	// Name of the plan to create.
	Name *string `json:"name,omitempty"`
	// Plan properties.
	Properties interface{} `json:"properties,omitempty"`
	// Revision of the plan that was updated - the value used here should match the one the server gave the client in the Plan.
	Revision *int `json:"revision,omitempty"`
	// Type of the plan
	Type *PlanType `json:"type,omitempty"`
}

type UpdatePlanArgs 

type UpdatePlanArgs struct {
	// (required) Plan definition to be updated
	UpdatedPlan *UpdatePlan
	// (required) Project ID or project name
	Project *string
	// (required) Identifier of the plan
	Id *string
}

Arguments for the UpdatePlan function

type UpdateTaskboardCardRuleSettingsArgs 

type UpdateTaskboardCardRuleSettingsArgs struct {
	// (required)
	BoardCardRuleSettings *BoardCardRuleSettings
	// (required) Project ID or project name
	Project *string
	// (required) Team ID or team name
	Team *string
}

Arguments for the UpdateTaskboardCardRuleSettings function

type UpdateTaskboardCardSettingsArgs 

type UpdateTaskboardCardSettingsArgs struct {
	// (required)
	BoardCardSettingsToSave *BoardCardSettings
	// (required) Project ID or project name
	Project *string
	// (required) Team ID or team name
	Team *string
}

Arguments for the UpdateTaskboardCardSettings function

type UpdateTeamDaysOffArgs 

type UpdateTeamDaysOffArgs struct {
	// (required) Team's days off patch containing a list of start and end dates
	DaysOffPatch *TeamSettingsDaysOffPatch
	// (required) Project ID or project name
	Project *string
	// (required) ID of the iteration
	IterationId *uuid.UUID
	// (optional) Team ID or team name
	Team *string
}

Arguments for the UpdateTeamDaysOff function

type UpdateTeamFieldValuesArgs 

type UpdateTeamFieldValuesArgs struct {
	// (required)
	Patch *TeamFieldValuesPatch
	// (required) Project ID or project name
	Project *string
	// (optional) Team ID or team name
	Team *string
}

Arguments for the UpdateTeamFieldValues function

type UpdateTeamSettingsArgs 

type UpdateTeamSettingsArgs struct {
	// (required) TeamSettings changes
	TeamSettingsPatch *TeamSettingsPatch
	// (required) Project ID or project name
	Project *string
	// (optional) Team ID or team name
	Team *string
}

Arguments for the UpdateTeamSettings function

type WorkItemColor 

type WorkItemColor struct {
	Icon             *string `json:"icon,omitempty"`
	PrimaryColor     *string `json:"primaryColor,omitempty"`
	WorkItemTypeName *string `json:"workItemTypeName,omitempty"`
}

Work item color and icon.

type WorkItemTypeStateInfo 

type WorkItemTypeStateInfo struct {
	// State name to state category map
	States *map[string]string `json:"states,omitempty"`
	// Work Item type name
	WorkItemTypeName *string `json:"workItemTypeName,omitempty"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.