CoreRestClient class
VSS REST API'lerine istekte bulunmak için kullanılması gereken (türetilen) temel sınıf
- Extends
| create |
|
| create |
|
| create |
|
| create |
Ekip projesinde ekip oluşturma. |
| delete |
|
| delete |
|
| delete |
Ekibi silme. |
| get |
Tüm ekiplerin listesini alın. |
| get |
|
| get |
|
| get |
|
| get |
Kimliğine göre bir işlem alın. |
| get |
İşlemlerin listesini alın. |
| get |
İsteğe bağlı olarak özellikler de dahil olmak üzere belirtilen kimlik veya adla proje alın. |
| get |
Belirtilen kimlik veya ada sahip proje koleksiyonunu alın. |
| get |
Bu uygulama için proje koleksiyonu başvurularını alın. |
| get |
Projedeki değişikliklerin geçmişini alır. |
| get |
Takım projesi özellikleri koleksiyonu alın. |
| get |
Kimliği doğrulanmış kullanıcının erişimi olan kuruluştaki tüm projeleri alın. |
| get |
Birden çok proje için bir takım projesi özellikleri koleksiyonu alın. |
| get |
Bir projedeki kullanıcı tarafından okunabilir ekiplerin listesini alır ve kullanıcının üyesi olduğu ekiplerin listesini alır (okunabilir listenin dışında tutulur). |
| get |
|
| get |
Belirli bir ekibi alın. |
| get |
Belirli bir ekip için üyelerin listesini alın. |
| get |
Ekiplerin listesini alın. |
| queue |
Oluşturulacak projeyi kuyruğa alır. Proje oluşturma durumunu düzenli aralıklarla denetlemek için GetOperation'ı kullanın. |
| queue |
Silinecek projeyi kuyruğa alır. Proje silme durumunu düzenli aralıklarla denetlemek için GetOperation'ı kullanın. |
| remove |
Projenin avatarını kaldırır. |
| set |
Projenin avatarını ayarlar. |
| set |
Ekip projesi özelliklerini oluşturun, güncelleştirin ve silin. |
| update |
|
| update |
Mevcut projenin adını, kısaltmasını, açıklamasını güncelleştirin veya projeyi geri yükleyin. |
| update |
Ekibin adını ve/veya açıklamasını güncelleştirin. |
static RESOURCE_AREA_ID: stringÖzellik Değeri
string
function createConnectedService(connectedServiceCreationData: WebApiConnectedServiceDetails, projectId: string): Promise<WebApiConnectedService>Parametreler
- connectedServiceCreationData
- WebApiConnectedServiceDetails
- projectId
-
string
Döndürülenler
Promise<WebApiConnectedService>
function createIdentityMru(mruData: IdentityData, mruName: string): Promise<void>Parametreler
- mruData
- IdentityData
- mruName
-
string
Döndürülenler
Promise<void>
function createOrUpdateProxy(proxy: Proxy): Promise<Proxy>Parametreler
- proxy
- Proxy
Döndürülenler
Promise<Proxy>
Ekip projesinde ekip oluşturma.
function createTeam(team: WebApiTeam, projectId: string): Promise<WebApiTeam>Parametreler
- team
- WebApiTeam
Ekibi oluşturmak için kullanılan ekip verileri.
- projectId
-
string
Ekibin oluşturulacağı takım projesinin adı veya kimliği (GUID).
Döndürülenler
Promise<WebApiTeam>
function deleteIdentityMru(mruData: IdentityData, mruName: string): Promise<void>Parametreler
- mruData
- IdentityData
- mruName
-
string
Döndürülenler
Promise<void>
function deleteProxy(proxyUrl: string, site?: string): Promise<void>Parametreler
- proxyUrl
-
string
- site
-
string
Döndürülenler
Promise<void>
Ekibi silme.
function deleteTeam(projectId: string, teamId: string): Promise<void>Parametreler
- projectId
-
string
Silinecek ekibi içeren takım projesinin adı veya kimliği (GUID).
- teamId
-
string
Silinecek ekibin adı veya kimliği.
Döndürülenler
Promise<void>
Tüm ekiplerin listesini alın.
function getAllTeams(mine?: boolean, top?: number, skip?: number, expandIdentity?: boolean): Promise<WebApiTeam[]>Parametreler
- mine
-
boolean
Doğruysa, kullanıcının üye olduğunu isteyen tüm ekipleri döndürebilirsiniz. Aksi takdirde tüm teams kullanıcı okuma erişimine sahip döndür.
- top
-
number
Döndürülecek ekip sayısı üst sınırı.
- skip
-
number
Atacak ekip sayısı.
- expandIdentity
-
boolean
Sonuç WebApiTeam nesnesinde Kimlik bilgilerinin genişletilip genişletilmeyeceğini belirten bir değer.
Döndürülenler
Promise<WebApiTeam[]>
function getConnectedServiceDetails(projectId: string, name: string): Promise<WebApiConnectedServiceDetails>Parametreler
- projectId
-
string
- name
-
string
Döndürülenler
Promise<WebApiConnectedServiceDetails>
function getConnectedServices(projectId: string, kind?: ConnectedServiceKind): Promise<WebApiConnectedService[]>Parametreler
- projectId
-
string
- kind
- ConnectedServiceKind
Döndürülenler
Promise<WebApiConnectedService[]>
function getIdentityMru(mruName: string): Promise<IdentityRef[]>Parametreler
- mruName
-
string
Döndürülenler
Promise<IdentityRef[]>
Kimliğine göre bir işlem alın.
function getProcessById(processId: string): Promise<Process>Parametreler
- processId
-
string
İşlemin kimliği.
Döndürülenler
Promise<Process>
İşlemlerin listesini alın.
function getProcesses(): Promise<Process[]>Döndürülenler
Promise<Process[]>
İsteğe bağlı olarak özellikler de dahil olmak üzere belirtilen kimlik veya adla proje alın.
function getProject(projectId: string, includeCapabilities?: boolean, includeHistory?: boolean): Promise<TeamProject>Parametreler
- projectId
-
string
- includeCapabilities
-
boolean
Takım projesi sonucuna özellikleri (kaynak denetimi gibi) ekleyin (varsayılan: false).
- includeHistory
-
boolean
Yeniden adlandırılan projelerin içinde (geçmişte böyle bir ada sahip olan) arama.
Döndürülenler
Promise<TeamProject>
Belirtilen kimlik veya ada sahip proje koleksiyonunu alın.
function getProjectCollection(collectionId: string): Promise<TeamProjectCollection>Parametreler
- collectionId
-
string
Döndürülenler
Promise<TeamProjectCollection>
Bu uygulama için proje koleksiyonu başvurularını alın.
function getProjectCollections(top?: number, skip?: number): Promise<TeamProjectCollectionReference[]>Parametreler
- top
-
number
- skip
-
number
Döndürülenler
Promise<TeamProjectCollectionReference[]>
Projedeki değişikliklerin geçmişini alır.
function getProjectHistoryEntries(minRevision?: number): Promise<ProjectInfo[]>Parametreler
- minRevision
-
number
Geçmişe döndürülecek en düşük düzeltme numarası.
Döndürülenler
Promise<ProjectInfo[]>
Takım projesi özellikleri koleksiyonu alın.
function getProjectProperties(projectId: string, keys?: string[]): Promise<ProjectProperty[]>Parametreler
- projectId
-
string
Takım projesi kimliği.
- keys
-
string[]
Takım projesi özellik adlarının virgülle ayrılmış dizesi. Joker karakterler ("?" ve "*") desteklenir. Anahtar belirtilmezse, tüm özellikler döndürülür.
Döndürülenler
Promise<ProjectProperty[]>
Kimliği doğrulanmış kullanıcının erişimi olan kuruluştaki tüm projeleri alın.
function getProjects(stateFilter?: any, top?: number, skip?: number, continuationToken?: number, getDefaultTeamImageUrl?: boolean): Promise<PagedList<TeamProjectReference>>Parametreler
- stateFilter
-
any
Belirli bir takım projesi durumundaki ekip projelerine filtre uygulama (varsayılan: WellFormed).
- top
-
number
- skip
-
number
- continuationToken
-
number
Zaten kaç projenin getirildiğini gösteren işaretçi.
- getDefaultTeamImageUrl
-
boolean
Döndürülenler
Promise<PagedList<TeamProjectReference>>
Birden çok proje için bir takım projesi özellikleri koleksiyonu alın.
function getProjectsProperties(projectIds: string[], properties?: string[]): Promise<ProjectProperties[]>Parametreler
- projectIds
-
string[]
Takım projesi kimliklerinin virgülle ayrılmış dizesi
- properties
-
string[]
Döndürülenler
Promise<ProjectProperties[]>
Bir projedeki kullanıcı tarafından okunabilir ekiplerin listesini alır ve kullanıcının üyesi olduğu ekiplerin listesini alır (okunabilir listenin dışında tutulur).
function getProjectTeamsByCategory(projectId: string, expandIdentity?: boolean, top?: number, skip?: number): Promise<CategorizedWebApiTeams>Parametreler
- projectId
-
string
Alınacak ekipleri içeren takım projesinin adı veya kimliği (GUID).
- expandIdentity
-
boolean
Sonuç WebApiTeam nesnesinde Kimlik bilgilerinin genişletilip genişletilmeyeceğini belirten bir değer.
- top
-
number
Döndürülecek ekip sayısı üst sınırı.
- skip
-
number
Atacak ekip sayısı.
Döndürülenler
Promise<CategorizedWebApiTeams>
function getProxies(proxyUrl?: string): Promise<Proxy[]>Parametreler
- proxyUrl
-
string
Döndürülenler
Promise<Proxy[]>
Belirli bir ekibi alın.
function getTeam(projectId: string, teamId: string, expandIdentity?: boolean): Promise<WebApiTeam>Parametreler
- projectId
-
string
Ekibi içeren takım projesinin adı veya kimliği (GUID).
- teamId
-
string
Ekibin adı veya kimliği (GUID).
- expandIdentity
-
boolean
Sonuç WebApiTeam nesnesinde Kimlik bilgilerinin genişletilip genişletilmeyeceğini belirten bir değer.
Döndürülenler
Promise<WebApiTeam>
Belirli bir ekip için üyelerin listesini alın.
function getTeamMembersWithExtendedProperties(projectId: string, teamId: string, top?: number, skip?: number): Promise<TeamMember[]>Parametreler
- projectId
-
string
Ekibin ait olduğu takım projesinin adı veya kimliği (GUID).
- teamId
-
string
Ekibin adı veya kimliği (GUID) .
- top
-
number
- skip
-
number
Döndürülenler
Promise<TeamMember[]>
Ekiplerin listesini alın.
function getTeams(projectId: string, mine?: boolean, top?: number, skip?: number, expandIdentity?: boolean): Promise<WebApiTeam[]>Parametreler
- projectId
-
string
- mine
-
boolean
True ise, kullanıcı isteyen tüm ekiplerin üye olduğunu, aksi takdirde tüm teams kullanıcısının okuma erişimine sahip olduğunu döndür.
- top
-
number
Döndürülecek ekip sayısı üst sınırı.
- skip
-
number
Atacak ekip sayısı.
- expandIdentity
-
boolean
Sonuç WebApiTeam nesnesinde Kimlik bilgilerinin genişletilip genişletilmeyeceğini belirten bir değer.
Döndürülenler
Promise<WebApiTeam[]>
Oluşturulacak projeyi kuyruğa alır. Proje oluşturma durumunu düzenli aralıklarla denetlemek için GetOperation'ı kullanın.
function queueCreateProject(projectToCreate: TeamProject): Promise<OperationReference>Parametreler
- projectToCreate
- TeamProject
Oluşturulacak proje.
Döndürülenler
Promise<OperationReference>
Silinecek projeyi kuyruğa alır. Proje silme durumunu düzenli aralıklarla denetlemek için GetOperation'ı kullanın.
function queueDeleteProject(projectId: string): Promise<OperationReference>Parametreler
- projectId
-
string
Silinecek projenin proje kimliği.
Döndürülenler
Promise<OperationReference>
Projenin avatarını kaldırır.
function removeProjectAvatar(projectId: string): Promise<void>Parametreler
- projectId
-
string
Projenin kimliği veya adı.
Döndürülenler
Promise<void>
Projenin avatarını ayarlar.
function setProjectAvatar(avatarBlob: ProjectAvatar, projectId: string): Promise<void>Parametreler
- avatarBlob
- ProjectAvatar
Karşıya yüklenecek avatar blob veri nesnesi.
- projectId
-
string
Projenin kimliği veya adı.
Döndürülenler
Promise<void>
Ekip projesi özelliklerini oluşturun, güncelleştirin ve silin.
function setProjectProperties(projectId: string, patchDocument: JsonPatchDocument): Promise<void>Parametreler
- projectId
-
string
Takım projesi kimliği.
- patchDocument
- JsonPatchDocument
Özellik işlemleri dizisini temsil eden bir JSON Patch belgesi. JSON Düzeltme Eki hakkında daha fazla bilgi için bkz. RFC 6902. Kabul edilen işlem fiilleri Ekle ve Kaldır'dır; burada Ekle özelliği hem oluşturma hem de güncelleştirme için kullanılır. Yol, eğik çizgi ve özellik adından oluşur.
Döndürülenler
Promise<void>
function updateIdentityMru(mruData: IdentityData, mruName: string): Promise<void>Parametreler
- mruData
- IdentityData
- mruName
-
string
Döndürülenler
Promise<void>
Mevcut projenin adını, kısaltmasını, açıklamasını güncelleştirin veya projeyi geri yükleyin.
function updateProject(projectUpdate: TeamProject, projectId: string): Promise<OperationReference>Parametreler
- projectUpdate
- TeamProject
Projenin güncelleştirmeleri. Projeyi geri yüklemek için durumun wellFormed olarak ayarlanması gerekir.
- projectId
-
string
Güncelleştirilecek projenin proje kimliği.
Döndürülenler
Promise<OperationReference>
Ekibin adını ve/veya açıklamasını güncelleştirin.
function updateTeam(teamData: WebApiTeam, projectId: string, teamId: string): Promise<WebApiTeam>Parametreler
- teamData
- WebApiTeam
- projectId
-
string
Güncelleştirilecek ekibi içeren takım projesinin adı veya kimliği (GUID).
- teamId
-
string
Güncelleştirilecek ekibin kimliğinin adı.
Döndürülenler
Promise<WebApiTeam>