import basem = require('./ClientApiBases'); import VsoBaseInterfaces = require('./interfaces/common/VsoBaseInterfaces'); import WorkItemTrackingProcessInterfaces = require("./interfaces/WorkItemTrackingProcessInterfaces"); export interface IWorkItemTrackingProcessApi extends basem.ClientApiBase { createProcessBehavior(behavior: WorkItemTrackingProcessInterfaces.ProcessBehaviorCreateRequest, processId: string): Promise; deleteProcessBehavior(processId: string, behaviorRefName: string): Promise; getProcessBehavior(processId: string, behaviorRefName: string, expand?: WorkItemTrackingProcessInterfaces.GetBehaviorsExpand): Promise; getProcessBehaviors(processId: string, expand?: WorkItemTrackingProcessInterfaces.GetBehaviorsExpand): Promise; updateProcessBehavior(behaviorData: WorkItemTrackingProcessInterfaces.ProcessBehaviorUpdateRequest, processId: string, behaviorRefName: string): Promise; createControlInGroup(control: WorkItemTrackingProcessInterfaces.Control, processId: string, witRefName: string, groupId: string): Promise; moveControlToGroup(control: WorkItemTrackingProcessInterfaces.Control, processId: string, witRefName: string, groupId: string, controlId: string, removeFromGroupId?: string): Promise; removeControlFromGroup(processId: string, witRefName: string, groupId: string, controlId: string): Promise; updateControl(control: WorkItemTrackingProcessInterfaces.Control, processId: string, witRefName: string, groupId: string, controlId: string): Promise; addFieldToWorkItemType(field: WorkItemTrackingProcessInterfaces.AddProcessWorkItemTypeFieldRequest, processId: string, witRefName: string): Promise; getAllWorkItemTypeFields(processId: string, witRefName: string): Promise; getWorkItemTypeField(processId: string, witRefName: string, fieldRefName: string): Promise; removeWorkItemTypeField(processId: string, witRefName: string, fieldRefName: string): Promise; updateWorkItemTypeField(field: WorkItemTrackingProcessInterfaces.UpdateProcessWorkItemTypeFieldRequest, processId: string, witRefName: string, fieldRefName: string): Promise; addGroup(group: WorkItemTrackingProcessInterfaces.Group, processId: string, witRefName: string, pageId: string, sectionId: string): Promise; moveGroupToPage(group: WorkItemTrackingProcessInterfaces.Group, processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string, removeFromPageId: string, removeFromSectionId: string): Promise; moveGroupToSection(group: WorkItemTrackingProcessInterfaces.Group, processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string, removeFromSectionId: string): Promise; removeGroup(processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string): Promise; updateGroup(group: WorkItemTrackingProcessInterfaces.Group, processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string): Promise; getFormLayout(processId: string, witRefName: string): Promise; createList(picklist: WorkItemTrackingProcessInterfaces.PickList): Promise; deleteList(listId: string): Promise; getList(listId: string): Promise; getListsMetadata(): Promise; updateList(picklist: WorkItemTrackingProcessInterfaces.PickList, listId: string): Promise; addPage(page: WorkItemTrackingProcessInterfaces.Page, processId: string, witRefName: string): Promise; removePage(processId: string, witRefName: string, pageId: string): Promise; updatePage(page: WorkItemTrackingProcessInterfaces.Page, processId: string, witRefName: string): Promise; createNewProcess(createRequest: WorkItemTrackingProcessInterfaces.CreateProcessModel): Promise; deleteProcessById(processTypeId: string): Promise; editProcess(updateRequest: WorkItemTrackingProcessInterfaces.UpdateProcessModel, processTypeId: string): Promise; getListOfProcesses(expand?: WorkItemTrackingProcessInterfaces.GetProcessExpandLevel): Promise; getProcessByItsId(processTypeId: string, expand?: WorkItemTrackingProcessInterfaces.GetProcessExpandLevel): Promise; addProcessWorkItemTypeRule(processRuleCreate: WorkItemTrackingProcessInterfaces.CreateProcessRuleRequest, processId: string, witRefName: string): Promise; deleteProcessWorkItemTypeRule(processId: string, witRefName: string, ruleId: string): Promise; getProcessWorkItemTypeRule(processId: string, witRefName: string, ruleId: string): Promise; getProcessWorkItemTypeRules(processId: string, witRefName: string): Promise; updateProcessWorkItemTypeRule(processRule: WorkItemTrackingProcessInterfaces.UpdateProcessRuleRequest, processId: string, witRefName: string, ruleId: string): Promise; createStateDefinition(stateModel: WorkItemTrackingProcessInterfaces.WorkItemStateInputModel, processId: string, witRefName: string): Promise; deleteStateDefinition(processId: string, witRefName: string, stateId: string): Promise; getStateDefinition(processId: string, witRefName: string, stateId: string): Promise; getStateDefinitions(processId: string, witRefName: string): Promise; hideStateDefinition(hideStateModel: WorkItemTrackingProcessInterfaces.HideStateModel, processId: string, witRefName: string, stateId: string): Promise; updateStateDefinition(stateModel: WorkItemTrackingProcessInterfaces.WorkItemStateInputModel, processId: string, witRefName: string, stateId: string): Promise; createProcessWorkItemType(workItemType: WorkItemTrackingProcessInterfaces.CreateProcessWorkItemTypeRequest, processId: string): Promise; deleteProcessWorkItemType(processId: string, witRefName: string): Promise; getProcessWorkItemType(processId: string, witRefName: string, expand?: WorkItemTrackingProcessInterfaces.GetWorkItemTypeExpand): Promise; getProcessWorkItemTypes(processId: string, expand?: WorkItemTrackingProcessInterfaces.GetWorkItemTypeExpand): Promise; updateProcessWorkItemType(workItemTypeUpdate: WorkItemTrackingProcessInterfaces.UpdateProcessWorkItemTypeRequest, processId: string, witRefName: string): Promise; addBehaviorToWorkItemType(behavior: WorkItemTrackingProcessInterfaces.WorkItemTypeBehavior, processId: string, witRefNameForBehaviors: string): Promise; getBehaviorForWorkItemType(processId: string, witRefNameForBehaviors: string, behaviorRefName: string): Promise; getBehaviorsForWorkItemType(processId: string, witRefNameForBehaviors: string): Promise; removeBehaviorFromWorkItemType(processId: string, witRefNameForBehaviors: string, behaviorRefName: string): Promise; updateBehaviorToWorkItemType(behavior: WorkItemTrackingProcessInterfaces.WorkItemTypeBehavior, processId: string, witRefNameForBehaviors: string): Promise; } export declare class WorkItemTrackingProcessApi extends basem.ClientApiBase implements IWorkItemTrackingProcessApi { constructor(baseUrl: string, handlers: VsoBaseInterfaces.IRequestHandler[], options?: VsoBaseInterfaces.IRequestOptions); static readonly RESOURCE_AREA_ID: string; /** * Creates a single behavior in the given process. * * @param {WorkItemTrackingProcessInterfaces.ProcessBehaviorCreateRequest} behavior * @param {string} processId - The ID of the process */ createProcessBehavior(behavior: WorkItemTrackingProcessInterfaces.ProcessBehaviorCreateRequest, processId: string): Promise; /** * Removes a behavior in the process. * * @param {string} processId - The ID of the process * @param {string} behaviorRefName - The reference name of the behavior */ deleteProcessBehavior(processId: string, behaviorRefName: string): Promise; /** * Returns a behavior of the process. * * @param {string} processId - The ID of the process * @param {string} behaviorRefName - The reference name of the behavior * @param {WorkItemTrackingProcessInterfaces.GetBehaviorsExpand} expand */ getProcessBehavior(processId: string, behaviorRefName: string, expand?: WorkItemTrackingProcessInterfaces.GetBehaviorsExpand): Promise; /** * Returns a list of all behaviors in the process. * * @param {string} processId - The ID of the process * @param {WorkItemTrackingProcessInterfaces.GetBehaviorsExpand} expand */ getProcessBehaviors(processId: string, expand?: WorkItemTrackingProcessInterfaces.GetBehaviorsExpand): Promise; /** * Replaces a behavior in the process. * * @param {WorkItemTrackingProcessInterfaces.ProcessBehaviorUpdateRequest} behaviorData * @param {string} processId - The ID of the process * @param {string} behaviorRefName - The reference name of the behavior */ updateProcessBehavior(behaviorData: WorkItemTrackingProcessInterfaces.ProcessBehaviorUpdateRequest, processId: string, behaviorRefName: string): Promise; /** * Creates a control in a group. * * @param {WorkItemTrackingProcessInterfaces.Control} control - The control. * @param {string} processId - The ID of the process. * @param {string} witRefName - The reference name of the work item type. * @param {string} groupId - The ID of the group to add the control to. */ createControlInGroup(control: WorkItemTrackingProcessInterfaces.Control, processId: string, witRefName: string, groupId: string): Promise; /** * Moves a control to a specified group. * * @param {WorkItemTrackingProcessInterfaces.Control} control - The control. * @param {string} processId - The ID of the process. * @param {string} witRefName - The reference name of the work item type. * @param {string} groupId - The ID of the group to move the control to. * @param {string} controlId - The ID of the control. * @param {string} removeFromGroupId - The group ID to remove the control from. */ moveControlToGroup(control: WorkItemTrackingProcessInterfaces.Control, processId: string, witRefName: string, groupId: string, controlId: string, removeFromGroupId?: string): Promise; /** * Removes a control from the work item form. * * @param {string} processId - The ID of the process. * @param {string} witRefName - The reference name of the work item type. * @param {string} groupId - The ID of the group. * @param {string} controlId - The ID of the control to remove. */ removeControlFromGroup(processId: string, witRefName: string, groupId: string, controlId: string): Promise; /** * Updates a control on the work item form. * * @param {WorkItemTrackingProcessInterfaces.Control} control - The updated control. * @param {string} processId - The ID of the process. * @param {string} witRefName - The reference name of the work item type. * @param {string} groupId - The ID of the group. * @param {string} controlId - The ID of the control. */ updateControl(control: WorkItemTrackingProcessInterfaces.Control, processId: string, witRefName: string, groupId: string, controlId: string): Promise; /** * Adds a field to a work item type. * * @param {WorkItemTrackingProcessInterfaces.AddProcessWorkItemTypeFieldRequest} field * @param {string} processId - The ID of the process. * @param {string} witRefName - The reference name of the work item type. */ addFieldToWorkItemType(field: WorkItemTrackingProcessInterfaces.AddProcessWorkItemTypeFieldRequest, processId: string, witRefName: string): Promise; /** * Returns a list of all fields in a work item type. * * @param {string} processId - The ID of the process. * @param {string} witRefName - The reference name of the work item type. */ getAllWorkItemTypeFields(processId: string, witRefName: string): Promise; /** * Returns a field in a work item type. * * @param {string} processId - The ID of the process. * @param {string} witRefName - The reference name of the work item type. * @param {string} fieldRefName - The reference name of the field. */ getWorkItemTypeField(processId: string, witRefName: string, fieldRefName: string): Promise; /** * Removes a field from a work item type. Does not permanently delete the field. * * @param {string} processId - The ID of the process. * @param {string} witRefName - The reference name of the work item type. * @param {string} fieldRefName - The reference name of the field. */ removeWorkItemTypeField(processId: string, witRefName: string, fieldRefName: string): Promise; /** * Updates a field in a work item type. * * @param {WorkItemTrackingProcessInterfaces.UpdateProcessWorkItemTypeFieldRequest} field * @param {string} processId - The ID of the process. * @param {string} witRefName - The reference name of the work item type. * @param {string} fieldRefName - The reference name of the field. */ updateWorkItemTypeField(field: WorkItemTrackingProcessInterfaces.UpdateProcessWorkItemTypeFieldRequest, processId: string, witRefName: string, fieldRefName: string): Promise; /** * Adds a group to the work item form. * * @param {WorkItemTrackingProcessInterfaces.Group} group - The group. * @param {string} processId - The ID of the process. * @param {string} witRefName - The reference name of the work item type. * @param {string} pageId - The ID of the page to add the group to. * @param {string} sectionId - The ID of the section to add the group to. */ addGroup(group: WorkItemTrackingProcessInterfaces.Group, processId: string, witRefName: string, pageId: string, sectionId: string): Promise; /** * Moves a group to a different page and section. * * @param {WorkItemTrackingProcessInterfaces.Group} group - The updated group. * @param {string} processId - The ID of the process. * @param {string} witRefName - The reference name of the work item type. * @param {string} pageId - The ID of the page the group is in. * @param {string} sectionId - The ID of the section the group is i.n * @param {string} groupId - The ID of the group. * @param {string} removeFromPageId - ID of the page to remove the group from. * @param {string} removeFromSectionId - ID of the section to remove the group from. */ moveGroupToPage(group: WorkItemTrackingProcessInterfaces.Group, processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string, removeFromPageId: string, removeFromSectionId: string): Promise; /** * Moves a group to a different section. * * @param {WorkItemTrackingProcessInterfaces.Group} group - The updated group. * @param {string} processId - The ID of the process. * @param {string} witRefName - The reference name of the work item type. * @param {string} pageId - The ID of the page the group is in. * @param {string} sectionId - The ID of the section the group is in. * @param {string} groupId - The ID of the group. * @param {string} removeFromSectionId - ID of the section to remove the group from. */ moveGroupToSection(group: WorkItemTrackingProcessInterfaces.Group, processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string, removeFromSectionId: string): Promise; /** * Removes a group from the work item form. * * @param {string} processId - The ID of the process * @param {string} witRefName - The reference name of the work item type * @param {string} pageId - The ID of the page the group is in * @param {string} sectionId - The ID of the section to the group is in * @param {string} groupId - The ID of the group */ removeGroup(processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string): Promise; /** * Updates a group in the work item form. * * @param {WorkItemTrackingProcessInterfaces.Group} group - The updated group. * @param {string} processId - The ID of the process. * @param {string} witRefName - The reference name of the work item type. * @param {string} pageId - The ID of the page the group is in. * @param {string} sectionId - The ID of the section the group is in. * @param {string} groupId - The ID of the group. */ updateGroup(group: WorkItemTrackingProcessInterfaces.Group, processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string): Promise; /** * Gets the form layout. * * @param {string} processId - The ID of the process. * @param {string} witRefName - The reference name of the work item type. */ getFormLayout(processId: string, witRefName: string): Promise; /** * Creates a picklist. * * @param {WorkItemTrackingProcessInterfaces.PickList} picklist - Picklist */ createList(picklist: WorkItemTrackingProcessInterfaces.PickList): Promise; /** * Removes a picklist. * * @param {string} listId - The ID of the list */ deleteList(listId: string): Promise; /** * Returns a picklist. * * @param {string} listId - The ID of the list */ getList(listId: string): Promise; /** * Returns meta data of the picklist. * */ getListsMetadata(): Promise; /** * Updates a list. * * @param {WorkItemTrackingProcessInterfaces.PickList} picklist * @param {string} listId - The ID of the list */ updateList(picklist: WorkItemTrackingProcessInterfaces.PickList, listId: string): Promise; /** * Adds a page to the work item form. * * @param {WorkItemTrackingProcessInterfaces.Page} page - The page. * @param {string} processId - The ID of the process. * @param {string} witRefName - The reference name of the work item type. */ addPage(page: WorkItemTrackingProcessInterfaces.Page, processId: string, witRefName: string): Promise; /** * Removes a page from the work item form * * @param {string} processId - The ID of the process * @param {string} witRefName - The reference name of the work item type * @param {string} pageId - The ID of the page */ removePage(processId: string, witRefName: string, pageId: string): Promise; /** * Updates a page on the work item form * * @param {WorkItemTrackingProcessInterfaces.Page} page - The page * @param {string} processId - The ID of the process * @param {string} witRefName - The reference name of the work item type */ updatePage(page: WorkItemTrackingProcessInterfaces.Page, processId: string, witRefName: string): Promise; /** * Creates a process. * * @param {WorkItemTrackingProcessInterfaces.CreateProcessModel} createRequest - CreateProcessModel. */ createNewProcess(createRequest: WorkItemTrackingProcessInterfaces.CreateProcessModel): Promise; /** * Removes a process of a specific ID. * * @param {string} processTypeId */ deleteProcessById(processTypeId: string): Promise; /** * Edit a process of a specific ID. * * @param {WorkItemTrackingProcessInterfaces.UpdateProcessModel} updateRequest * @param {string} processTypeId */ editProcess(updateRequest: WorkItemTrackingProcessInterfaces.UpdateProcessModel, processTypeId: string): Promise; /** * Get list of all processes including system and inherited. * * @param {WorkItemTrackingProcessInterfaces.GetProcessExpandLevel} expand */ getListOfProcesses(expand?: WorkItemTrackingProcessInterfaces.GetProcessExpandLevel): Promise; /** * Get a single process of a specified ID. * * @param {string} processTypeId * @param {WorkItemTrackingProcessInterfaces.GetProcessExpandLevel} expand */ getProcessByItsId(processTypeId: string, expand?: WorkItemTrackingProcessInterfaces.GetProcessExpandLevel): Promise; /** * Adds a rule to work item type in the process. * * @param {WorkItemTrackingProcessInterfaces.CreateProcessRuleRequest} processRuleCreate * @param {string} processId - The ID of the process * @param {string} witRefName - The reference name of the work item type */ addProcessWorkItemTypeRule(processRuleCreate: WorkItemTrackingProcessInterfaces.CreateProcessRuleRequest, processId: string, witRefName: string): Promise; /** * Removes a rule from the work item type in the process. * * @param {string} processId - The ID of the process * @param {string} witRefName - The reference name of the work item type * @param {string} ruleId - The ID of the rule */ deleteProcessWorkItemTypeRule(processId: string, witRefName: string, ruleId: string): Promise; /** * Returns a single rule in the work item type of the process. * * @param {string} processId - The ID of the process * @param {string} witRefName - The reference name of the work item type * @param {string} ruleId - The ID of the rule */ getProcessWorkItemTypeRule(processId: string, witRefName: string, ruleId: string): Promise; /** * Returns a list of all rules in the work item type of the process. * * @param {string} processId - The ID of the process * @param {string} witRefName - The reference name of the work item type */ getProcessWorkItemTypeRules(processId: string, witRefName: string): Promise; /** * Updates a rule in the work item type of the process. * * @param {WorkItemTrackingProcessInterfaces.UpdateProcessRuleRequest} processRule * @param {string} processId - The ID of the process * @param {string} witRefName - The reference name of the work item type * @param {string} ruleId - The ID of the rule */ updateProcessWorkItemTypeRule(processRule: WorkItemTrackingProcessInterfaces.UpdateProcessRuleRequest, processId: string, witRefName: string, ruleId: string): Promise; /** * Creates a state definition in the work item type of the process. * * @param {WorkItemTrackingProcessInterfaces.WorkItemStateInputModel} stateModel * @param {string} processId - The ID of the process * @param {string} witRefName - The reference name of the work item type */ createStateDefinition(stateModel: WorkItemTrackingProcessInterfaces.WorkItemStateInputModel, processId: string, witRefName: string): Promise; /** * Removes a state definition in the work item type of the process. * * @param {string} processId - ID of the process * @param {string} witRefName - The reference name of the work item type * @param {string} stateId - ID of the state */ deleteStateDefinition(processId: string, witRefName: string, stateId: string): Promise; /** * Returns a single state definition in a work item type of the process. * * @param {string} processId - The ID of the process * @param {string} witRefName - The reference name of the work item type * @param {string} stateId - The ID of the state */ getStateDefinition(processId: string, witRefName: string, stateId: string): Promise; /** * Returns a list of all state definitions in a work item type of the process. * * @param {string} processId - The ID of the process * @param {string} witRefName - The reference name of the work item type */ getStateDefinitions(processId: string, witRefName: string): Promise; /** * Hides a state definition in the work item type of the process.Only states with customizationType:System can be hidden. * * @param {WorkItemTrackingProcessInterfaces.HideStateModel} hideStateModel * @param {string} processId - The ID of the process * @param {string} witRefName - The reference name of the work item type * @param {string} stateId - The ID of the state */ hideStateDefinition(hideStateModel: WorkItemTrackingProcessInterfaces.HideStateModel, processId: string, witRefName: string, stateId: string): Promise; /** * Updates a given state definition in the work item type of the process. * * @param {WorkItemTrackingProcessInterfaces.WorkItemStateInputModel} stateModel * @param {string} processId - ID of the process * @param {string} witRefName - The reference name of the work item type * @param {string} stateId - ID of the state */ updateStateDefinition(stateModel: WorkItemTrackingProcessInterfaces.WorkItemStateInputModel, processId: string, witRefName: string, stateId: string): Promise; /** * Creates a work item type in the process. * * @param {WorkItemTrackingProcessInterfaces.CreateProcessWorkItemTypeRequest} workItemType * @param {string} processId - The ID of the process on which to create work item type. */ createProcessWorkItemType(workItemType: WorkItemTrackingProcessInterfaces.CreateProcessWorkItemTypeRequest, processId: string): Promise; /** * Removes a work itewm type in the process. * * @param {string} processId - The ID of the process. * @param {string} witRefName - The reference name of the work item type. */ deleteProcessWorkItemType(processId: string, witRefName: string): Promise; /** * Returns a single work item type in a process. * * @param {string} processId - The ID of the process * @param {string} witRefName - The reference name of the work item type * @param {WorkItemTrackingProcessInterfaces.GetWorkItemTypeExpand} expand - Flag to determine what properties of work item type to return */ getProcessWorkItemType(processId: string, witRefName: string, expand?: WorkItemTrackingProcessInterfaces.GetWorkItemTypeExpand): Promise; /** * Returns a list of all work item types in a process. * * @param {string} processId - The ID of the process * @param {WorkItemTrackingProcessInterfaces.GetWorkItemTypeExpand} expand - Flag to determine what properties of work item type to return */ getProcessWorkItemTypes(processId: string, expand?: WorkItemTrackingProcessInterfaces.GetWorkItemTypeExpand): Promise; /** * Updates a work item type of the process. * * @param {WorkItemTrackingProcessInterfaces.UpdateProcessWorkItemTypeRequest} workItemTypeUpdate * @param {string} processId - The ID of the process * @param {string} witRefName - The reference name of the work item type */ updateProcessWorkItemType(workItemTypeUpdate: WorkItemTrackingProcessInterfaces.UpdateProcessWorkItemTypeRequest, processId: string, witRefName: string): Promise; /** * Adds a behavior to the work item type of the process. * * @param {WorkItemTrackingProcessInterfaces.WorkItemTypeBehavior} behavior * @param {string} processId - The ID of the process * @param {string} witRefNameForBehaviors - Work item type reference name for the behavior */ addBehaviorToWorkItemType(behavior: WorkItemTrackingProcessInterfaces.WorkItemTypeBehavior, processId: string, witRefNameForBehaviors: string): Promise; /** * Returns a behavior for the work item type of the process. * * @param {string} processId - The ID of the process * @param {string} witRefNameForBehaviors - Work item type reference name for the behavior * @param {string} behaviorRefName - The reference name of the behavior */ getBehaviorForWorkItemType(processId: string, witRefNameForBehaviors: string, behaviorRefName: string): Promise; /** * Returns a list of all behaviors for the work item type of the process. * * @param {string} processId - The ID of the process * @param {string} witRefNameForBehaviors - Work item type reference name for the behavior */ getBehaviorsForWorkItemType(processId: string, witRefNameForBehaviors: string): Promise; /** * Removes a behavior for the work item type of the process. * * @param {string} processId - The ID of the process * @param {string} witRefNameForBehaviors - Work item type reference name for the behavior * @param {string} behaviorRefName - The reference name of the behavior */ removeBehaviorFromWorkItemType(processId: string, witRefNameForBehaviors: string, behaviorRefName: string): Promise; /** * Updates a behavior for the work item type of the process. * * @param {WorkItemTrackingProcessInterfaces.WorkItemTypeBehavior} behavior * @param {string} processId - The ID of the process * @param {string} witRefNameForBehaviors - Work item type reference name for the behavior */ updateBehaviorToWorkItemType(behavior: WorkItemTrackingProcessInterfaces.WorkItemTypeBehavior, processId: string, witRefNameForBehaviors: string): Promise; }