Favorites - Get Favorites

Referensi

Layanan:: Favorite

Versi API:: 7.1-preview.1

GET https://dev.azure.com/{organization}/_apis/favorite/favorites?api-version=7.1-preview.1

Dengan parameter opsional:

GET https://dev.azure.com/{organization}/_apis/favorite/favorites?artifactType={artifactType}&artifactScopeType={artifactScopeType}&artifactScopeId={artifactScopeId}&includeExtendedDetails={includeExtendedDetails}&api-version=7.1-preview.1

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
organization	path	True	string	Nama organisasi Azure DevOps.
api-version	query	True	string	Versi API yang akan digunakan. Ini harus diatur ke '7.1-preview.1' untuk menggunakan versi api ini.
artifactScopeId	query		string
artifactScopeType	query		string
artifactType	query		string
includeExtendedDetails	query		boolean

Respons

Nama	Jenis	Deskripsi
200 OK	Favorite[]	operasi berhasil

Keamanan

oauth2

Jenis: oauth2
Alur: accessCode
URL Otorisasi: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL token: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Cakupan

Nama	Deskripsi
vso.profile	Memberikan kemampuan untuk membaca profil, akun, koleksi, proyek, tim, dan artefak organisasi tingkat atas lainnya.

Contoh

Permintaan sampel

HTTP

GET https://dev.azure.com/{organization}/_apis/favorite/favorites?api-version=7.1-preview.1

Respon sampel

Kode status:: 200

{
  "count": 2,
  "value": [
    {
      "artifactScope": {
        "type": "Project",
        "id": "ee27e18d-f04c-456d-af1e-d335a6ecff2e",
        "name": "SampleProject"
      },
      "id": "931f376d-e3f7-4236-a60d-bb5eed1f358f",
      "owner": {
        "displayName": "John Doe",
        "id": "df1a0816-9fa8-6752-86bb-ddc55c149629",
        "uniqueName": "Identity df1a0816-9fa8-6752-86bb-ddc55c149629 (IdentityType: Microsoft.IdentityModel.Claims.ClaimsIdentity; Identifier: 000300009FE5275C@Live.com; DisplayName: John Doe)"
      },
      "artifactName": "SampleProject",
      "artifactType": "Microsoft.TeamFoundation.Classification.TeamProject",
      "artifactId": "ee27e18d-f04c-456d-af1e-d335a6ecff2e",
      "_links": {
        "page": {
          "href": "https://dev.azure.com/fabrikam/SampleProject"
        }
      }
    },
    {
      "artifactScope": {
        "type": "Project",
        "id": "ee27e18d-f04c-456d-af1e-d335a6ecff2e",
        "name": "SampleProject"
      },
      "id": "399c096c-beb6-42f1-b497-f579913bd4bd",
      "owner": {
        "displayName": "John Doe",
        "id": "df1a0816-9fa8-6752-86bb-ddc55c149629",
        "uniqueName": "Identity df1a0816-9fa8-6752-86bb-ddc55c149629 (IdentityType: Microsoft.IdentityModel.Claims.ClaimsIdentity; Identifier: 000300009FE5275C@Live.com; DisplayName: John Doe)"
      },
      "artifactName": "pipeline",
      "artifactType": "Microsoft.TeamFoundation.Build.Definition",
      "artifactId": "vstfs:///Build/Definition/1",
      "_links": {
        "page": {
          "href": "https://dev.azure.com/fabrikam/SampleProject/_build/definition?definitionId=1"
        }
      }
    }
  ]
}

Definisi

Nama	Deskripsi
ArtifactProperties
ArtifactScope	Menjelaskan ruang lingkup artefak favorit berada. misalnya proyek tim.
Favorite	Implementasi kontrak Favorit setelah penyimpanan modern
IdentityRef
ReferenceLinks	Kelas untuk mewakili kumpulan tautan referensi REST.

ArtifactProperties

Objek

ArtifactScope

Objek

Menjelaskan ruang lingkup artefak favorit berada. misalnya proyek tim.

Nama	Jenis	Deskripsi
id	string	Pengidentifikasi cakupan tempat artefak berada. Untuk Proyek TFS, ini mengacu pada string GUID Proyek. Untuk Koleksi, tandai properti ini dengan string kosong.
name	string	Nama cakupan artefak (misalnya Nama Proyek) Catatan: Properti ini adalah ekstensi baca-saja di atas model favorit yang disimpan. Nilai ini tidak dapat ditimpa pada penulisan.
type	string	Jenis cakupan tempat artefak favorit berada. Cakupan yang diketahui termasuk "Proyek" atau "Koleksi"

Favorite

Objek

Implementasi kontrak Favorit setelah penyimpanan modern

Nama	Jenis	Deskripsi
_links	ReferenceLinks	Tautan ke sumber daya yang terkait dengan artefak yang mendasar.
artifactId	string	ID artefak favorit, unik dalam konteks jenis artefak ini.
artifactIsDeleted	boolean	Menunjukkan apakah artefak yang dijelaskan oleh favorit ini tidak dapat ditemukan.
artifactName	string	Nama artefak terakhir yang diketahui.
artifactProperties	ArtifactProperties	Kamus properti cache yang menjelaskan artefak Favorited. Struktur dihasilkan oleh penyedia metadata fitur sisi layanan yang menangani Jenis Artefak ini.
artifactScope	ArtifactScope	Cakupan Artefak - Objek ini menjelaskan di mana artefak berada. misalnya param Wajib Proyek untuk membuat semua favorit.
artifactType	string	Jenis artefak.
creationDate	string	Tanggal dan waktu Favorit ini dibuat pada server.
id	string	Id unik item favorit, ditentukan oleh server pada waktu pembuatan.
owner	IdentityRef	Identitas pengguna, yang ditentukan oleh server, berdasarkan konteks pengguna aktif.
url	string	Fully-Qualified tautan ke Sumber Daya ini

IdentityRef

Objek

Nama	Jenis	Deskripsi
_links	ReferenceLinks	Bidang ini berisi nol atau lebih tautan menarik tentang subjek grafik. Tautan ini dapat dipanggil untuk mendapatkan hubungan tambahan atau informasi lebih rinci tentang subjek grafik ini.
descriptor	string	Deskriptor adalah cara utama untuk mereferensikan subjek grafik saat sistem berjalan. Bidang ini akan mengidentifikasi subjek grafik yang sama secara unik di seluruh Akun dan Organisasi.
directoryAlias	string	Tidak digunakan lagi - Dapat diambil dengan mengkueri pengguna Graph yang direferensikan dalam entri "mandiri" kamus IdentityRef "_links"
displayName	string	Ini adalah nama tampilan subjek grafik yang tidak unik. Untuk mengubah bidang ini, Anda harus mengubah nilainya di penyedia sumber.
id	string
imageUrl	string	Tidak digunakan lagi - Tersedia dalam entri "avatar" kamus IdentityRef "_links"
inactive	boolean	Tidak digunakan lagi - Dapat diambil dengan mengkueri status keanggotaan Graph yang direferensikan dalam entri "membershipState" kamus "_links" GraphUser
isAadIdentity	boolean	Tidak digunakan lagi - Dapat disimpulkan dari jenis subjek deskriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Tidak digunakan lagi - Dapat disimpulkan dari jenis subjek deskriptor (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Tidak digunakan lagi - tidak digunakan dalam sebagian besar implementasi ToIdentityRef yang sudah ada sebelumnya
uniqueName	string	Tidak digunakan lagi - gunakan Domain+PrincipalName sebagai gantinya
url	string	Url ini adalah rute lengkap ke sumber daya sumber subjek grafik ini.

ReferenceLinks

Objek

Kelas untuk mewakili kumpulan tautan referensi REST.

Nama	Jenis	Deskripsi
links	object	Tampilan baca-saja dari tautan. Karena tautan Referensi bersifat baca-saja, kami hanya ingin mengeksposnya sebagai baca-saja.

Bagikan melalui

Favorites - Get Favorites

Parameter URI

Respons

Keamanan

oauth2

Cakupan

Contoh

Permintaan sampel

Respon sampel

Definisi

ArtifactProperties

ArtifactScope

Favorite

IdentityRef

ReferenceLinks