Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ProcessesApi

Hierarchy

  • ProcessesApi

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

_export

  • _export(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<string>

  • Returns requested process template.

    Parameters

    • params: object
      • apiVersion: string
      • id: string
      • organization: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<string>

_import

  • _import(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ProcessImportResult>

  • Imports a process from zip file.

    Parameters

    • params: object
      • apiVersion: string
      • body: string
      • Optional ignoreWarnings?: boolean
      • organization: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ProcessImportResult>

checkTemplateExistence

  • Check if process template exists.

    Parameters

    • params: object
      • apiVersion: string
      • body: string
      • organization: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<CheckTemplateExistenceResult>

createNewProcess

  • createNewProcess(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ProcessInfo>

  • Creates a process.

    Parameters

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

    Returns Promise<ProcessInfo>

deleteProcessById

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

  • Removes a process of a specific ID.

    Parameters

    • params: object
      • apiVersion: string
      • organization: string
      • processTypeId: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<__type>

editProcess

  • editProcess(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ProcessInfo>

  • Edit a process of a specific ID.

    Parameters

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

    Returns Promise<ProcessInfo>

getListOfProcesses

  • getListOfProcesses(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<ProcessInfo>>

  • Get list of all processes including system and inherited.

    Parameters

    • params: object
      • Optional $Expand?: string
      • apiVersion: string
      • organization: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<ProcessInfo>>

getProcessById

  • getProcessById(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Process>

  • Get a process by ID.

    Parameters

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

    Returns Promise<Process>

getProcessByItsId

  • getProcessByItsId(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ProcessInfo>

  • Get a single process of a specified ID.

    Parameters

    • params: object
      • Optional $Expand?: string
      • apiVersion: string
      • organization: string
      • processTypeId: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ProcessInfo>

getProcesses

  • getProcesses(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<Process>>

  • Get a list of processes.

    Parameters

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

    Returns Promise<ArrayWrapper<Process>>

status

  • status(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ProcessPromoteStatus>

  • Tells whether promote has completed for the specified promote job ID.

    Parameters

    • params: object
      • apiVersion: string
      • id: string
      • organization: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ProcessPromoteStatus>

Generated using TypeDoc