Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PointsApi

Hierarchy

  • PointsApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new PointsApi(basePath?: string): PointsApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

getPoint

  • getPoint(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<TestPoint>

  • Get a test point.

    Parameters

    • params: object
      • apiVersion: string
      • organization: string
      • planId: number
      • pointIds: number
      • project: string
      • suiteId: number
      • Optional witFields?: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<TestPoint>

getPoints

  • getPoints(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<TestPoint>>

  • Get a list of test points.

    Parameters

    • params: object
      • Optional $Skip?: number
      • Optional $Top?: number
      • apiVersion: string
      • Optional configurationId?: string
      • Optional includePointDetails?: boolean
      • organization: string
      • planId: number
      • project: string
      • suiteId: number
      • Optional testCaseId?: string
      • Optional testPointIds?: string
      • Optional witFields?: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<TestPoint>>

getPointsByQuery

  • getPointsByQuery(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<TestPointsQuery>

  • Get test points using query.

    Parameters

    • params: object
      • Optional $Skip?: number
      • Optional $Top?: number
      • apiVersion: string
      • body: TestPointsQuery
      • organization: string
      • project: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<TestPointsQuery>

updateTestPoints

  • updateTestPoints(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<TestPoint>>

  • Update test points.

    Parameters

    • params: object
      • apiVersion: string
      • body: PointUpdateModel
      • organization: string
      • planId: number
      • pointIds: string
      • project: string
      • suiteId: number
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<TestPoint>>

Generated using TypeDoc