CoreRestClient class

Pakket:

azure-devops-extension-api

Basisklasse die moet worden gebruikt (afgeleid van) om aanvragen te doen naar VSS REST API's

Uitbreiding

RestClientBase

Constructors

CoreRestClient(IVssRestClientOptions)

Eigenschappen

RESOURCE_AREA_ID

Methoden

createConnectedService(WebApiConnectedServiceDetails, string)
createIdentityMru(IdentityData, string)
createOrUpdateProxy(Proxy)
createTeam(WebApiTeam, string)	Maak een team in een teamproject.
deleteIdentityMru(IdentityData, string)
deleteProxy(string, string)
deleteTeam(string, string)	Een team verwijderen.
getAllTeams(boolean, number, number, boolean)	Krijg een lijst van alle teams.
getConnectedServiceDetails(string, string)
getConnectedServices(string, ConnectedServiceKind)
getIdentityMru(string)
getProcessById(string)	Haal een proces op ID op.
getProcesses()	Krijg een lijst met processen.
getProject(string, boolean, boolean)	Haal het project op met de opgegeven id of naam, eventueel inclusief mogelijkheden.
getProjectCollection(string)	Haal een projectverzameling op met de opgegeven id of naam.
getProjectCollections(number, number)	Haal projectverzamelingsverwijzingen op voor deze toepassing.
getProjectHistoryEntries(number)	Hiermee haalt u de geschiedenis van wijzigingen in het project op.
getProjectProperties(string, string[])	Haal een verzameling eigenschappen van teamprojecten op.
getProjects(any, number, number, number, boolean)	Haal alle projecten op in de organisatie waartoe de geverifieerde gebruiker toegang heeft.
getProjectsProperties(string[], string[])	Haal een verzameling teamprojecteigenschappen op voor meerdere projecten.
getProjectTeamsByCategory(string, boolean, number, number)	Haalt een lijst op van door de gebruiker leesbare teams in een project en teams waarvan de gebruiker lid is (uitgesloten van leesbare lijst).
getProxies(string)
getTeam(string, string, boolean)	Zoek een specifiek team.
getTeamMembersWithExtendedProperties(string, string, number, number)	Krijg een lijst met leden voor een specifiek team.
getTeams(string, boolean, number, number, boolean)	Krijg een lijst met teams.
queueCreateProject(TeamProject)	Plaatst een project in de wachtrij dat moet worden gemaakt. Gebruik de GetOperation om regelmatig te controleren of de status van het project wordt gemaakt.
queueDeleteProject(string)	Plaatst een project in de wachtrij dat moet worden verwijderd. Gebruik de GetOperation om regelmatig te controleren of de projectstatus wordt verwijderd.
removeProjectAvatar(string)	Hiermee verwijdert u de avatar voor het project.
setProjectAvatar(ProjectAvatar, string)	Hiermee stelt u de avatar voor het project in.
setProjectProperties(string, JsonPatchDocument)	Eigenschappen van teamprojecten maken, bijwerken en verwijderen.
updateIdentityMru(IdentityData, string)
updateProject(TeamProject, string)	Werk de naam, afkorting of beschrijving van een bestaand project bij of herstel een project.
updateTeam(WebApiTeam, string, string)	Werk de naam en/of beschrijving van een team bij.

Constructordetails

CoreRestClient(IVssRestClientOptions)

new CoreRestClient(options: IVssRestClientOptions)

Parameters

options

IVssRestClientOptions

Eigenschapdetails

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Waarde van eigenschap

string

Methodedetails

createConnectedService(WebApiConnectedServiceDetails, string)

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

Parameters

connectedServiceCreationData

WebApiConnectedServiceDetails

projectId

string

Retouren

Promise<WebApiConnectedService>

createIdentityMru(IdentityData, string)

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

Parameters

mruData

IdentityData

mruName

string

Retouren

Promise<void>

createOrUpdateProxy(Proxy)

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

Parameters

proxy

Proxy

Retouren

Promise<Proxy>

createTeam(WebApiTeam, string)

Maak een team in een teamproject.

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

Parameters

team

WebApiTeam

De teamgegevens die zijn gebruikt om het team te maken.

projectId

string

De naam of id (GUID) van het teamproject waarin het team moet worden gemaakt.

Retouren

Promise<WebApiTeam>

deleteIdentityMru(IdentityData, string)

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

Parameters

mruData

IdentityData

mruName

string

Retouren

Promise<void>

deleteProxy(string, string)

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

Parameters

proxyUrl

string

site

string

Retouren

Promise<void>

deleteTeam(string, string)

Een team verwijderen.

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

Parameters

projectId

string

De naam of id (GUID) van het teamproject dat het te verwijderen team bevat.

teamId

string

De naam of ID van het team dat moet worden verwijderd.

Retouren

Promise<void>

getAllTeams(boolean, number, number, boolean)

Krijg een lijst van alle teams.

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

Parameters

mine

boolean

Als dit waar is, retourneert u alle teams die vragen dat de gebruiker lid is. Anders retourneer alle teams die de gebruiker leestoegang heeft.

top

number

Maximum aantal teams dat kan terugkeren.

skip

number

Aantal teams dat moet worden overgeslagen.

expandIdentity

boolean

Een waarde die aangeeft of identiteitsgegevens in het WebApiTeam-resultaat al dan niet moeten worden uitgevouwen.

Retouren

Promise<WebApiTeam[]>

getConnectedServiceDetails(string, string)

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

Parameters

projectId

string

name

string

Retouren

Promise<WebApiConnectedServiceDetails>

getConnectedServices(string, ConnectedServiceKind)

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

Parameters

projectId

string

kind

ConnectedServiceKind

Retouren

Promise<WebApiConnectedService[]>

getIdentityMru(string)

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

Parameters

mruName

string

Retouren

Promise<IdentityRef[]>

getProcessById(string)

Haal een proces op ID op.

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

Parameters

processId

string

ID voor een proces.

Retouren

Promise<Process>

getProcesses()

Krijg een lijst met processen.

function getProcesses(): Promise<Process[]>

Retouren

Promise<Process[]>

getProject(string, boolean, boolean)

Haal het project op met de opgegeven id of naam, eventueel inclusief mogelijkheden.

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

Parameters

projectId

string

includeCapabilities

boolean

Neem mogelijkheden (zoals bronbeheer) op in het teamprojectresultaat (standaard: onwaar).

includeHistory

boolean

Zoeken binnen hernoemde projecten (die in het verleden zo'n naam hadden).

Retouren

Promise<TeamProject>

getProjectCollection(string)

Haal een projectverzameling op met de opgegeven id of naam.

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

Parameters

collectionId

string

Retouren

Promise<TeamProjectCollection>

getProjectCollections(number, number)

Haal projectverzamelingsverwijzingen op voor deze toepassing.

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

Parameters

top

number

skip

number

Retouren

Promise<TeamProjectCollectionReference[]>

getProjectHistoryEntries(number)

Hiermee haalt u de geschiedenis van wijzigingen in het project op.

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

Parameters

minRevision

number

Het minimale revisienummer dat in de geschiedenis moet worden teruggegeven.

Retouren

Promise<ProjectInfo[]>

getProjectProperties(string, string[])

Haal een verzameling eigenschappen van teamprojecten op.

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

Parameters

projectId

string

De project-ID van het team.

keys

string[]

Een door komma's gescheiden reeks namen van teamprojecteigenschappen. Jokertekens ("?" en "*") worden ondersteund. Als er geen sleutel is opgegeven, worden alle eigenschappen geretourneerd.

Retouren

Promise<ProjectProperty[]>

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

Haal alle projecten op in de organisatie waartoe de geverifieerde gebruiker toegang heeft.

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

Parameters

stateFilter

any

Filter op teamprojecten in een specifieke status van het teamproject (standaard: WellFormed).

top

number

skip

number

continuationToken

number

Aanwijzer die laat zien hoeveel projecten er al zijn opgehaald.

getDefaultTeamImageUrl

boolean

Retouren

Promise<PagedList<TeamProjectReference>>

getProjectsProperties(string[], string[])

Haal een verzameling teamprojecteigenschappen op voor meerdere projecten.

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

Parameters

projectIds

string[]

Een door komma's gescheiden reeks teamproject-ID's

properties

string[]

Retouren

Promise<ProjectProperties[]>

getProjectTeamsByCategory(string, boolean, number, number)

Haalt een lijst op van door de gebruiker leesbare teams in een project en teams waarvan de gebruiker lid is (uitgesloten van leesbare lijst).

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

Parameters

projectId

string

De naam of ID (GUID) van het teamproject met de teams die moeten worden opgehaald.

expandIdentity

boolean

Een waarde die aangeeft of identiteitsgegevens in het WebApiTeam-resultaat al dan niet moeten worden uitgevouwen.

top

number

Maximum aantal teams dat kan terugkeren.

skip

number

Aantal teams dat moet worden overgeslagen.

Retouren

Promise<CategorizedWebApiTeams>

getProxies(string)

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

Parameters

proxyUrl

string

Retouren

Promise<Proxy[]>

getTeam(string, string, boolean)

Zoek een specifiek team.

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

Parameters

projectId

string

De naam of id (GUID) van het teamproject waarin het team is opgenomen.

teamId

string

De naam of ID (GUID) van het team.

expandIdentity

boolean

Een waarde die aangeeft of identiteitsgegevens in het WebApiTeam-resultaat al dan niet moeten worden uitgevouwen.

Retouren

Promise<WebApiTeam>

getTeamMembersWithExtendedProperties(string, string, number, number)

Krijg een lijst met leden voor een specifiek team.

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

Parameters

projectId

string

De naam of ID (GUID) van het teamproject waar het team deel van uitmaakt.

teamId

string

De naam of ID (GUID) van het team.

top

number

skip

number

Retouren

Promise<TeamMember[]>

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

Krijg een lijst met teams.

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

Parameters

projectId

string

mine

boolean

Als je echt retourneert, is alle teams die de gebruiker aanvragen lid, anders retourneer je alle teams die de gebruiker leestoegang geeft.

top

number

Maximum aantal teams dat kan terugkeren.

skip

number

Aantal teams dat moet worden overgeslagen.

expandIdentity

boolean

Een waarde die aangeeft of identiteitsgegevens in het WebApiTeam-resultaat al dan niet moeten worden uitgevouwen.

Retouren

Promise<WebApiTeam[]>

queueCreateProject(TeamProject)

Plaatst een project in de wachtrij dat moet worden gemaakt. Gebruik de GetOperation om regelmatig te controleren of de status van het project wordt gemaakt.

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

Parameters

projectToCreate

TeamProject

Het project om te creëren.

Retouren

Promise<OperationReference>

queueDeleteProject(string)

Plaatst een project in de wachtrij dat moet worden verwijderd. Gebruik de GetOperation om regelmatig te controleren of de projectstatus wordt verwijderd.

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

Parameters

projectId

string

De project-id van het project dat moet worden verwijderd.

Retouren

Promise<OperationReference>

removeProjectAvatar(string)

Hiermee verwijdert u de avatar voor het project.

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

Parameters

projectId

string

De ID of naam van het project.

Retouren

Promise<void>

setProjectAvatar(ProjectAvatar, string)

Hiermee stelt u de avatar voor het project in.

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

Parameters

avatarBlob

ProjectAvatar

Het object van de avatar-blobgegevens moet worden geüpload.

projectId

string

De ID of naam van het project.

Retouren

Promise<void>

setProjectProperties(string, JsonPatchDocument)

Eigenschappen van teamprojecten maken, bijwerken en verwijderen.

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

Parameters

projectId

string

De project-ID van het team.

patchDocument

JsonPatchDocument

Een JSON Patch-document dat een reeks eigendomsbewerkingen vertegenwoordigt. Zie RFC 6902 voor meer informatie over JSON Patch. De geaccepteerde bewerkingswerkwoorden zijn Toevoegen en Verwijderen, waarbij Toevoegen wordt gebruikt voor zowel het maken als het bijwerken van eigenschappen. Het pad bestaat uit een schuine streep en een eigenschapsnaam.

Retouren

Promise<void>

updateIdentityMru(IdentityData, string)

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

Parameters

mruData

IdentityData

mruName

string

Retouren

Promise<void>

updateProject(TeamProject, string)

Werk de naam, afkorting of beschrijving van een bestaand project bij of herstel een project.

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

Parameters

projectUpdate

TeamProject

De updates voor het project. De status moet worden ingesteld op wellFormed om het project te herstellen.

projectId

string

De project-id van het project dat moet worden bijgewerkt.

Retouren

Promise<OperationReference>

updateTeam(WebApiTeam, string, string)

Werk de naam en/of beschrijving van een team bij.

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

Parameters

teamData

WebApiTeam

projectId

string

De naam of id (GUID) van het teamproject dat het team bevat dat moet worden bijgewerkt.

teamId

string

De naam of ID van het team dat moet worden bijgewerkt.

Retouren

Promise<WebApiTeam>