Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ItemsApi

Hierarchy

  • ItemsApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new ItemsApi(basePath?: string): ItemsApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

getItems

  • getItems(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<GitItem>>

  • Get Item Metadata and/or Content for a collection of items. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content which is always returned as a download.

    Parameters

    • params: object
      • Optional $Format?: string
      • apiVersion: string
      • Optional download?: boolean
      • Optional includeContentMetadata?: boolean
      • Optional includeLinks?: boolean
      • Optional latestProcessedChange?: boolean
      • organization: string
      • project: string
      • Optional recursionLevel?: string
      • repositoryId: string
      • Optional scopePath?: string
      • Optional versionDescriptorVersion?: string
      • Optional versionDescriptorVersionOptions?: string
      • Optional versionDescriptorVersionType?: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<GitItem>>

getItemsBatch

  • getItemsBatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<Array<ERRORUNKNOWN>>>

  • Post for retrieving a creating a batch out of a set of items in a repo / project given a list of paths or a long path

    Parameters

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

    Returns Promise<ArrayWrapper<Array<ERRORUNKNOWN>>>

getItemsBatch_1

  • getItemsBatch_1(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<Array<ERRORUNKNOWN>>>

  • Post for retrieving a set of items given a list of paths or a long path. Allows for specifying the recursionLevel and version descriptors for each path.

    Parameters

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

    Returns Promise<ArrayWrapper<Array<ERRORUNKNOWN>>>

getItems_2

  • getItems_2(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<TfvcItem>>

  • Get a list of Tfvc items

    Parameters

    • params: object
      • apiVersion: string
      • Optional includeLinks?: boolean
      • organization: string
      • project: string
      • Optional recursionLevel?: string
      • Optional scopePath?: string
      • Optional versionDescriptorVersion?: string
      • Optional versionDescriptorVersionOption?: string
      • Optional versionDescriptorVersionType?: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<TfvcItem>>

Generated using TypeDoc