Odkaz na dokument pre položku katalógu

Pri odosielaní položky do katalógu musíte zahrnúť údaje vo formáte JSON. Tento článok popisuje platné vlastnosti pre daný dokument. JSON je príklad:

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

Táto tabuľka popisuje vlastnosti dokumentu odoslania:

Vlastnosť Typ Požaduje sa Description
modelVersion reťazec Nie Číslo verzie odoslaného dokumentu. Predvolená hodnota je 1.0.0.0.
sourcePortal int Nie Identifikuje zdroj tejto žiadosti. 526430005 Predvoleným typom je PAC CLI. V prípade iných zdrojov použite adresu 526430000. Funkcia mspcat_GetPowerCatalogDetails vráti celý zoznam. Vlastnosť mspcat_GetPowerCatalogDetailsResponse.CatalogDetails.sourceOptions obsahuje zoznam dostupných možností.
submissionId guid Nie Identifikátor GUID na identifikáciu odoslania. Táto hodnota je cudzím kľúčom, ktorý umožňuje prepojenie požiadavky s inými systémami.
operation reťazec Áno V prípade budúceho rozšírenia a v súčasnosti nie je rešpektovaný. Typ operácie, ktorá sa má použiť. Platné hodnoty:
- CreateOrUpdate (Predvolené)
- Create
- Update
- Disabled
businessJustification reťazec Nie Popisuje obchodnú hodnotu odoslania schvaľovateľovi. Táto hodnota môže obsahovať formát HTML alebo formát RTF. Táto informácia sa zobrazí v rámci plánovanej spotreby v používateľskom prostredí zisťovania tvorcu. Používatelia môžu povedať, že ich odoslanie pomáha napríklad znížením nákladov alebo produktivitou. Niektoré organizácie vyžadujú určité triedy hodnôt a tieto hodnoty je možné zadať tu.
publisherDetails Vydavateľ Áno Vydavateľ priradený k tomuto odoslaniu položky.
catalogItemDefinition CatalogItemDefinition Áno Definuje odosielanú položku katalógu.

Vydavateľ

Pomocou týchto údajov špecifikujte vlastnosť položky publisherDetails odoslania katalógu.

Vytvorí záznam vydavateľa, ktorý môže byť priradený k jednej alebo viacerým skupinám ID služby Microsoft Entra, ktoré obsahujú oprávnených používateľov, ktorí môžu vykonávať aktualizácie položky katalógu v budúcnosti.

Poznámka

Nezamieňajte si tento výraz s vydavateľom riešenia. Vydavateľ položiek katalógu sa nepoužíva s riešeniami.

Musíte zadať publisherDisplayName minimum. publisherId Hodnota môže byť ľubovoľná hodnota reťazca. Systém skontroluje, či daný vydavateľ existuje, inak ho vytvorí a priradí publisherId.

IT tím vývojárov môže napríklad vytvoriť vydavateľa a ID vývojárov pomocou skupiny Microsoft Entra ID.

Tu je ukážka záznamu vydavateľa, ktorý obsahuje operácie na pridanie 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"
      }
   ]
}
Vlastnosť Typ Požaduje sa Description
publisherId reťazec Áno Jedinečné ID tohto vydavateľa. Toto ID môžete použiť na identifikáciu tohto vydavateľa vždy, keď vytvárate alebo aktualizujete položku katalógu pre tohto vydavateľa. Položky katalógu možno priradiť iba jednému vydavateľovi naraz. Hodnotou môže byť identifikátor GUID alebo reťazec. Po nastavení sa musí zachovať.
publisherDisplayName reťazec Áno Spotrebiteľom sa tieto údaje zobrazia v galérii katalógu.
publisherUpnList CatalogUPNOperation[] Nie Ľudia, ktorí môžu odoslať nové alebo aktualizovať položky katalógu ako tento vydavateľ. Vždy zahŕňa odosielajúceho používateľa pri prvom vytvorení Vydavateľa.
publisherAADGroupOIDS CatalogGroupOperation[] Nie Skupiny ID entra, ktorých členovia majú povolený prístup k tomuto vydavateľovi.

CatalogUPNOperation

Pomocou týchto údajov špecifikujte vlastnosť PublisherpublisherUpnList .

Definuje operáciu na pridanie alebo odstránenie ľudí, ktorí môžu odoslať nové alebo aktualizovať položky katalógu ako tohto vydavateľa.

Vlastnosť Typ Požaduje sa Description
action reťazec Áno Akcia, ktorá sa vykoná s týmto upN. Platné hodnoty: Add alebo Remove.
upn reťazec Áno Hlavné meno používateľa (UPN) používateľa.
userOid guid Áno Identifikátor objektu používateľa.

CatalogGroupOperation

Pomocou týchto údajov špecifikujte vlastnosť PublisherpublisherAADGroupOIDS .

Definuje operáciu na pridanie alebo odstránenie skupiny Entra ID, ktorá má prístup k tomuto vydavateľovi.

Vlastnosť Typ Požaduje sa Description
action reťazec Áno Akcia, ktorá sa vykoná s týmto upN. Platné hodnoty: Add alebo Remove.
groupName reťazec Áno Názov skupiny.
groupOid guid Áno Identifikátor objektu pre skupinu.
groupType reťazec Áno Typ skupiny, ktorá sa má riešiť. Platné hodnoty sú Security a Modern.

CatalogItemDefinition

Pomocou týchto údajov špecifikujte vlastnosť položky catalogItemDefinition odoslania katalógu.

Tieto vlastnosti definujú odosielanú položku katalógu. Toto je skutočné riešenie služby Power Platform. Balík je to, čo je uložené v katalógu.

Tu je príklad položky katalógu vrátane engineeringName povinných položiek a supportName kontaktov.

"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"
   }
   }
}
Vlastnosť Typ Požaduje sa Description
id guid Áno Jedinečné ID položky katalógu. Toto ID použite pri aktualizácii alebo inštalácii položky katalógu.
displayName reťazec Áno Názov zobrazený spotrebiteľom v galériách katalógov.
description reťazec Nie Popis zobrazený spotrebiteľom v galériách katalógov.
offer OfferDetails Áno Podrobnosti o odoslaní položiek do katalógu.
packageFile CatalogFileAsset Áno Popisuje, kde sa má získať súbor balíka katalógu na odoslanie.

OfferDetails

Pomocou týchto údajov špecifikujte vlastnosť CatalogItemDefinitionoffer .

Tieto vlastnosti definujú podrobnosti o odoslaní položiek katalógu.

Vlastnosť Typ Požaduje sa Description
businessCategories int[] Nie Zoznam hodnôt možností výberu rešpektovaných cieľovým katalógom. Identifikuje obchodné kategórie, ktoré sa majú priradiť k tejto položke katalógu. Platné hodnoty, ktoré sa majú použiť, nájdete v téme Podnikové kategórie .
type reťazec Áno Typ položky katalógu. Platné hodnoty:
- Application
- Component_Collection
supportsApplicationTypes reťazec[] Nie Zoznam podporovaných typov aplikácií. Platné hodnoty:
- CanvasApps
- ModelApps
- PowerPortals
- PowerAutomate
deploymentType reťazec Áno Označuje typ nasadenia na nasadenie tejto položky v katalógu. Platné hodnoty:
- Normal predstavuje spravovanú položku.
- Template Kópia vášho nespravovaného riešenia, ktorú môžu ostatní tvorcovia upravovať, nech si vyberú.
Ďalšie informácie o typoch položiek katalógu
searchKeywords reťazec[] Nie Slová, ktoré by mohli ľudia použiť na vyhľadanie tejto položky katalógu.
small48x48Image CatalogFileAsset Nie Obrázok zobrazenia galérie. Ak tento obrázok neposkytnete, použije sa predvolená ikona systému.
large216x216Image CatalogFileAsset Nie Obrázok na zobrazenie podrobností. Zadajte ikonu, ktorá sa má zobraziť v používateľskom rozhraní tvorcu alebo inom vyhľadávaní. Niektoré používateľské prostredia používajú väčšie ikony na vykreslenie kariet na vyhľadávanie.
useCaseDocument CatalogFileAsset Nie Schvaľovateľom použite popis a vysvetlenie prípadu.
videos CatalogFileAsset[] Nie Zobrazenie podrobností zobrazuje prepojenia na tieto súbory videa/GIF.
documents CatalogFileAsset[] Nie Zobrazenie podrobností zobrazí prepojenia na tieto súbory.
screenshots CatalogFileAsset[] Nie V zobrazení podrobností sa zobrazia tieto obrázky. Tu vo svojej aplikácii môžete odovzdať snímky obrazovky, ktoré pomôžu tvorcom identifikovať, či táto aplikácia poskytuje funkcie alebo možnosti, ktoré hľadajú. Ľudia sa pred stiahnutím aplikácie alebo šablóny najčastejšie pozerajú na jej obrázky a snímky obrazovky, aby pochopili možnosti namiesto čítania popisu.
helpLink uri Nie Prepojenie na dokumentáciu. Tieto URL adresy môžu byť prepojenia na interné dokumenty alebo zdroje sharepointových služieb.
privacyPolicyLink uri Nie Prepojenie na dokument o ochrane osobných údajov. Politiky týkajúce sa dôsledného používania odosielanej súčasti alebo aplikácie.
legalTermsLink uri Nie Prepojenie na dokument Podmienky a požiadavky. Akékoľvek právne podmienky alebo interné pokyny na hodnotenie spotrebiteľa položky katalógu.
legalTerms reťazec Nie Markdown, HTML alebo textová verzia dokumentu Podmienky. Akékoľvek právne podmienky alebo interné pokyny na hodnotenie spotrebiteľa položky katalógu.
sourceCodeRepositoryLink uri Nie Prepojenie na odkladací priestor zdrojového kódu
engineeringName PersonContactInformation (OsobaKontaactInformation) Áno Kontaktné informácie pre inžiniera alebo skupinu, ktorá vyvinula túto položku katalógu.
supportName PersonContactInformation (OsobaKontaactInformation) Nie Kontaktné informácie pre podporu alebo skupinu, ktorá podporuje túto položku katalógu. Môže to byť rovnaký ako technický kontakt, na ktorý sa môže obrátiť spotrebiteľ položky katalógu, ak sa u neho v aplikácii môžu vyskytnúť problémy.

Obchodné kategórie

Nastavte vlastnosť OfferDetailsbusinessCategories na jednu alebo viacero z týchto obchodných kategórií:

Kód Description
526430000 Služby pre zákazníkov
526430001 Riadenie projektov
526430002 Správa kalendárov a plánovanie
526430003 Správa e-mailov
526430004 Súbory a dokumentácia
526430005 Oznámenia a pripomenutia
526430006 Analýzy
526430007 Spolupráca
526430008 Commerce
526430009 Financie
526430010 Súlad s právnymi predpismi
526430011 Sales
526430012 Nástroje IT
526430013 Marketing
526430014 Prevádzka a dodávateľské reťazce
526430015 Internet vecí
526430016 Strojové učenie umelej inteligencie
526430017 Geolokácia
526430018 Ľudské zdroje

V súčasnosti nie je možné nakonfigurovať nové obchodné kategórie, ale možno ich načítať z globálnej voľby Katalógu Business Category (mspcat_catalogbusinesscategory).

CatalogFileAsset

Tieto vlastnosti definujú súbor, na ktorý sa odkazuje v catalogItemDefinitionpackageFile , a vlastnosti OfferDetailssmall48x48Image, large216x216Image, useCaseDocument, videos, documentsa screenshots .

Vlastnosť Typ Požaduje sa Description
name reťazec Áno Názov súboru.
filesaslink uri Áno Prepojenie na stiahnutie súboru. Ak prepojenie vyžaduje overenie, poskytnite URL adresu podpisu zdieľaného prístupu (SAS).

PersonContactInformation (OsobaKontaactInformation)

Tieto vlastnosti definujú ľudí v položke katalógu OfferDetailsengineeringName a supportName vlastnosti.

Vlastnosť Typ Požaduje sa Description
firstName reťazec Nie Krstné meno osoby.
lastName reťazec Áno Priezvisko osoby.
email reťazec Áno E-mailová adresa osoby.
phoneNumber reťazec Nie Telefónne číslo osoby.
  • Last updated on