interface IWorkItemTrackingProcessDefinitionsApi {
    baseUrl: string;
    http: HttpClient;
    rest: RestClient;
    userAgent: string;
    vsoClient: VsoClient;
    addBehaviorToWorkItemType(
        behavior: WorkItemTypeBehavior,
        processId: string,
        witRefNameForBehaviors: string,
    ): Promise<WorkItemTypeBehavior>;
    addControlToGroup(
        control: Control,
        processId: string,
        witRefName: string,
        groupId: string,
    ): Promise<Control>;
    addFieldToWorkItemType(
        field: WorkItemTypeFieldModel2,
        processId: string,
        witRefNameForFields: string,
    ): Promise<WorkItemTypeFieldModel2>;
    addGroup(
        group: Group,
        processId: string,
        witRefName: string,
        pageId: string,
        sectionId: string,
    ): Promise<Group>;
    addPage(page: Page, processId: string, witRefName: string): Promise<Page>;
    createAcceptHeader(type: string, apiVersion?: string): string;
    createBehavior(
        behavior: BehaviorCreateModel,
        processId: string,
    ): Promise<BehaviorModel>;
    createField(field: FieldModel, processId: string): Promise<FieldModel>;
    createList(picklist: PickListModel): Promise<PickListModel>;
    createRequestOptions(type: string, apiVersion?: string): IRequestOptions;
    createStateDefinition(
        stateModel: WorkItemStateInputModel,
        processId: string,
        witRefName: string,
    ): Promise<WorkItemStateResultModel>;
    createWorkItemType(
        workItemType: WorkItemTypeModel,
        processId: string,
    ): Promise<WorkItemTypeModel>;
    deleteBehavior(processId: string, behaviorId: string): Promise<void>;
    deleteList(listId: string): Promise<void>;
    deleteStateDefinition(
        processId: string,
        witRefName: string,
        stateId: string,
    ): Promise<void>;
    deleteWorkItemType(processId: string, witRefName: string): Promise<void>;
    editControl(
        control: Control,
        processId: string,
        witRefName: string,
        groupId: string,
        controlId: string,
    ): Promise<Control>;
    editGroup(
        group: Group,
        processId: string,
        witRefName: string,
        pageId: string,
        sectionId: string,
        groupId: string,
    ): Promise<Group>;
    editPage(page: Page, processId: string, witRefName: string): Promise<Page>;
    formatResponse(
        data: any,
        responseTypeMetadata: any,
        isCollection: boolean,
    ): any;
    getBehavior(processId: string, behaviorId: string): Promise<BehaviorModel>;
    getBehaviorForWorkItemType(
        processId: string,
        witRefNameForBehaviors: string,
        behaviorRefName: string,
    ): Promise<WorkItemTypeBehavior>;
    getBehaviors(processId: string): Promise<BehaviorModel[]>;
    getBehaviorsForWorkItemType(
        processId: string,
        witRefNameForBehaviors: string,
    ): Promise<WorkItemTypeBehavior[]>;
    getFormLayout(processId: string, witRefName: string): Promise<FormLayout>;
    getList(listId: string): Promise<PickListModel>;
    getListsMetadata(): Promise<PickListMetadataModel[]>;
    getStateDefinition(
        processId: string,
        witRefName: string,
        stateId: string,
    ): Promise<WorkItemStateResultModel>;
    getStateDefinitions(
        processId: string,
        witRefName: string,
    ): Promise<WorkItemStateResultModel[]>;
    getWorkItemType(
        processId: string,
        witRefName: string,
        expand?: GetWorkItemTypeExpand,
    ): Promise<WorkItemTypeModel>;
    getWorkItemTypeField(
        processId: string,
        witRefNameForFields: string,
        fieldRefName: string,
    ): Promise<WorkItemTypeFieldModel2>;
    getWorkItemTypeFields(
        processId: string,
        witRefNameForFields: string,
    ): Promise<WorkItemTypeFieldModel2[]>;
    getWorkItemTypes(
        processId: string,
        expand?: GetWorkItemTypeExpand,
    ): Promise<WorkItemTypeModel[]>;
    hideStateDefinition(
        hideStateModel: HideStateModel,
        processId: string,
        witRefName: string,
        stateId: string,
    ): Promise<WorkItemStateResultModel>;
    removeBehaviorFromWorkItemType(
        processId: string,
        witRefNameForBehaviors: string,
        behaviorRefName: string,
    ): Promise<void>;
    removeControlFromGroup(
        processId: string,
        witRefName: string,
        groupId: string,
        controlId: string,
    ): Promise<void>;
    removeFieldFromWorkItemType(
        processId: string,
        witRefNameForFields: string,
        fieldRefName: string,
    ): Promise<void>;
    removeGroup(
        processId: string,
        witRefName: string,
        pageId: string,
        sectionId: string,
        groupId: string,
    ): Promise<void>;
    removePage(
        processId: string,
        witRefName: string,
        pageId: string,
    ): Promise<void>;
    replaceBehavior(
        behaviorData: BehaviorReplaceModel,
        processId: string,
        behaviorId: string,
    ): Promise<BehaviorModel>;
    setControlInGroup(
        control: Control,
        processId: string,
        witRefName: string,
        groupId: string,
        controlId: string,
        removeFromGroupId?: string,
    ): Promise<Control>;
    setGroupInPage(
        group: Group,
        processId: string,
        witRefName: string,
        pageId: string,
        sectionId: string,
        groupId: string,
        removeFromPageId: string,
        removeFromSectionId: string,
    ): Promise<Group>;
    setGroupInSection(
        group: Group,
        processId: string,
        witRefName: string,
        pageId: string,
        sectionId: string,
        groupId: string,
        removeFromSectionId: string,
    ): Promise<Group>;
    updateBehaviorToWorkItemType(
        behavior: WorkItemTypeBehavior,
        processId: string,
        witRefNameForBehaviors: string,
    ): Promise<WorkItemTypeBehavior>;
    updateField(field: FieldUpdate, processId: string): Promise<FieldModel>;
    updateList(picklist: PickListModel, listId: string): Promise<PickListModel>;
    updateStateDefinition(
        stateModel: WorkItemStateInputModel,
        processId: string,
        witRefName: string,
        stateId: string,
    ): Promise<WorkItemStateResultModel>;
    updateWorkItemType(
        workItemTypeUpdate: WorkItemTypeUpdateModel,
        processId: string,
        witRefName: string,
    ): Promise<WorkItemTypeModel>;
    updateWorkItemTypeField(
        field: WorkItemTypeFieldModel2,
        processId: string,
        witRefNameForFields: string,
    ): Promise<WorkItemTypeFieldModel2>;
}

Hierarchy (View Summary)

Implemented by

Properties

baseUrl: string
http: HttpClient
rest: RestClient
userAgent: string
vsoClient: VsoClient

Methods

  • Parameters

    • group: Group
    • processId: string
    • witRefName: string
    • pageId: string
    • sectionId: string
    • groupId: string
    • removeFromPageId: string
    • removeFromSectionId: string

    Returns Promise<Group>