Options
All
  • Public
  • Public/Protected
  • All
Menu

Class QueriesApi

Hierarchy

  • QueriesApi

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

createQuery

  • createQuery(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<QueryHierarchyItem>

  • Creates a query, or moves a query. Learn more about Work Item Query Language (WIQL) syntax here.

    Parameters

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

    Returns Promise<QueryHierarchyItem>

deleteQuery

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

  • Delete a query or a folder. This deletes any permission change on the deleted query or folder and any of its descendants if it is a folder. It is important to note that the deleted permission changes cannot be recovered upon undeleting the query or folder.

    Parameters

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

    Returns Promise<__type>

getQueries

  • Gets the root queries and their children

    Parameters

    • params: object
      • Optional $Depth?: number
      • Optional $Expand?: string
      • Optional $IncludeDeleted?: boolean
      • apiVersion: string
      • organization: string
      • project: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<QueryHierarchyItem>>

getQueriesBatch

getQuery

  • getQuery(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<QueryHierarchyItem>

  • Retrieves an individual query and its children

    Parameters

    • params: object
      • Optional $Depth?: number
      • Optional $Expand?: string
      • Optional $IncludeDeleted?: boolean
      • apiVersion: string
      • organization: string
      • project: string
      • query: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<QueryHierarchyItem>

updateQuery

  • updateQuery(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<QueryHierarchyItem>

  • Update a query or a folder. This allows you to update, rename and move queries and folders.

    Parameters

    • params: object
      • Optional $UndeleteDescendants?: boolean
      • apiVersion: string
      • body: QueryHierarchyItem
      • organization: string
      • project: string
      • query: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<QueryHierarchyItem>

Generated using TypeDoc