CoreRestClient class

new CoreRestClient(options: IVssRestClientOptions)

Paramètres

static RESOURCE_AREA_ID: string

Valeur de propriété

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

Paramètres

Retours

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

Paramètres

Retours

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

Paramètres

Retours

Créez une équipe dans un projet d’équipe.

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

Paramètres

Retours

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

Paramètres

Retours

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

Paramètres

Retours

Supprimer une équipe.

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

Paramètres

Retours

Obtenez la liste de toutes les équipes.

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

Paramètres

Retours

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

Paramètres

Retours

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

Paramètres

Retours

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

Paramètres

Retours

Obtenir un processus par ID.

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

Paramètres

Retours

Obtenez la liste des processus.

function getProcesses(): Promise<Process[]>

Retours

Obtenez le projet avec l’ID ou le nom spécifié, y compris éventuellement les fonctionnalités.

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

Paramètres

Retours

Obtenez la collection de projets avec l’ID ou le nom spécifié.

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

Paramètres

Retours

Obtenir des références de collection de projets pour cette application.

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

Paramètres

Retours

Obtient l’historique des modifications apportées au projet.

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

Paramètres

Retours

Obtenez une collection de propriétés de projet d’équipe.

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

Paramètres

Retours

Obtenez tous les projets dans le organization auxquels l’utilisateur authentifié a accès.

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

Paramètres

Retours

Obtenez une collection de propriétés de projet d’équipe pour plusieurs projets.

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

Paramètres

Retours

Obtient la liste des équipes lisibles par l’utilisateur dans un projet et l’utilisateur teams est membre de (exclu de la liste lisible).

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

Paramètres

Retours

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

Paramètres

Retours

Obtenez une équipe spécifique.

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

Paramètres

Retours

Obtenez la liste des membres d’une équipe spécifique.

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

Paramètres

Retours

Obtenez la liste des équipes.

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

Paramètres

Retours

Met en file d’attente un projet à créer. Utilisez GetOperation pour case activée régulièrement pour créer des status de projet.

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

Paramètres

Retours

Met en file d’attente un projet à supprimer. Utilisez GetOperation pour case activée régulièrement pour supprimer des status de projet.

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

Paramètres

Retours

Supprime l’avatar du projet.

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

Paramètres

Retours

Définit l’avatar du projet.

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

Paramètres

Retours

Créez, mettez à jour et supprimez des propriétés de projet d’équipe.

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

Paramètres

Retours

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

Paramètres

Retours

Mettre à jour le nom, l’abréviation, la description d’un projet existant ou restaurer un projet.

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

Paramètres

Retours

Mettre à jour le nom et/ou la description d’une équipe.

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

Paramètres

Retours