Dalintis per

Katalogo elementų pateikimo dokumento nuoroda

Kai pateikiate elementą į katalogą, turite įtraukti duomenis JSON formatu. Šiame straipsnyje aprašomos galiojančios šio dokumento ypatybės. Šis JSON yra pavyzdys:

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

Šioje lentelėje aprašomos pateikimo dokumento ypatybės:

Ypatybė Tipas Privalomas Aprašas
modelVersion eilutė Ne Pateikimo dokumento versijos numeris. Numatytoji reikšmė yra 1.0.0.0.
sourcePortal sveik. sk. Ne Identifikuoja šios užklausos šaltinį. Numatytosios reikšmės, kurios 526430005 yra PAC CLI. Jei naudojate kitus šaltinius, naudokite 526430000. Funkcija mspcat_GetPowerCatalogDetails pateikia visą sąrašą. Ypatybėje mspcat_GetPowerCatalogDetailsResponse.CatalogDetails.sourceOptions išvardytos galimos parinktys.
submissionId Guid Ne Guid , kad identifikuotumėte pateikimą. Ši reikšmė yra išorinis raktas, leidžiantis susieti užklausą su kitomis sistemomis.
operation eilutė Taip Dėl būsimos plėtros ir šiuo metu nėra gerbiamas. Naudojamos operacijos tipas. Leistinos reikšmės:
- CreateOrUpdate (Numatytasis parametras)
- Create
- Update
- Disabled
businessJustification eilutė Ne Aprašoma pateikimo tvirtintojas verslo vertė. Šioje reikšmėje gali būti HTML arba raiškiojo teksto formatas (RTF). Ši informacija rodoma suplanuotoje naudojimo patirtyje kūrėjo aptikimo vartotojo patirtyje. Pvz., vartotojai gali pasakyti, kad jų pateikimas padeda sumažinti sąnaudas arba našumą. Kai kurioms organizacijoms reikia tam tikrų reikšmių klasių ir šias reikšmes galima įvesti čia.
publisherDetails Leidykla Taip Leidėjas, susietas su šio elemento pateikimu.
catalogItemDefinition CatalogItemDefinition Taip Apibrėžia pateikiamą katalogo elementą.

Leidėjas

Naudokite šiuos duomenis, jei norite nurodyti katalogo pateikimo elemento publisherDetails ypatybę.

Sukuria leidėjo įrašą, kurį galima susieti su viena ar keliomis "Microsoft Entra" ID grupėmis, kuriose yra įgaliotųjų vartotojų, kurie gali naujinti katalogo elementą ateityje.

Pastaba.

Nepainiokite šio termino su sprendimų leidėju. Katalogo elemento leidėjas nenaudojamas su sprendimais.

Turite pateikti publisherDisplayName bent. publisherId gali būti bet kokia eilutės reikšmė. Sistema tikrina, ar leidėjas yra, o kitu atveju jį sukuria ir priskiria publisherId.

Pvz., HR IT komanda kūrėjams gali sukurti leidėją ir ID kūrėjams naudojant "Microsoft Entra ID" grupę.

Štai leidėjo įrašo pavyzdys, kuriame pateikiamos asmens įtraukimo ir "Entra ID" grupės įtraukimo operacijos

{
   "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"
      }
   ]
}
Ypatybė Tipas Privalomas Aprašas
publisherId eilutė Taip Unikalus šio leidėjo ID. Naudokite šį ID, jei norite nustatyti šį leidėją kaskart, kai kuriate arba naujinate šio leidėjo katalogo elementą. Katalogo elementus vienu metu galima susieti tik su vienu leidėju. Reikšmė gali būti GUID arba eilutė. Jį nustačius, jis turi būti palaikomas.
publisherDisplayName eilutė Taip Vartotojai mato šiuos duomenis katalogo galerijoje.
publisherUpnList CatalogUPNOperation[] Ne Žmonės, kurie gali pateikti naujus arba atnaujinti katalogo elementus kaip šį leidėją. Visada įtraukia pateikiamą vartotoją, kai pirmą kartą sukuriamas Publisher.
publisherAADGroupOIDS CatalogGroupOperation[] Ne Entra ID grupės, kurių nariams leidžiama pasiekti šį leidėją.

CatalogUPNOperation

Naudokite šiuos duomenis, kad nurodytumėte PublisherpublisherUpnList ypatybę.

Apibrėžia žmonių, kurie gali pateikti naujus arba naujinti katalogo elementus kaip šis leidėjas, įtraukimo arba šalinimo operaciją.

Ypatybė Tipas Privalomas Aprašas
action eilutė Taip Veiksmas, kurio reikia imtis su šiuo UPN. Leistinos reikšmės: Add arba Remove.
upn eilutė Taip Vartotojo sistemos vartotojo vardas (UPN).
userOid Guid Taip Vartotojo objekto identifikatorius.

CatalogGroupOperation

Naudokite šiuos duomenis, kad nurodytumėte PublisherpublisherAADGroupOIDS ypatybę.

Apibrėžia "Entra ID" grupės, kuri gali pasiekti šį leidėją, įtraukimo arba šalinimo operaciją.

Ypatybė Tipas Privalomas Aprašas
action eilutė Taip Veiksmas, kurio reikia imtis su šiuo UPN. Leistinos reikšmės: Add arba Remove.
groupName eilutė Taip Grupės pavadinimas.
groupOid Guid Taip Grupės objekto identifikatorius.
groupType eilutė Taip Grupės, į kurią kreipiamasi, tipas. Tinkamos reikšmės yra Security ir Modern.

CatalogItemDefinition

Naudokite šiuos duomenis, jei norite nurodyti katalogo pateikimo elemento catalogItemDefinition ypatybę.

Šios ypatybės apibrėžia pateikiamą katalogo elementą. Tai yra faktinis "Power Platform" sprendimas. Paketas yra tai, kas saugoma kataloge.

Toliau pateikiamas katalogo elemento, įskaitant jo engineeringName ir supportName kontaktų, kurie yra privalomi, pavyzdys.

"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"
   }
   }
}
Ypatybė Tipas Privalomas Aprašas
id Guid Taip Unikalus katalogo elemento ID. Naudokite šį ID naujindami arba diegdami katalogo elementą.
displayName eilutė Taip Pavadinimas, rodomas vartotojams katalogo galerijose.
description eilutė Ne Katalogo galerijose vartotojams rodomas aprašas.
offer Pasiūlymo pasiūlymai Taip Katalogo elementų pateikimo išsami informacija.
packageFile CatalogFileAsset Taip Aprašoma, kur gauti katalogo paketo failą pateikimui.

Pasiūlymo pasiūlymai

Naudokite šiuos duomenis, jei norite nurodyti ypatybę CatalogItemDefinitionoffer .

Šios ypatybės apibrėžia katalogo elementų pateikimo išsamią informaciją.

Ypatybė Tipas Privalomas Aprašas
businessCategories sveikasis skaičius [] Ne Pasirinkimo parinkčių reikšmių, kurias gerbia paskirties katalogas, sąrašas. Identifikuoja verslo kategorijas, susietas su šiuo katalogo elementu. Leistinų naudoti reikšmių žr. Verslo kategorijos .
type eilutė Taip Katalogo elemento tipas. Leistinos reikšmės:
- Application
- Component_Collection
supportsApplicationTypes eilutė[] Ne Palaikomų programų tipų sąrašas. Leistinos reikšmės:
- CanvasApps
- ModelApps
- PowerPortals
- PowerAutomate
deploymentType eilutė Taip Nurodo šio katalogo elemento diegimo tipą. Leistinos reikšmės:
- Normal nurodo valdomą elementą.
- Template Nevaldomo sprendimo kopija, kurią kiti kūrėjai gali redaguoti, kaip jie pasirenka.
Sužinokite daugiau apie katalogo elementų tipus
searchKeywords eilutė[] Ne Žodžiai, kuriuos žmonės gali naudoti norėdami rasti šį katalogo elementą.
small48x48Image CatalogFileAsset Ne Galerijos rodinio vaizdas. Jei nepateiksite šio vaizdo, bus naudojama sistemos numatytoji piktograma.
large216x216Image CatalogFileAsset Ne Išsamios informacijos rodinio vaizdas. Pateikite piktogramą, kuri bus rodoma kūrėjo ar kitoje aptikimo vartotojo sąsajoje. Kai kurios vartotojo patirtys naudoja didesnes piktogramas, kad galėtų generuoti kortelių aptikimą.
useCaseDocument CatalogFileAsset Ne Tvirtintojai gali naudoti atvejo aprašą ir paaiškinimą.
videos CatalogFileAsset[] Ne Išsamios informacijos rodinyje rodomi saitai su šiais vaizdo / GIF failais.
documents CatalogFileAsset[] Ne Išsamios informacijos rodinyje rodomi saitai su šiais failais.
screenshots CatalogFileAsset[] Ne Išsamios informacijos rodinyje rodomi šie vaizdai. Čia galite perduoti savo taikomosios programos ekrano kopijas, kad padėtumėte kūrėjams nustatyti, ar ši taikomoji programa teikia funkcijas ar galimybes, kurių jie ieško. Dažniausias dalykas, kurį žmonės daro prieš atsisiųsdami programėlę arba šabloną, yra peržiūrėti jos vaizdus ir ekrano kopijas, kad suprastų galimybes, užuot skaitę aprašą.
helpLink Uri Ne Saitas į dokumentaciją. Šie URL gali būti saitai į vidinius dokumentus arba "SharePoint" išteklius.
privacyPolicyLink Uri Ne Saitas į privatumo dokumentą. Strategijos dėl atidaus pateikiamo komponento arba taikomosios programos naudojimo.
legalTermsLink Uri Ne Saitas į Sąlygų dokumentą. Bet kokios teisinės sąlygos arba vidinės rekomendacijos, skirtos katalogo elemento vartotojo vertinimui.
legalTerms eilutė Ne Sąlygų dokumento "Markdown", HTML arba teksto versija. Bet kokios teisinės sąlygos arba vidinės rekomendacijos, skirtos katalogo elemento vartotojo vertinimui.
sourceCodeRepositoryLink Uri Ne Saitas į šaltinio kodo saugyklą
engineeringName PersonContactInformation Taip Inžinieriaus arba grupės, kuri sukūrė šį katalogo elementą, kontaktinė informacija.
supportName PersonContactInformation Ne Palaikymo arba grupės, palaikančios šį katalogo elementą, kontaktinė informacija. Gali būti toks pat kaip inžinerinis kontaktas, su kuriuo gali susisiekti katalogo elemento vartotojas, jei susiduria su programos problemomis.

Verslo kategorijos

Ypatybę OfferDetailsbusinessCategories nustatykite į vieną ar kelias iš šių verslo kategorijų:

Kodas Aprašas
526430000 Klientų aptarnavimas
526430001 Projekto valdymas
526430002 Kalendoriaus valdymas ir planavimas
526430003 El. pašto valdymas
526430004 Failai ir dokumentacija
526430005 Pranešimas ir priminimai
526430006 Analytics
526430007 Bendradarbiavimas
526430008 Commerce
526430009 Finansai
526430010 Atitiktis ir teisinis
526430011 Sales
526430012 IT įrankiai
526430013 Marketing
526430014 Operacijos ir tiekimo grandinė
526430015 Internetu sąveikaujantys įrenginiai
526430016 DI mašininis mokymas
526430017 Geografinė vieta
526430018 Personalas

Šiuo metu negalima konfigūruoti naujų verslo kategorijų, tačiau jas galima gauti iš katalogo verslo kategorijos (mspcat_catalogbusinesscategory) visuotinio pasirinkimo.

CatalogFileAsset

Šios ypatybės apibrėžia failą, nurodytą CatalogItemDefinitionpackageFile ir OfferDetailssmall48x48Image, large216x216Image, useCaseDocument, videos, documentsir screenshots ypatybėse.

Ypatybė Tipas Privalomas Aprašas
name eilutė Taip Failo vardas.
filesaslink Uri Taip Saitas failui atsisiųsti. Jei saitą reikia autentifikuoti, pateikite bendrinamos prieigos parašo (SAS) URL.

PersonContactInformation

Šios ypatybės apibrėžia žmones katalogo elemente OfferDetails ir engineeringName ypatybessupportName.

Ypatybė Tipas Privalomas Aprašas
firstName eilutė Ne Asmens vardas.
lastName eilutė Taip Asmens šeimos vardas.
email eilutė Taip Asmens el. pašto adresas.
phoneNumber eilutė Ne Asmens telefono numeris.
  • Last updated on