interface IWorkItemTrackingProcessApi {
    baseUrl: string;
    http: HttpClient;
    rest: RestClient;
    userAgent: string;
    vsoClient: VsoClient;
    addBehaviorToWorkItemType(
        behavior: WorkItemTypeBehavior,
        processId: string,
        witRefNameForBehaviors: string,
    ): Promise<WorkItemTypeBehavior>;
    addFieldToWorkItemType(
        field: AddProcessWorkItemTypeFieldRequest,
        processId: string,
        witRefName: string,
    ): Promise<ProcessWorkItemTypeField>;
    addGroup(
        group: Group,
        processId: string,
        witRefName: string,
        pageId: string,
        sectionId: string,
    ): Promise<Group>;
    addPage(page: Page, processId: string, witRefName: string): Promise<Page>;
    addProcessWorkItemTypeRule(
        processRuleCreate: CreateProcessRuleRequest,
        processId: string,
        witRefName: string,
    ): Promise<ProcessRule>;
    createAcceptHeader(type: string, apiVersion?: string): string;
    createControlInGroup(
        control: Control,
        processId: string,
        witRefName: string,
        groupId: string,
    ): Promise<Control>;
    createList(picklist: PickList): Promise<PickList>;
    createNewProcess(createRequest: CreateProcessModel): Promise<ProcessInfo>;
    createProcessBehavior(
        behavior: ProcessBehaviorCreateRequest,
        processId: string,
    ): Promise<ProcessBehavior>;
    createProcessWorkItemType(
        workItemType: CreateProcessWorkItemTypeRequest,
        processId: string,
    ): Promise<ProcessWorkItemType>;
    createRequestOptions(type: string, apiVersion?: string): IRequestOptions;
    createStateDefinition(
        stateModel: WorkItemStateInputModel,
        processId: string,
        witRefName: string,
    ): Promise<WorkItemStateResultModel>;
    deleteList(listId: string): Promise<void>;
    deleteProcessBehavior(
        processId: string,
        behaviorRefName: string,
    ): Promise<void>;
    deleteProcessById(processTypeId: string): Promise<void>;
    deleteProcessWorkItemType(
        processId: string,
        witRefName: string,
    ): Promise<void>;
    deleteProcessWorkItemTypeRule(
        processId: string,
        witRefName: string,
        ruleId: string,
    ): Promise<void>;
    deleteStateDefinition(
        processId: string,
        witRefName: string,
        stateId: string,
    ): Promise<void>;
    deleteSystemControl(
        processId: string,
        witRefName: string,
        controlId: string,
    ): Promise<Control[]>;
    editProcess(
        updateRequest: UpdateProcessModel,
        processTypeId: string,
    ): Promise<ProcessInfo>;
    formatResponse(
        data: any,
        responseTypeMetadata: any,
        isCollection: boolean,
    ): any;
    getAllWorkItemTypeFields(
        processId: string,
        witRefName: string,
    ): Promise<ProcessWorkItemTypeField[]>;
    getBehaviorForWorkItemType(
        processId: string,
        witRefNameForBehaviors: string,
        behaviorRefName: string,
    ): Promise<WorkItemTypeBehavior>;
    getBehaviorsForWorkItemType(
        processId: string,
        witRefNameForBehaviors: string,
    ): Promise<WorkItemTypeBehavior[]>;
    getFormLayout(processId: string, witRefName: string): Promise<FormLayout>;
    getList(listId: string): Promise<PickList>;
    getListOfProcesses(expand?: GetProcessExpandLevel): Promise<ProcessInfo[]>;
    getListsMetadata(): Promise<PickListMetadata[]>;
    getProcessBehavior(
        processId: string,
        behaviorRefName: string,
        expand?: GetBehaviorsExpand,
    ): Promise<ProcessBehavior>;
    getProcessBehaviors(
        processId: string,
        expand?: GetBehaviorsExpand,
    ): Promise<ProcessBehavior[]>;
    getProcessByItsId(
        processTypeId: string,
        expand?: GetProcessExpandLevel,
    ): Promise<ProcessInfo>;
    getProcessWorkItemType(
        processId: string,
        witRefName: string,
        expand?: GetWorkItemTypeExpand,
    ): Promise<ProcessWorkItemType>;
    getProcessWorkItemTypeRule(
        processId: string,
        witRefName: string,
        ruleId: string,
    ): Promise<ProcessRule>;
    getProcessWorkItemTypeRules(
        processId: string,
        witRefName: string,
    ): Promise<ProcessRule[]>;
    getProcessWorkItemTypes(
        processId: string,
        expand?: GetWorkItemTypeExpand,
    ): Promise<ProcessWorkItemType[]>;
    getStateDefinition(
        processId: string,
        witRefName: string,
        stateId: string,
    ): Promise<WorkItemStateResultModel>;
    getStateDefinitions(
        processId: string,
        witRefName: string,
    ): Promise<WorkItemStateResultModel[]>;
    getSystemControls(
        processId: string,
        witRefName: string,
    ): Promise<Control[]>;
    getWorkItemTypeField(
        processId: string,
        witRefName: string,
        fieldRefName: string,
        expand?: ProcessWorkItemTypeFieldsExpandLevel,
    ): Promise<ProcessWorkItemTypeField>;
    hideStateDefinition(
        hideStateModel: HideStateModel,
        processId: string,
        witRefName: string,
        stateId: string,
    ): Promise<WorkItemStateResultModel>;
    moveControlToGroup(
        control: Control,
        processId: string,
        witRefName: string,
        groupId: string,
        controlId: string,
        removeFromGroupId?: string,
    ): Promise<Control>;
    moveGroupToPage(
        group: Group,
        processId: string,
        witRefName: string,
        pageId: string,
        sectionId: string,
        groupId: string,
        removeFromPageId: string,
        removeFromSectionId: string,
    ): Promise<Group>;
    moveGroupToSection(
        group: Group,
        processId: string,
        witRefName: string,
        pageId: string,
        sectionId: string,
        groupId: string,
        removeFromSectionId: string,
    ): Promise<Group>;
    removeBehaviorFromWorkItemType(
        processId: string,
        witRefNameForBehaviors: string,
        behaviorRefName: string,
    ): Promise<void>;
    removeControlFromGroup(
        processId: string,
        witRefName: string,
        groupId: string,
        controlId: 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>;
    removeWorkItemTypeField(
        processId: string,
        witRefName: string,
        fieldRefName: string,
    ): Promise<void>;
    updateBehaviorToWorkItemType(
        behavior: WorkItemTypeBehavior,
        processId: string,
        witRefNameForBehaviors: string,
    ): Promise<WorkItemTypeBehavior>;
    updateControl(
        control: Control,
        processId: string,
        witRefName: string,
        groupId: string,
        controlId: string,
    ): Promise<Control>;
    updateGroup(
        group: Group,
        processId: string,
        witRefName: string,
        pageId: string,
        sectionId: string,
        groupId: string,
    ): Promise<Group>;
    updateList(picklist: PickList, listId: string): Promise<PickList>;
    updatePage(
        page: Page,
        processId: string,
        witRefName: string,
    ): Promise<Page>;
    updateProcessBehavior(
        behaviorData: ProcessBehaviorUpdateRequest,
        processId: string,
        behaviorRefName: string,
    ): Promise<ProcessBehavior>;
    updateProcessWorkItemType(
        workItemTypeUpdate: UpdateProcessWorkItemTypeRequest,
        processId: string,
        witRefName: string,
    ): Promise<ProcessWorkItemType>;
    updateProcessWorkItemTypeRule(
        processRule: UpdateProcessRuleRequest,
        processId: string,
        witRefName: string,
        ruleId: string,
    ): Promise<ProcessRule>;
    updateStateDefinition(
        stateModel: WorkItemStateInputModel,
        processId: string,
        witRefName: string,
        stateId: string,
    ): Promise<WorkItemStateResultModel>;
    updateSystemControl(
        control: Control,
        processId: string,
        witRefName: string,
        controlId: string,
    ): Promise<Control>;
    updateWorkItemTypeField(
        field: UpdateProcessWorkItemTypeFieldRequest,
        processId: string,
        witRefName: string,
        fieldRefName: string,
    ): Promise<ProcessWorkItemTypeField>;
}

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>

  • Parameters

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

    Returns Promise<Group>

  • Parameters

    • processId: string
    • witRefNameForBehaviors: string
    • behaviorRefName: string

    Returns Promise<void>

  • Parameters

    • processId: string
    • witRefName: string
    • pageId: string
    • sectionId: string
    • groupId: string

    Returns Promise<void>