Kongsi melalui

Rujukan dokumen penyerahan item katalog

Anda mesti memasukkan data dalam format JSON apabila anda menyerahkan item ke katalog. Artikel ini menerangkan sifat yang sah untuk dokumen tersebut. JSON ini ialah contoh:

{
  "modelVersion": "1.0.0.0",
  "operation": "CreateOrUpdate",
  "sourcePortal": 526430005,
  "businessJustification": "Power Platform custom connector for Conference API",
  "publisherDetails": {
    "publisherId": "ContosoConferencesTeam",
    "publisherDisplayName": "Catalog Conferences Team"
  },
  "catalogItemDefinition": {
    "id": "ContosoConferencesCustomConnector",
    "displayName": "Contoso Conference Custom Connector",
    "description": "Demo Custom connector to query Conference Speakers & Sessions",
    "offer": {
      "type": "Component_Collection",
      "deploymentType": "Normal",
      "engineeringName": {
        "firstName": "Jennifer",
        "lastName": "Wilkins",
        "email": "jwilkins@contoso.com",
        "phoneNumber": "555-111-1234"
      },
      "supportName": {
        "firstName": "Aidan",
        "lastName": "Hunt",
        "email": "ahunt@contoso.com",
        "phoneNumber": "555-111-1234"
      }
    },
      "packageFile": {
         "name": "packageFileName.zip",
         "filesaslink": "https://Contoso.blob.core.windows.net/ContosoConferencesCustomConnector/packageFileName.zip"
      }
  }
}

Jadual ini menerangkan sifat untuk dokumen penyerahan:

Hartanah Jenis Wajib Description
modelVersion rentetan Tidak Nombor versi dokumen penyerahan. Lalai ialah 1.0.0.0.
sourcePortal Int Tidak Mengenal pasti sumber permintaan ini. Lalai 526430005 yang mana ialah PAC CLI. Untuk sumber lain, gunakan 526430000. Fungsi ini mspcat_GetPowerCatalogDetails mengembalikan senarai penuh. Harta mspcat_GetPowerCatalogDetailsResponse.CatalogDetails.sourceOptions ini menyenaraikan pilihan yang tersedia.
submissionId guid Tidak Guid untuk mengenal pasti penyerahan. Nilai ini ialah kunci asing untuk membolehkan memautkan permintaan kepada sistem lain.
operation rentetan Ya Untuk pengembangan masa depan dan tidak dihormati pada masa ini. Jenis operasi yang akan digunakan. Nilai yang sah:
- CreateOrUpdate (Lalai)
- Create
- Update
- Disabled
businessJustification rentetan Tidak Menerangkan nilai perniagaan penyerahan kepada pelulus. Nilai ini boleh mengandungi HTML atau Format Teks Kaya (RTF). Maklumat ini muncul dalam pengalaman penggunaan yang dirancang dalam pengalaman pengguna penemuan pembuat. Pengguna mungkin mengatakan penyerahan mereka membantu pengurangan kos atau produktiviti, sebagai contoh. Sesetengah organisasi memerlukan kelas nilai tertentu dan nilai tersebut boleh dimasukkan di sini.
publisherDetails Penerbit Ya Penerbit yang dikaitkan dengan penyerahan item ini.
catalogItemDefinition CatalogItemDefinition Ya Mentakrifkan item katalog yang diserahkan.

Penerbit

Gunakan data ini untuk menentukan sifat item publisherDetails penyerahan katalog.

Mencipta rekod penerbit yang boleh dikaitkan dengan satu atau lebih kumpulan ID Microsoft Entra yang mengandungi pengguna yang dibenarkan yang boleh membuat kemas kini pada item katalog pada masa hadapan.

Nota

Jangan mengelirukan istilah ini dengan Penerbit Penyelesaian. Penerbit item katalog tidak digunakan dengan penyelesaian.

Anda perlu menyediakan sekurang-kurangnya publisherDisplayName . publisherId boleh menjadi mana-mana nilai rentetan. Sistem menyemak sama ada penerbit itu wujud, jika tidak, menciptanya dan memberikan .publisherId

Sebagai contoh, pasukan pembangun IT HR boleh mencipta penerbit dan ID pembangun menggunakan kumpulan ID Microsoft Entra.

Berikut ialah contoh rekod penerbit yang termasuk operasi untuk menambah seseorang dan kumpulan ID Entra

{
   "publisherId": "MyPublisherId",
   "publisherDisplayName": "Contoso Publishing",
   "publisherUpnList": [
      {
         "action": "Add",
         "upn": "john.doe@contoso.com"
      }
   ],
   "publisherAADGroupOIDS": [
      {
         "action": "Add",
         "groupName": "PowerCatalogSubmitters",
         "groupOID": "2ded6de9-ab44-4478-9bd4-e609947daa2e",
         "groupType": "Security"
      }
   ]
}
Hartanah Jenis Wajib Description
publisherId rentetan Ya ID unik untuk penerbit ini. Gunakan ID ini untuk mengenal pasti penerbit ini pada bila-bila masa anda mencipta atau mengemas kini item katalog untuk penerbit ini. Item Katalog hanya boleh dikaitkan dengan satu penerbit pada satu masa. Nilai boleh menjadi GUID atau rentetan. Setelah ditetapkan, ia mesti dikekalkan.
publisherDisplayName rentetan Ya Pengguna melihat data ini dalam galeri katalog.
publisherUpnList KatalogUPNOperation[] Tidak Orang yang boleh menyerahkan item katalog baharu atau mengemas kini sebagai penerbit ini. Sentiasa sertakan pengguna yang menyerahkan pada kali pertama Penerbit dicipta.
publisherAADGroupOIDS Operasi Kumpulan Katalog[] Tidak Kumpulan ID Entra yang ahlinya dibenarkan mengakses penerbit ini.

KatalogUPNOperation

Gunakan data ini untuk menentukan sifat PenerbitpublisherUpnList .

Mentakrifkan operasi untuk menambah atau mengalih keluar orang yang boleh menyerahkan item katalog baharu atau mengemas kini sebagai penerbit ini.

Hartanah Jenis Wajib Description
action rentetan Ya Tindakan yang perlu diambil dengan UPN ini. Nilai yang sah: Add atau Remove.
upn rentetan Ya Nama Utama Pengguna (UPN) pengguna.
userOid guid Ya Pengecam Objek untuk pengguna.

Operasi Kumpulan Katalog

Gunakan data ini untuk menentukan sifat PenerbitpublisherAADGroupOIDS .

Mentakrifkan operasi untuk menambah atau mengalih keluar Kumpulan ID Entra yang boleh mengakses penerbit ini.

Hartanah Jenis Wajib Description
action rentetan Ya Tindakan yang perlu diambil dengan UPN ini. Nilai yang sah: Add atau Remove.
groupName rentetan Ya Nama kumpulan.
groupOid guid Ya Pengecam objek untuk kumpulan.
groupType rentetan Ya Jenis Kumpulan yang ditangani. Nilai Sah ialah Security dan Modern.

CatalogItemDefinition

Gunakan data ini untuk menentukan sifat item catalogItemDefinition penyerahan katalog.

Sifat ini mentakrifkan item katalog yang diserahkan. Ini ialah penyelesaian Power Platform sebenar. Pakej ialah apa yang disimpan dalam katalog.

Berikut ialah contoh item katalog termasuk kenalannya engineeringName dan supportName kenalannya yang wajib.

"catalogItemDefinition": {
   "id": "ContosoTravelsApp",
   "displayName": "Contoso Travel Expense App",
   "description": "Submit expenses on the go!",
   "offer": {
   "businessCategories": [526430000, 526430001, 526430002],
   "type": "Component_Collection",
   "deploymentType": "Normal",
   "small48x48Image": {
      "name": "Small48Image",
      "fileSasLink": "https://www.contoso.com/icon48.jpg"      
   },
   "large216x216Image": {
      "name": "Large216image2",
      "fileSasLink": "https://www.contoso.com/icon216.jpg"
   },
   "documents": [
      {
         "name": "ImaNewfile",
         "fileSasLink": "https://www.contoso.com/screenshot1.jpg"
      },
      {
         "name": "ImaNewfile2",
         "fileSasLink": "https://www.contoso.com/screenshot2.jpg"
      }
   ],
   "helpLink": "https://www.contoso.com/help.html",
   "privacyPolicyLink": "https://www.contoso.com/privacy.html",
   "legalTerms": "https://www.contoso.com/legal.html",
   "engineeringName": {
      "firstName": "John",
      "lastName": "Roon",
      "email": "john@contoso.com",
      "phoneNumber": "999-111-1234"
   },
   "supportName": {
      "firstName": "Jane",
      "lastName": "Drill",
      "email": "jane@contoso.com",
      "phoneNumber": "999-111-1234"
   }
   }
}
Hartanah Jenis Wajib Description
id guid Ya ID unik item katalog. Gunakan ID ini semasa mengemas kini atau memasang item katalog.
displayName rentetan Ya Nama ditunjukkan kepada pengguna dalam galeri katalog.
description rentetan Tidak Penerangan ditunjukkan kepada pengguna dalam galeri katalog.
offer Butiran Tawaran Ya Butiran penyerahan item katalog.
packageFile CatalogFileAsset Ya Menerangkan tempat untuk mendapatkan fail pakej katalog untuk penyerahan.

Butiran Tawaran

Gunakan data ini untuk menentukan sifat CatalogItemDefinitionoffer .

Sifat ini mentakrifkan butiran penyerahan item katalog.

Hartanah Jenis Wajib Description
businessCategories int[] Tidak Senarai nilai pilihan pilihan yang dihormati oleh katalog sasaran. Mengenal pasti kategori perniagaan untuk dikaitkan dengan item katalog ini. Lihat Kategori perniagaan untuk mendapatkan nilai yang sah untuk digunakan.
type rentetan Ya Jenis item katalog. Nilai yang sah:
- Application
- Component_Collection
supportsApplicationTypes rentetan[] Tidak Senarai jenis aplikasi yang disokong. Nilai yang sah:
- CanvasApps
- ModelApps
- PowerPortals
- PowerAutomate
deploymentType rentetan Ya Menunjukkan jenis penggunaan untuk menggunakan item katalog ini. Nilai yang sah:
- Normal mewakili item terurus.
- Template Salinan penyelesaian anda yang tidak terurus yang boleh diedit oleh pembuat lain mengikut pilihan mereka.
Ketahui lebih lanjut tentang jenis item katalog
searchKeywords rentetan[] Tidak Perkataan yang mungkin digunakan oleh orang ramai untuk mencari item katalog ini.
small48x48Image CatalogFileAsset Tidak Imej untuk paparan galeri. Jika anda tidak memberikan imej ini, ikon lalai sistem digunakan.
large216x216Image CatalogFileAsset Tidak Imej untuk paparan terperinci. Sediakan ikon untuk dipaparkan dalam pembuat atau UI penemuan lain. Sesetengah pengalaman pengguna menggunakan ikon yang lebih besar untuk memaparkan kad untuk penemuan.
useCaseDocument CatalogFileAsset Tidak Gunakan penerangan dan penjelasan kes kepada pemberi kelulus.
videos CatalogFileAsset[] Tidak Paparan terperinci memaparkan pautan ke fail video/gif ini.
documents CatalogFileAsset[] Tidak Pandangan terperinci memaparkan pautan ke fail ini.
screenshots CatalogFileAsset[] Tidak Paparan terperinci memaparkan imej ini. Anda boleh menghantar tangkapan skrin aplikasi anda di sini untuk membantu pembuat mengenal pasti sama ada apl ini menyediakan fungsi atau keupayaan yang mereka cari. Perkara yang paling biasa dilakukan orang sebelum memuat turun apl atau templat ialah melihat imej dan tangkapan skrinnya untuk memahami keupayaan dan bukannya membaca perihalan.
helpLink Uri Tidak Pautan ke dokumentasi. URL ini boleh menjadi pautan kepada dokumen dalaman atau sumber sharepoint.
privacyPolicyLink Uri Tidak Pautan ke dokumen privasi. Dasar mengenai penggunaan komponen atau aplikasi yang diserahkan dengan teliti.
legalTermsLink Uri Tidak Pautan ke dokumen Terma dan Syarat. Sebarang terma undang-undang atau panduan dalaman untuk penilaian pengguna item katalog.
legalTerms rentetan Tidak Markdown, HTML atau versi teks dokumen Terma dan Syarat. Sebarang terma undang-undang atau panduan dalaman untuk penilaian pengguna item katalog.
sourceCodeRepositoryLink Uri Tidak Pautan ke repositori kod sumber
engineeringName Maklumat Hubungan Orang Ya Maklumat hubungan untuk jurutera atau kumpulan yang membangunkan item katalog ini.
supportName Maklumat Hubungan Orang Tidak Maklumat hubungan untuk sokongan atau kumpulan yang menyokong item katalog ini. Boleh sama dengan kenalan kejuruteraan yang boleh dihubungi oleh pengguna item katalog jika mereka menghadapi masalah dengan aplikasi.

Kategori perniagaan

Tetapkan sifat OfferDetailsbusinessCategories kepada satu atau lebih kategori perniagaan ini:

Kod Description
526430000 Khidmat Pelanggan
526430001 Pengurusan Projek
526430002 Pengurusan & Penjadualan Kalendar
526430003 Pengurusan E-mel
526430004 Fail & Dokumentasi
526430005 Pemberitahuan & Peringatan
526430006 Analitis
526430007 Kerjasama
526430008 Perdagangan
526430009 Kewangan
526430010 Pematuhan & Undang-undang
526430011 Sales
526430012 Alat IT
526430013 Marketing
526430014 Operasi & Rantaian Bekalan
526430015 Internet Objek
526430016 Pembelajaran Mesin AI
526430017 Geolokasi
526430018 Sumber Manusia

Pada masa ini, kategori perniagaan baharu tidak boleh dikonfigurasikan, tetapi ia boleh diambil daripada pilihan global Kategori Perniagaan Katalog (mspcat_catalogbusinesscategory).

CatalogFileAsset

Sifat ini mentakrifkan fail yang dirujuk dalam CatalogItemDefinitionpackageFile dan OfferDetailssmall48x48Image, large216x216Image, , useCaseDocumentvideosdocuments, dan screenshots sifat.

Hartanah Jenis Wajib Description
name rentetan Ya Nama fail.
filesaslink Uri Ya Pautan untuk memuat turun fail. Jika pautan memerlukan pengesahan, berikan URL tandatangan akses dikongsi (SAS).

Maklumat Hubungan Orang

Sifat ini mentakrifkan orang dalam item katalog OfferDetailsengineeringName dan supportName sifat.

Hartanah Jenis Wajib Description
firstName rentetan Tidak Nama pertama orang.
lastName rentetan Ya Nama keluarga orang.
email rentetan Ya Alamat e-mel orang.
phoneNumber rentetan Tidak Nombor telefon orang.
  • Last updated on