Options
All
  • Public
  • Public/Protected
  • All
Menu

Class StatesApi

Hierarchy

  • StatesApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new StatesApi(basePath?: string): StatesApi

Properties

Protected basePath

basePath: string = "https://dev.azure.com/"

defaultHeaders

defaultHeaders: any

Methods

createStateDefinition

  • createStateDefinition(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<WorkItemStateResultModel>

  • Creates a state definition in the work item type of the process.

    Parameters

    • params: object
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<WorkItemStateResultModel>

createStateDefinition_1

  • createStateDefinition_1(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<WorkItemStateResultModel>

  • Creates a state definition in the work item type of the process.

    Parameters

    • params: object
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<WorkItemStateResultModel>

deleteStateDefinition

  • deleteStateDefinition(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<__type>

  • Removes a state definition in the work item type of the process.

    Parameters

    • params: object
      • apiVersion: string
      • organization: string
      • processId: string
      • stateId: string
      • witRefName: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<__type>

deleteStateDefinition_2

  • deleteStateDefinition_2(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<__type>

  • Removes a state definition in the work item type of the process.

    Parameters

    • params: object
      • apiVersion: string
      • organization: string
      • processId: string
      • stateId: string
      • witRefName: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<__type>

getStateDefinition

  • Returns a state definition in the work item type of the process.

    Parameters

    • params: object
      • apiVersion: string
      • organization: string
      • processId: string
      • stateId: string
      • witRefName: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<WorkItemStateResultModel>

getStateDefinition_3

  • getStateDefinition_3(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<WorkItemStateResultModel>

  • Returns a single state definition in a work item type of the process.

    Parameters

    • params: object
      • apiVersion: string
      • organization: string
      • processId: string
      • stateId: string
      • witRefName: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<WorkItemStateResultModel>

getStateDefinitions

  • Returns a list of all state definitions in the work item type of the process.

    Parameters

    • params: object
      • apiVersion: string
      • organization: string
      • processId: string
      • witRefName: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<WorkItemStateResultModel>>

getStateDefinitions_4

  • Returns a list of all state definitions in a work item type of the process.

    Parameters

    • params: object
      • apiVersion: string
      • organization: string
      • processId: string
      • witRefName: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<WorkItemStateResultModel>>

hideStateDefinition

  • hideStateDefinition(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<WorkItemStateResultModel>

  • Hides a state definition in the work item type of the process.

    Parameters

    • params: object
      • apiVersion: string
      • body: HideStateModel
      • organization: string
      • processId: string
      • stateId: string
      • witRefName: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<WorkItemStateResultModel>

hideStateDefinition_5

  • hideStateDefinition_5(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<WorkItemStateResultModel>

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

    Parameters

    • params: object
      • apiVersion: string
      • body: HideStateModel
      • organization: string
      • processId: string
      • stateId: string
      • witRefName: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<WorkItemStateResultModel>

updateStateDefinition

  • updateStateDefinition(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<WorkItemStateResultModel>

  • Updates a given state definition in the work item type of the process.

    Parameters

    • params: object
      • apiVersion: string
      • body: WorkItemStateInputModel
      • organization: string
      • processId: string
      • stateId: string
      • witRefName: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<WorkItemStateResultModel>

updateStateDefinition_6

  • updateStateDefinition_6(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<WorkItemStateResultModel>

  • Updates a given state definition in the work item type of the process.

    Parameters

    • params: object
      • apiVersion: string
      • body: WorkItemStateInputModel
      • organization: string
      • processId: string
      • stateId: string
      • witRefName: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<WorkItemStateResultModel>

Generated using TypeDoc