Sdílet prostřednictvím

Referenční informace k dokumentu pro odeslání položky katalogu

Při odesílání položky do katalogu je nutné zahrnout data ve formátu JSON. Tento článek popisuje platné vlastnosti pro daný dokument. Tento kód JSON je příkladem:

{
  "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"
      }
  }
}

Tato tabulka popisuje vlastnosti dokumentu pro odeslání:

Vlastnictví Typ Povinné Description
modelVersion řetězec Ne Číslo verze dokumentu pro odeslání Výchozí hodnota je 1.0.0.0.
sourcePortal int Ne Identifikuje zdroj tohoto požadavku. Výchozí hodnota 526430005 je rozhraní příkazového řádku PAC. Pro jiné zdroje použijte 526430000. Funkce mspcat_GetPowerCatalogDetails vrátí úplný seznam. Tato mspcat_GetPowerCatalogDetailsResponse.CatalogDetails.sourceOptions vlastnost obsahuje seznam dostupných možností.
submissionId GUID (globálně unikátní identifikátor) Ne Identifikátor GUID pro identifikaci odeslání Tato hodnota je cizí klíč, který umožňuje propojení požadavku s jinými systémy.
operation řetězec Ano Pro budoucí rozšíření a v současné době se nerespektuje. Typ operace, která se má použít. Platné hodnoty:
- CreateOrUpdate (Výchozí)
- Create
- Update
- Disabled
businessJustification řetězec Ne Popisuje obchodní hodnotu odeslání schvalovateli. Tato hodnota může obsahovat FORMÁT RTF (HTML nebo RTF). Tyto informace se zobrazí v prostředí plánované spotřeby v uživatelském prostředí zjišťování tvůrce. Uživatelé můžou říct, že jejich odeslání pomáhá například se snížením nákladů nebo produktivitou. Některé organizace vyžadují určité třídy hodnot a tyto hodnoty se dají zadat tady.
publisherDetails Vydavatel Ano Vydavatel přidružený k odeslání této položky.
catalogItemDefinition CatalogItemDefinition Ano Definuje odesílanou položku katalogu.

Vydavatel

Tato data použijte k určení vlastnosti položky publisherDetails odeslání katalogu.

Vytvoří záznam vydavatele, který lze přidružit k jedné nebo více skupinám Microsoft Entra ID obsahujícím autorizované uživatele, kteří můžou aktualizovat položku katalogu.

Poznámka:

Nezaměňujte tento termín s Vydavatelem řešení. Vydavatel položek katalogu se nepoužívá s řešeními.

Musíte zadat publisherDisplayName minimálně. publisherId může být libovolná řetězcová hodnota. Systém zkontroluje, zda daný vydavatel existuje, jinak ho publisherIdvytvoří a přiřadí .

Například tým IT pro personální oddělení vývojářů může vytvořit vydavatele a ID vývojářů pomocí skupiny Microsoft Entra ID.

Tady je ukázka záznamu vydavatele, který obsahuje operace pro přidání osoby a skupiny 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"
      }
   ]
}
Vlastnictví Typ Povinné Description
publisherId řetězec Ano Jedinečné ID tohoto vydavatele. Toto ID použijte k identifikaci tohoto vydavatele, kdykoli vytváříte nebo aktualizujete položku katalogu pro tohoto vydavatele. Položky katalogu lze přidružit pouze k jednomu vydavateli najednou. Hodnota může být identifikátor GUID nebo řetězec. Po nastavení se musí udržovat.
publisherDisplayName řetězec Ano Uživatelé vidí tato data v galerii katalogu.
publisherUpnList CatalogUPNOperation[] Ne Lidé, kteří můžou odesílat nové nebo aktualizovat položky katalogu jako tohoto vydavatele Vždy zahrnuje odesílajícího uživatele při prvním vytvoření publisheru.
publisherAADGroupOIDS CatalogGroupOperation[] Ne Entra ID Groups, jejichž členové mají povolený přístup k tomuto vydavateli.

CatalogUPNOperation

Tato data použijte k určení vlastnosti PublisherpublisherUpnList .

Definuje operaci pro přidání nebo odebrání lidí, kteří můžou odesílat nové nebo aktualizovat položky katalogu jako tohoto vydavatele.

Vlastnictví Typ Povinné Description
action řetězec Ano Akce, která se má provést s tímto hlavním uživatelem uživatele (UPN). Platné hodnoty: Add nebo Remove.
upn řetězec Ano Hlavní název uživatele (UPN) uživatele.
userOid GUID (globálně unikátní identifikátor) Ano Identifikátor objektu pro uživatele.

CatalogGroupOperation

Tato data použijte k určení vlastnosti PublisherpublisherAADGroupOIDS .

Definuje operaci pro přidání nebo odebrání skupiny ID Entra, která má přístup k tomuto vydavateli.

Vlastnictví Typ Povinné Description
action řetězec Ano Akce, která se má provést s tímto hlavním uživatelem uživatele (UPN). Platné hodnoty: Add nebo Remove.
groupName řetězec Ano Název skupiny
groupOid GUID (globálně unikátní identifikátor) Ano Identifikátor objektu pro skupinu.
groupType řetězec Ano Typ adresované skupiny Platné hodnoty jsou Security a Modern.

CatalogItemDefinition

Tato data použijte k určení vlastnosti položky catalogItemDefinition odeslání katalogu.

Tyto vlastnosti definují odesílanou položku katalogu. Toto je skutečné řešení Power Platform. Balíček je to, co je uloženo v katalogu.

Tady je příklad položky katalogu, včetně jejích engineeringName a supportName kontaktů, které jsou povinné.

"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"
   }
   }
}
Vlastnictví Typ Povinné Description
id GUID (globálně unikátní identifikátor) Ano Jedinečné ID položky katalogu. Toto ID použijte při aktualizaci nebo instalaci položky katalogu.
displayName řetězec Ano Název zobrazený příjemcům v galeriích katalogu
description řetězec Ne Popis zobrazený příjemcům v galeriích katalogu
offer OfferDetails Ano Podrobnosti o odeslání položky katalogu.
packageFile CatalogFileAsset Ano Popisuje, kde získat soubor balíčku katalogu pro odeslání.

Podrobnosti nabídky

Tato data použijte k určení CatalogItemDefinitionoffer vlastnost.

Tyto vlastnosti definují podrobnosti o odeslání položky katalogu.

Vlastnictví Typ Povinné Description
businessCategories int[] Ne Seznam hodnot voleb respektovaných cílovým katalogem Identifikuje obchodní kategorie, které se mají přidružit k této položce katalogu. Platné hodnoty, které se mají použít, najdete v kategoriích firmy .
type řetězec Ano Typ položky katalogu Platné hodnoty:
- Application
- Component_Collection
supportsApplicationTypes řetězec[] Ne Seznam podporovaných typů aplikací Platné hodnoty:
- CanvasApps
- ModelApps
- PowerPortals
- PowerAutomate
deploymentType řetězec Ano Určuje typ nasazení pro nasazení této položky katalogu. Platné hodnoty:
- Normal představuje spravovanou položku.
- Template Kopie nespravovaného řešení, kterou můžou ostatní tvůrci upravovat, ale vyberou.
Další informace o typech položek katalogu
searchKeywords řetězec[] Ne Slova, která lidé můžou použít k vyhledání této položky katalogu.
small48x48Image CatalogFileAsset Ne Obrázek zobrazení galerie Pokud tuto image nezadáte, použije se výchozí ikona systému.
large216x216Image CatalogFileAsset Ne Obrázek pro zobrazení podrobností Zadejte ikonu, která se má zobrazit v tvůrci nebo jiném uživatelském rozhraní zjišťování. Některá uživatelská prostředí používají k vykreslení karet pro zjišťování větší ikony.
useCaseDocument CatalogFileAsset Ne Popis případu a vysvětlení použijte ke schvalovateli.
videos CatalogFileAsset[] Ne Zobrazení podrobností zobrazuje odkazy na tyto videosoubory nebo soubory gif.
documents CatalogFileAsset[] Ne Zobrazení podrobností zobrazuje odkazy na tyto soubory.
screenshots CatalogFileAsset[] Ne Zobrazení podrobností zobrazuje tyto obrázky. Tady můžete předat snímky obrazovky vaší aplikace, které pomáhají tvůrcům určit, jestli tato aplikace poskytuje funkce nebo možnosti, které hledají. Nejběžnější věc, kterou lidé dělají před stažením aplikace nebo šablony, je podívat se na její obrázky a snímky obrazovky, abyste porozuměli možnostem, a nečetli popis.
helpLink URI Ne Odkaz na dokumentaci Tyto adresy URL můžou být odkazy na interní dokumenty nebo sharepointové prostředky.
privacyPolicyLink URI Ne Odkaz na dokument ochrany osobních údajů Zásady týkající se pečlivého používání komponenty nebo aplikace, které se odesílají
legalTermsLink URI Ne Odkaz na dokument Podmínky a ujednání Jakékoli právní podmínky nebo interní pokyny pro vyhodnocení příjemce položky katalogu.
legalTerms řetězec Ne Markdown, HTML nebo textová verze dokumentu Podmínky a ujednání. Jakékoli právní podmínky nebo interní pokyny pro vyhodnocení příjemce položky katalogu.
sourceCodeRepositoryLink URI Ne Propojení s úložištěm zdrojového kódu
engineeringName PersonContactInformation Ano Kontaktní informace pro inženýra nebo skupinu, které tuto položku katalogu vyvinuly.
supportName PersonContactInformation Ne Kontaktní informace pro podporu nebo skupinu, které tuto položku katalogu podporují. Může být stejný jako technický kontakt, na který se příjemce položky katalogu může obrátit, pokud narazí na problémy s aplikací.

Obchodní kategorie

Nastavte vlastnost OfferDetailsbusinessCategories na jednu nebo více z těchto obchodních kategorií:

Code Description
526430000 Zákaznická služba
526430001 Správa projektů
526430002 Správa a plánování kalendářů
526430003 Správa e-mailů
526430004 Soubory a dokumentace
526430005 Oznámení a připomenutí
526430006 Analytika
526430007 Spolupráce
526430008 Commerce
526430009 Finance
526430010 Dodržování předpisů a právní předpisy
526430011 Sales
526430012 NÁSTROJE IT
526430013 Marketing
526430014 Provozní a dodavatelský řetězec
526430015 Internet věcí
526430016 AI Machine Learning
526430017 Geolocation
526430018 Lidské zdroje

V současné době není možné konfigurovat nové obchodní kategorie, ale dají se načíst z globální volby Kategorie obchodního katalogu (mspcat_catalogbusinesscategory).

CatalogFileAsset

Tyto vlastnosti definují soubor odkazovaný v CatalogItemDefinitionpackageFile a OfferDetailssmall48x48Image, , large216x216Image, useCaseDocument, videosdocumentsa screenshots vlastnosti.

Vlastnictví Typ Povinné Description
name řetězec Ano Název souboru.
filesaslink URI Ano Odkaz pro stažení souboru Pokud odkaz vyžaduje ověření, zadejte adresu URL sdíleného přístupového podpisu (SAS).

PersonContactInformation

Tyto vlastnosti definují osoby v položce katalogu OfferDetailsengineeringName a supportName vlastnosti.

Vlastnictví Typ Povinné Description
firstName řetězec Ne Jméno osoby.
lastName řetězec Ano Jméno rodiny osob.
email řetězec Ano E-mailová adresa osoby.
phoneNumber řetězec Ne Telefonní číslo osoby.
  • Last updated on