workitemtracking

package
v7.2.4 Latest Latest
Warning

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

 Go to latest Published: Mar 14, 2024 License: MIT Imports: 11 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var ClassificationNodesErrorPolicyValues = classificationNodesErrorPolicyValuesType{
	Fail: "fail",
	Omit: "omit",
}
View Source 
var CommentExpandOptionsValues = commentExpandOptionsValuesType{
	None: "none",

	Reactions: "reactions",

	RenderedText: "renderedText",

	RenderedTextOnly: "renderedTextOnly",
	All:              "all",
}
View Source 
var CommentFormatValues = commentFormatValuesType{
	Markdown: "markdown",
	Html:     "html",
}
View Source 
var CommentReactionTypeValues = commentReactionTypeValuesType{
	Like:     "like",
	Dislike:  "dislike",
	Heart:    "heart",
	Hooray:   "hooray",
	Smile:    "smile",
	Confused: "confused",
}
View Source 
var CommentSortOrderValues = commentSortOrderValuesType{

	Asc: "asc",

	Desc: "desc",
}
View Source 
var FieldTypeValues = fieldTypeValuesType{

	String: "string",

	Integer: "integer",

	DateTime: "dateTime",

	PlainText: "plainText",

	Html: "html",

	TreePath: "treePath",

	History: "history",

	Double: "double",

	Guid: "guid",

	Boolean: "boolean",

	Identity: "identity",

	PicklistString: "picklistString",

	PicklistInteger: "picklistInteger",

	PicklistDouble: "picklistDouble",
}
View Source 
var FieldUsageValues = fieldUsageValuesType{

	None: "none",

	WorkItem: "workItem",

	WorkItemLink: "workItemLink",

	Tree: "tree",

	WorkItemTypeExtension: "workItemTypeExtension",
}
View Source 
var GetFieldsExpandValues = getFieldsExpandValuesType{

	None: "none",

	ExtensionFields: "extensionFields",

	IncludeDeleted: "includeDeleted",
}
View Source 
var LinkQueryModeValues = linkQueryModeValuesType{

	WorkItems: "workItems",

	LinksOneHopMustContain: "linksOneHopMustContain",

	LinksOneHopMayContain: "linksOneHopMayContain",

	LinksOneHopDoesNotContain: "linksOneHopDoesNotContain",
	LinksRecursiveMustContain: "linksRecursiveMustContain",

	LinksRecursiveMayContain:     "linksRecursiveMayContain",
	LinksRecursiveDoesNotContain: "linksRecursiveDoesNotContain",
}
View Source 
var LogicalOperationValues = logicalOperationValuesType{
	None: "none",
	And:  "and",
	Or:   "or",
}
View Source 
var ProvisioningActionTypeValues = provisioningActionTypeValuesType{
	Import:   "import",
	Validate: "validate",
}
View Source 
var QueryErrorPolicyValues = queryErrorPolicyValuesType{
	Fail: "fail",
	Omit: "omit",
}
View Source 
var QueryExpandValues = queryExpandValuesType{

	None: "none",

	Wiql: "wiql",

	Clauses: "clauses",

	All: "all",

	Minimal: "minimal",
}
View Source 
var QueryOptionValues = queryOptionValuesType{
	Doing:    "doing",
	Done:     "done",
	Followed: "followed",
}
View Source 
var QueryRecursionOptionValues = queryRecursionOptionValuesType{

	ParentFirst: "parentFirst",

	ChildFirst: "childFirst",
}
View Source 
var QueryResultTypeValues = queryResultTypeValuesType{

	WorkItem: "workItem",

	WorkItemLink: "workItemLink",
}
View Source 
var QueryTypeValues = queryTypeValuesType{

	Flat: "flat",

	Tree: "tree",

	OneHop: "oneHop",
}
View Source 
var ReportingRevisionsExpandValues = reportingRevisionsExpandValuesType{

	None: "none",

	Fields: "fields",
}
View Source 
var ResourceAreaId, _ = uuid.Parse("5264459e-e5e0-4bd8-b118-0985e68a4ec5")
View Source 
var TemplateTypeValues = templateTypeValuesType{
	WorkItemType:   "workItemType",
	GlobalWorkflow: "globalWorkflow",
}
View Source 
var TreeNodeStructureTypeValues = treeNodeStructureTypeValuesType{

	Area: "area",

	Iteration: "iteration",
}
View Source 
var TreeStructureGroupValues = treeStructureGroupValuesType{
	Areas:      "areas",
	Iterations: "iterations",
}
View Source 
var WorkItemErrorPolicyValues = workItemErrorPolicyValuesType{

	Fail: "fail",

	Omit: "omit",
}
View Source 
var WorkItemExpandValues = workItemExpandValuesType{

	None: "none",

	Relations: "relations",

	Fields: "fields",

	Links: "links",

	All: "all",
}
View Source 
var WorkItemRecentActivityTypeValues = workItemRecentActivityTypeValuesType{
	Visited:  "visited",
	Edited:   "edited",
	Deleted:  "deleted",
	Restored: "restored",
}
View Source 
var WorkItemTypeFieldsExpandLevelValues = workItemTypeFieldsExpandLevelValuesType{

	None: "none",

	AllowedValues: "allowedValues",

	DependentFields: "dependentFields",

	All: "all",
}

Functions

This section is empty.

Types

type AccountMyWorkResult 

type AccountMyWorkResult struct {
	// True, when length of WorkItemDetails is same as the limit
	QuerySizeLimitExceeded *bool `json:"querySizeLimitExceeded,omitempty"`
	// WorkItem Details
	WorkItemDetails *[]AccountWorkWorkItemModel `json:"workItemDetails,omitempty"`
}

type AccountRecentActivityWorkItemModel 

type AccountRecentActivityWorkItemModel struct {
	// Date of the last Activity by the user
	ActivityDate *azuredevops.Time `json:"activityDate,omitempty"`
	// Type of the activity
	ActivityType *WorkItemRecentActivityType `json:"activityType,omitempty"`
	// Last changed date of the work item
	ChangedDate *azuredevops.Time `json:"changedDate,omitempty"`
	// Work Item Id
	Id *int `json:"id,omitempty"`
	// TeamFoundationId of the user this activity belongs to
	IdentityId *uuid.UUID `json:"identityId,omitempty"`
	// State of the work item
	State *string `json:"state,omitempty"`
	// Team project the work item belongs to
	TeamProject *string `json:"teamProject,omitempty"`
	// Title of the work item
	Title *string `json:"title,omitempty"`
	// Type of Work Item
	WorkItemType *string `json:"workItemType,omitempty"`
	// Assigned To
	AssignedTo *string `json:"assignedTo,omitempty"`
}

Represents Work Item Recent Activity

type AccountRecentActivityWorkItemModel2 

type AccountRecentActivityWorkItemModel2 struct {
	// Date of the last Activity by the user
	ActivityDate *azuredevops.Time `json:"activityDate,omitempty"`
	// Type of the activity
	ActivityType *WorkItemRecentActivityType `json:"activityType,omitempty"`
	// Last changed date of the work item
	ChangedDate *azuredevops.Time `json:"changedDate,omitempty"`
	// Work Item Id
	Id *int `json:"id,omitempty"`
	// TeamFoundationId of the user this activity belongs to
	IdentityId *uuid.UUID `json:"identityId,omitempty"`
	// State of the work item
	State *string `json:"state,omitempty"`
	// Team project the work item belongs to
	TeamProject *string `json:"teamProject,omitempty"`
	// Title of the work item
	Title *string `json:"title,omitempty"`
	// Type of Work Item
	WorkItemType *string `json:"workItemType,omitempty"`
	// Assigned To
	AssignedTo *webapi.IdentityRef `json:"assignedTo,omitempty"`
}

Represents Work Item Recent Activity

type AccountRecentActivityWorkItemModelBase 

type AccountRecentActivityWorkItemModelBase struct {
	// Date of the last Activity by the user
	ActivityDate *azuredevops.Time `json:"activityDate,omitempty"`
	// Type of the activity
	ActivityType *WorkItemRecentActivityType `json:"activityType,omitempty"`
	// Last changed date of the work item
	ChangedDate *azuredevops.Time `json:"changedDate,omitempty"`
	// Work Item Id
	Id *int `json:"id,omitempty"`
	// TeamFoundationId of the user this activity belongs to
	IdentityId *uuid.UUID `json:"identityId,omitempty"`
	// State of the work item
	State *string `json:"state,omitempty"`
	// Team project the work item belongs to
	TeamProject *string `json:"teamProject,omitempty"`
	// Title of the work item
	Title *string `json:"title,omitempty"`
	// Type of Work Item
	WorkItemType *string `json:"workItemType,omitempty"`
}

Represents Work Item Recent Activity

type AccountRecentMentionWorkItemModel 

type AccountRecentMentionWorkItemModel struct {
	// Assigned To
	AssignedTo *string `json:"assignedTo,omitempty"`
	// Work Item Id
	Id *int `json:"id,omitempty"`
	// Latest date that the user were mentioned
	MentionedDateField *azuredevops.Time `json:"mentionedDateField,omitempty"`
	// State of the work item
	State *string `json:"state,omitempty"`
	// Team project the work item belongs to
	TeamProject *string `json:"teamProject,omitempty"`
	// Title of the work item
	Title *string `json:"title,omitempty"`
	// Type of Work Item
	WorkItemType *string `json:"workItemType,omitempty"`
}

Represents Recent Mention Work Item

type AccountWorkWorkItemModel 

type AccountWorkWorkItemModel struct {
	AssignedTo   *string           `json:"assignedTo,omitempty"`
	ChangedDate  *azuredevops.Time `json:"changedDate,omitempty"`
	Id           *int              `json:"id,omitempty"`
	State        *string           `json:"state,omitempty"`
	TeamProject  *string           `json:"teamProject,omitempty"`
	Title        *string           `json:"title,omitempty"`
	WorkItemType *string           `json:"workItemType,omitempty"`
}

type AddCommentArgs 

type AddCommentArgs struct {
	// (required) Comment create request.
	Request *CommentCreate
	// (required) Project ID or project name
	Project *string
	// (required) Id of a work item.
	WorkItemId *int
}

Arguments for the AddComment function

type AddWorkItemCommentArgs 

type AddWorkItemCommentArgs struct {
	// (required) Comment create request.
	Request *CommentCreate
	// (required) Project ID or project name
	Project *string
	// (required) Id of a work item.
	WorkItemId *int
	// (required) Format of a work item comment (Markdown or Html).
	Format *CommentFormat
}

Arguments for the AddWorkItemComment function

type ArtifactUriQuery 

type ArtifactUriQuery struct {
	// List of artifact URIs to use for querying work items.
	ArtifactUris *[]string `json:"artifactUris,omitempty"`
}

Contains criteria for querying work items based on artifact URI.

type ArtifactUriQueryResult 

type ArtifactUriQueryResult struct {
	// A Dictionary that maps a list of work item references to the given list of artifact URI.
	ArtifactUrisQueryResult *map[string][]WorkItemReference `json:"artifactUrisQueryResult,omitempty"`
}

Defines result of artifact URI query on work items. Contains mapping of work item IDs to artifact URI.

type AttachmentReference 

type AttachmentReference struct {
	Id  *uuid.UUID `json:"id,omitempty"`
	Url *string    `json:"url,omitempty"`
}

type ClassificationNodesErrorPolicy 

type ClassificationNodesErrorPolicy string

Flag to control error policy in a batch classification nodes get request.

type Client 

type Client interface {
	// [Preview API] Add a comment on a work item.
	AddComment(context.Context, AddCommentArgs) (*Comment, error)
	// [Preview API] Add a comment on a work item.
	AddWorkItemComment(context.Context, AddWorkItemCommentArgs) (*Comment, error)
	// [Preview API] Uploads an attachment.
	CreateAttachment(context.Context, CreateAttachmentArgs) (*AttachmentReference, error)
	// [Preview API] Adds a new reaction to a comment.
	CreateCommentReaction(context.Context, CreateCommentReactionArgs) (*CommentReaction, error)
	// [Preview API] Create new or update an existing classification node.
	CreateOrUpdateClassificationNode(context.Context, CreateOrUpdateClassificationNodeArgs) (*WorkItemClassificationNode, error)
	// [Preview API] Creates a query, or moves a query.
	CreateQuery(context.Context, CreateQueryArgs) (*QueryHierarchyItem, error)
	// [Preview API] Creates a template
	CreateTemplate(context.Context, CreateTemplateArgs) (*WorkItemTemplate, error)
	// [Preview API] Creates a temporary query
	CreateTempQuery(context.Context, CreateTempQueryArgs) (*TemporaryQueryResponseModel, error)
	// [Preview API] Creates a single work item.
	CreateWorkItem(context.Context, CreateWorkItemArgs) (*WorkItem, error)
	// [Preview API] Create a new field.
	CreateWorkItemField(context.Context, CreateWorkItemFieldArgs) (*WorkItemField2, error)
	// [Preview API] Delete an existing classification node.
	DeleteClassificationNode(context.Context, DeleteClassificationNodeArgs) error
	// [Preview API] Delete a comment on a work item.
	DeleteComment(context.Context, DeleteCommentArgs) error
	// [Preview API] Deletes an existing reaction on a comment.
	DeleteCommentReaction(context.Context, DeleteCommentReactionArgs) (*CommentReaction, error)
	// [Preview API] 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.
	DeleteQuery(context.Context, DeleteQueryArgs) error
	// [Preview API]
	DeleteTag(context.Context, DeleteTagArgs) error
	// [Preview API] Deletes the template with given id
	DeleteTemplate(context.Context, DeleteTemplateArgs) error
	// [Preview API] Deletes the specified work item and sends it to the Recycle Bin, so that it can be restored back, if required. Optionally, if the destroy parameter has been set to true, it destroys the work item permanently. 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.
	DeleteWorkItem(context.Context, DeleteWorkItemArgs) (*WorkItemDelete, error)
	// [Preview API] Deletes the field. To undelete a filed, see "Update Field" API.
	DeleteWorkItemField(context.Context, DeleteWorkItemFieldArgs) error
	// [Preview API] Deletes specified work items and sends them to the Recycle Bin, so that it can be restored back, if required. Optionally, if the destroy parameter has been set to true, it destroys the work item permanently. 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.
	DeleteWorkItems(context.Context, DeleteWorkItemsArgs) (*WorkItemDeleteBatch, error)
	// [Preview API] Destroys the specified work item permanently from the Recycle Bin. This action can not be undone.
	DestroyWorkItem(context.Context, DestroyWorkItemArgs) error
	// [Preview API] Downloads an attachment.
	GetAttachmentContent(context.Context, GetAttachmentContentArgs) (io.ReadCloser, error)
	// [Preview API] Downloads an attachment.
	GetAttachmentZip(context.Context, GetAttachmentZipArgs) (io.ReadCloser, error)
	// [Preview API] Gets the classification node for a given node path.
	GetClassificationNode(context.Context, GetClassificationNodeArgs) (*WorkItemClassificationNode, error)
	// [Preview API] Gets root classification nodes or list of classification nodes for a given list of nodes ids, for a given project. In case ids parameter is supplied you will  get list of classification nodes for those ids. Otherwise you will get root classification nodes for this project.
	GetClassificationNodes(context.Context, GetClassificationNodesArgs) (*[]WorkItemClassificationNode, error)
	// [Preview API] Returns a work item comment.
	GetComment(context.Context, GetCommentArgs) (*Comment, error)
	// [Preview API] Gets reactions of a comment.
	GetCommentReactions(context.Context, GetCommentReactionsArgs) (*[]CommentReaction, error)
	// [Preview API] Returns a list of work item comments, pageable.
	GetComments(context.Context, GetCommentsArgs) (*CommentList, error)
	// [Preview API] Returns a list of work item comments by ids.
	GetCommentsBatch(context.Context, GetCommentsBatchArgs) (*CommentList, error)
	// [Preview API]
	GetCommentVersion(context.Context, GetCommentVersionArgs) (*CommentVersion, error)
	// [Preview API]
	GetCommentVersions(context.Context, GetCommentVersionsArgs) (*[]CommentVersion, error)
	// [Preview API] Gets a deleted work item from Recycle Bin.
	GetDeletedWorkItem(context.Context, GetDeletedWorkItemArgs) (*WorkItemDelete, error)
	// [Preview API] Gets the work items from the recycle bin, whose IDs have been specified in the parameters
	GetDeletedWorkItems(context.Context, GetDeletedWorkItemsArgs) (*[]WorkItemDeleteReference, error)
	// [Preview API] Gets a list of the IDs and the URLs of the deleted the work items in the Recycle Bin.
	GetDeletedWorkItemShallowReferences(context.Context, GetDeletedWorkItemShallowReferencesArgs) (*[]WorkItemDeleteShallowReference, error)
	// [Preview API] Get users who reacted on the comment.
	GetEngagedUsers(context.Context, GetEngagedUsersArgs) (*[]webapi.IdentityRef, error)
	// [Preview API] Gets a list of repos within specified github connection.
	GetGithubConnectionRepositories(context.Context, GetGithubConnectionRepositoriesArgs) (*[]GitHubConnectionRepoModel, error)
	// [Preview API] Gets a list of github connections
	GetGithubConnections(context.Context, GetGithubConnectionsArgs) (*[]GitHubConnectionModel, error)
	// [Preview API] Gets the root queries and their children
	GetQueries(context.Context, GetQueriesArgs) (*[]QueryHierarchyItem, error)
	// [Preview API] Gets a list of queries by ids (Maximum 1000)
	GetQueriesBatch(context.Context, GetQueriesBatchArgs) (*[]QueryHierarchyItem, error)
	// [Preview API] Retrieves an individual query and its children
	GetQuery(context.Context, GetQueryArgs) (*QueryHierarchyItem, error)
	// [Preview API] Gets the results of the query given the query ID.
	GetQueryResultCount(context.Context, GetQueryResultCountArgs) (*int, error)
	// [Preview API] Gets recent work item activities
	GetRecentActivityData(context.Context, GetRecentActivityDataArgs) (*[]AccountRecentActivityWorkItemModel2, error)
	// [Preview API] Gets the work item relation type definition.
	GetRelationType(context.Context, GetRelationTypeArgs) (*WorkItemRelationType, error)
	// [Preview API] Gets the work item relation types.
	GetRelationTypes(context.Context, GetRelationTypesArgs) (*[]WorkItemRelationType, error)
	// [Preview API] Get a batch of work item links
	GetReportingLinksByLinkType(context.Context, GetReportingLinksByLinkTypeArgs) (*ReportingWorkItemLinksBatch, error)
	// [Preview API] Returns a fully hydrated work item for the requested revision
	GetRevision(context.Context, GetRevisionArgs) (*WorkItem, error)
	// [Preview API] Returns the list of fully hydrated work item revisions, paged.
	GetRevisions(context.Context, GetRevisionsArgs) (*[]WorkItem, error)
	// [Preview API] Gets root classification nodes under the project.
	GetRootNodes(context.Context, GetRootNodesArgs) (*[]WorkItemClassificationNode, error)
	// [Preview API]
	GetTag(context.Context, GetTagArgs) (*WorkItemTagDefinition, error)
	// [Preview API]
	GetTags(context.Context, GetTagsArgs) (*[]WorkItemTagDefinition, error)
	// [Preview API] Gets the template with specified id
	GetTemplate(context.Context, GetTemplateArgs) (*WorkItemTemplate, error)
	// [Preview API] Gets template
	GetTemplates(context.Context, GetTemplatesArgs) (*[]WorkItemTemplateReference, error)
	// [Preview API] Returns a single update for a work item
	GetUpdate(context.Context, GetUpdateArgs) (*WorkItemUpdate, error)
	// [Preview API] Returns a the deltas between work item revisions
	GetUpdates(context.Context, GetUpdatesArgs) (*[]WorkItemUpdate, error)
	// [Preview API] Get the list of work item tracking outbound artifact link types.
	GetWorkArtifactLinkTypes(context.Context, GetWorkArtifactLinkTypesArgs) (*[]WorkArtifactLink, error)
	// [Preview API] Returns a single work item.
	GetWorkItem(context.Context, GetWorkItemArgs) (*WorkItem, error)
	// [Preview API] Gets information on a specific field.
	GetWorkItemField(context.Context, GetWorkItemFieldArgs) (*WorkItemField2, error)
	// [Preview API] Returns information for all fields. The project ID/name parameter is optional.
	GetWorkItemFields(context.Context, GetWorkItemFieldsArgs) (*[]WorkItemField2, error)
	// [Preview API] Get a work item icon given the friendly name and icon color.
	GetWorkItemIconJson(context.Context, GetWorkItemIconJsonArgs) (*WorkItemIcon, error)
	// [Preview API] Get a list of all work item icons.
	GetWorkItemIcons(context.Context, GetWorkItemIconsArgs) (*[]WorkItemIcon, error)
	// [Preview API] Get a work item icon given the friendly name and icon color.
	GetWorkItemIconSvg(context.Context, GetWorkItemIconSvgArgs) (io.ReadCloser, error)
	// [Preview API] Get a work item icon given the friendly name and icon color.
	GetWorkItemIconXaml(context.Context, GetWorkItemIconXamlArgs) (io.ReadCloser, error)
	// [Preview API] Returns the next state on the given work item IDs.
	GetWorkItemNextStatesOnCheckinAction(context.Context, GetWorkItemNextStatesOnCheckinActionArgs) (*[]WorkItemNextStateOnTransition, error)
	// [Preview API] Returns a list of work items (Maximum 200)
	GetWorkItems(context.Context, GetWorkItemsArgs) (*[]WorkItem, error)
	// [Preview API] Gets work items for a list of work item ids (Maximum 200)
	GetWorkItemsBatch(context.Context, GetWorkItemsBatchArgs) (*[]WorkItem, error)
	// [Preview API] Returns a single work item from a template.
	GetWorkItemTemplate(context.Context, GetWorkItemTemplateArgs) (*WorkItem, error)
	// [Preview API] Returns a work item type definition.
	GetWorkItemType(context.Context, GetWorkItemTypeArgs) (*WorkItemType, error)
	// [Preview API] Get all work item type categories.
	GetWorkItemTypeCategories(context.Context, GetWorkItemTypeCategoriesArgs) (*[]WorkItemTypeCategory, error)
	// [Preview API] Get specific work item type category by name.
	GetWorkItemTypeCategory(context.Context, GetWorkItemTypeCategoryArgs) (*WorkItemTypeCategory, error)
	// [Preview API] Get a list of fields for a work item type with detailed references.
	GetWorkItemTypeFieldsWithReferences(context.Context, GetWorkItemTypeFieldsWithReferencesArgs) (*[]WorkItemTypeFieldWithReferences, error)
	// [Preview API] Get a field for a work item type with detailed references.
	GetWorkItemTypeFieldWithReferences(context.Context, GetWorkItemTypeFieldWithReferencesArgs) (*WorkItemTypeFieldWithReferences, error)
	// [Preview API] Returns the list of work item types
	GetWorkItemTypes(context.Context, GetWorkItemTypesArgs) (*[]WorkItemType, error)
	// [Preview API] Returns the state names and colors for a work item type.
	GetWorkItemTypeStates(context.Context, GetWorkItemTypeStatesArgs) (*[]WorkItemStateColor, error)
	// [Preview API] 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.
	MigrateProjectsProcess(context.Context, MigrateProjectsProcessArgs) (*ProcessMigrationResultModel, error)
	// [Preview API] Gets the results of the query given the query ID.
	QueryById(context.Context, QueryByIdArgs) (*WorkItemQueryResult, error)
	// [Preview API] Gets the results of the query given its WIQL.
	QueryByWiql(context.Context, QueryByWiqlArgs) (*WorkItemQueryResult, error)
	// [Preview API] Queries work items linked to a given list of artifact URI.
	QueryWorkItemsForArtifactUris(context.Context, QueryWorkItemsForArtifactUrisArgs) (*ArtifactUriQueryResult, error)
	// [Preview API]
	ReadReportingDiscussions(context.Context, ReadReportingDiscussionsArgs) (*ReportingWorkItemRevisionsBatch, error)
	// [Preview API] Get a batch of work item revisions with the option of including deleted items
	ReadReportingRevisionsGet(context.Context, ReadReportingRevisionsGetArgs) (*ReportingWorkItemRevisionsBatch, error)
	// [Preview API] Get a batch of work item revisions. This request may be used if your list of fields is large enough that it may run the URL over the length limit.
	ReadReportingRevisionsPost(context.Context, ReadReportingRevisionsPostArgs) (*ReportingWorkItemRevisionsBatch, error)
	// [Preview API] Replace template contents
	ReplaceTemplate(context.Context, ReplaceTemplateArgs) (*WorkItemTemplate, error)
	// [Preview API] Restores the deleted work item from Recycle Bin.
	RestoreWorkItem(context.Context, RestoreWorkItemArgs) (*WorkItemDelete, error)
	// [Preview API] Searches all queries the user has access to in the current project
	SearchQueries(context.Context, SearchQueriesArgs) (*QueryHierarchyItemsResult, error)
	// [Preview API] RESTful method to send mail for selected/queried work items.
	SendMail(context.Context, SendMailArgs) error
	// [Preview API] Update an existing classification node.
	UpdateClassificationNode(context.Context, UpdateClassificationNodeArgs) (*WorkItemClassificationNode, error)
	// [Preview API] Update a comment on a work item.
	UpdateComment(context.Context, UpdateCommentArgs) (*Comment, error)
	// [Preview API] Add/remove list of repos within specified github connection.
	UpdateGithubConnectionRepos(context.Context, UpdateGithubConnectionReposArgs) (*[]GitHubConnectionRepoModel, error)
	// [Preview API] Update a query or a folder. This allows you to update, rename and move queries and folders.
	UpdateQuery(context.Context, UpdateQueryArgs) (*QueryHierarchyItem, error)
	// [Preview API]
	UpdateTag(context.Context, UpdateTagArgs) (*WorkItemTagDefinition, error)
	// [Preview API] Updates a single work item.
	UpdateWorkItem(context.Context, UpdateWorkItemArgs) (*WorkItem, error)
	// [Preview API] Update a comment on a work item.
	UpdateWorkItemComment(context.Context, UpdateWorkItemCommentArgs) (*Comment, error)
	// [Preview API] Update a field.
	UpdateWorkItemField(context.Context, UpdateWorkItemFieldArgs) (*WorkItemField2, error)
}

func NewClient 

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

type ClientImpl 

type ClientImpl struct {
	Client azuredevops.Client
}

func (*ClientImpl) AddComment 

func (client *ClientImpl) AddComment(ctx context.Context, args AddCommentArgs) (*Comment, error)

[Preview API] Add a comment on a work item.

func (*ClientImpl) AddWorkItemComment 

func (client *ClientImpl) AddWorkItemComment(ctx context.Context, args AddWorkItemCommentArgs) (*Comment, error)

[Preview API] Add a comment on a work item.

func (*ClientImpl) CreateAttachment 

func (client *ClientImpl) CreateAttachment(ctx context.Context, args CreateAttachmentArgs) (*AttachmentReference, error)

[Preview API] Uploads an attachment.

func (*ClientImpl) CreateCommentReaction 

func (client *ClientImpl) CreateCommentReaction(ctx context.Context, args CreateCommentReactionArgs) (*CommentReaction, error)

[Preview API] Adds a new reaction to a comment.

func (*ClientImpl) CreateOrUpdateClassificationNode 

func (client *ClientImpl) CreateOrUpdateClassificationNode(ctx context.Context, args CreateOrUpdateClassificationNodeArgs) (*WorkItemClassificationNode, error)

[Preview API] Create new or update an existing classification node.

func (*ClientImpl) CreateQuery 

func (client *ClientImpl) CreateQuery(ctx context.Context, args CreateQueryArgs) (*QueryHierarchyItem, error)

[Preview API] Creates a query, or moves a query.

func (*ClientImpl) CreateTempQuery 

func (client *ClientImpl) CreateTempQuery(ctx context.Context, args CreateTempQueryArgs) (*TemporaryQueryResponseModel, error)

[Preview API] Creates a temporary query

func (*ClientImpl) CreateTemplate 

func (client *ClientImpl) CreateTemplate(ctx context.Context, args CreateTemplateArgs) (*WorkItemTemplate, error)

[Preview API] Creates a template

func (*ClientImpl) CreateWorkItem 

func (client *ClientImpl) CreateWorkItem(ctx context.Context, args CreateWorkItemArgs) (*WorkItem, error)

[Preview API] Creates a single work item.

func (*ClientImpl) CreateWorkItemField 

func (client *ClientImpl) CreateWorkItemField(ctx context.Context, args CreateWorkItemFieldArgs) (*WorkItemField2, error)

[Preview API] Create a new field.

func (*ClientImpl) DeleteClassificationNode 

func (client *ClientImpl) DeleteClassificationNode(ctx context.Context, args DeleteClassificationNodeArgs) error

[Preview API] Delete an existing classification node.

func (*ClientImpl) DeleteComment 

func (client *ClientImpl) DeleteComment(ctx context.Context, args DeleteCommentArgs) error

[Preview API] Delete a comment on a work item.

func (*ClientImpl) DeleteCommentReaction 

func (client *ClientImpl) DeleteCommentReaction(ctx context.Context, args DeleteCommentReactionArgs) (*CommentReaction, error)

[Preview API] Deletes an existing reaction on a comment.

func (*ClientImpl) DeleteQuery 

func (client *ClientImpl) DeleteQuery(ctx context.Context, args DeleteQueryArgs) error

[Preview API] 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.

func (*ClientImpl) DeleteTag 

func (client *ClientImpl) DeleteTag(ctx context.Context, args DeleteTagArgs) error

[Preview API]

func (*ClientImpl) DeleteTemplate 

func (client *ClientImpl) DeleteTemplate(ctx context.Context, args DeleteTemplateArgs) error

[Preview API] Deletes the template with given id

func (*ClientImpl) DeleteWorkItem 

func (client *ClientImpl) DeleteWorkItem(ctx context.Context, args DeleteWorkItemArgs) (*WorkItemDelete, error)

[Preview API] Deletes the specified work item and sends it to the Recycle Bin, so that it can be restored back, if required. Optionally, if the destroy parameter has been set to true, it destroys the work item permanently. 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.

func (*ClientImpl) DeleteWorkItemField 

func (client *ClientImpl) DeleteWorkItemField(ctx context.Context, args DeleteWorkItemFieldArgs) error

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

func (*ClientImpl) DeleteWorkItems 

func (client *ClientImpl) DeleteWorkItems(ctx context.Context, args DeleteWorkItemsArgs) (*WorkItemDeleteBatch, error)

[Preview API] Deletes specified work items and sends them to the Recycle Bin, so that it can be restored back, if required. Optionally, if the destroy parameter has been set to true, it destroys the work item permanently. 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.

func (*ClientImpl) DestroyWorkItem 

func (client *ClientImpl) DestroyWorkItem(ctx context.Context, args DestroyWorkItemArgs) error

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

func (*ClientImpl) GetAttachmentContent 

func (client *ClientImpl) GetAttachmentContent(ctx context.Context, args GetAttachmentContentArgs) (io.ReadCloser, error)

[Preview API] Downloads an attachment.

func (*ClientImpl) GetAttachmentZip 

func (client *ClientImpl) GetAttachmentZip(ctx context.Context, args GetAttachmentZipArgs) (io.ReadCloser, error)

[Preview API] Downloads an attachment.

func (*ClientImpl) GetClassificationNode 

func (client *ClientImpl) GetClassificationNode(ctx context.Context, args GetClassificationNodeArgs) (*WorkItemClassificationNode, error)

[Preview API] Gets the classification node for a given node path.

func (*ClientImpl) GetClassificationNodes 

func (client *ClientImpl) GetClassificationNodes(ctx context.Context, args GetClassificationNodesArgs) (*[]WorkItemClassificationNode, error)

[Preview API] Gets root classification nodes or list of classification nodes for a given list of nodes ids, for a given project. In case ids parameter is supplied you will get list of classification nodes for those ids. Otherwise you will get root classification nodes for this project.

func (*ClientImpl) GetComment 

func (client *ClientImpl) GetComment(ctx context.Context, args GetCommentArgs) (*Comment, error)

[Preview API] Returns a work item comment.

func (*ClientImpl) GetCommentReactions 

func (client *ClientImpl) GetCommentReactions(ctx context.Context, args GetCommentReactionsArgs) (*[]CommentReaction, error)

[Preview API] Gets reactions of a comment.

func (*ClientImpl) GetCommentVersion 

func (client *ClientImpl) GetCommentVersion(ctx context.Context, args GetCommentVersionArgs) (*CommentVersion, error)

[Preview API]

func (*ClientImpl) GetCommentVersions 

func (client *ClientImpl) GetCommentVersions(ctx context.Context, args GetCommentVersionsArgs) (*[]CommentVersion, error)

[Preview API]

func (*ClientImpl) GetComments 

func (client *ClientImpl) GetComments(ctx context.Context, args GetCommentsArgs) (*CommentList, error)

[Preview API] Returns a list of work item comments, pageable.

func (*ClientImpl) GetCommentsBatch 

func (client *ClientImpl) GetCommentsBatch(ctx context.Context, args GetCommentsBatchArgs) (*CommentList, error)

[Preview API] Returns a list of work item comments by ids.

func (*ClientImpl) GetDeletedWorkItem 

func (client *ClientImpl) GetDeletedWorkItem(ctx context.Context, args GetDeletedWorkItemArgs) (*WorkItemDelete, error)

[Preview API] Gets a deleted work item from Recycle Bin.

func (*ClientImpl) GetDeletedWorkItemShallowReferences 

func (client *ClientImpl) GetDeletedWorkItemShallowReferences(ctx context.Context, args GetDeletedWorkItemShallowReferencesArgs) (*[]WorkItemDeleteShallowReference, error)

[Preview API] Gets a list of the IDs and the URLs of the deleted the work items in the Recycle Bin.

func (*ClientImpl) GetDeletedWorkItems 

func (client *ClientImpl) GetDeletedWorkItems(ctx context.Context, args GetDeletedWorkItemsArgs) (*[]WorkItemDeleteReference, error)

[Preview API] Gets the work items from the recycle bin, whose IDs have been specified in the parameters

func (*ClientImpl) GetEngagedUsers 

func (client *ClientImpl) GetEngagedUsers(ctx context.Context, args GetEngagedUsersArgs) (*[]webapi.IdentityRef, error)

[Preview API] Get users who reacted on the comment.

func (*ClientImpl) GetGithubConnectionRepositories 

func (client *ClientImpl) GetGithubConnectionRepositories(ctx context.Context, args GetGithubConnectionRepositoriesArgs) (*[]GitHubConnectionRepoModel, error)

[Preview API] Gets a list of repos within specified github connection.

func (*ClientImpl) GetGithubConnections 

func (client *ClientImpl) GetGithubConnections(ctx context.Context, args GetGithubConnectionsArgs) (*[]GitHubConnectionModel, error)

[Preview API] Gets a list of github connections

func (*ClientImpl) GetQueries 

func (client *ClientImpl) GetQueries(ctx context.Context, args GetQueriesArgs) (*[]QueryHierarchyItem, error)

[Preview API] Gets the root queries and their children

func (*ClientImpl) GetQueriesBatch 

func (client *ClientImpl) GetQueriesBatch(ctx context.Context, args GetQueriesBatchArgs) (*[]QueryHierarchyItem, error)

[Preview API] Gets a list of queries by ids (Maximum 1000)

func (*ClientImpl) GetQuery 

func (client *ClientImpl) GetQuery(ctx context.Context, args GetQueryArgs) (*QueryHierarchyItem, error)

[Preview API] Retrieves an individual query and its children

func (*ClientImpl) GetQueryResultCount 

func (client *ClientImpl) GetQueryResultCount(ctx context.Context, args GetQueryResultCountArgs) (*int, error)

[Preview API] Gets the results of the query given the query ID.

func (*ClientImpl) GetRecentActivityData 

func (client *ClientImpl) GetRecentActivityData(ctx context.Context, args GetRecentActivityDataArgs) (*[]AccountRecentActivityWorkItemModel2, error)

[Preview API] Gets recent work item activities

func (*ClientImpl) GetRelationType 

func (client *ClientImpl) GetRelationType(ctx context.Context, args GetRelationTypeArgs) (*WorkItemRelationType, error)

[Preview API] Gets the work item relation type definition.

func (*ClientImpl) GetRelationTypes 

func (client *ClientImpl) GetRelationTypes(ctx context.Context, args GetRelationTypesArgs) (*[]WorkItemRelationType, error)

[Preview API] Gets the work item relation types.

func (*ClientImpl) GetReportingLinksByLinkType 

func (client *ClientImpl) GetReportingLinksByLinkType(ctx context.Context, args GetReportingLinksByLinkTypeArgs) (*ReportingWorkItemLinksBatch, error)

[Preview API] Get a batch of work item links

func (*ClientImpl) GetRevision 

func (client *ClientImpl) GetRevision(ctx context.Context, args GetRevisionArgs) (*WorkItem, error)

[Preview API] Returns a fully hydrated work item for the requested revision

func (*ClientImpl) GetRevisions 

func (client *ClientImpl) GetRevisions(ctx context.Context, args GetRevisionsArgs) (*[]WorkItem, error)

[Preview API] Returns the list of fully hydrated work item revisions, paged.

func (*ClientImpl) GetRootNodes 

func (client *ClientImpl) GetRootNodes(ctx context.Context, args GetRootNodesArgs) (*[]WorkItemClassificationNode, error)

[Preview API] Gets root classification nodes under the project.

func (*ClientImpl) GetTag 

func (client *ClientImpl) GetTag(ctx context.Context, args GetTagArgs) (*WorkItemTagDefinition, error)

[Preview API]

func (*ClientImpl) GetTags 

func (client *ClientImpl) GetTags(ctx context.Context, args GetTagsArgs) (*[]WorkItemTagDefinition, error)

[Preview API]

func (*ClientImpl) GetTemplate 

func (client *ClientImpl) GetTemplate(ctx context.Context, args GetTemplateArgs) (*WorkItemTemplate, error)

[Preview API] Gets the template with specified id

func (*ClientImpl) GetTemplates 

func (client *ClientImpl) GetTemplates(ctx context.Context, args GetTemplatesArgs) (*[]WorkItemTemplateReference, error)

[Preview API] Gets template

func (*ClientImpl) GetUpdate 

func (client *ClientImpl) GetUpdate(ctx context.Context, args GetUpdateArgs) (*WorkItemUpdate, error)

[Preview API] Returns a single update for a work item

func (*ClientImpl) GetUpdates 

func (client *ClientImpl) GetUpdates(ctx context.Context, args GetUpdatesArgs) (*[]WorkItemUpdate, error)

[Preview API] Returns a the deltas between work item revisions

func (*ClientImpl) GetWorkArtifactLinkTypes 

func (client *ClientImpl) GetWorkArtifactLinkTypes(ctx context.Context, args GetWorkArtifactLinkTypesArgs) (*[]WorkArtifactLink, error)

[Preview API] Get the list of work item tracking outbound artifact link types.

func (*ClientImpl) GetWorkItem 

func (client *ClientImpl) GetWorkItem(ctx context.Context, args GetWorkItemArgs) (*WorkItem, error)

[Preview API] Returns a single work item.

func (*ClientImpl) GetWorkItemField 

func (client *ClientImpl) GetWorkItemField(ctx context.Context, args GetWorkItemFieldArgs) (*WorkItemField2, error)

[Preview API] Gets information on a specific field.

func (*ClientImpl) GetWorkItemFields 

func (client *ClientImpl) GetWorkItemFields(ctx context.Context, args GetWorkItemFieldsArgs) (*[]WorkItemField2, error)

[Preview API] Returns information for all fields. The project ID/name parameter is optional.

func (*ClientImpl) GetWorkItemIconJson 

func (client *ClientImpl) GetWorkItemIconJson(ctx context.Context, args GetWorkItemIconJsonArgs) (*WorkItemIcon, error)

[Preview API] Get a work item icon given the friendly name and icon color.

func (*ClientImpl) GetWorkItemIconSvg 

func (client *ClientImpl) GetWorkItemIconSvg(ctx context.Context, args GetWorkItemIconSvgArgs) (io.ReadCloser, error)

[Preview API] Get a work item icon given the friendly name and icon color.

func (*ClientImpl) GetWorkItemIconXaml 

func (client *ClientImpl) GetWorkItemIconXaml(ctx context.Context, args GetWorkItemIconXamlArgs) (io.ReadCloser, error)

[Preview API] Get a work item icon given the friendly name and icon color.

func (*ClientImpl) GetWorkItemIcons 

func (client *ClientImpl) GetWorkItemIcons(ctx context.Context, args GetWorkItemIconsArgs) (*[]WorkItemIcon, error)

[Preview API] Get a list of all work item icons.

func (*ClientImpl) GetWorkItemNextStatesOnCheckinAction 

func (client *ClientImpl) GetWorkItemNextStatesOnCheckinAction(ctx context.Context, args GetWorkItemNextStatesOnCheckinActionArgs) (*[]WorkItemNextStateOnTransition, error)

[Preview API] Returns the next state on the given work item IDs.

func (*ClientImpl) GetWorkItemTemplate 

func (client *ClientImpl) GetWorkItemTemplate(ctx context.Context, args GetWorkItemTemplateArgs) (*WorkItem, error)

[Preview API] Returns a single work item from a template.

func (*ClientImpl) GetWorkItemType 

func (client *ClientImpl) GetWorkItemType(ctx context.Context, args GetWorkItemTypeArgs) (*WorkItemType, error)

[Preview API] Returns a work item type definition.

func (*ClientImpl) GetWorkItemTypeCategories 

func (client *ClientImpl) GetWorkItemTypeCategories(ctx context.Context, args GetWorkItemTypeCategoriesArgs) (*[]WorkItemTypeCategory, error)

[Preview API] Get all work item type categories.

func (*ClientImpl) GetWorkItemTypeCategory 

func (client *ClientImpl) GetWorkItemTypeCategory(ctx context.Context, args GetWorkItemTypeCategoryArgs) (*WorkItemTypeCategory, error)

[Preview API] Get specific work item type category by name.

func (*ClientImpl) GetWorkItemTypeFieldWithReferences 

func (client *ClientImpl) GetWorkItemTypeFieldWithReferences(ctx context.Context, args GetWorkItemTypeFieldWithReferencesArgs) (*WorkItemTypeFieldWithReferences, error)

[Preview API] Get a field for a work item type with detailed references.

func (*ClientImpl) GetWorkItemTypeFieldsWithReferences 

func (client *ClientImpl) GetWorkItemTypeFieldsWithReferences(ctx context.Context, args GetWorkItemTypeFieldsWithReferencesArgs) (*[]WorkItemTypeFieldWithReferences, error)

[Preview API] Get a list of fields for a work item type with detailed references.

func (*ClientImpl) GetWorkItemTypeStates 

func (client *ClientImpl) GetWorkItemTypeStates(ctx context.Context, args GetWorkItemTypeStatesArgs) (*[]WorkItemStateColor, error)

[Preview API] Returns the state names and colors for a work item type.

func (*ClientImpl) GetWorkItemTypes 

func (client *ClientImpl) GetWorkItemTypes(ctx context.Context, args GetWorkItemTypesArgs) (*[]WorkItemType, error)

[Preview API] Returns the list of work item types

func (*ClientImpl) GetWorkItems 

func (client *ClientImpl) GetWorkItems(ctx context.Context, args GetWorkItemsArgs) (*[]WorkItem, error)

[Preview API] Returns a list of work items (Maximum 200)

func (*ClientImpl) GetWorkItemsBatch 

func (client *ClientImpl) GetWorkItemsBatch(ctx context.Context, args GetWorkItemsBatchArgs) (*[]WorkItem, error)

[Preview API] Gets work items for a list of work item ids (Maximum 200)

func (*ClientImpl) MigrateProjectsProcess 

func (client *ClientImpl) MigrateProjectsProcess(ctx context.Context, args MigrateProjectsProcessArgs) (*ProcessMigrationResultModel, error)

[Preview API] 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.

func (*ClientImpl) QueryById 

func (client *ClientImpl) QueryById(ctx context.Context, args QueryByIdArgs) (*WorkItemQueryResult, error)

[Preview API] Gets the results of the query given the query ID.

func (*ClientImpl) QueryByWiql 

func (client *ClientImpl) QueryByWiql(ctx context.Context, args QueryByWiqlArgs) (*WorkItemQueryResult, error)

[Preview API] Gets the results of the query given its WIQL.

func (*ClientImpl) QueryWorkItemsForArtifactUris 

func (client *ClientImpl) QueryWorkItemsForArtifactUris(ctx context.Context, args QueryWorkItemsForArtifactUrisArgs) (*ArtifactUriQueryResult, error)

[Preview API] Queries work items linked to a given list of artifact URI.

func (*ClientImpl) ReadReportingDiscussions 

func (client *ClientImpl) ReadReportingDiscussions(ctx context.Context, args ReadReportingDiscussionsArgs) (*ReportingWorkItemRevisionsBatch, error)

[Preview API]

func (*ClientImpl) ReadReportingRevisionsGet 

func (client *ClientImpl) ReadReportingRevisionsGet(ctx context.Context, args ReadReportingRevisionsGetArgs) (*ReportingWorkItemRevisionsBatch, error)

[Preview API] Get a batch of work item revisions with the option of including deleted items

func (*ClientImpl) ReadReportingRevisionsPost 

func (client *ClientImpl) ReadReportingRevisionsPost(ctx context.Context, args ReadReportingRevisionsPostArgs) (*ReportingWorkItemRevisionsBatch, error)

[Preview API] Get a batch of work item revisions. This request may be used if your list of fields is large enough that it may run the URL over the length limit.

func (*ClientImpl) ReplaceTemplate 

func (client *ClientImpl) ReplaceTemplate(ctx context.Context, args ReplaceTemplateArgs) (*WorkItemTemplate, error)

[Preview API] Replace template contents

func (*ClientImpl) RestoreWorkItem 

func (client *ClientImpl) RestoreWorkItem(ctx context.Context, args RestoreWorkItemArgs) (*WorkItemDelete, error)

[Preview API] Restores the deleted work item from Recycle Bin.

func (*ClientImpl) SearchQueries 

func (client *ClientImpl) SearchQueries(ctx context.Context, args SearchQueriesArgs) (*QueryHierarchyItemsResult, error)

[Preview API] Searches all queries the user has access to in the current project

func (*ClientImpl) SendMail 

func (client *ClientImpl) SendMail(ctx context.Context, args SendMailArgs) error

[Preview API] RESTful method to send mail for selected/queried work items.

func (*ClientImpl) UpdateClassificationNode 

func (client *ClientImpl) UpdateClassificationNode(ctx context.Context, args UpdateClassificationNodeArgs) (*WorkItemClassificationNode, error)

[Preview API] Update an existing classification node.

func (*ClientImpl) UpdateComment 

func (client *ClientImpl) UpdateComment(ctx context.Context, args UpdateCommentArgs) (*Comment, error)

[Preview API] Update a comment on a work item.

func (*ClientImpl) UpdateGithubConnectionRepos 

func (client *ClientImpl) UpdateGithubConnectionRepos(ctx context.Context, args UpdateGithubConnectionReposArgs) (*[]GitHubConnectionRepoModel, error)

[Preview API] Add/remove list of repos within specified github connection.

func (*ClientImpl) UpdateQuery 

func (client *ClientImpl) UpdateQuery(ctx context.Context, args UpdateQueryArgs) (*QueryHierarchyItem, error)

[Preview API] Update a query or a folder. This allows you to update, rename and move queries and folders.

func (*ClientImpl) UpdateTag 

func (client *ClientImpl) UpdateTag(ctx context.Context, args UpdateTagArgs) (*WorkItemTagDefinition, error)

[Preview API]

func (*ClientImpl) UpdateWorkItem 

func (client *ClientImpl) UpdateWorkItem(ctx context.Context, args UpdateWorkItemArgs) (*WorkItem, error)

[Preview API] Updates a single work item.

func (*ClientImpl) UpdateWorkItemComment 

func (client *ClientImpl) UpdateWorkItemComment(ctx context.Context, args UpdateWorkItemCommentArgs) (*Comment, error)

[Preview API] Update a comment on a work item.

func (*ClientImpl) UpdateWorkItemField 

func (client *ClientImpl) UpdateWorkItemField(ctx context.Context, args UpdateWorkItemFieldArgs) (*WorkItemField2, error)

[Preview API] Update a field.

type Comment 

type Comment struct {
	Url *string `json:"url,omitempty"`
	// Link references to related REST resources.
	Links interface{} `json:"_links,omitempty"`
	// IdentityRef of the creator of the comment.
	CreatedBy *webapi.IdentityRef `json:"createdBy,omitempty"`
	// The creation date of the comment.
	CreatedDate *azuredevops.Time `json:"createdDate,omitempty"`
	// Effective Date/time value for adding the comment. Can be optionally different from CreatedDate.
	CreatedOnBehalfDate *azuredevops.Time `json:"createdOnBehalfDate,omitempty"`
	// Identity on whose behalf this comment has been added. Can be optionally different from CreatedBy.
	CreatedOnBehalfOf *webapi.IdentityRef `json:"createdOnBehalfOf,omitempty"`
	// Represents the possible types for the comment format.
	Format *CommentFormat `json:"format,omitempty"`
	// The id assigned to the comment.
	Id *int `json:"id,omitempty"`
	// Indicates if the comment has been deleted.
	IsDeleted *bool `json:"isDeleted,omitempty"`
	// The mentions of the comment.
	Mentions *[]CommentMention `json:"mentions,omitempty"`
	// IdentityRef of the user who last modified the comment.
	ModifiedBy *webapi.IdentityRef `json:"modifiedBy,omitempty"`
	// The last modification date of the comment.
	ModifiedDate *azuredevops.Time `json:"modifiedDate,omitempty"`
	// The reactions of the comment.
	Reactions *[]CommentReaction `json:"reactions,omitempty"`
	// The text of the comment in HTML format.
	RenderedText *string `json:"renderedText,omitempty"`
	// The text of the comment.
	Text *string `json:"text,omitempty"`
	// The current version of the comment.
	Version *int `json:"version,omitempty"`
	// The id of the work item this comment belongs to.
	WorkItemId *int `json:"workItemId,omitempty"`
}

Comment on a Work Item.

type CommentCreate 

type CommentCreate struct {
	// The text of the comment.
	Text *string `json:"text,omitempty"`
}

Represents a request to create a work item comment.

type CommentExpandOptions 

type CommentExpandOptions string

[Flags] Specifies the additional data retrieval options for work item comments.

type CommentFormat 

type CommentFormat string

Represents the possible types for the comment format. Should be in sync with WorkItemCommentFormat.cs

type CommentList 

type CommentList struct {
	Url *string `json:"url,omitempty"`
	// Link references to related REST resources.
	Links interface{} `json:"_links,omitempty"`
	// List of comments in the current batch.
	Comments *[]Comment `json:"comments,omitempty"`
	// A string token that can be used to retrieving next page of comments if available. Otherwise null.
	ContinuationToken *string `json:"continuationToken,omitempty"`
	// The count of comments in the current batch.
	Count *int `json:"count,omitempty"`
	// Uri to the next page of comments if it is available. Otherwise null.
	NextPage *string `json:"nextPage,omitempty"`
	// Total count of comments on a work item.
	TotalCount *int `json:"totalCount,omitempty"`
}

Represents a list of work item comments.

type CommentMention 

type CommentMention struct {
	Url *string `json:"url,omitempty"`
	// Link references to related REST resources.
	Links interface{} `json:"_links,omitempty"`
	// The artifact portion of the parsed text. (i.e. the work item's id)
	ArtifactId *string `json:"artifactId,omitempty"`
	// The type the parser assigned to the mention. (i.e. person, work item, etc)
	ArtifactType *string `json:"artifactType,omitempty"`
	// The comment id of the mention.
	CommentId *int `json:"commentId,omitempty"`
	// The resolved target of the mention. An example of this could be a user's tfid
	TargetId *string `json:"targetId,omitempty"`
}

type CommentReaction 

type CommentReaction struct {
	Url *string `json:"url,omitempty"`
	// Link references to related REST resources.
	Links interface{} `json:"_links,omitempty"`
	// The id of the comment this reaction belongs to.
	CommentId *int `json:"commentId,omitempty"`
	// Total number of reactions for the CommentReactionType.
	Count *int `json:"count,omitempty"`
	// Flag to indicate if the current user has engaged on this particular EngagementType (e.g. if they liked the associated comment).
	IsCurrentUserEngaged *bool `json:"isCurrentUserEngaged,omitempty"`
	// Type of the reaction.
	Type *CommentReactionType `json:"type,omitempty"`
}

Contains information about work item comment reaction for a particular reaction type.

type CommentReactionType 

type CommentReactionType string

Represents different reaction types for a work item comment.

type CommentSortOrder 

type CommentSortOrder string

type CommentUpdate 

type CommentUpdate struct {
	// The updated text of the comment.
	Text *string `json:"text,omitempty"`
}

Represents a request to update a work item comment.

type CommentVersion 

type CommentVersion struct {
	Url *string `json:"url,omitempty"`
	// Link references to related REST resources.
	Links interface{} `json:"_links,omitempty"`
	// IdentityRef of the creator of the comment.
	CreatedBy *webapi.IdentityRef `json:"createdBy,omitempty"`
	// The creation date of the comment.
	CreatedDate *azuredevops.Time `json:"createdDate,omitempty"`
	// Effective Date/time value for adding the comment. Can be optionally different from CreatedDate.
	CreatedOnBehalfDate *azuredevops.Time `json:"createdOnBehalfDate,omitempty"`
	// Identity on whose behalf this comment has been added. Can be optionally different from CreatedBy.
	CreatedOnBehalfOf *webapi.IdentityRef `json:"createdOnBehalfOf,omitempty"`
	// The id assigned to the comment.
	Id *int `json:"id,omitempty"`
	// Indicates if the comment has been deleted at this version.
	IsDeleted *bool `json:"isDeleted,omitempty"`
	// IdentityRef of the user who modified the comment at this version.
	ModifiedBy *webapi.IdentityRef `json:"modifiedBy,omitempty"`
	// The modification date of the comment for this version.
	ModifiedDate *azuredevops.Time `json:"modifiedDate,omitempty"`
	// The rendered content of the comment at this version.
	RenderedText *string `json:"renderedText,omitempty"`
	// The text of the comment at this version.
	Text *string `json:"text,omitempty"`
	// The version number.
	Version *int `json:"version,omitempty"`
}

Represents a specific version of a comment on a work item.

type CreateAttachmentArgs 

type CreateAttachmentArgs struct {
	// (required) Stream to upload
	UploadStream io.Reader
	// (optional) Project ID or project name
	Project *string
	// (optional) The name of the file
	FileName *string
	// (optional) Attachment upload type: Simple or Chunked
	UploadType *string
	// (optional) Target project Area Path
	AreaPath *string
}

Arguments for the CreateAttachment function

type CreateCommentReactionArgs 

type CreateCommentReactionArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) WorkItem ID
	WorkItemId *int
	// (required) Comment ID
	CommentId *int
	// (required) Type of the reaction
	ReactionType *CommentReactionType
}

Arguments for the CreateCommentReaction function

type CreateOrUpdateClassificationNodeArgs 

type CreateOrUpdateClassificationNodeArgs struct {
	// (required) Node to create or update.
	PostedNode *WorkItemClassificationNode
	// (required) Project ID or project name
	Project *string
	// (required) Structure group of the classification node, area or iteration.
	StructureGroup *TreeStructureGroup
	// (optional) Path of the classification node.
	Path *string
}

Arguments for the CreateOrUpdateClassificationNode function

type CreateQueryArgs 

type CreateQueryArgs struct {
	// (required) The query to create.
	PostedQuery *QueryHierarchyItem
	// (required) Project ID or project name
	Project *string
	// (required) The parent id or path under which the query is to be created.
	Query *string
	// (optional) If you only want to validate your WIQL query without actually creating one, set it to true. Default is false.
	ValidateWiqlOnly *bool
}

Arguments for the CreateQuery function

type CreateTempQueryArgs 

type CreateTempQueryArgs struct {
	// (required) The temporary query to create
	PostedQuery *TemporaryQueryRequestModel
	// (required) Project ID or project name
	Project *string
}

Arguments for the CreateTempQuery function

type CreateTemplateArgs 

type CreateTemplateArgs struct {
	// (required) Template contents
	Template *WorkItemTemplate
	// (required) Project ID or project name
	Project *string
	// (required) Team ID or team name
	Team *string
}

Arguments for the CreateTemplate function

type CreateWorkItemArgs 

type CreateWorkItemArgs struct {
	// (required) The JSON Patch document representing the work item
	Document *[]webapi.JsonPatchOperation
	// (required) Project ID or project name
	Project *string
	// (required) The work item type of the work item to create
	Type *string
	// (optional) Indicate if you only want to validate the changes without saving the work item
	ValidateOnly *bool
	// (optional) Do not enforce the work item type rules on this update
	BypassRules *bool
	// (optional) Do not fire any notifications for this change
	SuppressNotifications *bool
	// (optional) The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }.
	Expand *WorkItemExpand
}

Arguments for the CreateWorkItem function

type CreateWorkItemFieldArgs 

type CreateWorkItemFieldArgs struct {
	// (required) New field definition
	WorkItemField *WorkItemField2
	// (optional) Project ID or project name
	Project *string
}

Arguments for the CreateWorkItemField function

type DeleteClassificationNodeArgs 

type DeleteClassificationNodeArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) Structure group of the classification node, area or iteration.
	StructureGroup *TreeStructureGroup
	// (optional) Path of the classification node.
	Path *string
	// (optional) Id of the target classification node for reclassification.
	ReclassifyId *int
}

Arguments for the DeleteClassificationNode function

type DeleteCommentArgs 

type DeleteCommentArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) Id of a work item.
	WorkItemId *int
	// (required)
	CommentId *int
}

Arguments for the DeleteComment function

type DeleteCommentReactionArgs 

type DeleteCommentReactionArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) WorkItem ID
	WorkItemId *int
	// (required) Comment ID
	CommentId *int
	// (required) Type of the reaction
	ReactionType *CommentReactionType
}

Arguments for the DeleteCommentReaction function

type DeleteQueryArgs 

type DeleteQueryArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) ID or path of the query or folder to delete.
	Query *string
}

Arguments for the DeleteQuery function

type DeleteTagArgs 

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

Arguments for the DeleteTag function

type DeleteTemplateArgs 

type DeleteTemplateArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) Team ID or team name
	Team *string
	// (required) Template id
	TemplateId *uuid.UUID
}

Arguments for the DeleteTemplate function

type DeleteWorkItemArgs 

type DeleteWorkItemArgs struct {
	// (required) ID of the work item to be deleted
	Id *int
	// (optional) Project ID or project name
	Project *string
	// (optional) Optional parameter, if set to true, the work item is deleted permanently. Please note: the destroy action is PERMANENT and cannot be undone.
	Destroy *bool
}

Arguments for the DeleteWorkItem function

type DeleteWorkItemFieldArgs 

type DeleteWorkItemFieldArgs struct {
	// (required) Field simple name or reference name
	FieldNameOrRefName *string
	// (optional) Project ID or project name
	Project *string
}

Arguments for the DeleteWorkItemField function

type DeleteWorkItemsArgs 

type DeleteWorkItemsArgs struct {
	// (required)
	DeleteRequest *WorkItemDeleteBatchRequest
	// (optional) Project ID or project name
	Project *string
}

Arguments for the DeleteWorkItems function

type DestroyWorkItemArgs 

type DestroyWorkItemArgs struct {
	// (required) ID of the work item to be destroyed permanently
	Id *int
	// (optional) Project ID or project name
	Project *string
}

Arguments for the DestroyWorkItem function

type EmailRecipients 

type EmailRecipients struct {
	// Plaintext email addresses.
	EmailAddresses *[]string `json:"emailAddresses,omitempty"`
	// TfIds
	TfIds *[]uuid.UUID `json:"tfIds,omitempty"`
	// Unresolved entity ids
	UnresolvedEntityIds *[]uuid.UUID `json:"unresolvedEntityIds,omitempty"`
}

type ExternalDeployment 

type ExternalDeployment struct {
	ArtifactId         *uuid.UUID           `json:"artifactId,omitempty"`
	CreatedBy          *uuid.UUID           `json:"createdBy,omitempty"`
	Description        *string              `json:"description,omitempty"`
	DisplayName        *string              `json:"displayName,omitempty"`
	Environment        *ExternalEnvironment `json:"environment,omitempty"`
	Group              *string              `json:"group,omitempty"`
	Pipeline           *ExternalPipeline    `json:"pipeline,omitempty"`
	RelatedWorkItemIds *[]int               `json:"relatedWorkItemIds,omitempty"`
	RunId              *int                 `json:"runId,omitempty"`
	SequenceNumber     *int                 `json:"sequenceNumber,omitempty"`
	Status             *string              `json:"status,omitempty"`
	StatusDate         *azuredevops.Time    `json:"statusDate,omitempty"`
	Url                *string              `json:"url,omitempty"`
}

type ExternalEnvironment 

type ExternalEnvironment struct {
	DisplayName *string `json:"displayName,omitempty"`
	Id          *int    `json:"id,omitempty"`
	Type        *string `json:"type,omitempty"`
}

type ExternalPipeline 

type ExternalPipeline struct {
	DisplayName *string `json:"displayName,omitempty"`
	Id          *int    `json:"id,omitempty"`
	Url         *string `json:"url,omitempty"`
}

type FieldDependentRule 

type FieldDependentRule struct {
	Url *string `json:"url,omitempty"`
	// Link references to related REST resources.
	Links interface{} `json:"_links,omitempty"`
	// The dependent fields.
	DependentFields *[]WorkItemFieldReference `json:"dependentFields,omitempty"`
}

Describes a list of dependent fields for a rule.

type FieldType 

type FieldType string

Enum for field types.

type FieldUpdate 

type FieldUpdate struct {
	// Indicates whether the user wants to restore the field.
	IsDeleted *bool `json:"isDeleted,omitempty"`
	// Indicates whether the user wants to lock the field.
	IsLocked *bool `json:"isLocked,omitempty"`
}

Describes an update request for a work item field.

type FieldUsage 

type FieldUsage string

Enum for field usages.

type GetAttachmentContentArgs 

type GetAttachmentContentArgs struct {
	// (required) Attachment ID
	Id *uuid.UUID
	// (optional) Project ID or project name
	Project *string
	// (optional) Name of the file
	FileName *string
	// (optional) If set to <c>true</c> always download attachment
	Download *bool
}

Arguments for the GetAttachmentContent function

type GetAttachmentZipArgs 

type GetAttachmentZipArgs struct {
	// (required) Attachment ID
	Id *uuid.UUID
	// (optional) Project ID or project name
	Project *string
	// (optional) Name of the file
	FileName *string
	// (optional) If set to <c>true</c> always download attachment
	Download *bool
}

Arguments for the GetAttachmentZip function

type GetClassificationNodeArgs 

type GetClassificationNodeArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) Structure group of the classification node, area or iteration.
	StructureGroup *TreeStructureGroup
	// (optional) Path of the classification node.
	Path *string
	// (optional) Depth of children to fetch.
	Depth *int
}

Arguments for the GetClassificationNode function

type GetClassificationNodesArgs 

type GetClassificationNodesArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) Comma separated integer classification nodes ids. It's not required, if you want root nodes.
	Ids *[]int
	// (optional) Depth of children to fetch.
	Depth *int
	// (optional) Flag to handle errors in getting some nodes. Possible options are Fail and Omit.
	ErrorPolicy *ClassificationNodesErrorPolicy
}

Arguments for the GetClassificationNodes function

type GetCommentArgs 

type GetCommentArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) Id of a work item to get the comment.
	WorkItemId *int
	// (required) Id of the comment to return.
	CommentId *int
	// (optional) Specify if the deleted comment should be retrieved.
	IncludeDeleted *bool
	// (optional) Specifies the additional data retrieval options for work item comments.
	Expand *CommentExpandOptions
}

Arguments for the GetComment function

type GetCommentReactionsArgs 

type GetCommentReactionsArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) WorkItem ID
	WorkItemId *int
	// (required) Comment ID
	CommentId *int
}

Arguments for the GetCommentReactions function

type GetCommentVersionArgs 

type GetCommentVersionArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required)
	WorkItemId *int
	// (required)
	CommentId *int
	// (required)
	Version *int
}

Arguments for the GetCommentVersion function

type GetCommentVersionsArgs 

type GetCommentVersionsArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required)
	WorkItemId *int
	// (required)
	CommentId *int
}

Arguments for the GetCommentVersions function

type GetCommentsArgs 

type GetCommentsArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) Id of a work item to get comments for.
	WorkItemId *int
	// (optional) Max number of comments to return.
	Top *int
	// (optional) Used to query for the next page of comments.
	ContinuationToken *string
	// (optional) Specify if the deleted comments should be retrieved.
	IncludeDeleted *bool
	// (optional) Specifies the additional data retrieval options for work item comments.
	Expand *CommentExpandOptions
	// (optional) Order in which the comments should be returned.
	Order *CommentSortOrder
}

Arguments for the GetComments function

type GetCommentsBatchArgs 

type GetCommentsBatchArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) Id of a work item to get comments for.
	WorkItemId *int
	// (required) Comma-separated list of comment ids to return.
	Ids *[]int
	// (optional) Specify if the deleted comments should be retrieved.
	IncludeDeleted *bool
	// (optional) Specifies the additional data retrieval options for work item comments.
	Expand *CommentExpandOptions
}

Arguments for the GetCommentsBatch function

type GetDeletedWorkItemArgs 

type GetDeletedWorkItemArgs struct {
	// (required) ID of the work item to be returned
	Id *int
	// (optional) Project ID or project name
	Project *string
}

Arguments for the GetDeletedWorkItem function

type GetDeletedWorkItemShallowReferencesArgs 

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

Arguments for the GetDeletedWorkItemShallowReferences function

type GetDeletedWorkItemsArgs 

type GetDeletedWorkItemsArgs struct {
	// (required) Comma separated list of IDs of the deleted work items to be returned
	Ids *[]int
	// (optional) Project ID or project name
	Project *string
}

Arguments for the GetDeletedWorkItems function

type GetEngagedUsersArgs 

type GetEngagedUsersArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) WorkItem ID.
	WorkItemId *int
	// (required) Comment ID.
	CommentId *int
	// (required) Type of the reaction.
	ReactionType *CommentReactionType
	// (optional)
	Top *int
	// (optional)
	Skip *int
}

Arguments for the GetEngagedUsers function

type GetFieldsExpand 

type GetFieldsExpand string

Flag to expand types of fields.

type GetGithubConnectionRepositoriesArgs 

type GetGithubConnectionRepositoriesArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required)
	ConnectionId *uuid.UUID
}

Arguments for the GetGithubConnectionRepositories function

type GetGithubConnectionsArgs 

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

Arguments for the GetGithubConnections function

type GetQueriesArgs 

type GetQueriesArgs struct {
	// (required) Project ID or project name
	Project *string
	// (optional) Include the query string (wiql), clauses, query result columns, and sort options in the results.
	Expand *QueryExpand
	// (optional) In the folder of queries, return child queries and folders to this depth.
	Depth *int
	// (optional) Include deleted queries and folders
	IncludeDeleted *bool
}

Arguments for the GetQueries function

type GetQueriesBatchArgs 

type GetQueriesBatchArgs struct {
	// (required)
	QueryGetRequest *QueryBatchGetRequest
	// (required) Project ID or project name
	Project *string
}

Arguments for the GetQueriesBatch function

type GetQueryArgs 

type GetQueryArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) ID or path of the query.
	Query *string
	// (optional) Include the query string (wiql), clauses, query result columns, and sort options in the results.
	Expand *QueryExpand
	// (optional) In the folder of queries, return child queries and folders to this depth.
	Depth *int
	// (optional) Include deleted queries and folders
	IncludeDeleted *bool
	// (optional) DateTime query clauses will be formatted using a ISO 8601 compliant format
	UseIsoDateFormat *bool
}

Arguments for the GetQuery function

type GetQueryResultCountArgs 

type GetQueryResultCountArgs struct {
	// (required) The query ID.
	Id *uuid.UUID
	// (optional) Project ID or project name
	Project *string
	// (optional) Team ID or team name
	Team *string
	// (optional) Whether or not to use time precision.
	TimePrecision *bool
	// (optional) The max number of results to return.
	Top *int
}

Arguments for the GetQueryResultCount function

type GetRecentActivityDataArgs 

type GetRecentActivityDataArgs struct {
}

Arguments for the GetRecentActivityData function

type GetRelationTypeArgs 

type GetRelationTypeArgs struct {
	// (required) The relation name
	Relation *string
}

Arguments for the GetRelationType function

type GetRelationTypesArgs 

type GetRelationTypesArgs struct {
}

Arguments for the GetRelationTypes function

type GetReportingLinksByLinkTypeArgs 

type GetReportingLinksByLinkTypeArgs struct {
	// (optional) Project ID or project name
	Project *string
	// (optional) A list of types to filter the results to specific link types. Omit this parameter to get work item links of all link types.
	LinkTypes *[]string
	// (optional) A list of types to filter the results to specific work item types. Omit this parameter to get work item links of all work item types.
	Types *[]string
	// (optional) Specifies the continuationToken to start the batch from. Omit this parameter to get the first batch of links.
	ContinuationToken *string
	// (optional) Date/time to use as a starting point for link changes. Only link changes that occurred after that date/time will be returned. Cannot be used in conjunction with 'watermark' parameter.
	StartDateTime *azuredevops.Time
}

Arguments for the GetReportingLinksByLinkType function

type GetRevisionArgs 

type GetRevisionArgs struct {
	// (required)
	Id *int
	// (required)
	RevisionNumber *int
	// (optional) Project ID or project name
	Project *string
	// (optional)
	Expand *WorkItemExpand
}

Arguments for the GetRevision function

type GetRevisionsArgs 

type GetRevisionsArgs struct {
	// (required)
	Id *int
	// (optional) Project ID or project name
	Project *string
	// (optional)
	Top *int
	// (optional)
	Skip *int
	// (optional)
	Expand *WorkItemExpand
}

Arguments for the GetRevisions function

type GetRootNodesArgs 

type GetRootNodesArgs struct {
	// (required) Project ID or project name
	Project *string
	// (optional) Depth of children to fetch.
	Depth *int
}

Arguments for the GetRootNodes function

type GetTagArgs 

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

Arguments for the GetTag function

type GetTagsArgs 

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

Arguments for the GetTags function

type GetTemplateArgs 

type GetTemplateArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) Team ID or team name
	Team *string
	// (required) Template Id
	TemplateId *uuid.UUID
}

Arguments for the GetTemplate function

type GetTemplatesArgs 

type GetTemplatesArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) Team ID or team name
	Team *string
	// (optional) Optional, When specified returns templates for given Work item type.
	Workitemtypename *string
}

Arguments for the GetTemplates function

type GetUpdateArgs 

type GetUpdateArgs struct {
	// (required)
	Id *int
	// (required)
	UpdateNumber *int
	// (optional) Project ID or project name
	Project *string
}

Arguments for the GetUpdate function

type GetUpdatesArgs 

type GetUpdatesArgs struct {
	// (required)
	Id *int
	// (optional) Project ID or project name
	Project *string
	// (optional)
	Top *int
	// (optional)
	Skip *int
}

Arguments for the GetUpdates function

type GetWorkArtifactLinkTypesArgs 

type GetWorkArtifactLinkTypesArgs struct {
}

Arguments for the GetWorkArtifactLinkTypes function

type GetWorkItemArgs 

type GetWorkItemArgs struct {
	// (required) The work item id
	Id *int
	// (optional) Project ID or project name
	Project *string
	// (optional) Comma-separated list of requested fields
	Fields *[]string
	// (optional) AsOf UTC date time string
	AsOf *azuredevops.Time
	// (optional) The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }.
	Expand *WorkItemExpand
}

Arguments for the GetWorkItem function

type GetWorkItemFieldArgs 

type GetWorkItemFieldArgs struct {
	// (required) Field simple name or reference name
	FieldNameOrRefName *string
	// (optional) Project ID or project name
	Project *string
}

Arguments for the GetWorkItemField function

type GetWorkItemFieldsArgs 

type GetWorkItemFieldsArgs struct {
	// (optional) Project ID or project name
	Project *string
	// (optional) Use ExtensionFields to include extension fields, otherwise exclude them. Unless the feature flag for this parameter is enabled, extension fields are always included.
	Expand *GetFieldsExpand
}

Arguments for the GetWorkItemFields function

type GetWorkItemIconJsonArgs 

type GetWorkItemIconJsonArgs struct {
	// (required) The name of the icon
	Icon *string
	// (optional) The 6-digit hex color for the icon
	Color *string
	// (optional) The version of the icon (used only for cache invalidation)
	V *int
}

Arguments for the GetWorkItemIconJson function

type GetWorkItemIconSvgArgs 

type GetWorkItemIconSvgArgs struct {
	// (required) The name of the icon
	Icon *string
	// (optional) The 6-digit hex color for the icon
	Color *string
	// (optional) The version of the icon (used only for cache invalidation)
	V *int
}

Arguments for the GetWorkItemIconSvg function

type GetWorkItemIconXamlArgs 

type GetWorkItemIconXamlArgs struct {
	// (required) The name of the icon
	Icon *string
	// (optional) The 6-digit hex color for the icon
	Color *string
	// (optional) The version of the icon (used only for cache invalidation)
	V *int
}

Arguments for the GetWorkItemIconXaml function

type GetWorkItemIconsArgs 

type GetWorkItemIconsArgs struct {
}

Arguments for the GetWorkItemIcons function

type GetWorkItemNextStatesOnCheckinActionArgs 

type GetWorkItemNextStatesOnCheckinActionArgs struct {
	// (required) list of work item ids
	Ids *[]int
	// (optional) possible actions. Currently only supports checkin
	Action *string
}

Arguments for the GetWorkItemNextStatesOnCheckinAction function

type GetWorkItemTemplateArgs 

type GetWorkItemTemplateArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) The work item type name
	Type *string
	// (optional) Comma-separated list of requested fields
	Fields *string
	// (optional) AsOf UTC date time string
	AsOf *azuredevops.Time
	// (optional) The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }.
	Expand *WorkItemExpand
}

Arguments for the GetWorkItemTemplate function

type GetWorkItemTypeArgs 

type GetWorkItemTypeArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) Work item type name
	Type *string
}

Arguments for the GetWorkItemType function

type GetWorkItemTypeCategoriesArgs 

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

Arguments for the GetWorkItemTypeCategories function

type GetWorkItemTypeCategoryArgs 

type GetWorkItemTypeCategoryArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) The category name
	Category *string
}

Arguments for the GetWorkItemTypeCategory function

type GetWorkItemTypeFieldWithReferencesArgs 

type GetWorkItemTypeFieldWithReferencesArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) Work item type.
	Type *string
	// (required)
	Field *string
	// (optional) Expand level for the API response. Properties: to include allowedvalues, default value, isRequired etc. as a part of response; None: to skip these properties.
	Expand *WorkItemTypeFieldsExpandLevel
}

Arguments for the GetWorkItemTypeFieldWithReferences function

type GetWorkItemTypeFieldsWithReferencesArgs 

type GetWorkItemTypeFieldsWithReferencesArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) Work item type.
	Type *string
	// (optional) Expand level for the API response. Properties: to include allowedvalues, default value, isRequired etc. as a part of response; None: to skip these properties.
	Expand *WorkItemTypeFieldsExpandLevel
}

Arguments for the GetWorkItemTypeFieldsWithReferences function

type GetWorkItemTypeStatesArgs 

type GetWorkItemTypeStatesArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) The state name
	Type *string
}

Arguments for the GetWorkItemTypeStates function

type GetWorkItemTypesArgs 

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

Arguments for the GetWorkItemTypes function

type GetWorkItemsArgs 

type GetWorkItemsArgs struct {
	// (required) The comma-separated list of requested work item ids. (Maximum 200 ids allowed).
	Ids *[]int
	// (optional) Project ID or project name
	Project *string
	// (optional) Comma-separated list of requested fields
	Fields *[]string
	// (optional) AsOf UTC date time string
	AsOf *azuredevops.Time
	// (optional) The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }.
	Expand *WorkItemExpand
	// (optional) The flag to control error policy in a bulk get work items request. Possible options are {Fail, Omit}.
	ErrorPolicy *WorkItemErrorPolicy
}

Arguments for the GetWorkItems function

type GetWorkItemsBatchArgs 

type GetWorkItemsBatchArgs struct {
	// (required)
	WorkItemGetRequest *WorkItemBatchGetRequest
	// (optional) Project ID or project name
	Project *string
}

Arguments for the GetWorkItemsBatch function

type GitHubConnectionModel 

type GitHubConnectionModel struct {
	// Github connection authorization type (f. e. PAT, OAuth)
	AuthorizationType *string `json:"authorizationType,omitempty"`
	// Github connection created by
	CreatedBy *webapi.IdentityRef `json:"createdBy,omitempty"`
	// Github connection id
	Id *uuid.UUID `json:"id,omitempty"`
	// Whether current Github connection is valid or not
	IsConnectionValid *bool `json:"isConnectionValid,omitempty"`
	// Github connection name (should contain organization/user name)
	Name *string `json:"name,omitempty"`
}

Describes Github connection.

type GitHubConnectionRepoModel 

type GitHubConnectionRepoModel struct {
	// Error message
	ErrorMessage *string `json:"errorMessage,omitempty"`
	// Repository web url
	GitHubRepositoryUrl *string `json:"gitHubRepositoryUrl,omitempty"`
}

Describes Github connection's repo.

type GitHubConnectionReposBatchRequest 

type GitHubConnectionReposBatchRequest struct {
	// Requested repos urls
	GitHubRepositoryUrls *[]GitHubConnectionRepoModel `json:"gitHubRepositoryUrls,omitempty"`
	// Operation type (f. e. add, remove)
	OperationType *string `json:"operationType,omitempty"`
}

Describes Github connection's repo bulk request

type IdentityReference 

type IdentityReference struct {
	// This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject.
	Links interface{} `json:"_links,omitempty"`
	// The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.
	Descriptor *string `json:"descriptor,omitempty"`
	// This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.
	DisplayName *string `json:"displayName,omitempty"`
	// This url is the full route to the source resource of this graph subject.
	Url *string `json:"url,omitempty"`
	// Deprecated - Can be retrieved by querying the Graph user referenced in the "self" entry of the IdentityRef "_links" dictionary
	DirectoryAlias *string `json:"directoryAlias,omitempty"`
	// Deprecated - Available in the "avatar" entry of the IdentityRef "_links" dictionary
	ImageUrl *string `json:"imageUrl,omitempty"`
	// Deprecated - Can be retrieved by querying the Graph membership state referenced in the "membershipState" entry of the GraphUser "_links" dictionary
	Inactive *bool `json:"inactive,omitempty"`
	// Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
	IsAadIdentity *bool `json:"isAadIdentity,omitempty"`
	// Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)
	IsContainer       *bool `json:"isContainer,omitempty"`
	IsDeletedInOrigin *bool `json:"isDeletedInOrigin,omitempty"`
	// Deprecated - not in use in most preexisting implementations of ToIdentityRef
	ProfileUrl *string `json:"profileUrl,omitempty"`
	// Deprecated - use Domain+PrincipalName instead
	UniqueName *string    `json:"uniqueName,omitempty"`
	Id         *uuid.UUID `json:"id,omitempty"`
	// Legacy back-compat property. This has been the WIT specific value from Constants. Will be hidden (but exists) on the client unless they are targeting the newest version
	Name *string `json:"name,omitempty"`
}

Describes a reference to an identity. 

type Link struct {
	// Collection of link attributes.
	Attributes *map[string]interface{} `json:"attributes,omitempty"`
	// Relation type.
	Rel *string `json:"rel,omitempty"`
	// Link url.
	Url *string `json:"url,omitempty"`
}

Link description.

type LinkQueryMode 

type LinkQueryMode string

The link query mode which determines the behavior of the query.

type LogicalOperation 

type LogicalOperation string

type MailMessage 

type MailMessage struct {
	// The mail body in HTML format.
	Body *string `json:"body,omitempty"`
	// CC recipients.
	Cc *EmailRecipients `json:"cc,omitempty"`
	// The in-reply-to header value
	InReplyTo *string `json:"inReplyTo,omitempty"`
	// The Message Id value
	MessageId *string `json:"messageId,omitempty"`
	// Reply To recipients.
	ReplyTo *EmailRecipients `json:"replyTo,omitempty"`
	// The mail subject.
	Subject *string `json:"subject,omitempty"`
	// To recipients
	To *EmailRecipients `json:"to,omitempty"`
}

type MigrateProjectsProcessArgs 

type MigrateProjectsProcessArgs struct {
	// (required)
	NewProcess *ProcessIdModel
	// (required) Project ID or project name
	Project *string
}

Arguments for the MigrateProjectsProcess function

type ProcessIdModel 

type ProcessIdModel struct {
	// The ID of the process.
	TypeId *uuid.UUID `json:"typeId,omitempty"`
}

Stores process ID.

type ProcessMigrationResultModel 

type ProcessMigrationResultModel struct {
	// The ID of the process.
	ProcessId *uuid.UUID `json:"processId,omitempty"`
	// The ID of the project.
	ProjectId *uuid.UUID `json:"projectId,omitempty"`
}

Stores project ID and its process ID.

type ProjectWorkItemStateColors 

type ProjectWorkItemStateColors struct {
	// Project name
	ProjectName *string `json:"projectName,omitempty"`
	// State colors for all work item type in a project
	WorkItemTypeStateColors *[]WorkItemTypeStateColors `json:"workItemTypeStateColors,omitempty"`
}

Project work item type state colors

type ProvisioningActionType 

type ProvisioningActionType string

Enumerates the possible provisioning actions that can be triggered on process template update.

type ProvisioningResult 

type ProvisioningResult struct {
	// Details about of the provisioning import events.
	ProvisioningImportEvents *[]string `json:"provisioningImportEvents,omitempty"`
}

Result of an update work item type XML update operation.

type QueryBatchGetRequest 

type QueryBatchGetRequest struct {
	// The expand parameters for queries. Possible options are { None, Wiql, Clauses, All, Minimal }
	Expand *QueryExpand `json:"$expand,omitempty"`
	// The flag to control error policy in a query batch request. Possible options are { Fail, Omit }.
	ErrorPolicy *QueryErrorPolicy `json:"errorPolicy,omitempty"`
	// The requested query ids
	Ids *[]uuid.UUID `json:"ids,omitempty"`
}

Describes a request to get a list of queries

type QueryByIdArgs 

type QueryByIdArgs struct {
	// (required) The query ID.
	Id *uuid.UUID
	// (optional) Project ID or project name
	Project *string
	// (optional) Team ID or team name
	Team *string
	// (optional) Whether or not to use time precision.
	TimePrecision *bool
	// (optional) The max number of results to return.
	Top *int
}

Arguments for the QueryById function

type QueryByWiqlArgs 

type QueryByWiqlArgs struct {
	// (required) The query containing the WIQL.
	Wiql *Wiql
	// (optional) Project ID or project name
	Project *string
	// (optional) Team ID or team name
	Team *string
	// (optional) Whether or not to use time precision.
	TimePrecision *bool
	// (optional) The max number of results to return.
	Top *int
}

Arguments for the QueryByWiql function

type QueryErrorPolicy 

type QueryErrorPolicy string

Enum to control error policy in a query batch request.

type QueryExpand 

type QueryExpand string

Determines which set of additional query properties to display

type QueryHierarchyItem 

type QueryHierarchyItem struct {
	Url *string `json:"url,omitempty"`
	// Link references to related REST resources.
	Links interface{} `json:"_links,omitempty"`
	// The clauses for a flat query.
	Clauses *WorkItemQueryClause `json:"clauses,omitempty"`
	// The columns of the query.
	Columns *[]WorkItemFieldReference `json:"columns,omitempty"`
	// The identity who created the query item.
	CreatedBy *IdentityReference `json:"createdBy,omitempty"`
	// When the query item was created.
	CreatedDate *azuredevops.Time `json:"createdDate,omitempty"`
	// The link query mode.
	FilterOptions *LinkQueryMode `json:"filterOptions,omitempty"`
	// If this is a query folder, indicates if it contains any children.
	HasChildren *bool `json:"hasChildren,omitempty"`
	// The child query items inside a query folder.
	Children *[]QueryHierarchyItem `json:"children,omitempty"`
	// The id of the query item.
	Id *uuid.UUID `json:"id,omitempty"`
	// Indicates if this query item is deleted. Setting this to false on a deleted query item will undelete it. Undeleting a query or folder will not bring back the permission changes that were previously applied to it.
	IsDeleted *bool `json:"isDeleted,omitempty"`
	// Indicates if this is a query folder or a query.
	IsFolder *bool `json:"isFolder,omitempty"`
	// Indicates if the WIQL of this query is invalid. This could be due to invalid syntax or a no longer valid area/iteration path.
	IsInvalidSyntax *bool `json:"isInvalidSyntax,omitempty"`
	// Indicates if this query item is public or private.
	IsPublic *bool `json:"isPublic,omitempty"`
	// The identity who last ran the query.
	LastExecutedBy *IdentityReference `json:"lastExecutedBy,omitempty"`
	// When the query was last run.
	LastExecutedDate *azuredevops.Time `json:"lastExecutedDate,omitempty"`
	// The identity who last modified the query item.
	LastModifiedBy *IdentityReference `json:"lastModifiedBy,omitempty"`
	// When the query item was last modified.
	LastModifiedDate *azuredevops.Time `json:"lastModifiedDate,omitempty"`
	// The link query clause.
	LinkClauses *WorkItemQueryClause `json:"linkClauses,omitempty"`
	// The name of the query item.
	Name *string `json:"name,omitempty"`
	// The path of the query item.
	Path *string `json:"path,omitempty"`
	// The recursion option for use in a tree query.
	QueryRecursionOption *QueryRecursionOption `json:"queryRecursionOption,omitempty"`
	// The type of query.
	QueryType *QueryType `json:"queryType,omitempty"`
	// The sort columns of the query.
	SortColumns *[]WorkItemQuerySortColumn `json:"sortColumns,omitempty"`
	// The source clauses in a tree or one-hop link query.
	SourceClauses *WorkItemQueryClause `json:"sourceClauses,omitempty"`
	// The target clauses in a tree or one-hop link query.
	TargetClauses *WorkItemQueryClause `json:"targetClauses,omitempty"`
	// The WIQL text of the query
	Wiql *string `json:"wiql,omitempty"`
}

Represents an item in the work item query hierarchy. This can be either a query or a folder.

type QueryHierarchyItemsResult 

type QueryHierarchyItemsResult struct {
	// The count of items.
	Count *int `json:"count,omitempty"`
	// Indicates if the max return limit was hit but there are still more items
	HasMore *bool `json:"hasMore,omitempty"`
	// The list of items
	Value *[]QueryHierarchyItem `json:"value,omitempty"`
}

type QueryOption 

type QueryOption string

type QueryRecursionOption 

type QueryRecursionOption string

Determines whether a tree query matches parents or children first.

type QueryResultType 

type QueryResultType string

The query result type

type QueryType 

type QueryType string

The type of query.

type QueryWorkItemsForArtifactUrisArgs 

type QueryWorkItemsForArtifactUrisArgs struct {
	// (required) Defines a list of artifact URI for querying work items.
	ArtifactUriQuery *ArtifactUriQuery
	// (optional) Project ID or project name
	Project *string
}

Arguments for the QueryWorkItemsForArtifactUris function

type ReadReportingDiscussionsArgs 

type ReadReportingDiscussionsArgs struct {
	// (optional) Project ID or project name
	Project *string
	// (optional)
	ContinuationToken *string
	// (optional)
	MaxPageSize *int
}

Arguments for the ReadReportingDiscussions function

type ReadReportingRevisionsGetArgs 

type ReadReportingRevisionsGetArgs struct {
	// (optional) Project ID or project name
	Project *string
	// (optional) A list of fields to return in work item revisions. Omit this parameter to get all reportable fields.
	Fields *[]string
	// (optional) A list of types to filter the results to specific work item types. Omit this parameter to get work item revisions of all work item types.
	Types *[]string
	// (optional) Specifies the watermark to start the batch from. Omit this parameter to get the first batch of revisions.
	ContinuationToken *string
	// (optional) Date/time to use as a starting point for revisions, all revisions will occur after this date/time. Cannot be used in conjunction with 'watermark' parameter.
	StartDateTime *azuredevops.Time
	// (optional) Return an identity reference instead of a string value for identity fields.
	IncludeIdentityRef *bool
	// (optional) Specify if the deleted item should be returned.
	IncludeDeleted *bool
	// (optional) Specify if the tag objects should be returned for System.Tags field.
	IncludeTagRef *bool
	// (optional) Return only the latest revisions of work items, skipping all historical revisions
	IncludeLatestOnly *bool
	// (optional) Return all the fields in work item revisions, including long text fields which are not returned by default
	Expand *ReportingRevisionsExpand
	// (optional) Return only the those revisions of work items, where only history field was changed
	IncludeDiscussionChangesOnly *bool
	// (optional) The maximum number of results to return in this batch
	MaxPageSize *int
}

Arguments for the ReadReportingRevisionsGet function

type ReadReportingRevisionsPostArgs 

type ReadReportingRevisionsPostArgs struct {
	// (required) An object that contains request settings: field filter, type filter, identity format
	Filter *ReportingWorkItemRevisionsFilter
	// (optional) Project ID or project name
	Project *string
	// (optional) Specifies the watermark to start the batch from. Omit this parameter to get the first batch of revisions.
	ContinuationToken *string
	// (optional) Date/time to use as a starting point for revisions, all revisions will occur after this date/time. Cannot be used in conjunction with 'watermark' parameter.
	StartDateTime *azuredevops.Time
	// (optional)
	Expand *ReportingRevisionsExpand
}

Arguments for the ReadReportingRevisionsPost function

type ReplaceTemplateArgs 

type ReplaceTemplateArgs struct {
	// (required) Template contents to replace with
	TemplateContent *WorkItemTemplate
	// (required) Project ID or project name
	Project *string
	// (required) Team ID or team name
	Team *string
	// (required) Template id
	TemplateId *uuid.UUID
}

Arguments for the ReplaceTemplate function

type ReportingRevisionsExpand 

type ReportingRevisionsExpand string

The reporting revision expand level.

type ReportingWorkItemLinksBatch 

type ReportingWorkItemLinksBatch struct {
	// ContinuationToken acts as a waterMark. Used while querying large results.
	ContinuationToken *string `json:"continuationToken,omitempty"`
	// Returns 'true' if it's last batch, 'false' otherwise.
	IsLastBatch *bool `json:"isLastBatch,omitempty"`
	// The next link for the work item.
	NextLink *string `json:"nextLink,omitempty"`
	// Values such as rel, sourceId, TargetId, ChangedDate, isActive.
	Values *[]interface{} `json:"values,omitempty"`
}

type ReportingWorkItemRevisionsBatch 

type ReportingWorkItemRevisionsBatch struct {
	// ContinuationToken acts as a waterMark. Used while querying large results.
	ContinuationToken *string `json:"continuationToken,omitempty"`
	// Returns 'true' if it's last batch, 'false' otherwise.
	IsLastBatch *bool `json:"isLastBatch,omitempty"`
	// The next link for the work item.
	NextLink *string `json:"nextLink,omitempty"`
	// Values such as rel, sourceId, TargetId, ChangedDate, isActive.
	Values *[]interface{} `json:"values,omitempty"`
}

type ReportingWorkItemRevisionsFilter 

type ReportingWorkItemRevisionsFilter struct {
	// A list of fields to return in work item revisions. Omit this parameter to get all reportable fields.
	Fields *[]string `json:"fields,omitempty"`
	// Include deleted work item in the result.
	IncludeDeleted *bool `json:"includeDeleted,omitempty"`
	// Return an identity reference instead of a string value for identity fields.
	IncludeIdentityRef *bool `json:"includeIdentityRef,omitempty"`
	// Include only the latest version of a work item, skipping over all previous revisions of the work item.
	IncludeLatestOnly *bool `json:"includeLatestOnly,omitempty"`
	// Include tag reference instead of string value for System.Tags field
	IncludeTagRef *bool `json:"includeTagRef,omitempty"`
	// A list of types to filter the results to specific work item types. Omit this parameter to get work item revisions of all work item types.
	Types *[]string `json:"types,omitempty"`
}

The class represents the reporting work item revision filer.

type RestoreWorkItemArgs 

type RestoreWorkItemArgs struct {
	// (required) Paylod with instructions to update the IsDeleted flag to false
	Payload *WorkItemDeleteUpdate
	// (required) ID of the work item to be restored
	Id *int
	// (optional) Project ID or project name
	Project *string
}

Arguments for the RestoreWorkItem function

type SearchQueriesArgs 

type SearchQueriesArgs struct {
	// (required) Project ID or project name
	Project *string
	// (required) The text to filter the queries with.
	Filter *string
	// (optional) The number of queries to return (Default is 50 and maximum is 200).
	Top *int
	// (optional)
	Expand *QueryExpand
	// (optional) Include deleted queries and folders
	IncludeDeleted *bool
}

Arguments for the SearchQueries function

type SendMailArgs 

type SendMailArgs struct {
	// (required)
	Body *SendMailBody
	// (optional) Project ID or project name
	Project *string
}

Arguments for the SendMail function

type SendMailBody 

type SendMailBody struct {
	Fields        *[]string    `json:"fields,omitempty"`
	Ids           *[]int       `json:"ids,omitempty"`
	Message       *MailMessage `json:"message,omitempty"`
	PersistenceId *uuid.UUID   `json:"persistenceId,omitempty"`
	ProjectId     *string      `json:"projectId,omitempty"`
	SortFields    *[]string    `json:"sortFields,omitempty"`
	TempQueryId   *string      `json:"tempQueryId,omitempty"`
	Wiql          *string      `json:"wiql,omitempty"`
}

type StreamedBatch 

type StreamedBatch struct {
	// ContinuationToken acts as a waterMark. Used while querying large results.
	ContinuationToken *string `json:"continuationToken,omitempty"`
	// Returns 'true' if it's last batch, 'false' otherwise.
	IsLastBatch *bool `json:"isLastBatch,omitempty"`
	// The next link for the work item.
	NextLink *string `json:"nextLink,omitempty"`
	// Values such as rel, sourceId, TargetId, ChangedDate, isActive.
	Values *[]interface{} `json:"values,omitempty"`
}

The class describes reporting work item revision batch.

type TemplateType 

type TemplateType string

Enumerates types of supported xml templates used for customization.

type TemporaryQueryRequestModel 

type TemporaryQueryRequestModel struct {
	Url *string `json:"url,omitempty"`
	// Link references to related REST resources.
	Links interface{} `json:"_links,omitempty"`
	// The WIQL text of the temporary query
	Wiql *string `json:"wiql,omitempty"`
}

Describes a request to create a temporary query

type TemporaryQueryResponseModel 

type TemporaryQueryResponseModel struct {
	// The id of the temporary query item.
	Id *uuid.UUID `json:"id,omitempty"`
}

The result of a temporary query creation.

type TreeNodeStructureType 

type TreeNodeStructureType string

Types of tree node structures.

type TreeStructureGroup 

type TreeStructureGroup string

Types of tree structures groups.

type UpdateClassificationNodeArgs 

type UpdateClassificationNodeArgs struct {
	// (required) Node to create or update.
	PostedNode *WorkItemClassificationNode
	// (required) Project ID or project name
	Project *string
	// (required) Structure group of the classification node, area or iteration.
	StructureGroup *TreeStructureGroup
	// (optional) Path of the classification node.
	Path *string
}

Arguments for the UpdateClassificationNode function

type UpdateCommentArgs 

type UpdateCommentArgs struct {
	// (required) Comment update request.
	Request *CommentUpdate
	// (required) Project ID or project name
	Project *string
	// (required) Id of a work item.
	WorkItemId *int
	// (required)
	CommentId *int
}

Arguments for the UpdateComment function

type UpdateGithubConnectionReposArgs 

type UpdateGithubConnectionReposArgs struct {
	// (required)
	ReposOperationData *GitHubConnectionReposBatchRequest
	// (required) Project ID or project name
	Project *string
	// (required)
	ConnectionId *uuid.UUID
}

Arguments for the UpdateGithubConnectionRepos function

type UpdateQueryArgs 

type UpdateQueryArgs struct {
	// (required) The query to update.
	QueryUpdate *QueryHierarchyItem
	// (required) Project ID or project name
	Project *string
	// (required) The ID or path for the query to update.
	Query *string
	// (optional) Undelete the children of this folder. It is important to note that this will not bring back the permission changes that were previously applied to the descendants.
	UndeleteDescendants *bool
}

Arguments for the UpdateQuery function

type UpdateTagArgs 

type UpdateTagArgs struct {
	// (required)
	TagData *WorkItemTagDefinition
	// (required) Project ID or project name
	Project *string
	// (required)
	TagIdOrName *string
}

Arguments for the UpdateTag function

type UpdateWorkItemArgs 

type UpdateWorkItemArgs struct {
	// (required) The JSON Patch document representing the update
	Document *[]webapi.JsonPatchOperation
	// (required) The id of the work item to update
	Id *int
	// (optional) Project ID or project name
	Project *string
	// (optional) Indicate if you only want to validate the changes without saving the work item
	ValidateOnly *bool
	// (optional) Do not enforce the work item type rules on this update
	BypassRules *bool
	// (optional) Do not fire any notifications for this change
	SuppressNotifications *bool
	// (optional) The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }.
	Expand *WorkItemExpand
}

Arguments for the UpdateWorkItem function

type UpdateWorkItemCommentArgs 

type UpdateWorkItemCommentArgs struct {
	// (required) Comment update request.
	Request *CommentUpdate
	// (required) Project ID or project name
	Project *string
	// (required) Id of a work item.
	WorkItemId *int
	// (required)
	CommentId *int
	// (required) Format of a work item comment (Markdown or Html).
	Format *CommentFormat
}

Arguments for the UpdateWorkItemComment function

type UpdateWorkItemField 

type UpdateWorkItemField struct {
	// Indicates whether the user wants to restore the field.
	IsDeleted *bool `json:"isDeleted,omitempty"`
}

Describes an update request for a work item field.

type UpdateWorkItemFieldArgs 

type UpdateWorkItemFieldArgs struct {
	// (required) Payload contains desired value of the field's properties
	Payload *FieldUpdate
	// (required) Name/reference name of the field to be updated
	FieldNameOrRefName *string
	// (optional) Project ID or project name
	Project *string
}

Arguments for the UpdateWorkItemField function

type Wiql 

type Wiql struct {
	// The text of the WIQL query
	Query *string `json:"query,omitempty"`
}

A WIQL query 

type WorkArtifactLink struct {
	// Target artifact type.
	ArtifactType *string `json:"artifactType,omitempty"`
	// Outbound link type.
	LinkType *string `json:"linkType,omitempty"`
	// Target tool type.
	ToolType *string `json:"toolType,omitempty"`
}

A work artifact link describes an outbound artifact link type.

type WorkItem 

type WorkItem struct {
	Url *string `json:"url,omitempty"`
	// Link references to related REST resources.
	Links interface{} `json:"_links,omitempty"`
	// Reference to a specific version of the comment added/edited/deleted in this revision.
	CommentVersionRef *WorkItemCommentVersionRef `json:"commentVersionRef,omitempty"`
	// Map of field and values for the work item.
	Fields *map[string]interface{} `json:"fields,omitempty"`
	// The work item ID.
	Id *int `json:"id,omitempty"`
	// Relations of the work item.
	Relations *[]WorkItemRelation `json:"relations,omitempty"`
	// Revision number of the work item.
	Rev *int `json:"rev,omitempty"`
}

Describes a work item.

type WorkItemBatchGetRequest 

type WorkItemBatchGetRequest struct {
	// The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }
	Expand *WorkItemExpand `json:"$expand,omitempty"`
	// AsOf UTC date time string
	AsOf *azuredevops.Time `json:"asOf,omitempty"`
	// The flag to control error policy in a bulk get work items request. Possible options are {Fail, Omit}.
	ErrorPolicy *WorkItemErrorPolicy `json:"errorPolicy,omitempty"`
	// The requested fields
	Fields *[]string `json:"fields,omitempty"`
	// The requested work item ids
	Ids *[]int `json:"ids,omitempty"`
}

Describes a request to get a set of work items

type WorkItemClassificationNode 

type WorkItemClassificationNode struct {
	Url *string `json:"url,omitempty"`
	// Link references to related REST resources.
	Links interface{} `json:"_links,omitempty"`
	// Dictionary that has node attributes like start/finish date for iteration nodes.
	Attributes *map[string]interface{} `json:"attributes,omitempty"`
	// Flag that indicates if the classification node has any child nodes.
	HasChildren *bool `json:"hasChildren,omitempty"`
	// List of child nodes fetched.
	Children *[]WorkItemClassificationNode `json:"children,omitempty"`
	// Integer ID of the classification node.
	Id *int `json:"id,omitempty"`
	// GUID ID of the classification node.
	Identifier *uuid.UUID `json:"identifier,omitempty"`
	// Name of the classification node.
	Name *string `json:"name,omitempty"`
	// Path of the classification node.
	Path *string `json:"path,omitempty"`
	// Node structure type.
	StructureType *TreeNodeStructureType `json:"structureType,omitempty"`
}

Defines a classification node for work item tracking.

type WorkItemComment 

type WorkItemComment struct {
	Url *string `json:"url,omitempty"`
	// Link references to related REST resources.
	Links interface{} `json:"_links,omitempty"`
	// Represents the possible types for the comment format.
	Format *CommentFormat `json:"format,omitempty"`
	// The text of the comment in HTML format.
	RenderedText *string `json:"renderedText,omitempty"`
	// Identity of user who added the comment.
	RevisedBy *IdentityReference `json:"revisedBy,omitempty"`
	// The date of comment.
	RevisedDate *azuredevops.Time `json:"revisedDate,omitempty"`
	// The work item revision number.
	Revision *int `json:"revision,omitempty"`
	// The text of the comment.
	Text *string `json:"text,omitempty"`
}

Comment on Work Item

type WorkItemCommentVersionRef 

type WorkItemCommentVersionRef struct {
	Url *string `json:"url,omitempty"`
	// The id assigned to the comment.
	CommentId *int `json:"commentId,omitempty"`
	// [Internal] The work item revision where this comment was originally added.
	CreatedInRevision *int `json:"createdInRevision,omitempty"`
	// [Internal] Specifies whether comment was deleted.
	IsDeleted *bool `json:"isDeleted,omitempty"`
	// [Internal] The text of the comment.
	Text *string `json:"text,omitempty"`
	// The version number.
	Version *int `json:"version,omitempty"`
}

Represents the reference to a specific version of a comment on a Work Item.

type WorkItemComments 

type WorkItemComments struct {
	Url *string `json:"url,omitempty"`
	// Link references to related REST resources.
	Links interface{} `json:"_links,omitempty"`
	// Comments collection.
	Comments *[]WorkItemComment `json:"comments,omitempty"`
	// The count of comments.
	Count *int `json:"count,omitempty"`
	// Count of comments from the revision.
	FromRevisionCount *int `json:"fromRevisionCount,omitempty"`
	// Total count of comments.
	TotalCount *int `json:"totalCount,omitempty"`
}

Collection of comments.

type WorkItemDelete 

type WorkItemDelete struct {
	// The HTTP status code for work item operation in a batch request.
	Code *int `json:"code,omitempty"`
	// The user who deleted the work item type.
	DeletedBy *string `json:"deletedBy,omitempty"`
	// The work item deletion date.
	DeletedDate *string `json:"deletedDate,omitempty"`
	// Work item ID.
	Id *int `json:"id,omitempty"`
	// The exception message for work item operation in a batch request.
	Message *string `json:"message,omitempty"`
	// Name or title of the work item.
	Name *string `json:"name,omitempty"`
	// Parent project of the deleted work item.
	Project *string `json:"project,omitempty"`
	// Type of work item.
	Type *string `json:"type,omitempty"`
	// REST API URL of the resource
	Url *string `json:"url,omitempty"`
	// The work item object that was deleted.
	Resource *WorkItem `json:"resource,omitempty"`
}

Full deleted work item object. Includes the work item itself.

type WorkItemDeleteBatch 

type WorkItemDeleteBatch struct {
	// List of results for each work item
	Results *[]WorkItemDelete `json:"results,omitempty"`
}

Describes response to delete a set of work items.

type WorkItemDeleteBatchRequest 

type WorkItemDeleteBatchRequest struct {
	// Optional parameter, if set to true, the work item is deleted permanently. Please note: the destroy action is PERMANENT and cannot be undone.
	Destroy *bool `json:"destroy,omitempty"`
	// The requested work item ids
	Ids *[]int `json:"ids,omitempty"`
	// Optional parameter, if set to true, notifications will be disabled.
	SkipNotifications *bool `json:"skipNotifications,omitempty"`
}

Describes a request to delete a set of work items

type WorkItemDeleteReference 

type WorkItemDeleteReference struct {
	// The HTTP status code for work item operation in a batch request.
	Code *int `json:"code,omitempty"`
	// The user who deleted the work item type.
	DeletedBy *string `json:"deletedBy,omitempty"`
	// The work item deletion date.
	DeletedDate *string `json:"deletedDate,omitempty"`
	// Work item ID.
	Id *int `json:"id,omitempty"`
	// The exception message for work item operation in a batch request.
	Message *string `json:"message,omitempty"`
	// Name or title of the work item.
	Name *string `json:"name,omitempty"`
	// Parent project of the deleted work item.
	Project *string `json:"project,omitempty"`
	// Type of work item.
	Type *string `json:"type,omitempty"`
	// REST API URL of the resource
	Url *string `json:"url,omitempty"`
}

Reference to a deleted work item.

type WorkItemDeleteShallowReference 

type WorkItemDeleteShallowReference struct {
	// Work item ID.
	Id *int `json:"id,omitempty"`
	// REST API URL of the resource
	Url *string `json:"url,omitempty"`
}

Shallow Reference to a deleted work item.

type WorkItemDeleteUpdate 

type WorkItemDeleteUpdate struct {
	// Sets a value indicating whether this work item is deleted.
	IsDeleted *bool `json:"isDeleted,omitempty"`
}

Describes an update request for a deleted work item.

type WorkItemErrorPolicy 

type WorkItemErrorPolicy string

Enum to control error policy in a bulk get work items request.

type WorkItemExpand 

type WorkItemExpand string

Flag to control payload properties from get work item command.

type WorkItemField 

type WorkItemField struct {
	Url *string `json:"url,omitempty"`
	// Link references to related REST resources.
	Links interface{} `json:"_links,omitempty"`
	// Indicates whether the field is sortable in server queries.
	CanSortBy *bool `json:"canSortBy,omitempty"`
	// The description of the field.
	Description *string `json:"description,omitempty"`
	// Indicates whether this field is deleted.
	IsDeleted *bool `json:"isDeleted,omitempty"`
	// Indicates whether this field is an identity field.
	IsIdentity *bool `json:"isIdentity,omitempty"`
	// Indicates whether this instance is picklist.
	IsPicklist *bool `json:"isPicklist,omitempty"`
	// Indicates whether this instance is a suggested picklist .
	IsPicklistSuggested *bool `json:"isPicklistSuggested,omitempty"`
	// Indicates whether the field can be queried in the server.
	IsQueryable *bool `json:"isQueryable,omitempty"`
	// The name of the field.
	Name *string `json:"name,omitempty"`
	// If this field is picklist, the identifier of the picklist associated, otherwise null
	PicklistId *uuid.UUID `json:"picklistId,omitempty"`
	// Indicates whether the field is [read only].
	ReadOnly *bool `json:"readOnly,omitempty"`
	// The reference name of the field.
	ReferenceName *string `json:"referenceName,omitempty"`
	// The supported operations on this field.
	SupportedOperations *[]WorkItemFieldOperation `json:"supportedOperations,omitempty"`
	// The type of the field.
	Type *FieldType `json:"type,omitempty"`
	// The usage of the field.
	Usage *FieldUsage `json:"usage,omitempty"`
}

Describes a field on a work item and it's properties specific to that work item type.

type WorkItemField2 

type WorkItemField2 struct {
	Url *string `json:"url,omitempty"`
	// Link references to related REST resources.
	Links interface{} `json:"_links,omitempty"`
	// Indicates whether the field is sortable in server queries.
	CanSortBy *bool `json:"canSortBy,omitempty"`
	// The description of the field.
	Description *string `json:"description,omitempty"`
	// Indicates whether this field is deleted.
	IsDeleted *bool `json:"isDeleted,omitempty"`
	// Indicates whether this field is an identity field.
	IsIdentity *bool `json:"isIdentity,omitempty"`
	// Indicates whether this instance is picklist.
	IsPicklist *bool `json:"isPicklist,omitempty"`
	// Indicates whether this instance is a suggested picklist .
	IsPicklistSuggested *bool `json:"isPicklistSuggested,omitempty"`
	// Indicates whether the field can be queried in the server.
	IsQueryable *bool `json:"isQueryable,omitempty"`
	// The name of the field.
	Name *string `json:"name,omitempty"`
	// If this field is picklist, the identifier of the picklist associated, otherwise null
	PicklistId *uuid.UUID `json:"picklistId,omitempty"`
	// Indicates whether the field is [read only].
	ReadOnly *bool `json:"readOnly,omitempty"`
	// The reference name of the field.
	ReferenceName *string `json:"referenceName,omitempty"`
	// The supported operations on this field.
	SupportedOperations *[]WorkItemFieldOperation `json:"supportedOperations,omitempty"`
	// The type of the field.
	Type *FieldType `json:"type,omitempty"`
	// The usage of the field.
	Usage *FieldUsage `json:"usage,omitempty"`
	// Indicates whether this field is marked as locked for editing.
	IsLocked *bool `json:"isLocked,omitempty"`
}

Describes a field on a work item and it's properties specific to that work item type.

type WorkItemFieldAllowedValues 

type WorkItemFieldAllowedValues struct {
	// The list of field allowed values.
	AllowedValues *[]string `json:"allowedValues,omitempty"`
	// Name of the field.
	FieldName *string `json:"fieldName,omitempty"`
}

Describes the list of allowed values of the field.

type WorkItemFieldOperation 

type WorkItemFieldOperation struct {
	// Friendly name of the operation.
	Name *string `json:"name,omitempty"`
	// Reference name of the operation.
	ReferenceName *string `json:"referenceName,omitempty"`
}

Describes a work item field operation.

type WorkItemFieldReference 

type WorkItemFieldReference struct {
	// The friendly name of the field.
	Name *string `json:"name,omitempty"`
	// The reference name of the field.
	ReferenceName *string `json:"referenceName,omitempty"`
	// The REST URL of the resource.
	Url *string `json:"url,omitempty"`
}

Reference to a field in a work item

type WorkItemFieldUpdate 

type WorkItemFieldUpdate struct {
	// The new value of the field.
	NewValue interface{} `json:"newValue,omitempty"`
	// The old value of the field.
	OldValue interface{} `json:"oldValue,omitempty"`
}

Describes an update to a work item field.

type WorkItemHistory 

type WorkItemHistory struct {
	Url *string `json:"url,omitempty"`
	// Link references to related REST resources.
	Links       interface{}        `json:"_links,omitempty"`
	Rev         *int               `json:"rev,omitempty"`
	RevisedBy   *IdentityReference `json:"revisedBy,omitempty"`
	RevisedDate *azuredevops.Time  `json:"revisedDate,omitempty"`
	Value       *string            `json:"value,omitempty"`
}

type WorkItemIcon 

type WorkItemIcon struct {
	// The identifier of the icon.
	Id *string `json:"id,omitempty"`
	// The REST URL of the resource.
	Url *string `json:"url,omitempty"`
}

Reference to a work item icon. 

type WorkItemLink struct {
	// The type of link.
	Rel *string `json:"rel,omitempty"`
	// The source work item.
	Source *WorkItemReference `json:"source,omitempty"`
	// The target work item.
	Target *WorkItemReference `json:"target,omitempty"`
}

A link between two work items.

type WorkItemNextStateOnTransition 

type WorkItemNextStateOnTransition struct {
	// Error code if there is no next state transition possible.
	ErrorCode *string `json:"errorCode,omitempty"`
	// Work item ID.
	Id *int `json:"id,omitempty"`
	// Error message if there is no next state transition possible.
	Message *string `json:"message,omitempty"`
	// Name of the next state on transition.
	StateOnTransition *string `json:"stateOnTransition,omitempty"`
}

Describes the next state for a work item.

type WorkItemQueryClause 

type WorkItemQueryClause struct {
	// Child clauses if the current clause is a logical operator
	Clauses *[]WorkItemQueryClause `json:"clauses,omitempty"`
	// Field associated with condition
	Field *WorkItemFieldReference `json:"field,omitempty"`
	// Right side of the condition when a field to field comparison
	FieldValue *WorkItemFieldReference `json:"fieldValue,omitempty"`
	// Determines if this is a field to field comparison
	IsFieldValue *bool `json:"isFieldValue,omitempty"`
	// Logical operator separating the condition clause
	LogicalOperator *LogicalOperation `json:"logicalOperator,omitempty"`
	// The field operator
	Operator *WorkItemFieldOperation `json:"operator,omitempty"`
	// Right side of the condition when a field to value comparison
	Value *string `json:"value,omitempty"`
}

Represents a clause in a work item query. This shows the structure of a work item query.

type WorkItemQueryResult 

type WorkItemQueryResult struct {
	// The date the query was run in the context of.
	AsOf *azuredevops.Time `json:"asOf,omitempty"`
	// The columns of the query.
	Columns *[]WorkItemFieldReference `json:"columns,omitempty"`
	// The result type
	QueryResultType *QueryResultType `json:"queryResultType,omitempty"`
	// The type of the query
	QueryType *QueryType `json:"queryType,omitempty"`
	// The sort columns of the query.
	SortColumns *[]WorkItemQuerySortColumn `json:"sortColumns,omitempty"`
	// The work item links returned by the query.
	WorkItemRelations *[]WorkItemLink `json:"workItemRelations,omitempty"`
	// The work items returned by the query.
	WorkItems *[]WorkItemReference `json:"workItems,omitempty"`
}

The result of a work item query.

type WorkItemQuerySortColumn 

type WorkItemQuerySortColumn struct {
	// The direction to sort by.
	Descending *bool `json:"descending,omitempty"`
	// A work item field.
	Field *WorkItemFieldReference `json:"field,omitempty"`
}

A sort column.

type WorkItemRecentActivityType 

type WorkItemRecentActivityType string

Type of the activity

type WorkItemReference 

type WorkItemReference struct {
	// Work item ID.
	Id *int `json:"id,omitempty"`
	// REST API URL of the resource
	Url *string `json:"url,omitempty"`
}

Contains reference to a work item.

type WorkItemRelation 

type WorkItemRelation struct {
	// Collection of link attributes.
	Attributes *map[string]interface{} `json:"attributes,omitempty"`
	// Relation type.
	Rel *string `json:"rel,omitempty"`
	// Link url.
	Url *string `json:"url,omitempty"`
}

type WorkItemRelationType 

type WorkItemRelationType struct {
	Url *string `json:"url,omitempty"`
	// Link references to related REST resources.
	Links interface{} `json:"_links,omitempty"`
	// The name.
	Name *string `json:"name,omitempty"`
	// The reference name.
	ReferenceName *string `json:"referenceName,omitempty"`
	// The collection of relation type attributes.
	Attributes *map[string]interface{} `json:"attributes,omitempty"`
}

Represents the work item type relation type.

type WorkItemRelationUpdates 

type WorkItemRelationUpdates struct {
	// List of newly added relations.
	Added *[]WorkItemRelation `json:"added,omitempty"`
	// List of removed relations.
	Removed *[]WorkItemRelation `json:"removed,omitempty"`
	// List of updated relations.
	Updated *[]WorkItemRelation `json:"updated,omitempty"`
}

Describes updates to a work item's relations.

type WorkItemStateColor 

type WorkItemStateColor struct {
	// Category of state
	Category *string `json:"category,omitempty"`
	// Color value
	Color *string `json:"color,omitempty"`
	// Work item type state name
	Name *string `json:"name,omitempty"`
}

Work item type state name, color and state category

type WorkItemStateTransition 

type WorkItemStateTransition struct {
	// Gets a list of actions needed to transition to that state.
	Actions *[]string `json:"actions,omitempty"`
	// Name of the next state.
	To *string `json:"to,omitempty"`
}

Describes a state transition in a work item.

type WorkItemTagDefinition 

type WorkItemTagDefinition struct {
	Id          *uuid.UUID        `json:"id,omitempty"`
	LastUpdated *azuredevops.Time `json:"lastUpdated,omitempty"`
	Name        *string           `json:"name,omitempty"`
	Url         *string           `json:"url,omitempty"`
}

type WorkItemTemplate 

type WorkItemTemplate struct {
	Url *string `json:"url,omitempty"`
	// Link references to related REST resources.
	Links interface{} `json:"_links,omitempty"`
	// The description of the work item template.
	Description *string `json:"description,omitempty"`
	// The identifier of the work item template.
	Id *uuid.UUID `json:"id,omitempty"`
	// The name of the work item template.
	Name *string `json:"name,omitempty"`
	// The name of the work item type.
	WorkItemTypeName *string `json:"workItemTypeName,omitempty"`
	// Mapping of field and its templated value.
	Fields *map[string]string `json:"fields,omitempty"`
}

Describes a work item template.

type WorkItemTemplateReference 

type WorkItemTemplateReference struct {
	Url *string `json:"url,omitempty"`
	// Link references to related REST resources.
	Links interface{} `json:"_links,omitempty"`
	// The description of the work item template.
	Description *string `json:"description,omitempty"`
	// The identifier of the work item template.
	Id *uuid.UUID `json:"id,omitempty"`
	// The name of the work item template.
	Name *string `json:"name,omitempty"`
	// The name of the work item type.
	WorkItemTypeName *string `json:"workItemTypeName,omitempty"`
}

Describes a shallow reference to a work item template.

type WorkItemTrackingReference 

type WorkItemTrackingReference struct {
	Url *string `json:"url,omitempty"`
	// Link references to related REST resources.
	Links interface{} `json:"_links,omitempty"`
	// The name.
	Name *string `json:"name,omitempty"`
	// The reference name.
	ReferenceName *string `json:"referenceName,omitempty"`
}

type WorkItemTrackingResource 

type WorkItemTrackingResource struct {
	Url *string `json:"url,omitempty"`
	// Link references to related REST resources.
	Links interface{} `json:"_links,omitempty"`
}

Base class for WIT REST resources.

type WorkItemTrackingResourceReference 

type WorkItemTrackingResourceReference struct {
	Url *string `json:"url,omitempty"`
}

Base class for work item tracking resource references.

type WorkItemType 

type WorkItemType struct {
	Url *string `json:"url,omitempty"`
	// Link references to related REST resources.
	Links interface{} `json:"_links,omitempty"`
	// The color.
	Color *string `json:"color,omitempty"`
	// The description of the work item type.
	Description *string `json:"description,omitempty"`
	// The fields that exist on the work item type.
	FieldInstances *[]WorkItemTypeFieldInstance `json:"fieldInstances,omitempty"`
	// The fields that exist on the work item type.
	Fields *[]WorkItemTypeFieldInstance `json:"fields,omitempty"`
	// The icon of the work item type.
	Icon *WorkItemIcon `json:"icon,omitempty"`
	// True if work item type is disabled
	IsDisabled *bool `json:"isDisabled,omitempty"`
	// Gets the name of the work item type.
	Name *string `json:"name,omitempty"`
	// The reference name of the work item type.
	ReferenceName *string `json:"referenceName,omitempty"`
	// Gets state information for the work item type.
	States *[]WorkItemStateColor `json:"states,omitempty"`
	// Gets the various state transition mappings in the work item type.
	Transitions *map[string][]WorkItemStateTransition `json:"transitions,omitempty"`
	// The XML form.
	XmlForm *string `json:"xmlForm,omitempty"`
}

Describes a work item type.

type WorkItemTypeCategory 

type WorkItemTypeCategory struct {
	Url *string `json:"url,omitempty"`
	// Link references to related REST resources.
	Links interface{} `json:"_links,omitempty"`
	// Gets or sets the default type of the work item.
	DefaultWorkItemType *WorkItemTypeReference `json:"defaultWorkItemType,omitempty"`
	// The name of the category.
	Name *string `json:"name,omitempty"`
	// The reference name of the category.
	ReferenceName *string `json:"referenceName,omitempty"`
	// The work item types that belong to the category.
	WorkItemTypes *[]WorkItemTypeReference `json:"workItemTypes,omitempty"`
}

Describes a work item type category.

type WorkItemTypeColor 

type WorkItemTypeColor struct {
	// Gets or sets the color of the primary.
	PrimaryColor *string `json:"primaryColor,omitempty"`
	// Gets or sets the color of the secondary.
	SecondaryColor *string `json:"secondaryColor,omitempty"`
	// The name of the work item type.
	WorkItemTypeName *string `json:"workItemTypeName,omitempty"`
}

Describes a work item type's colors.

type WorkItemTypeColorAndIcon 

type WorkItemTypeColorAndIcon struct {
	// The color of the work item type in hex format.
	Color *string `json:"color,omitempty"`
	// The work item type icon.
	Icon *string `json:"icon,omitempty"`
	// Indicates if the work item is disabled in the process.
	IsDisabled *bool `json:"isDisabled,omitempty"`
	// The name of the work item type.
	WorkItemTypeName *string `json:"workItemTypeName,omitempty"`
}

Describes work item type name, its icon and color.

type WorkItemTypeFieldInstance 

type WorkItemTypeFieldInstance struct {
	// The friendly name of the field.
	Name *string `json:"name,omitempty"`
	// The reference name of the field.
	ReferenceName *string `json:"referenceName,omitempty"`
	// The REST URL of the resource.
	Url *string `json:"url,omitempty"`
	// Indicates whether field value is always required.
	AlwaysRequired *bool `json:"alwaysRequired,omitempty"`
	// The list of dependent fields.
	DependentFields *[]WorkItemFieldReference `json:"dependentFields,omitempty"`
	// Gets the help text for the field.
	HelpText *string `json:"helpText,omitempty"`
	// The list of field allowed values.
	AllowedValues *[]string `json:"allowedValues,omitempty"`
	// Represents the default value of the field.
	DefaultValue *string `json:"defaultValue,omitempty"`
}

Field instance of a work item type.

type WorkItemTypeFieldInstanceBase 

type WorkItemTypeFieldInstanceBase struct {
	// The friendly name of the field.
	Name *string `json:"name,omitempty"`
	// The reference name of the field.
	ReferenceName *string `json:"referenceName,omitempty"`
	// The REST URL of the resource.
	Url *string `json:"url,omitempty"`
	// Indicates whether field value is always required.
	AlwaysRequired *bool `json:"alwaysRequired,omitempty"`
	// The list of dependent fields.
	DependentFields *[]WorkItemFieldReference `json:"dependentFields,omitempty"`
	// Gets the help text for the field.
	HelpText *string `json:"helpText,omitempty"`
}

Base field instance for workItemType fields.

type WorkItemTypeFieldWithReferences 

type WorkItemTypeFieldWithReferences struct {
	// The friendly name of the field.
	Name *string `json:"name,omitempty"`
	// The reference name of the field.
	ReferenceName *string `json:"referenceName,omitempty"`
	// The REST URL of the resource.
	Url *string `json:"url,omitempty"`
	// Indicates whether field value is always required.
	AlwaysRequired *bool `json:"alwaysRequired,omitempty"`
	// The list of dependent fields.
	DependentFields *[]WorkItemFieldReference `json:"dependentFields,omitempty"`
	// Gets the help text for the field.
	HelpText *string `json:"helpText,omitempty"`
	// The list of field allowed values.
	AllowedValues *[]interface{} `json:"allowedValues,omitempty"`
	// Represents the default value of the field.
	DefaultValue interface{} `json:"defaultValue,omitempty"`
}

Field Instance of a workItemype with detailed references.

type WorkItemTypeFieldsExpandLevel 

type WorkItemTypeFieldsExpandLevel string

Expand options for the work item field(s) request.

type WorkItemTypeReference 

type WorkItemTypeReference struct {
	Url *string `json:"url,omitempty"`
	// Name of the work item type.
	Name *string `json:"name,omitempty"`
}

Reference to a work item type.

type WorkItemTypeStateColors 

type WorkItemTypeStateColors struct {
	// Work item type state colors
	StateColors *[]WorkItemStateColor `json:"stateColors,omitempty"`
	// Work item type name
	WorkItemTypeName *string `json:"workItemTypeName,omitempty"`
}

State colors for a work item type

type WorkItemTypeTemplate 

type WorkItemTypeTemplate struct {
	// XML template in string format.
	Template *string `json:"template,omitempty"`
}

Describes a work item type template.

type WorkItemTypeTemplateUpdateModel 

type WorkItemTypeTemplateUpdateModel struct {
	// Describes the type of the action for the update request.
	ActionType *ProvisioningActionType `json:"actionType,omitempty"`
	// Methodology to which the template belongs, eg. Agile, Scrum, CMMI.
	Methodology *string `json:"methodology,omitempty"`
	// String representation of the work item type template.
	Template *string `json:"template,omitempty"`
	// The type of the template described in the request body.
	TemplateType *TemplateType `json:"templateType,omitempty"`
}

Describes a update work item type template request body.

type WorkItemUpdate 

type WorkItemUpdate struct {
	Url *string `json:"url,omitempty"`
	// Link references to related REST resources.
	Links interface{} `json:"_links,omitempty"`
	// List of updates to fields.
	Fields *map[string]WorkItemFieldUpdate `json:"fields,omitempty"`
	// ID of update.
	Id *int `json:"id,omitempty"`
	// List of updates to relations.
	Relations *WorkItemRelationUpdates `json:"relations,omitempty"`
	// The revision number of work item update.
	Rev *int `json:"rev,omitempty"`
	// Identity for the work item update.
	RevisedBy *IdentityReference `json:"revisedBy,omitempty"`
	// The work item updates revision date.
	RevisedDate *azuredevops.Time `json:"revisedDate,omitempty"`
	// The work item ID.
	WorkItemId *int `json:"workItemId,omitempty"`
}

Describes an update to a work item.

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.