CoreRestClient class

Пакет:: azure-devops-extension-api

Базовый класс, который должен использоваться (производный от) для выполнения запросов к REST API VSS

Extends: RestClientBase

Конструкторы

Свойства

Методы

createConnectedService(WebApiConnectedServiceDetails, string)
createIdentityMru(IdentityData, string)
createOrUpdateProxy(Proxy)
createTeam(WebApiTeam, string)	Создание команды в командном проекте.
deleteIdentityMru(IdentityData, string)
deleteProxy(string, string)
deleteTeam(string, string)	Удаление команды.
getAllTeams(boolean, number, number, boolean)	Получите список всех команд.
getConnectedServiceDetails(string, string)
getConnectedServices(string, ConnectedServiceKind)
getIdentityMru(string)
getProcessById(string)	Получить процесс по ID.
getProcesses()	Получите список процессов.
getProject(string, boolean, boolean)	Получите проект с указанным идентификатором или именем, при необходимости включая возможности.
getProjectCollection(string)	Получите коллекцию проектов с указанным id или именем.
getProjectCollections(number, number)	Получите ссылки на коллекцию проектов для этого приложения.
getProjectHistoryEntries(number)	Получает историю изменений в проекте.
getProjectProperties(string, string[])	Получите коллекцию свойств командного проекта.
getProjects(any, number, number, number, boolean)	Получите все проекты в организации, к которым у аутентифицированного пользователя есть доступ.
getProjectsProperties(string[], string[])	Получите коллекцию свойств командных проектов для нескольких проектов.
getProjectTeamsByCategory(string, boolean, number, number)	Получает список читаемых пользователем команд в проекте, в которых пользователь состоит (исключен из читабельного списка).
getProxies(string)
getTeam(string, string, boolean)	Подберите конкретную команду.
getTeamMembersWithExtendedProperties(string, string, number, number)	Получите список участников для определенной команды.
getTeams(string, boolean, number, number, boolean)	Получите список команд.
queueCreateProject(TeamProject)	Ставит в очередь проект, который должен быть создан. Используйте GetOperation для периодической проверки состояния созданного проекта.
queueDeleteProject(string)	Ставит в очередь проект, который необходимо удалить. Используйте GetOperation для периодической проверки состояния удаленного проекта.
removeProjectAvatar(string)	Удаляет аватар для проекта.
setProjectAvatar(ProjectAvatar, string)	Устанавливает аватар для проекта.
setProjectProperties(string, JsonPatchDocument)	Создание, обновление и удаление свойств командного проекта.
updateIdentityMru(IdentityData, string)
updateProject(TeamProject, string)	Обновление имени, аббревиатуры, описания существующего проекта или восстановление проекта.
updateTeam(WebApiTeam, string, string)	Обновите название и/или описание команды.

Сведения о конструкторе

CoreRestClient(IVssRestClientOptions)

new CoreRestClient(options: IVssRestClientOptions)

Параметры

options: IVssRestClientOptions

Сведения о свойстве

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Значение свойства

string

Сведения о методе

createConnectedService(WebApiConnectedServiceDetails, string)

function createConnectedService(connectedServiceCreationData: WebApiConnectedServiceDetails, projectId: string): Promise<WebApiConnectedService>

Параметры

connectedServiceCreationData: WebApiConnectedServiceDetails

projectId: string

Возвращаемое значение

Promise<WebApiConnectedService>

createIdentityMru(IdentityData, string)

function createIdentityMru(mruData: IdentityData, mruName: string): Promise<void>

Параметры

mruData: IdentityData

mruName: string

Возвращаемое значение

Promise<void>

createOrUpdateProxy(Proxy)

function createOrUpdateProxy(proxy: Proxy): Promise<Proxy>

Параметры

proxy: Proxy

Возвращаемое значение

Promise<Proxy>

createTeam(WebApiTeam, string)

Создание команды в командном проекте.

function createTeam(team: WebApiTeam, projectId: string): Promise<WebApiTeam>

Параметры

team: WebApiTeam

Данные команды, использованные для создания команды.

projectId: string

Имя или идентификатор (GUID) командного проекта, в котором создается команда.

Возвращаемое значение

Promise<WebApiTeam>

deleteIdentityMru(IdentityData, string)

function deleteIdentityMru(mruData: IdentityData, mruName: string): Promise<void>

Параметры

mruData: IdentityData

mruName: string

Возвращаемое значение

Promise<void>

deleteProxy(string, string)

function deleteProxy(proxyUrl: string, site?: string): Promise<void>

Параметры

proxyUrl: string

site: string

Возвращаемое значение

Promise<void>

deleteTeam(string, string)

Удаление команды.

function deleteTeam(projectId: string, teamId: string): Promise<void>

Параметры

projectId: string

Имя или идентификатор (GUID) командного проекта, содержащего удаляемую команду.

teamId: string

Название или идентификатор удаляемой команды.

Возвращаемое значение

Promise<void>

getAllTeams(boolean, number, number, boolean)

Получите список всех команд.

function getAllTeams(mine?: boolean, top?: number, skip?: number, expandIdentity?: boolean): Promise<WebApiTeam[]>

Параметры

mine: boolean

Если true, то возвращаются все команды, запрашивающие пользователя как участника. В противном случае возвращаются все команды пользователя, имеющего доступ на чтение.

top: number

Максимальное количество возвращаемых команд.

skip: number

Количество команд, которые нужно пропустить.

expandIdentity: boolean

Значение, указывающее, следует ли расширять информацию об удостоверении в результирующем объекте WebApiTeam.

Возвращаемое значение

Promise<WebApiTeam[]>

getConnectedServiceDetails(string, string)

function getConnectedServiceDetails(projectId: string, name: string): Promise<WebApiConnectedServiceDetails>

Параметры

projectId: string

name: string

Возвращаемое значение

Promise<WebApiConnectedServiceDetails>

getConnectedServices(string, ConnectedServiceKind)

function getConnectedServices(projectId: string, kind?: ConnectedServiceKind): Promise<WebApiConnectedService[]>

Параметры

projectId: string

kind: ConnectedServiceKind

Возвращаемое значение

Promise<WebApiConnectedService[]>

getIdentityMru(string)

function getIdentityMru(mruName: string): Promise<IdentityRef[]>

Параметры

mruName: string

Возвращаемое значение

Promise<IdentityRef[]>

getProcessById(string)

Получить процесс по ID.

function getProcessById(processId: string): Promise<Process>

Параметры

processId: string

ID для процесса.

Возвращаемое значение

Promise<Process>

getProcesses()

Получите список процессов.

function getProcesses(): Promise<Process[]>

Возвращаемое значение

Promise<Process[]>

getProject(string, boolean, boolean)

Получите проект с указанным идентификатором или именем, при необходимости включая возможности.

function getProject(projectId: string, includeCapabilities?: boolean, includeHistory?: boolean): Promise<TeamProject>

Параметры

projectId: string

includeCapabilities: boolean

Включите возможности (например, систему управления версиями) в результат командного проекта (по умолчанию: false).

includeHistory: boolean

Поиск по переименованным проектам (которые носили такое имя в прошлом).

Возвращаемое значение

Promise<TeamProject>

getProjectCollection(string)

Получите коллекцию проектов с указанным id или именем.

function getProjectCollection(collectionId: string): Promise<TeamProjectCollection>

Параметры

collectionId: string

Возвращаемое значение

Promise<TeamProjectCollection>

getProjectCollections(number, number)

Получите ссылки на коллекцию проектов для этого приложения.

function getProjectCollections(top?: number, skip?: number): Promise<TeamProjectCollectionReference[]>

Параметры

top: number

skip: number

Возвращаемое значение

Promise<TeamProjectCollectionReference[]>

getProjectHistoryEntries(number)

Получает историю изменений в проекте.

function getProjectHistoryEntries(minRevision?: number): Promise<ProjectInfo[]>

Параметры

minRevision: number

Минимальный номер ревизии для возвращения в историю.

Возвращаемое значение

Promise<ProjectInfo[]>

getProjectProperties(string, string[])

Получите коллекцию свойств командного проекта.

function getProjectProperties(projectId: string, keys?: string[]): Promise<ProjectProperty[]>

Параметры

projectId: string

Идентификатор командного проекта.

keys: string[]

Строка имен свойств командного проекта, разделенная запятыми. Поддерживаются подстановочные знаки («?» и «*»). Если ключ не указан, будут возвращены все свойства.

Возвращаемое значение

Promise<ProjectProperty[]>

getProjects(any, number, number, number, boolean)

Получите все проекты в организации, к которым у аутентифицированного пользователя есть доступ.

function getProjects(stateFilter?: any, top?: number, skip?: number, continuationToken?: number, getDefaultTeamImageUrl?: boolean): Promise<PagedList<TeamProjectReference>>

Параметры

stateFilter: any

Фильтрация командных проектов в определенном состоянии командного проекта (по умолчанию: WellFormed).

top: number

skip: number

continuationToken: number

Указатель, показывающий, сколько проектов уже было получено.

getDefaultTeamImageUrl: boolean

Возвращаемое значение

Promise<PagedList<TeamProjectReference>>

getProjectsProperties(string[], string[])

Получите коллекцию свойств командных проектов для нескольких проектов.

function getProjectsProperties(projectIds: string[], properties?: string[]): Promise<ProjectProperties[]>

Параметры

projectIds: string[]

Строка идентификаторов командных проектов, разделенных запятыми

properties: string[]

Возвращаемое значение

Promise<ProjectProperties[]>

getProjectTeamsByCategory(string, boolean, number, number)

Получает список читаемых пользователем команд в проекте, в которых пользователь состоит (исключен из читабельного списка).

function getProjectTeamsByCategory(projectId: string, expandIdentity?: boolean, top?: number, skip?: number): Promise<CategorizedWebApiTeams>

Параметры

projectId: string

Имя или идентификатор (GUID) командного проекта, содержащего команды для извлечения.

expandIdentity: boolean

Значение, указывающее, следует ли расширять информацию об удостоверении в результирующем объекте WebApiTeam.

top: number

Максимальное количество возвращаемых команд.

skip: number

Количество команд, которые нужно пропустить.

Возвращаемое значение

Promise<CategorizedWebApiTeams>

getProxies(string)

function getProxies(proxyUrl?: string): Promise<Proxy[]>

Параметры

proxyUrl: string

Возвращаемое значение

Promise<Proxy[]>

getTeam(string, string, boolean)

Подберите конкретную команду.

function getTeam(projectId: string, teamId: string, expandIdentity?: boolean): Promise<WebApiTeam>

Параметры

projectId: string

Имя или идентификатор (GUID) командного проекта, содержащего команду.

teamId: string

Имя или идентификатор (GUID) команды.

expandIdentity: boolean

Значение, указывающее, следует ли расширять информацию об удостоверении в результирующем объекте WebApiTeam.

Возвращаемое значение

Promise<WebApiTeam>

getTeamMembersWithExtendedProperties(string, string, number, number)

Получите список участников для определенной команды.

function getTeamMembersWithExtendedProperties(projectId: string, teamId: string, top?: number, skip?: number): Promise<TeamMember[]>

Параметры

projectId: string

Имя или идентификатор (GUID) командного проекта, к которому принадлежит команда.

teamId: string

Имя или идентификатор (GUID) команды .

top: number

skip: number

Возвращаемое значение

Promise<TeamMember[]>

getTeams(string, boolean, number, number, boolean)

Получите список команд.

function getTeams(projectId: string, mine?: boolean, top?: number, skip?: number, expandIdentity?: boolean): Promise<WebApiTeam[]>

Параметры

projectId: string

mine: boolean

Если true, возвращает всех запрашивающих пользователей команд является участником, в противном случае возвращает всех пользователей, у которых есть доступ на чтение.

top: number

Максимальное количество возвращаемых команд.

skip: number

Количество команд, которые нужно пропустить.

expandIdentity: boolean

Значение, указывающее, следует ли расширять информацию об удостоверении в результирующем объекте WebApiTeam.

Возвращаемое значение

Promise<WebApiTeam[]>

queueCreateProject(TeamProject)

Ставит в очередь проект, который должен быть создан. Используйте GetOperation для периодической проверки состояния созданного проекта.

function queueCreateProject(projectToCreate: TeamProject): Promise<OperationReference>

Параметры

projectToCreate: TeamProject

Проект для создания.

Возвращаемое значение

Promise<OperationReference>

queueDeleteProject(string)

Ставит в очередь проект, который необходимо удалить. Используйте GetOperation для периодической проверки состояния удаленного проекта.

function queueDeleteProject(projectId: string): Promise<OperationReference>

Параметры

projectId: string

Идентификатор удаляемого проекта.

Возвращаемое значение

Promise<OperationReference>

removeProjectAvatar(string)

Удаляет аватар для проекта.

function removeProjectAvatar(projectId: string): Promise<void>

Параметры

projectId: string

Идентификатор или название проекта.

Возвращаемое значение

Promise<void>

setProjectAvatar(ProjectAvatar, string)

Устанавливает аватар для проекта.

function setProjectAvatar(avatarBlob: ProjectAvatar, projectId: string): Promise<void>

Параметры

avatarBlob: ProjectAvatar

Объект данных BLOB-объекта аватара для отправки.

projectId: string

Идентификатор или название проекта.

Возвращаемое значение

Promise<void>

setProjectProperties(string, JsonPatchDocument)

Создание, обновление и удаление свойств командного проекта.

function setProjectProperties(projectId: string, patchDocument: JsonPatchDocument): Promise<void>

Параметры

projectId: string

Идентификатор командного проекта.

patchDocument: JsonPatchDocument

Документ JSON Patch, представляющий массив операций со свойствами. Дополнительные сведения о JSON Patch см. в RFC 6902. Допустимыми командами операции являются Add и Remove, где Add используется как для создания, так и для обновления свойств. Путь состоит из косой черты и имени свойства.

Возвращаемое значение

Promise<void>

updateIdentityMru(IdentityData, string)

function updateIdentityMru(mruData: IdentityData, mruName: string): Promise<void>

Параметры

mruData: IdentityData

mruName: string

Возвращаемое значение

Promise<void>

updateProject(TeamProject, string)

Обновление имени, аббревиатуры, описания существующего проекта или восстановление проекта.

function updateProject(projectUpdate: TeamProject, projectId: string): Promise<OperationReference>

Параметры

projectUpdate: TeamProject

Обновления для проекта. Для восстановления проекта состояние должно быть установлено в wellFormed.

projectId: string

Идентификатор проекта для обновления.

Возвращаемое значение

Promise<OperationReference>

updateTeam(WebApiTeam, string, string)

Обновите название и/или описание команды.

function updateTeam(teamData: WebApiTeam, projectId: string, teamId: string): Promise<WebApiTeam>

Параметры

teamData: WebApiTeam

projectId: string

Имя или идентификатор (GUID) командного проекта, содержащего команду для обновления.

teamId: string

Название ID команды для обновления.

Возвращаемое значение

Promise<WebApiTeam>

Обратная связь

Была ли эта страница полезна?

Поделиться через

CoreRestClient class

Конструкторы

Свойства

Методы

Сведения о конструкторе

CoreRestClient(IVssRestClientOptions)

Параметры

Сведения о свойстве

RESOURCE_AREA_ID

Значение свойства

Сведения о методе

createConnectedService(WebApiConnectedServiceDetails, string)

Параметры

Возвращаемое значение

createIdentityMru(IdentityData, string)

Параметры

Возвращаемое значение

createOrUpdateProxy(Proxy)

Параметры

Возвращаемое значение

createTeam(WebApiTeam, string)

Параметры

Возвращаемое значение

deleteIdentityMru(IdentityData, string)

Параметры

Возвращаемое значение

deleteProxy(string, string)

Параметры

Возвращаемое значение

deleteTeam(string, string)

Параметры

Возвращаемое значение

getAllTeams(boolean, number, number, boolean)

Параметры

Возвращаемое значение

getConnectedServiceDetails(string, string)

Параметры

Возвращаемое значение

getConnectedServices(string, ConnectedServiceKind)

Параметры

Возвращаемое значение

getIdentityMru(string)

Параметры

Возвращаемое значение

getProcessById(string)

Параметры

Возвращаемое значение

getProcesses()

Возвращаемое значение

getProject(string, boolean, boolean)

Параметры

Возвращаемое значение

getProjectCollection(string)

Параметры

Возвращаемое значение

getProjectCollections(number, number)

Параметры

Возвращаемое значение

getProjectHistoryEntries(number)

Параметры

Возвращаемое значение

getProjectProperties(string, string[])

Параметры

Возвращаемое значение

getProjects(any, number, number, number, boolean)

Параметры

Возвращаемое значение

getProjectsProperties(string[], string[])

Параметры

Возвращаемое значение

getProjectTeamsByCategory(string, boolean, number, number)

Параметры

Возвращаемое значение

getProxies(string)

Параметры

Возвращаемое значение

getTeam(string, string, boolean)

Параметры

Возвращаемое значение