CoreRestClient class

Pakket:

azure-devops-extension-api

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

Extends

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)	Een lijst met alle teams ophalen.
getConnectedServiceDetails(string, string)
getConnectedServices(string, ConnectedServiceKind)
getIdentityMru(string)
getProcessById(string)	Een proces ophalen op basis van id.
getProcesses()	Een lijst met processen ophalen.
getProject(string, boolean, boolean)	Haal het project op met de opgegeven id of naam, optioneel inclusief mogelijkheden.
getProjectCollection(string)	Haal de projectverzameling op met de opgegeven id of naam.
getProjectCollections(number, number)	Haal verwijzingen naar projectverzamelingen op voor deze toepassing.
getProjectHistoryEntries(number)	Hiermee haalt u de geschiedenis van wijzigingen in het project op.
getProjectProperties(string, string[])	Een verzameling teamprojecteigenschappen ophalen.
getProjects(any, number, number, number, boolean)	Haal alle projecten in de organisatie op waartoe de geverifieerde gebruiker toegang heeft.
getProjectsProperties(string[], string[])	Een verzameling teamprojecteigenschappen voor meerdere projecten ophalen.
getProjectTeamsByCategory(string, boolean, number, number)	Hiermee haalt u een lijst op met door de gebruiker leesbare teams in een project en de teams-gebruiker is lid van (uitgesloten van de leesbare lijst).
getProxies(string)
getTeam(string, string, boolean)	Haal een specifiek team op.
getTeamMembersWithExtendedProperties(string, string, number, number)	Een lijst met leden voor een specifiek team ophalen.
getTeams(string, boolean, number, number, boolean)	Een lijst met teams ophalen.
queueCreateProject(TeamProject)	Een project in de wachtrij plaatsen dat moet worden gemaakt. Gebruik GetOperation om periodiek te controleren op de status van het maken van een project.
queueDeleteProject(string)	Een project in de wachtrij plaatsen dat moet worden verwijderd. Gebruik GetOperation om periodiek te controleren op de status van het project verwijderen.
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 teamproject maken, bijwerken en verwijderen.
updateIdentityMru(IdentityData, string)
updateProject(TeamProject, string)	Werk de naam, afkorting, beschrijving van een bestaand project bij of herstel een project.
updateTeam(WebApiTeam, string, string)	De naam en/of beschrijving van een team bijwerken.

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 worden 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 met het team dat u wilt verwijderen.

teamId

string

De naam of id van het team dat u wilt verwijderen.

Retouren

Promise<void>

getAllTeams(boolean, number, number, boolean)

Een lijst met alle teams ophalen.

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

Parameters

mine

boolean

Als dit waar is, retourneer dan alle teams die vragen om gebruiker is lid. Retourneer anders alle Teams-gebruikers die leestoegang hebben.

top

number

Maximum aantal teams om terug te keren.

skip

number

Aantal teams dat moet worden overgeslagen.

expandIdentity

boolean

Een waarde die aangeeft of identiteitsgegevens moeten worden uitgevouwen in het WebApiTeam-object als resultaat.

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)

Een proces ophalen op basis van id.

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

Parameters

processId

string

Id voor een proces.

Retouren

Promise<Process>

getProcesses()

Een lijst met processen ophalen.

function getProcesses(): Promise<Process[]>

Retouren

Promise<Process[]>

getProject(string, boolean, boolean)

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

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

Parameters

projectId

string

includeCapabilities

boolean

Mogelijkheden (zoals broncodebeheer) opnemen in het resultaat van het teamproject (standaard: onwaar).

includeHistory

boolean

Zoek in projecten met een andere naam (die in het verleden een dergelijke naam hadden).

Retouren

Promise<TeamProject>

getProjectCollection(string)

Haal de projectverzameling op met de opgegeven id of naam.

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

Parameters

collectionId

string

Retouren

Promise<TeamProjectCollection>

getProjectCollections(number, number)

Haal verwijzingen naar projectverzamelingen 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 geretourneerd.

Retouren

Promise<ProjectInfo[]>

getProjectProperties(string, string[])

Een verzameling teamprojecteigenschappen ophalen.

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

Parameters

projectId

string

De teamproject-id.

keys

string[]

Een door komma's gescheiden tekenreeks met teamprojecteigenschapsnamen. 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 in de organisatie op 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 teamprojectstatus (standaard: WellFormed).

top

number

skip

number

continuationToken

number

Aanwijzer die aangeeft hoeveel projecten al zijn opgehaald.

getDefaultTeamImageUrl

boolean

Retouren

Promise<PagedList<TeamProjectReference>>

getProjectsProperties(string[], string[])

Een verzameling teamprojecteigenschappen voor meerdere projecten ophalen.

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

Parameters

projectIds

string[]

Een door komma's gescheiden tekenreeks van teamproject-id's

properties

string[]

Retouren

Promise<ProjectProperties[]>

getProjectTeamsByCategory(string, boolean, number, number)

Hiermee haalt u een lijst op met door de gebruiker leesbare teams in een project en de teams-gebruiker is lid van (uitgesloten van de 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 moeten worden uitgevouwen in het WebApiTeam-object als resultaat.

top

number

Maximum aantal teams om terug te keren.

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)

Haal een specifiek team op.

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

Parameters

projectId

string

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

teamId

string

De naam of id (GUID) van het team.

expandIdentity

boolean

Een waarde die aangeeft of identiteitsgegevens moeten worden uitgevouwen in het WebApiTeam-object als resultaat.

Retouren

Promise<WebApiTeam>

getTeamMembersWithExtendedProperties(string, string, number, number)

Een lijst met leden voor een specifiek team ophalen.

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

Parameters

projectId

string

De naam of id (GUID) van het teamproject waartoe het team behoort.

teamId

string

De naam of id (GUID) van het team .

top

number

skip

number

Retouren

Promise<TeamMember[]>

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

Een lijst met teams ophalen.

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

Parameters

projectId

string

mine

boolean

Als true retourneert alle teams die de gebruiker aanvragen lid is, retourneer anders alle teams-gebruikers leestoegang.

top

number

Maximum aantal teams om terug te keren.

skip

number

Aantal teams dat moet worden overgeslagen.

expandIdentity

boolean

Een waarde die aangeeft of identiteitsgegevens in het resultaatobject WebApiTeam moeten worden uitgevouwen.

Retouren

Promise<WebApiTeam[]>

queueCreateProject(TeamProject)

Een project in de wachtrij plaatsen dat moet worden gemaakt. Gebruik GetOperation om periodiek te controleren op de status van het maken van een project.

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

Parameters

projectToCreate

TeamProject

Het project dat moet worden gemaakt.

Retouren

Promise<OperationReference>

queueDeleteProject(string)

Een project in de wachtrij plaatsen dat moet worden verwijderd. Gebruik GetOperation om periodiek te controleren op de status van het project verwijderen.

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 avatar-blobgegevensobject dat moet worden geüpload.

projectId

string

De id of naam van het project.

Retouren

Promise<void>

setProjectProperties(string, JsonPatchDocument)

Eigenschappen van teamproject maken, bijwerken en verwijderen.

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

Parameters

projectId

string

De teamproject-id.

patchDocument

JsonPatchDocument

Een JSON Patch-document dat een matrix van eigenschapsbewerkingen vertegenwoordigt. Zie RFC 6902 voor meer informatie over JSON Patch. De geaccepteerde bewerkingen zijn Toevoegen en Verwijderen, waarbij Toevoegen wordt gebruikt voor het maken en bijwerken van eigenschappen. Het pad bestaat uit een slash 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, 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)

De naam en/of beschrijving van een team bijwerken.

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

Parameters

teamData

WebApiTeam

projectId

string

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

teamId

string

De naam van de id van het team dat moet worden bijgewerkt.

Retouren

Promise<WebApiTeam>