workitemtrackingprocess

package
v7.2.2 Latest Latest
Warning

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

 Go to latest Published: Mar 14, 2024 License: MIT Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var CustomizationTypeValues = customizationTypeValuesType{

	System: "system",

	Inherited: "inherited",

	Custom: "custom",
}
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",

	PicklistInteger: "picklistInteger",

	PicklistString: "picklistString",

	PicklistDouble: "picklistDouble",
}
View Source 
var GetBehaviorsExpandValues = getBehaviorsExpandValuesType{

	None: "none",

	Fields: "fields",

	CombinedFields: "combinedFields",
}
View Source 
var GetProcessExpandLevelValues = getProcessExpandLevelValuesType{

	None: "none",

	Projects: "projects",
}
View Source 
var GetWorkItemTypeExpandValues = getWorkItemTypeExpandValuesType{

	None: "none",

	States: "states",

	Behaviors: "behaviors",

	Layout: "layout",
}
View Source 
var PageTypeValues = pageTypeValuesType{

	Custom: "custom",

	History: "history",

	Links: "links",

	Attachments: "attachments",
}
View Source 
var ProcessClassValues = processClassValuesType{
	System:  "system",
	Derived: "derived",
	Custom:  "custom",
}
View Source 
var ProcessWorkItemTypeFieldsExpandLevelValues = processWorkItemTypeFieldsExpandLevelValuesType{

	None: "none",

	AllowedValues: "allowedValues",

	All: "all",
}
View Source 
var ResourceAreaId, _ = uuid.Parse("5264459e-e5e0-4bd8-b118-0985e68a4ec5")
View Source 
var RuleActionTypeValues = ruleActionTypeValuesType{

	MakeRequired: "makeRequired",

	MakeReadOnly: "makeReadOnly",

	SetDefaultValue: "setDefaultValue",

	SetDefaultFromClock: "setDefaultFromClock",

	SetDefaultFromCurrentUser: "setDefaultFromCurrentUser",

	SetDefaultFromField: "setDefaultFromField",

	CopyValue: "copyValue",

	CopyFromClock: "copyFromClock",

	CopyFromCurrentUser: "copyFromCurrentUser",

	CopyFromField: "copyFromField",

	SetValueToEmpty: "setValueToEmpty",

	CopyFromServerClock: "copyFromServerClock",

	CopyFromServerCurrentUser: "copyFromServerCurrentUser",

	HideTargetField: "hideTargetField",

	DisallowValue: "disallowValue",
}
View Source 
var RuleConditionTypeValues = ruleConditionTypeValuesType{

	When: "when",

	WhenNot: "whenNot",

	WhenChanged: "whenChanged",

	WhenNotChanged:                    "whenNotChanged",
	WhenWas:                           "whenWas",
	WhenStateChangedTo:                "whenStateChangedTo",
	WhenStateChangedFromAndTo:         "whenStateChangedFromAndTo",
	WhenWorkItemIsCreated:             "whenWorkItemIsCreated",
	WhenValueIsDefined:                "whenValueIsDefined",
	WhenValueIsNotDefined:             "whenValueIsNotDefined",
	WhenCurrentUserIsMemberOfGroup:    "whenCurrentUserIsMemberOfGroup",
	WhenCurrentUserIsNotMemberOfGroup: "whenCurrentUserIsNotMemberOfGroup",
}
View Source 
var WorkItemTypeClassValues = workItemTypeClassValuesType{
	System:  "system",
	Derived: "derived",
	Custom:  "custom",
}

Functions

This section is empty.

Types

type AddBehaviorToWorkItemTypeArgs 

type AddBehaviorToWorkItemTypeArgs struct {
	// (required)
	Behavior *WorkItemTypeBehavior
	// (required) The ID of the process
	ProcessId *uuid.UUID
	// (required) Work item type reference name for the behavior
	WitRefNameForBehaviors *string
}

Arguments for the AddBehaviorToWorkItemType function

type AddFieldToWorkItemTypeArgs 

type AddFieldToWorkItemTypeArgs struct {
	// (required)
	Field *AddProcessWorkItemTypeFieldRequest
	// (required) The ID of the process.
	ProcessId *uuid.UUID
	// (required) The reference name of the work item type.
	WitRefName *string
}

Arguments for the AddFieldToWorkItemType function

type AddGroupArgs 

type AddGroupArgs struct {
	// (required) The group.
	Group *Group
	// (required) The ID of the process.
	ProcessId *uuid.UUID
	// (required) The reference name of the work item type.
	WitRefName *string
	// (required) The ID of the page to add the group to.
	PageId *string
	// (required) The ID of the section to add the group to.
	SectionId *string
}

Arguments for the AddGroup function

type AddPageArgs 

type AddPageArgs struct {
	// (required) The page.
	Page *Page
	// (required) The ID of the process.
	ProcessId *uuid.UUID
	// (required) The reference name of the work item type.
	WitRefName *string
}

Arguments for the AddPage function

type AddProcessWorkItemTypeFieldRequest 

type AddProcessWorkItemTypeFieldRequest struct {
	// The list of field allowed values.
	AllowedValues *[]string `json:"allowedValues,omitempty"`
	// Allow setting field value to a group identity. Only applies to identity fields.
	AllowGroups *bool `json:"allowGroups,omitempty"`
	// The default value of the field.
	DefaultValue interface{} `json:"defaultValue,omitempty"`
	// If true the field cannot be edited.
	ReadOnly *bool `json:"readOnly,omitempty"`
	// Reference name of the field.
	ReferenceName *string `json:"referenceName,omitempty"`
	// If true the field cannot be empty.
	Required *bool `json:"required,omitempty"`
}

Class that describes a request to add a field in a work item type.

type AddProcessWorkItemTypeRuleArgs 

type AddProcessWorkItemTypeRuleArgs struct {
	// (required)
	ProcessRuleCreate *CreateProcessRuleRequest
	// (required) The ID of the process
	ProcessId *uuid.UUID
	// (required) The reference name of the work item type
	WitRefName *string
}

Arguments for the AddProcessWorkItemTypeRule function

type Client 

type Client interface {
	// [Preview API] Adds a behavior to the work item type of the process.
	AddBehaviorToWorkItemType(context.Context, AddBehaviorToWorkItemTypeArgs) (*WorkItemTypeBehavior, error)
	// [Preview API] Adds a field to a work item type.
	AddFieldToWorkItemType(context.Context, AddFieldToWorkItemTypeArgs) (*ProcessWorkItemTypeField, error)
	// [Preview API] Adds a group to the work item form.
	AddGroup(context.Context, AddGroupArgs) (*Group, error)
	// [Preview API] Adds a page to the work item form.
	AddPage(context.Context, AddPageArgs) (*Page, error)
	// [Preview API] Adds a rule to work item type in the process.
	AddProcessWorkItemTypeRule(context.Context, AddProcessWorkItemTypeRuleArgs) (*ProcessRule, error)
	// [Preview API] Creates a control in a group.
	CreateControlInGroup(context.Context, CreateControlInGroupArgs) (*Control, error)
	// [Preview API] Creates a picklist.
	CreateList(context.Context, CreateListArgs) (*PickList, error)
	// [Preview API] Creates a process.
	CreateNewProcess(context.Context, CreateNewProcessArgs) (*ProcessInfo, error)
	// [Preview API] Creates a single behavior in the given process.
	CreateProcessBehavior(context.Context, CreateProcessBehaviorArgs) (*ProcessBehavior, error)
	// [Preview API] Creates a work item type in the process.
	CreateProcessWorkItemType(context.Context, CreateProcessWorkItemTypeArgs) (*ProcessWorkItemType, error)
	// [Preview API] Creates a state definition in the work item type of the process.
	CreateStateDefinition(context.Context, CreateStateDefinitionArgs) (*WorkItemStateResultModel, error)
	// [Preview API] Removes a picklist.
	DeleteList(context.Context, DeleteListArgs) error
	// [Preview API] Removes a behavior in the process.
	DeleteProcessBehavior(context.Context, DeleteProcessBehaviorArgs) error
	// [Preview API] Removes a process of a specific ID.
	DeleteProcessById(context.Context, DeleteProcessByIdArgs) error
	// [Preview API] Removes a work item type in the process.
	DeleteProcessWorkItemType(context.Context, DeleteProcessWorkItemTypeArgs) error
	// [Preview API] Removes a rule from the work item type in the process.
	DeleteProcessWorkItemTypeRule(context.Context, DeleteProcessWorkItemTypeRuleArgs) error
	// [Preview API] Removes a state definition in the work item type of the process.
	DeleteStateDefinition(context.Context, DeleteStateDefinitionArgs) error
	// [Preview API] Deletes a system control modification on the work item form.
	DeleteSystemControl(context.Context, DeleteSystemControlArgs) (*[]Control, error)
	// [Preview API] Edit a process of a specific ID.
	EditProcess(context.Context, EditProcessArgs) (*ProcessInfo, error)
	// [Preview API] Returns a list of all fields in a work item type.
	GetAllWorkItemTypeFields(context.Context, GetAllWorkItemTypeFieldsArgs) (*[]ProcessWorkItemTypeField, error)
	// [Preview API] Returns a behavior for the work item type of the process.
	GetBehaviorForWorkItemType(context.Context, GetBehaviorForWorkItemTypeArgs) (*WorkItemTypeBehavior, error)
	// [Preview API] Returns a list of all behaviors for the work item type of the process.
	GetBehaviorsForWorkItemType(context.Context, GetBehaviorsForWorkItemTypeArgs) (*[]WorkItemTypeBehavior, error)
	// [Preview API] Gets the form layout.
	GetFormLayout(context.Context, GetFormLayoutArgs) (*FormLayout, error)
	// [Preview API] Returns a picklist.
	GetList(context.Context, GetListArgs) (*PickList, error)
	// [Preview API] Get list of all processes including system and inherited.
	GetListOfProcesses(context.Context, GetListOfProcessesArgs) (*[]ProcessInfo, error)
	// [Preview API] Returns meta data of the picklist.
	GetListsMetadata(context.Context, GetListsMetadataArgs) (*[]PickListMetadata, error)
	// [Preview API] Returns a behavior of the process.
	GetProcessBehavior(context.Context, GetProcessBehaviorArgs) (*ProcessBehavior, error)
	// [Preview API] Returns a list of all behaviors in the process.
	GetProcessBehaviors(context.Context, GetProcessBehaviorsArgs) (*[]ProcessBehavior, error)
	// [Preview API] Get a single process of a specified ID.
	GetProcessByItsId(context.Context, GetProcessByItsIdArgs) (*ProcessInfo, error)
	// [Preview API] Returns a single work item type in a process.
	GetProcessWorkItemType(context.Context, GetProcessWorkItemTypeArgs) (*ProcessWorkItemType, error)
	// [Preview API] Returns a single rule in the work item type of the process.
	GetProcessWorkItemTypeRule(context.Context, GetProcessWorkItemTypeRuleArgs) (*ProcessRule, error)
	// [Preview API] Returns a list of all rules in the work item type of the process.
	GetProcessWorkItemTypeRules(context.Context, GetProcessWorkItemTypeRulesArgs) (*[]ProcessRule, error)
	// [Preview API] Returns a list of all work item types in a process.
	GetProcessWorkItemTypes(context.Context, GetProcessWorkItemTypesArgs) (*[]ProcessWorkItemType, error)
	// [Preview API] Returns a single state definition in a work item type of the process.
	GetStateDefinition(context.Context, GetStateDefinitionArgs) (*WorkItemStateResultModel, error)
	// [Preview API] Returns a list of all state definitions in a work item type of the process.
	GetStateDefinitions(context.Context, GetStateDefinitionsArgs) (*[]WorkItemStateResultModel, error)
	// [Preview API] Gets edited system controls for a work item type in a process. To get all system controls (base + edited) use layout API(s)
	GetSystemControls(context.Context, GetSystemControlsArgs) (*[]Control, error)
	// [Preview API] Returns a field in a work item type.
	GetWorkItemTypeField(context.Context, GetWorkItemTypeFieldArgs) (*ProcessWorkItemTypeField, error)
	// [Preview API] Hides a state definition in the work item type of the process.Only states with customizationType:System can be hidden.
	HideStateDefinition(context.Context, HideStateDefinitionArgs) (*WorkItemStateResultModel, error)
	// [Preview API] Moves a control to a specified group.
	MoveControlToGroup(context.Context, MoveControlToGroupArgs) (*Control, error)
	// [Preview API] Moves a group to a different page and section.
	MoveGroupToPage(context.Context, MoveGroupToPageArgs) (*Group, error)
	// [Preview API] Moves a group to a different section.
	MoveGroupToSection(context.Context, MoveGroupToSectionArgs) (*Group, error)
	// [Preview API] Removes a behavior for the work item type of the process.
	RemoveBehaviorFromWorkItemType(context.Context, RemoveBehaviorFromWorkItemTypeArgs) error
	// [Preview API] Removes a control from the work item form.
	RemoveControlFromGroup(context.Context, RemoveControlFromGroupArgs) error
	// [Preview API] Removes a group from the work item form.
	RemoveGroup(context.Context, RemoveGroupArgs) error
	// [Preview API] Removes a page from the work item form
	RemovePage(context.Context, RemovePageArgs) error
	// [Preview API] Removes a field from a work item type. Does not permanently delete the field.
	RemoveWorkItemTypeField(context.Context, RemoveWorkItemTypeFieldArgs) error
	// [Preview API] Updates a behavior for the work item type of the process.
	UpdateBehaviorToWorkItemType(context.Context, UpdateBehaviorToWorkItemTypeArgs) (*WorkItemTypeBehavior, error)
	// [Preview API] Updates a control on the work item form.
	UpdateControl(context.Context, UpdateControlArgs) (*Control, error)
	// [Preview API] Updates a group in the work item form.
	UpdateGroup(context.Context, UpdateGroupArgs) (*Group, error)
	// [Preview API] Updates a list.
	UpdateList(context.Context, UpdateListArgs) (*PickList, error)
	// [Preview API] Updates a page on the work item form
	UpdatePage(context.Context, UpdatePageArgs) (*Page, error)
	// [Preview API] Replaces a behavior in the process.
	UpdateProcessBehavior(context.Context, UpdateProcessBehaviorArgs) (*ProcessBehavior, error)
	// [Preview API] Updates a work item type of the process.
	UpdateProcessWorkItemType(context.Context, UpdateProcessWorkItemTypeArgs) (*ProcessWorkItemType, error)
	// [Preview API] Updates a rule in the work item type of the process.
	UpdateProcessWorkItemTypeRule(context.Context, UpdateProcessWorkItemTypeRuleArgs) (*ProcessRule, error)
	// [Preview API] Updates a given state definition in the work item type of the process.
	UpdateStateDefinition(context.Context, UpdateStateDefinitionArgs) (*WorkItemStateResultModel, error)
	// [Preview API] Updates/adds a system control on the work item form.
	UpdateSystemControl(context.Context, UpdateSystemControlArgs) (*Control, error)
	// [Preview API] Updates a field in a work item type.
	UpdateWorkItemTypeField(context.Context, UpdateWorkItemTypeFieldArgs) (*ProcessWorkItemTypeField, error)
}

func NewClient 

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

type ClientImpl 

type ClientImpl struct {
	Client azuredevops.Client
}

func (*ClientImpl) AddBehaviorToWorkItemType 

func (client *ClientImpl) AddBehaviorToWorkItemType(ctx context.Context, args AddBehaviorToWorkItemTypeArgs) (*WorkItemTypeBehavior, error)

[Preview API] Adds a behavior to the work item type of the process.

func (*ClientImpl) AddFieldToWorkItemType 

func (client *ClientImpl) AddFieldToWorkItemType(ctx context.Context, args AddFieldToWorkItemTypeArgs) (*ProcessWorkItemTypeField, error)

[Preview API] Adds a field to a work item type.

func (*ClientImpl) AddGroup 

func (client *ClientImpl) AddGroup(ctx context.Context, args AddGroupArgs) (*Group, error)

[Preview API] Adds a group to the work item form.

func (*ClientImpl) AddPage 

func (client *ClientImpl) AddPage(ctx context.Context, args AddPageArgs) (*Page, error)

[Preview API] Adds a page to the work item form.

func (*ClientImpl) AddProcessWorkItemTypeRule 

func (client *ClientImpl) AddProcessWorkItemTypeRule(ctx context.Context, args AddProcessWorkItemTypeRuleArgs) (*ProcessRule, error)

[Preview API] Adds a rule to work item type in the process.

func (*ClientImpl) CreateControlInGroup 

func (client *ClientImpl) CreateControlInGroup(ctx context.Context, args CreateControlInGroupArgs) (*Control, error)

[Preview API] Creates a control in a group.

func (*ClientImpl) CreateList 

func (client *ClientImpl) CreateList(ctx context.Context, args CreateListArgs) (*PickList, error)

[Preview API] Creates a picklist.

func (*ClientImpl) CreateNewProcess 

func (client *ClientImpl) CreateNewProcess(ctx context.Context, args CreateNewProcessArgs) (*ProcessInfo, error)

[Preview API] Creates a process.

func (*ClientImpl) CreateProcessBehavior 

func (client *ClientImpl) CreateProcessBehavior(ctx context.Context, args CreateProcessBehaviorArgs) (*ProcessBehavior, error)

[Preview API] Creates a single behavior in the given process.

func (*ClientImpl) CreateProcessWorkItemType 

func (client *ClientImpl) CreateProcessWorkItemType(ctx context.Context, args CreateProcessWorkItemTypeArgs) (*ProcessWorkItemType, error)

[Preview API] Creates a work item type in the process.

func (*ClientImpl) CreateStateDefinition 

func (client *ClientImpl) CreateStateDefinition(ctx context.Context, args CreateStateDefinitionArgs) (*WorkItemStateResultModel, error)

[Preview API] Creates a state definition in the work item type of the process.

func (*ClientImpl) DeleteList 

func (client *ClientImpl) DeleteList(ctx context.Context, args DeleteListArgs) error

[Preview API] Removes a picklist.

func (*ClientImpl) DeleteProcessBehavior 

func (client *ClientImpl) DeleteProcessBehavior(ctx context.Context, args DeleteProcessBehaviorArgs) error

[Preview API] Removes a behavior in the process.

func (*ClientImpl) DeleteProcessById 

func (client *ClientImpl) DeleteProcessById(ctx context.Context, args DeleteProcessByIdArgs) error

[Preview API] Removes a process of a specific ID.

func (*ClientImpl) DeleteProcessWorkItemType 

func (client *ClientImpl) DeleteProcessWorkItemType(ctx context.Context, args DeleteProcessWorkItemTypeArgs) error

[Preview API] Removes a work item type in the process.

func (*ClientImpl) DeleteProcessWorkItemTypeRule 

func (client *ClientImpl) DeleteProcessWorkItemTypeRule(ctx context.Context, args DeleteProcessWorkItemTypeRuleArgs) error

[Preview API] Removes a rule from the work item type in the process.

func (*ClientImpl) DeleteStateDefinition 

func (client *ClientImpl) DeleteStateDefinition(ctx context.Context, args DeleteStateDefinitionArgs) error

[Preview API] Removes a state definition in the work item type of the process.

func (*ClientImpl) DeleteSystemControl 

func (client *ClientImpl) DeleteSystemControl(ctx context.Context, args DeleteSystemControlArgs) (*[]Control, error)

[Preview API] Deletes a system control modification on the work item form.

func (*ClientImpl) EditProcess 

func (client *ClientImpl) EditProcess(ctx context.Context, args EditProcessArgs) (*ProcessInfo, error)

[Preview API] Edit a process of a specific ID.

func (*ClientImpl) GetAllWorkItemTypeFields 

func (client *ClientImpl) GetAllWorkItemTypeFields(ctx context.Context, args GetAllWorkItemTypeFieldsArgs) (*[]ProcessWorkItemTypeField, error)

[Preview API] Returns a list of all fields in a work item type.

func (*ClientImpl) GetBehaviorForWorkItemType 

func (client *ClientImpl) GetBehaviorForWorkItemType(ctx context.Context, args GetBehaviorForWorkItemTypeArgs) (*WorkItemTypeBehavior, error)

[Preview API] Returns a behavior for the work item type of the process.

func (*ClientImpl) GetBehaviorsForWorkItemType 

func (client *ClientImpl) GetBehaviorsForWorkItemType(ctx context.Context, args GetBehaviorsForWorkItemTypeArgs) (*[]WorkItemTypeBehavior, error)

[Preview API] Returns a list of all behaviors for the work item type of the process.

func (*ClientImpl) GetFormLayout 

func (client *ClientImpl) GetFormLayout(ctx context.Context, args GetFormLayoutArgs) (*FormLayout, error)

[Preview API] Gets the form layout.

func (*ClientImpl) GetList 

func (client *ClientImpl) GetList(ctx context.Context, args GetListArgs) (*PickList, error)

[Preview API] Returns a picklist.

func (*ClientImpl) GetListOfProcesses 

func (client *ClientImpl) GetListOfProcesses(ctx context.Context, args GetListOfProcessesArgs) (*[]ProcessInfo, error)

[Preview API] Get list of all processes including system and inherited.

func (*ClientImpl) GetListsMetadata 

func (client *ClientImpl) GetListsMetadata(ctx context.Context, args GetListsMetadataArgs) (*[]PickListMetadata, error)

[Preview API] Returns meta data of the picklist.

func (*ClientImpl) GetProcessBehavior 

func (client *ClientImpl) GetProcessBehavior(ctx context.Context, args GetProcessBehaviorArgs) (*ProcessBehavior, error)

[Preview API] Returns a behavior of the process.

func (*ClientImpl) GetProcessBehaviors 

func (client *ClientImpl) GetProcessBehaviors(ctx context.Context, args GetProcessBehaviorsArgs) (*[]ProcessBehavior, error)

[Preview API] Returns a list of all behaviors in the process.

func (*ClientImpl) GetProcessByItsId 

func (client *ClientImpl) GetProcessByItsId(ctx context.Context, args GetProcessByItsIdArgs) (*ProcessInfo, error)

[Preview API] Get a single process of a specified ID.

func (*ClientImpl) GetProcessWorkItemType 

func (client *ClientImpl) GetProcessWorkItemType(ctx context.Context, args GetProcessWorkItemTypeArgs) (*ProcessWorkItemType, error)

[Preview API] Returns a single work item type in a process.

func (*ClientImpl) GetProcessWorkItemTypeRule 

func (client *ClientImpl) GetProcessWorkItemTypeRule(ctx context.Context, args GetProcessWorkItemTypeRuleArgs) (*ProcessRule, error)

[Preview API] Returns a single rule in the work item type of the process.

func (*ClientImpl) GetProcessWorkItemTypeRules 

func (client *ClientImpl) GetProcessWorkItemTypeRules(ctx context.Context, args GetProcessWorkItemTypeRulesArgs) (*[]ProcessRule, error)

[Preview API] Returns a list of all rules in the work item type of the process.

func (*ClientImpl) GetProcessWorkItemTypes 

func (client *ClientImpl) GetProcessWorkItemTypes(ctx context.Context, args GetProcessWorkItemTypesArgs) (*[]ProcessWorkItemType, error)

[Preview API] Returns a list of all work item types in a process.

func (*ClientImpl) GetStateDefinition 

func (client *ClientImpl) GetStateDefinition(ctx context.Context, args GetStateDefinitionArgs) (*WorkItemStateResultModel, error)

[Preview API] Returns a single state definition in a work item type of the process.

func (*ClientImpl) GetStateDefinitions 

func (client *ClientImpl) GetStateDefinitions(ctx context.Context, args GetStateDefinitionsArgs) (*[]WorkItemStateResultModel, error)

[Preview API] Returns a list of all state definitions in a work item type of the process.

func (*ClientImpl) GetSystemControls 

func (client *ClientImpl) GetSystemControls(ctx context.Context, args GetSystemControlsArgs) (*[]Control, error)

[Preview API] Gets edited system controls for a work item type in a process. To get all system controls (base + edited) use layout API(s)

func (*ClientImpl) GetWorkItemTypeField 

func (client *ClientImpl) GetWorkItemTypeField(ctx context.Context, args GetWorkItemTypeFieldArgs) (*ProcessWorkItemTypeField, error)

[Preview API] Returns a field in a work item type.

func (*ClientImpl) HideStateDefinition 

func (client *ClientImpl) HideStateDefinition(ctx context.Context, args HideStateDefinitionArgs) (*WorkItemStateResultModel, error)

[Preview API] Hides a state definition in the work item type of the process.Only states with customizationType:System can be hidden.

func (*ClientImpl) MoveControlToGroup 

func (client *ClientImpl) MoveControlToGroup(ctx context.Context, args MoveControlToGroupArgs) (*Control, error)

[Preview API] Moves a control to a specified group.

func (*ClientImpl) MoveGroupToPage 

func (client *ClientImpl) MoveGroupToPage(ctx context.Context, args MoveGroupToPageArgs) (*Group, error)

[Preview API] Moves a group to a different page and section.

func (*ClientImpl) MoveGroupToSection 

func (client *ClientImpl) MoveGroupToSection(ctx context.Context, args MoveGroupToSectionArgs) (*Group, error)

[Preview API] Moves a group to a different section.

func (*ClientImpl) RemoveBehaviorFromWorkItemType 

func (client *ClientImpl) RemoveBehaviorFromWorkItemType(ctx context.Context, args RemoveBehaviorFromWorkItemTypeArgs) error

[Preview API] Removes a behavior for the work item type of the process.

func (*ClientImpl) RemoveControlFromGroup 

func (client *ClientImpl) RemoveControlFromGroup(ctx context.Context, args RemoveControlFromGroupArgs) error

[Preview API] Removes a control from the work item form.

func (*ClientImpl) RemoveGroup 

func (client *ClientImpl) RemoveGroup(ctx context.Context, args RemoveGroupArgs) error

[Preview API] Removes a group from the work item form.

func (*ClientImpl) RemovePage 

func (client *ClientImpl) RemovePage(ctx context.Context, args RemovePageArgs) error

[Preview API] Removes a page from the work item form

func (*ClientImpl) RemoveWorkItemTypeField 

func (client *ClientImpl) RemoveWorkItemTypeField(ctx context.Context, args RemoveWorkItemTypeFieldArgs) error

[Preview API] Removes a field from a work item type. Does not permanently delete the field.

func (*ClientImpl) UpdateBehaviorToWorkItemType 

func (client *ClientImpl) UpdateBehaviorToWorkItemType(ctx context.Context, args UpdateBehaviorToWorkItemTypeArgs) (*WorkItemTypeBehavior, error)

[Preview API] Updates a behavior for the work item type of the process.

func (*ClientImpl) UpdateControl 

func (client *ClientImpl) UpdateControl(ctx context.Context, args UpdateControlArgs) (*Control, error)

[Preview API] Updates a control on the work item form.

func (*ClientImpl) UpdateGroup 

func (client *ClientImpl) UpdateGroup(ctx context.Context, args UpdateGroupArgs) (*Group, error)

[Preview API] Updates a group in the work item form.

func (*ClientImpl) UpdateList 

func (client *ClientImpl) UpdateList(ctx context.Context, args UpdateListArgs) (*PickList, error)

[Preview API] Updates a list.

func (*ClientImpl) UpdatePage 

func (client *ClientImpl) UpdatePage(ctx context.Context, args UpdatePageArgs) (*Page, error)

[Preview API] Updates a page on the work item form

func (*ClientImpl) UpdateProcessBehavior 

func (client *ClientImpl) UpdateProcessBehavior(ctx context.Context, args UpdateProcessBehaviorArgs) (*ProcessBehavior, error)

[Preview API] Replaces a behavior in the process.

func (*ClientImpl) UpdateProcessWorkItemType 

func (client *ClientImpl) UpdateProcessWorkItemType(ctx context.Context, args UpdateProcessWorkItemTypeArgs) (*ProcessWorkItemType, error)

[Preview API] Updates a work item type of the process.

func (*ClientImpl) UpdateProcessWorkItemTypeRule 

func (client *ClientImpl) UpdateProcessWorkItemTypeRule(ctx context.Context, args UpdateProcessWorkItemTypeRuleArgs) (*ProcessRule, error)

[Preview API] Updates a rule in the work item type of the process.

func (*ClientImpl) UpdateStateDefinition 

func (client *ClientImpl) UpdateStateDefinition(ctx context.Context, args UpdateStateDefinitionArgs) (*WorkItemStateResultModel, error)

[Preview API] Updates a given state definition in the work item type of the process.

func (*ClientImpl) UpdateSystemControl 

func (client *ClientImpl) UpdateSystemControl(ctx context.Context, args UpdateSystemControlArgs) (*Control, error)

[Preview API] Updates/adds a system control on the work item form.

func (*ClientImpl) UpdateWorkItemTypeField 

func (client *ClientImpl) UpdateWorkItemTypeField(ctx context.Context, args UpdateWorkItemTypeFieldArgs) (*ProcessWorkItemTypeField, error)

[Preview API] Updates a field in a work item type.

type Control 

type Control struct {
	// Contribution for the control.
	Contribution *WitContribution `json:"contribution,omitempty"`
	// Type of the control.
	ControlType *string `json:"controlType,omitempty"`
	// Height of the control, for html controls.
	Height *int `json:"height,omitempty"`
	// The id for the layout node.
	Id *string `json:"id,omitempty"`
	// A value indicating whether this layout node has been inherited. from a parent layout.  This is expected to only be only set by the combiner.
	Inherited *bool `json:"inherited,omitempty"`
	// A value indicating if the layout node is contribution or not.
	IsContribution *bool `json:"isContribution,omitempty"`
	// Label for the field.
	Label *string `json:"label,omitempty"`
	// Inner text of the control.
	Metadata *string `json:"metadata,omitempty"`
	// Order in which the control should appear in its group.
	Order *int `json:"order,omitempty"`
	// A value indicating whether this layout node has been overridden . by a child layout.
	Overridden *bool `json:"overridden,omitempty"`
	// A value indicating if the control is readonly.
	ReadOnly *bool `json:"readOnly,omitempty"`
	// A value indicating if the control should be hidden or not.
	Visible *bool `json:"visible,omitempty"`
	// Watermark text for the textbox.
	Watermark *string `json:"watermark,omitempty"`
}

Represent a control in the form.

type CreateControlInGroupArgs 

type CreateControlInGroupArgs struct {
	// (required) The control.
	Control *Control
	// (required) The ID of the process.
	ProcessId *uuid.UUID
	// (required) The reference name of the work item type.
	WitRefName *string
	// (required) The ID of the group to add the control to.
	GroupId *string
}

Arguments for the CreateControlInGroup function

type CreateListArgs 

type CreateListArgs struct {
	// (required) Picklist
	Picklist *PickList
}

Arguments for the CreateList function

type CreateNewProcessArgs 

type CreateNewProcessArgs struct {
	// (required) CreateProcessModel.
	CreateRequest *CreateProcessModel
}

Arguments for the CreateNewProcess function

type CreateProcessBehaviorArgs 

type CreateProcessBehaviorArgs struct {
	// (required)
	Behavior *ProcessBehaviorCreateRequest
	// (required) The ID of the process
	ProcessId *uuid.UUID
}

Arguments for the CreateProcessBehavior function

type CreateProcessModel 

type CreateProcessModel struct {
	// Description of the process
	Description *string `json:"description,omitempty"`
	// Name of the process
	Name *string `json:"name,omitempty"`
	// The ID of the parent process
	ParentProcessTypeId *uuid.UUID `json:"parentProcessTypeId,omitempty"`
	// Reference name of process being created. If not specified, server will assign a unique reference name
	ReferenceName *string `json:"referenceName,omitempty"`
}

Describes a process being created.

type CreateProcessRuleRequest 

type CreateProcessRuleRequest struct {
	// List of actions to take when the rule is triggered.
	Actions *[]RuleAction `json:"actions,omitempty"`
	// List of conditions when the rule should be triggered.
	Conditions *[]RuleCondition `json:"conditions,omitempty"`
	// Indicates if the rule is disabled.
	IsDisabled *bool `json:"isDisabled,omitempty"`
	// Name for the rule.
	Name *string `json:"name,omitempty"`
}

Request object/class for creating a rule on a work item type.

type CreateProcessWorkItemTypeArgs 

type CreateProcessWorkItemTypeArgs struct {
	// (required)
	WorkItemType *CreateProcessWorkItemTypeRequest
	// (required) The ID of the process on which to create work item type.
	ProcessId *uuid.UUID
}

Arguments for the CreateProcessWorkItemType function

type CreateProcessWorkItemTypeRequest 

type CreateProcessWorkItemTypeRequest struct {
	// Color hexadecimal code to represent the work item type
	Color *string `json:"color,omitempty"`
	// Description of the work item type
	Description *string `json:"description,omitempty"`
	// Icon to represent the work item type
	Icon *string `json:"icon,omitempty"`
	// Parent work item type for work item type
	InheritsFrom *string `json:"inheritsFrom,omitempty"`
	// True if the work item type need to be disabled
	IsDisabled *bool `json:"isDisabled,omitempty"`
	// Name of work item type
	Name *string `json:"name,omitempty"`
}

Class for create work item type request

type CreateStateDefinitionArgs 

type CreateStateDefinitionArgs struct {
	// (required)
	StateModel *WorkItemStateInputModel
	// (required) The ID of the process
	ProcessId *uuid.UUID
	// (required) The reference name of the work item type
	WitRefName *string
}

Arguments for the CreateStateDefinition function

type CustomizationType 

type CustomizationType string

Indicates the customization-type. Customization-type is System if is system generated or by default. Customization-type is Inherited if the existing workitemtype of inherited process is customized. Customization-type is Custom if the newly created workitemtype is customized.

type DeleteListArgs 

type DeleteListArgs struct {
	// (required) The ID of the list
	ListId *uuid.UUID
}

Arguments for the DeleteList function

type DeleteProcessBehaviorArgs 

type DeleteProcessBehaviorArgs struct {
	// (required) The ID of the process
	ProcessId *uuid.UUID
	// (required) The reference name of the behavior
	BehaviorRefName *string
}

Arguments for the DeleteProcessBehavior function

type DeleteProcessByIdArgs 

type DeleteProcessByIdArgs struct {
	// (required)
	ProcessTypeId *uuid.UUID
}

Arguments for the DeleteProcessById function

type DeleteProcessWorkItemTypeArgs 

type DeleteProcessWorkItemTypeArgs struct {
	// (required) The ID of the process.
	ProcessId *uuid.UUID
	// (required) The reference name of the work item type.
	WitRefName *string
}

Arguments for the DeleteProcessWorkItemType function

type DeleteProcessWorkItemTypeRuleArgs 

type DeleteProcessWorkItemTypeRuleArgs struct {
	// (required) The ID of the process
	ProcessId *uuid.UUID
	// (required) The reference name of the work item type
	WitRefName *string
	// (required) The ID of the rule
	RuleId *uuid.UUID
}

Arguments for the DeleteProcessWorkItemTypeRule function

type DeleteStateDefinitionArgs 

type DeleteStateDefinitionArgs struct {
	// (required) ID of the process
	ProcessId *uuid.UUID
	// (required) The reference name of the work item type
	WitRefName *string
	// (required) ID of the state
	StateId *uuid.UUID
}

Arguments for the DeleteStateDefinition function

type DeleteSystemControlArgs 

type DeleteSystemControlArgs struct {
	// (required) The ID of the process.
	ProcessId *uuid.UUID
	// (required) The reference name of the work item type.
	WitRefName *string
	// (required) The ID of the control.
	ControlId *string
}

Arguments for the DeleteSystemControl function

type EditProcessArgs 

type EditProcessArgs struct {
	// (required)
	UpdateRequest *UpdateProcessModel
	// (required)
	ProcessTypeId *uuid.UUID
}

Arguments for the EditProcess function

type Extension 

type Extension struct {
	// Id of the extension
	Id *string `json:"id,omitempty"`
}

Represents the extensions part of the layout

type FieldModel 

type FieldModel struct {
	Description *string    `json:"description,omitempty"`
	Id          *string    `json:"id,omitempty"`
	IsIdentity  *bool      `json:"isIdentity,omitempty"`
	IsLocked    *bool      `json:"isLocked,omitempty"`
	Name        *string    `json:"name,omitempty"`
	Type        *FieldType `json:"type,omitempty"`
	Url         *string    `json:"url,omitempty"`
}

type FieldRuleModel 

type FieldRuleModel struct {
	Actions      *[]RuleActionModel    `json:"actions,omitempty"`
	Conditions   *[]RuleConditionModel `json:"conditions,omitempty"`
	FriendlyName *string               `json:"friendlyName,omitempty"`
	Id           *uuid.UUID            `json:"id,omitempty"`
	IsDisabled   *bool                 `json:"isDisabled,omitempty"`
	IsSystem     *bool                 `json:"isSystem,omitempty"`
}

type FieldType 

type FieldType string

Enum for the type of a field.

type FormLayout 

type FormLayout struct {
	// Gets and sets extensions list.
	Extensions *[]Extension `json:"extensions,omitempty"`
	// Top level tabs of the layout.
	Pages *[]Page `json:"pages,omitempty"`
	// Headers controls of the layout.
	SystemControls *[]Control `json:"systemControls,omitempty"`
}

Describes the layout of a work item type

type GetAllWorkItemTypeFieldsArgs 

type GetAllWorkItemTypeFieldsArgs struct {
	// (required) The ID of the process.
	ProcessId *uuid.UUID
	// (required) The reference name of the work item type.
	WitRefName *string
}

Arguments for the GetAllWorkItemTypeFields function

type GetBehaviorForWorkItemTypeArgs 

type GetBehaviorForWorkItemTypeArgs struct {
	// (required) The ID of the process
	ProcessId *uuid.UUID
	// (required) Work item type reference name for the behavior
	WitRefNameForBehaviors *string
	// (required) The reference name of the behavior
	BehaviorRefName *string
}

Arguments for the GetBehaviorForWorkItemType function

type GetBehaviorsExpand 

type GetBehaviorsExpand string

Expand options to fetch fields for behaviors API.

type GetBehaviorsForWorkItemTypeArgs 

type GetBehaviorsForWorkItemTypeArgs struct {
	// (required) The ID of the process
	ProcessId *uuid.UUID
	// (required) Work item type reference name for the behavior
	WitRefNameForBehaviors *string
}

Arguments for the GetBehaviorsForWorkItemType function

type GetFormLayoutArgs 

type GetFormLayoutArgs struct {
	// (required) The ID of the process.
	ProcessId *uuid.UUID
	// (required) The reference name of the work item type.
	WitRefName *string
}

Arguments for the GetFormLayout function

type GetListArgs 

type GetListArgs struct {
	// (required) The ID of the list
	ListId *uuid.UUID
}

Arguments for the GetList function

type GetListOfProcessesArgs 

type GetListOfProcessesArgs struct {
	// (optional)
	Expand *GetProcessExpandLevel
}

Arguments for the GetListOfProcesses function

type GetListsMetadataArgs 

type GetListsMetadataArgs struct {
}

Arguments for the GetListsMetadata function

type GetProcessBehaviorArgs 

type GetProcessBehaviorArgs struct {
	// (required) The ID of the process
	ProcessId *uuid.UUID
	// (required) The reference name of the behavior
	BehaviorRefName *string
	// (optional)
	Expand *GetBehaviorsExpand
}

Arguments for the GetProcessBehavior function

type GetProcessBehaviorsArgs 

type GetProcessBehaviorsArgs struct {
	// (required) The ID of the process
	ProcessId *uuid.UUID
	// (optional)
	Expand *GetBehaviorsExpand
}

Arguments for the GetProcessBehaviors function

type GetProcessByItsIdArgs 

type GetProcessByItsIdArgs struct {
	// (required)
	ProcessTypeId *uuid.UUID
	// (optional)
	Expand *GetProcessExpandLevel
}

Arguments for the GetProcessByItsId function

type GetProcessExpandLevel 

type GetProcessExpandLevel string

[Flags] The expand level of returned processes.

type GetProcessWorkItemTypeArgs 

type GetProcessWorkItemTypeArgs struct {
	// (required) The ID of the process
	ProcessId *uuid.UUID
	// (required) The reference name of the work item type
	WitRefName *string
	// (optional) Flag to determine what properties of work item type to return
	Expand *GetWorkItemTypeExpand
}

Arguments for the GetProcessWorkItemType function

type GetProcessWorkItemTypeRuleArgs 

type GetProcessWorkItemTypeRuleArgs struct {
	// (required) The ID of the process
	ProcessId *uuid.UUID
	// (required) The reference name of the work item type
	WitRefName *string
	// (required) The ID of the rule
	RuleId *uuid.UUID
}

Arguments for the GetProcessWorkItemTypeRule function

type GetProcessWorkItemTypeRulesArgs 

type GetProcessWorkItemTypeRulesArgs struct {
	// (required) The ID of the process
	ProcessId *uuid.UUID
	// (required) The reference name of the work item type
	WitRefName *string
}

Arguments for the GetProcessWorkItemTypeRules function

type GetProcessWorkItemTypesArgs 

type GetProcessWorkItemTypesArgs struct {
	// (required) The ID of the process
	ProcessId *uuid.UUID
	// (optional) Flag to determine what properties of work item type to return
	Expand *GetWorkItemTypeExpand
}

Arguments for the GetProcessWorkItemTypes function

type GetStateDefinitionArgs 

type GetStateDefinitionArgs struct {
	// (required) The ID of the process
	ProcessId *uuid.UUID
	// (required) The reference name of the work item type
	WitRefName *string
	// (required) The ID of the state
	StateId *uuid.UUID
}

Arguments for the GetStateDefinition function

type GetStateDefinitionsArgs 

type GetStateDefinitionsArgs struct {
	// (required) The ID of the process
	ProcessId *uuid.UUID
	// (required) The reference name of the work item type
	WitRefName *string
}

Arguments for the GetStateDefinitions function

type GetSystemControlsArgs 

type GetSystemControlsArgs struct {
	// (required) The ID of the process.
	ProcessId *uuid.UUID
	// (required) The reference name of the work item type.
	WitRefName *string
}

Arguments for the GetSystemControls function

type GetWorkItemTypeExpand 

type GetWorkItemTypeExpand string

[Flags] Flag to define what properties to return in get work item type response.

type GetWorkItemTypeFieldArgs 

type GetWorkItemTypeFieldArgs struct {
	// (required) The ID of the process.
	ProcessId *uuid.UUID
	// (required) The reference name of the work item type.
	WitRefName *string
	// (required) The reference name of the field.
	FieldRefName *string
	// (optional)
	Expand *ProcessWorkItemTypeFieldsExpandLevel
}

Arguments for the GetWorkItemTypeField function

type Group 

type Group struct {
	// Contribution for the group.
	Contribution *WitContribution `json:"contribution,omitempty"`
	// Controls to be put in the group.
	Controls *[]Control `json:"controls,omitempty"`
	// The height for the contribution.
	Height *int `json:"height,omitempty"`
	// The id for the layout node.
	Id *string `json:"id,omitempty"`
	// A value indicating whether this layout node has been inherited from a parent layout.  This is expected to only be only set by the combiner.
	Inherited *bool `json:"inherited,omitempty"`
	// A value indicating if the layout node is contribution are not.
	IsContribution *bool `json:"isContribution,omitempty"`
	// Label for the group.
	Label *string `json:"label,omitempty"`
	// Order in which the group should appear in the section.
	Order *int `json:"order,omitempty"`
	// A value indicating whether this layout node has been overridden by a child layout.
	Overridden *bool `json:"overridden,omitempty"`
	// A value indicating if the group should be hidden or not.
	Visible *bool `json:"visible,omitempty"`
}

Represent a group in the form that holds controls in it.

type HideStateDefinitionArgs 

type HideStateDefinitionArgs struct {
	// (required)
	HideStateModel *HideStateModel
	// (required) The ID of the process
	ProcessId *uuid.UUID
	// (required) The reference name of the work item type
	WitRefName *string
	// (required) The ID of the state
	StateId *uuid.UUID
}

Arguments for the HideStateDefinition function

type HideStateModel 

type HideStateModel struct {
	// Returns 'true', if workitem state is hidden, 'false' otherwise.
	Hidden *bool `json:"hidden,omitempty"`
}

Class that describes the work item state is hidden.

type MoveControlToGroupArgs 

type MoveControlToGroupArgs struct {
	// (required) The control.
	Control *Control
	// (required) The ID of the process.
	ProcessId *uuid.UUID
	// (required) The reference name of the work item type.
	WitRefName *string
	// (required) The ID of the group to move the control to.
	GroupId *string
	// (required) The ID of the control.
	ControlId *string
	// (optional) The group ID to remove the control from.
	RemoveFromGroupId *string
}

Arguments for the MoveControlToGroup function

type MoveGroupToPageArgs 

type MoveGroupToPageArgs struct {
	// (required) The updated group.
	Group *Group
	// (required) The ID of the process.
	ProcessId *uuid.UUID
	// (required) The reference name of the work item type.
	WitRefName *string
	// (required) The ID of the page the group is in.
	PageId *string
	// (required) The ID of the section the group is i.n
	SectionId *string
	// (required) The ID of the group.
	GroupId *string
	// (required) ID of the page to remove the group from.
	RemoveFromPageId *string
	// (required) ID of the section to remove the group from.
	RemoveFromSectionId *string
}

Arguments for the MoveGroupToPage function

type MoveGroupToSectionArgs 

type MoveGroupToSectionArgs struct {
	// (required) The updated group.
	Group *Group
	// (required) The ID of the process.
	ProcessId *uuid.UUID
	// (required) The reference name of the work item type.
	WitRefName *string
	// (required) The ID of the page the group is in.
	PageId *string
	// (required) The ID of the section the group is in.
	SectionId *string
	// (required) The ID of the group.
	GroupId *string
	// (required) ID of the section to remove the group from.
	RemoveFromSectionId *string
}

Arguments for the MoveGroupToSection function

type Page 

type Page struct {
	// Contribution for the page.
	Contribution *WitContribution `json:"contribution,omitempty"`
	// The id for the layout node.
	Id *string `json:"id,omitempty"`
	// A value indicating whether this layout node has been inherited from a parent layout.  This is expected to only be only set by the combiner.
	Inherited *bool `json:"inherited,omitempty"`
	// A value indicating if the layout node is contribution are not.
	IsContribution *bool `json:"isContribution,omitempty"`
	// The label for the page.
	Label *string `json:"label,omitempty"`
	// A value indicating whether any user operations are permitted on this page and the contents of this page
	Locked *bool `json:"locked,omitempty"`
	// Order in which the page should appear in the layout.
	Order *int `json:"order,omitempty"`
	// A value indicating whether this layout node has been overridden by a child layout.
	Overridden *bool `json:"overridden,omitempty"`
	// The icon for the page.
	PageType *PageType `json:"pageType,omitempty"`
	// The sections of the page.
	Sections *[]Section `json:"sections,omitempty"`
	// A value indicating if the page should be hidden or not.
	Visible *bool `json:"visible,omitempty"`
}

Describes a page in the work item form layout

type PageType 

type PageType string

Enum for the types of pages in the work item form layout

type PickList 

type PickList struct {
	// ID of the picklist
	Id *uuid.UUID `json:"id,omitempty"`
	// Indicates whether items outside of suggested list are allowed
	IsSuggested *bool `json:"isSuggested,omitempty"`
	// Name of the picklist
	Name *string `json:"name,omitempty"`
	// DataType of picklist
	Type *string `json:"type,omitempty"`
	// Url of the picklist
	Url *string `json:"url,omitempty"`
	// A list of PicklistItemModel.
	Items *[]string `json:"items,omitempty"`
}

Picklist.

type PickListMetadata 

type PickListMetadata struct {
	// ID of the picklist
	Id *uuid.UUID `json:"id,omitempty"`
	// Indicates whether items outside of suggested list are allowed
	IsSuggested *bool `json:"isSuggested,omitempty"`
	// Name of the picklist
	Name *string `json:"name,omitempty"`
	// DataType of picklist
	Type *string `json:"type,omitempty"`
	// Url of the picklist
	Url *string `json:"url,omitempty"`
}

Metadata for picklist.

type ProcessBehavior 

type ProcessBehavior struct {
	// Color.
	Color *string `json:"color,omitempty"`
	// Indicates the type of customization on this work item. System behaviors are inherited from parent process but not modified. Inherited behaviors are modified behaviors that were inherited from parent process. Custom behaviors are behaviors created by user in current process.
	Customization *CustomizationType `json:"customization,omitempty"`
	// . Description
	Description *string `json:"description,omitempty"`
	// Process Behavior Fields.
	Fields *[]ProcessBehaviorField `json:"fields,omitempty"`
	// Parent behavior reference.
	Inherits *ProcessBehaviorReference `json:"inherits,omitempty"`
	// Behavior Name.
	Name *string `json:"name,omitempty"`
	// Rank of the behavior
	Rank *int `json:"rank,omitempty"`
	// Behavior Id
	ReferenceName *string `json:"referenceName,omitempty"`
	// Url of the behavior.
	Url *string `json:"url,omitempty"`
}

Process Behavior Model.

type ProcessBehaviorCreateRequest 

type ProcessBehaviorCreateRequest struct {
	// Color.
	Color *string `json:"color,omitempty"`
	// Parent behavior id.
	Inherits *string `json:"inherits,omitempty"`
	// Name of the behavior.
	Name *string `json:"name,omitempty"`
	// ReferenceName is optional, if not specified will be auto-generated.
	ReferenceName *string `json:"referenceName,omitempty"`
}

Process Behavior Create Payload.

type ProcessBehaviorField 

type ProcessBehaviorField struct {
	// Name of the field.
	Name *string `json:"name,omitempty"`
	// Reference name of the field.
	ReferenceName *string `json:"referenceName,omitempty"`
	// Url to field.
	Url *string `json:"url,omitempty"`
}

Process Behavior Field.

type ProcessBehaviorReference 

type ProcessBehaviorReference struct {
	// Id of a Behavior.
	BehaviorRefName *string `json:"behaviorRefName,omitempty"`
	// Url to behavior.
	Url *string `json:"url,omitempty"`
}

Process behavior Reference.

type ProcessBehaviorUpdateRequest 

type ProcessBehaviorUpdateRequest struct {
	// Color.
	Color *string `json:"color,omitempty"`
	// Behavior Name.
	Name *string `json:"name,omitempty"`
}

Process Behavior Replace Payload.

type ProcessClass 

type ProcessClass string

type ProcessInfo 

type ProcessInfo struct {
	// Indicates the type of customization on this process. System Process is default process. Inherited Process is modified process that was System process before.
	CustomizationType *CustomizationType `json:"customizationType,omitempty"`
	// Description of the process.
	Description *string `json:"description,omitempty"`
	// Is the process default.
	IsDefault *bool `json:"isDefault,omitempty"`
	// Is the process enabled.
	IsEnabled *bool `json:"isEnabled,omitempty"`
	// Name of the process.
	Name *string `json:"name,omitempty"`
	// ID of the parent process.
	ParentProcessTypeId *uuid.UUID `json:"parentProcessTypeId,omitempty"`
	// Projects in this process to which the user is subscribed to.
	Projects *[]ProjectReference `json:"projects,omitempty"`
	// Reference name of the process.
	ReferenceName *string `json:"referenceName,omitempty"`
	// The ID of the process.
	TypeId *uuid.UUID `json:"typeId,omitempty"`
}

Process.

type ProcessModel 

type ProcessModel struct {
	// Description of the process
	Description *string `json:"description,omitempty"`
	// Name of the process
	Name *string `json:"name,omitempty"`
	// Projects in this process
	Projects *[]ProjectReference `json:"projects,omitempty"`
	// Properties of the process
	Properties *ProcessProperties `json:"properties,omitempty"`
	// Reference name of the process
	ReferenceName *string `json:"referenceName,omitempty"`
	// The ID of the process
	TypeId *uuid.UUID `json:"typeId,omitempty"`
}

type ProcessProperties 

type ProcessProperties struct {
	// Class of the process.
	Class *ProcessClass `json:"class,omitempty"`
	// Is the process default process.
	IsDefault *bool `json:"isDefault,omitempty"`
	// Is the process enabled.
	IsEnabled *bool `json:"isEnabled,omitempty"`
	// ID of the parent process.
	ParentProcessTypeId *uuid.UUID `json:"parentProcessTypeId,omitempty"`
	// Version of the process.
	Version *string `json:"version,omitempty"`
}

Properties of the process.

type ProcessRule 

type ProcessRule struct {
	// List of actions to take when the rule is triggered.
	Actions *[]RuleAction `json:"actions,omitempty"`
	// List of conditions when the rule should be triggered.
	Conditions *[]RuleCondition `json:"conditions,omitempty"`
	// Indicates if the rule is disabled.
	IsDisabled *bool `json:"isDisabled,omitempty"`
	// Name for the rule.
	Name *string `json:"name,omitempty"`
	// Indicates if the rule is system generated or created by user.
	CustomizationType *CustomizationType `json:"customizationType,omitempty"`
	// Id to uniquely identify the rule.
	Id *uuid.UUID `json:"id,omitempty"`
	// Resource Url.
	Url *string `json:"url,omitempty"`
}

Process Rule Response.

type ProcessWorkItemType 

type ProcessWorkItemType struct {
	Behaviors *[]WorkItemTypeBehavior `json:"behaviors,omitempty"`
	// Color hexadecimal code to represent the work item type
	Color *string `json:"color,omitempty"`
	// Indicates the type of customization on this work item System work item types are inherited from parent process but not modified Inherited work item types are modified work item that were inherited from parent process Custom work item types are work item types that were created in the current process
	Customization *CustomizationType `json:"customization,omitempty"`
	// Description of the work item type
	Description *string `json:"description,omitempty"`
	// Icon to represent the work item typ
	Icon *string `json:"icon,omitempty"`
	// Reference name of the parent work item type
	Inherits *string `json:"inherits,omitempty"`
	// Indicates if a work item type is disabled
	IsDisabled *bool       `json:"isDisabled,omitempty"`
	Layout     *FormLayout `json:"layout,omitempty"`
	// Name of the work item type
	Name *string `json:"name,omitempty"`
	// Reference name of work item type
	ReferenceName *string                     `json:"referenceName,omitempty"`
	States        *[]WorkItemStateResultModel `json:"states,omitempty"`
	// Url of the work item type
	Url *string `json:"url,omitempty"`
}

Class that describes a work item type object

type ProcessWorkItemTypeField 

type ProcessWorkItemTypeField struct {
	// The list of field allowed values.
	AllowedValues *[]interface{} `json:"allowedValues,omitempty"`
	// Allow setting field value to a group identity. Only applies to identity fields.
	AllowGroups *bool `json:"allowGroups,omitempty"`
	// Indicates the type of customization on this work item.
	Customization *CustomizationType `json:"customization,omitempty"`
	// The default value of the field.
	DefaultValue interface{} `json:"defaultValue,omitempty"`
	// Description of the field.
	Description *string `json:"description,omitempty"`
	// Information about field definition being locked for editing
	IsLocked *bool `json:"isLocked,omitempty"`
	// Name of the field.
	Name *string `json:"name,omitempty"`
	// If true the field cannot be edited.
	ReadOnly *bool `json:"readOnly,omitempty"`
	// Reference name of the field.
	ReferenceName *string `json:"referenceName,omitempty"`
	// If true the field cannot be empty.
	Required *bool `json:"required,omitempty"`
	// Type of the field.
	Type *FieldType `json:"type,omitempty"`
	// Resource URL of the field.
	Url *string `json:"url,omitempty"`
}

Class that describes a field in a work item type and its properties.

type ProcessWorkItemTypeFieldsExpandLevel 

type ProcessWorkItemTypeFieldsExpandLevel string

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

type ProjectReference 

type ProjectReference struct {
	// Description of the project
	Description *string `json:"description,omitempty"`
	// The ID of the project
	Id *uuid.UUID `json:"id,omitempty"`
	// Name of the project
	Name *string `json:"name,omitempty"`
	// Url of the project
	Url *string `json:"url,omitempty"`
}

Defines the project reference class.

type RemoveBehaviorFromWorkItemTypeArgs 

type RemoveBehaviorFromWorkItemTypeArgs struct {
	// (required) The ID of the process
	ProcessId *uuid.UUID
	// (required) Work item type reference name for the behavior
	WitRefNameForBehaviors *string
	// (required) The reference name of the behavior
	BehaviorRefName *string
}

Arguments for the RemoveBehaviorFromWorkItemType function

type RemoveControlFromGroupArgs 

type RemoveControlFromGroupArgs struct {
	// (required) The ID of the process.
	ProcessId *uuid.UUID
	// (required) The reference name of the work item type.
	WitRefName *string
	// (required) The ID of the group.
	GroupId *string
	// (required) The ID of the control to remove.
	ControlId *string
}

Arguments for the RemoveControlFromGroup function

type RemoveGroupArgs 

type RemoveGroupArgs struct {
	// (required) The ID of the process
	ProcessId *uuid.UUID
	// (required) The reference name of the work item type
	WitRefName *string
	// (required) The ID of the page the group is in
	PageId *string
	// (required) The ID of the section to the group is in
	SectionId *string
	// (required) The ID of the group
	GroupId *string
}

Arguments for the RemoveGroup function

type RemovePageArgs 

type RemovePageArgs struct {
	// (required) The ID of the process
	ProcessId *uuid.UUID
	// (required) The reference name of the work item type
	WitRefName *string
	// (required) The ID of the page
	PageId *string
}

Arguments for the RemovePage function

type RemoveWorkItemTypeFieldArgs 

type RemoveWorkItemTypeFieldArgs struct {
	// (required) The ID of the process.
	ProcessId *uuid.UUID
	// (required) The reference name of the work item type.
	WitRefName *string
	// (required) The reference name of the field.
	FieldRefName *string
}

Arguments for the RemoveWorkItemTypeField function

type RuleAction 

type RuleAction struct {
	// Type of action to take when the rule is triggered.
	ActionType *RuleActionType `json:"actionType,omitempty"`
	// Field on which the action should be taken.
	TargetField *string `json:"targetField,omitempty"`
	// Value to apply on target field, once the action is taken.
	Value *string `json:"value,omitempty"`
}

Action to take when the rule is triggered.

type RuleActionModel 

type RuleActionModel struct {
	ActionType  *string `json:"actionType,omitempty"`
	TargetField *string `json:"targetField,omitempty"`
	Value       *string `json:"value,omitempty"`
}

Action to take when the rule is triggered.

type RuleActionType 

type RuleActionType string

Type of action to take when the rule is triggered.

type RuleCondition 

type RuleCondition struct {
	// Type of condition. $When. This condition limits the execution of its children to cases when another field has a particular value, i.e. when the Is value of the referenced field is equal to the given literal value. $WhenNot.This condition limits the execution of its children to cases when another field does not have a particular value, i.e.when the Is value of the referenced field is not equal to the given literal value. $WhenChanged.This condition limits the execution of its children to cases when another field has changed, i.e.when the Is value of the referenced field is not equal to the Was value of that field. $WhenNotChanged.This condition limits the execution of its children to cases when another field has not changed, i.e.when the Is value of the referenced field is equal to the Was value of that field.
	ConditionType *RuleConditionType `json:"conditionType,omitempty"`
	// Field that defines condition.
	Field *string `json:"field,omitempty"`
	// Value of field to define the condition for rule.
	Value *string `json:"value,omitempty"`
}

Defines a condition on a field when the rule should be triggered.

type RuleConditionModel 

type RuleConditionModel struct {
	ConditionType *string `json:"conditionType,omitempty"`
	Field         *string `json:"field,omitempty"`
	Value         *string `json:"value,omitempty"`
}

type RuleConditionType 

type RuleConditionType string

Type of rule condition.

type Section 

type Section struct {
	// List of child groups in this section
	Groups *[]Group `json:"groups,omitempty"`
	// The id for the layout node.
	Id *string `json:"id,omitempty"`
	// A value indicating whether this layout node has been overridden by a child layout.
	Overridden *bool `json:"overridden,omitempty"`
}

Defines a section of the work item form layout

type UpdateBehaviorToWorkItemTypeArgs 

type UpdateBehaviorToWorkItemTypeArgs struct {
	// (required)
	Behavior *WorkItemTypeBehavior
	// (required) The ID of the process
	ProcessId *uuid.UUID
	// (required) Work item type reference name for the behavior
	WitRefNameForBehaviors *string
}

Arguments for the UpdateBehaviorToWorkItemType function

type UpdateControlArgs 

type UpdateControlArgs struct {
	// (required) The updated control.
	Control *Control
	// (required) The ID of the process.
	ProcessId *uuid.UUID
	// (required) The reference name of the work item type.
	WitRefName *string
	// (required) The ID of the group.
	GroupId *string
	// (required) The ID of the control.
	ControlId *string
}

Arguments for the UpdateControl function

type UpdateGroupArgs 

type UpdateGroupArgs struct {
	// (required) The updated group.
	Group *Group
	// (required) The ID of the process.
	ProcessId *uuid.UUID
	// (required) The reference name of the work item type.
	WitRefName *string
	// (required) The ID of the page the group is in.
	PageId *string
	// (required) The ID of the section the group is in.
	SectionId *string
	// (required) The ID of the group.
	GroupId *string
}

Arguments for the UpdateGroup function

type UpdateListArgs 

type UpdateListArgs struct {
	// (required)
	Picklist *PickList
	// (required) The ID of the list
	ListId *uuid.UUID
}

Arguments for the UpdateList function

type UpdatePageArgs 

type UpdatePageArgs struct {
	// (required) The page
	Page *Page
	// (required) The ID of the process
	ProcessId *uuid.UUID
	// (required) The reference name of the work item type
	WitRefName *string
}

Arguments for the UpdatePage function

type UpdateProcessBehaviorArgs 

type UpdateProcessBehaviorArgs struct {
	// (required)
	BehaviorData *ProcessBehaviorUpdateRequest
	// (required) The ID of the process
	ProcessId *uuid.UUID
	// (required) The reference name of the behavior
	BehaviorRefName *string
}

Arguments for the UpdateProcessBehavior function

type UpdateProcessModel 

type UpdateProcessModel struct {
	// New description of the process
	Description *string `json:"description,omitempty"`
	// If true new projects will use this process by default
	IsDefault *bool `json:"isDefault,omitempty"`
	// If false the process will be disabled and cannot be used to create projects
	IsEnabled *bool `json:"isEnabled,omitempty"`
	// New name of the process
	Name *string `json:"name,omitempty"`
}

Describes a request to update a process

type UpdateProcessRuleRequest 

type UpdateProcessRuleRequest struct {
	// List of actions to take when the rule is triggered.
	Actions *[]RuleAction `json:"actions,omitempty"`
	// List of conditions when the rule should be triggered.
	Conditions *[]RuleCondition `json:"conditions,omitempty"`
	// Indicates if the rule is disabled.
	IsDisabled *bool `json:"isDisabled,omitempty"`
	// Name for the rule.
	Name *string `json:"name,omitempty"`
	// Id to uniquely identify the rule.
	Id *uuid.UUID `json:"id,omitempty"`
}

Request class/object to update the rule.

type UpdateProcessWorkItemTypeArgs 

type UpdateProcessWorkItemTypeArgs struct {
	// (required)
	WorkItemTypeUpdate *UpdateProcessWorkItemTypeRequest
	// (required) The ID of the process
	ProcessId *uuid.UUID
	// (required) The reference name of the work item type
	WitRefName *string
}

Arguments for the UpdateProcessWorkItemType function

type UpdateProcessWorkItemTypeFieldRequest 

type UpdateProcessWorkItemTypeFieldRequest struct {
	// The list of field allowed values.
	AllowedValues *[]string `json:"allowedValues,omitempty"`
	// Allow setting field value to a group identity. Only applies to identity fields.
	AllowGroups *bool `json:"allowGroups,omitempty"`
	// The default value of the field.
	DefaultValue interface{} `json:"defaultValue,omitempty"`
	// If true the field cannot be edited.
	ReadOnly *bool `json:"readOnly,omitempty"`
	// The default value of the field.
	Required *bool `json:"required,omitempty"`
}

Class to describe a request that updates a field's properties in a work item type.

type UpdateProcessWorkItemTypeRequest 

type UpdateProcessWorkItemTypeRequest struct {
	// Color of the work item type
	Color *string `json:"color,omitempty"`
	// Description of the work item type
	Description *string `json:"description,omitempty"`
	// Icon of the work item type
	Icon *string `json:"icon,omitempty"`
	// If set will disable the work item type
	IsDisabled *bool `json:"isDisabled,omitempty"`
}

Class for update request on a work item type

type UpdateProcessWorkItemTypeRuleArgs 

type UpdateProcessWorkItemTypeRuleArgs struct {
	// (required)
	ProcessRule *UpdateProcessRuleRequest
	// (required) The ID of the process
	ProcessId *uuid.UUID
	// (required) The reference name of the work item type
	WitRefName *string
	// (required) The ID of the rule
	RuleId *uuid.UUID
}

Arguments for the UpdateProcessWorkItemTypeRule function

type UpdateStateDefinitionArgs 

type UpdateStateDefinitionArgs struct {
	// (required)
	StateModel *WorkItemStateInputModel
	// (required) ID of the process
	ProcessId *uuid.UUID
	// (required) The reference name of the work item type
	WitRefName *string
	// (required) ID of the state
	StateId *uuid.UUID
}

Arguments for the UpdateStateDefinition function

type UpdateSystemControlArgs 

type UpdateSystemControlArgs struct {
	// (required)
	Control *Control
	// (required) The ID of the process.
	ProcessId *uuid.UUID
	// (required) The reference name of the work item type.
	WitRefName *string
	// (required) The ID of the control.
	ControlId *string
}

Arguments for the UpdateSystemControl function

type UpdateWorkItemTypeFieldArgs 

type UpdateWorkItemTypeFieldArgs struct {
	// (required)
	Field *UpdateProcessWorkItemTypeFieldRequest
	// (required) The ID of the process.
	ProcessId *uuid.UUID
	// (required) The reference name of the work item type.
	WitRefName *string
	// (required) The reference name of the field.
	FieldRefName *string
}

Arguments for the UpdateWorkItemTypeField function

type WitContribution 

type WitContribution struct {
	// The id for the contribution.
	ContributionId *string `json:"contributionId,omitempty"`
	// The height for the contribution.
	Height *int `json:"height,omitempty"`
	// A dictionary holding key value pairs for contribution inputs.
	Inputs *map[string]interface{} `json:"inputs,omitempty"`
	// A value indicating if the contribution should be show on deleted workItem.
	ShowOnDeletedWorkItem *bool `json:"showOnDeletedWorkItem,omitempty"`
}

Properties of a work item form contribution

type WorkItemBehavior 

type WorkItemBehavior struct {
	Abstract    *bool                      `json:"abstract,omitempty"`
	Color       *string                    `json:"color,omitempty"`
	Description *string                    `json:"description,omitempty"`
	Fields      *[]WorkItemBehaviorField   `json:"fields,omitempty"`
	Id          *string                    `json:"id,omitempty"`
	Inherits    *WorkItemBehaviorReference `json:"inherits,omitempty"`
	Name        *string                    `json:"name,omitempty"`
	Overriden   *bool                      `json:"overriden,omitempty"`
	Rank        *int                       `json:"rank,omitempty"`
	Url         *string                    `json:"url,omitempty"`
}

type WorkItemBehaviorField 

type WorkItemBehaviorField struct {
	BehaviorFieldId *string `json:"behaviorFieldId,omitempty"`
	Id              *string `json:"id,omitempty"`
	Url             *string `json:"url,omitempty"`
}

type WorkItemBehaviorReference 

type WorkItemBehaviorReference struct {
	// The ID of the reference behavior.
	Id *string `json:"id,omitempty"`
	// The url of the reference behavior.
	Url *string `json:"url,omitempty"`
}

Reference to the behavior of a work item type.

type WorkItemStateInputModel 

type WorkItemStateInputModel struct {
	// Color of the state
	Color *string `json:"color,omitempty"`
	// Name of the state
	Name *string `json:"name,omitempty"`
	// Order in which state should appear
	Order *int `json:"order,omitempty"`
	// Category of the state
	StateCategory *string `json:"stateCategory,omitempty"`
}

Class That represents a work item state input.

type WorkItemStateResultModel 

type WorkItemStateResultModel struct {
	// Work item state color.
	Color *string `json:"color,omitempty"`
	// Work item state customization type.
	CustomizationType *CustomizationType `json:"customizationType,omitempty"`
	// If the Work item state is hidden.
	Hidden *bool `json:"hidden,omitempty"`
	// Id of the Workitemstate.
	Id *uuid.UUID `json:"id,omitempty"`
	// Work item state name.
	Name *string `json:"name,omitempty"`
	// Work item state order.
	Order *int `json:"order,omitempty"`
	// Work item state statecategory.
	StateCategory *string `json:"stateCategory,omitempty"`
	// Work item state url.
	Url *string `json:"url,omitempty"`
}

Class that represents a work item state result.

type WorkItemTypeBehavior 

type WorkItemTypeBehavior struct {
	// Reference to the behavior of a work item type
	Behavior *WorkItemBehaviorReference `json:"behavior,omitempty"`
	// If true the work item type is the default work item type in the behavior
	IsDefault *bool `json:"isDefault,omitempty"`
	// If true the work item type is the default work item type in the parent behavior
	IsLegacyDefault *bool `json:"isLegacyDefault,omitempty"`
	// URL of the work item type behavior
	Url *string `json:"url,omitempty"`
}

Association between a work item type and it's behavior

type WorkItemTypeClass 

type WorkItemTypeClass string

type WorkItemTypeModel 

type WorkItemTypeModel struct {
	Behaviors   *[]WorkItemTypeBehavior `json:"behaviors,omitempty"`
	Class       *WorkItemTypeClass      `json:"class,omitempty"`
	Color       *string                 `json:"color,omitempty"`
	Description *string                 `json:"description,omitempty"`
	Icon        *string                 `json:"icon,omitempty"`
	Id          *string                 `json:"id,omitempty"`
	// Parent WIT Id/Internal ReferenceName that it inherits from
	Inherits   *string                     `json:"inherits,omitempty"`
	IsDisabled *bool                       `json:"isDisabled,omitempty"`
	Layout     *FormLayout                 `json:"layout,omitempty"`
	Name       *string                     `json:"name,omitempty"`
	States     *[]WorkItemStateResultModel `json:"states,omitempty"`
	Url        *string                     `json:"url,omitempty"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

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