Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RunsApi

Hierarchy

  • RunsApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new RunsApi(basePath?: string): RunsApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

createTestRun

  • createTestRun(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<TestRun>

  • Create new test run.

    Parameters

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

    Returns Promise<TestRun>

deleteTestRun

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

  • Delete a test run by its ID.

    Parameters

    • params: object
      • apiVersion: string
      • organization: string
      • project: string
      • runId: number
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<__type>

getTestRunById

  • getTestRunById(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<TestRun>

  • Get a test run by its ID.

    Parameters

    • params: object
      • apiVersion: string
      • Optional includeDetails?: boolean
      • organization: string
      • project: string
      • runId: number
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<TestRun>

getTestRunStatistics

  • getTestRunStatistics(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<TestRunStatistic>

  • Get test run statistics

    Parameters

    • params: object
      • apiVersion: string
      • organization: string
      • project: string
      • runId: number
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<TestRunStatistic>

getTestRuns

  • getTestRuns(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<TestRun>>

  • Get a list of test runs.

    Parameters

    • params: object
      • Optional $Skip?: number
      • Optional $Top?: number
      • apiVersion: string
      • Optional automated?: boolean
      • Optional buildUri?: string
      • Optional includeRunDetails?: boolean
      • organization: string
      • Optional owner?: string
      • Optional planId?: number
      • project: string
      • Optional tmiRunId?: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<TestRun>>

updateTestRun

  • updateTestRun(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<TestRun>

  • Update test run by its ID.

    Parameters

    • params: object
      • apiVersion: string
      • body: RunUpdateModel
      • organization: string
      • project: string
      • runId: number
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<TestRun>

Generated using TypeDoc