Del via

Dokumentreference til afsendelse af katalogelement

Du skal medtage data i JSON-format, når du sender et element til kataloget. I denne artikel beskrives de gyldige egenskaber for dokumentet. Dette JSON er et eksempel:

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

I denne tabel beskrives egenskaberne for afsendelsesdokumentet:

Egenskab Type Påkrævet Beskrivelse
modelVersion streng Nej Versionsnummer for afsendelsesdokumentet. Standard er 1.0.0.0.
sourcePortal int Nej Identificerer kilden til denne anmodning. 526430005 Som standard er PAC-kommandolinjegrænsefladen. For andre kilder skal du bruge 526430000. Funktionen mspcat_GetPowerCatalogDetails returnerer den komplette liste. Egenskaben mspcat_GetPowerCatalogDetailsResponse.CatalogDetails.sourceOptions viser de tilgængelige indstillinger.
submissionId guid Nej GUID til at identificere afsendelsen. Denne værdi er en fremmed nøgle, der gør det muligt at sammenkæde anmodningen med andre systemer.
operation streng Ja Til fremtidig udvidelse og respekteres i øjeblikket ikke. Den type handling, der skal bruges. Gyldige værdier:
- CreateOrUpdate (Standard)
- Create
- Update
- Disabled
businessJustification streng Nej Beskriver forretningsværdien af indsendelsen til godkenderen. Denne værdi kan indeholde HTML- eller RTF-format (Rich Text Format). Disse oplysninger vises i den planlagte forbrugsoplevelse i udviklerregistreringsbrugeroplevelsen. Brugerne kan f.eks. sige, at deres indsendelse hjælper med omkostningsreduktion eller produktivitet. Nogle organisationer kræver visse værdiklasser, og disse værdier kan angives her.
publisherDetails Publisher Ja Den udgiver, der er knyttet til dette element.
catalogItemDefinition CatalogItemDefinition Ja Definerer det katalogelement, der sendes.

Publisher

Brug disse data til at angive egenskaben for elementet til indsendelse af publisherDetails kataloger.

Opretter en udgiverpost, der kan knyttes til en eller flere Microsoft Entra ID-grupper, der indeholder godkendte brugere, som fremover kan foretage opdateringer af katalogelementet.

Notat

Forveksler ikke dette ord med Løsningsudgiver. Udgiveren af katalogelementet bruges ikke sammen med løsninger.

Du skal som minimum angive publisherDisplayName . publisherId kan være en hvilken som helst strengværdi. Systemet kontrollerer, om udgiveren findes. Ellers oprettes den, og der tildeles en publisherId.

HR-it-team af udviklere kan f.eks. oprette en udgiver og et id for udviklerne ved hjælp af en Microsoft Entra-id-gruppe.

Her er et eksempel på en udgiverpost, der indeholder handlinger til at tilføje en person og en entra-id-gruppe

{
   "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"
      }
   ]
}
Egenskab Type Påkrævet Beskrivelse
publisherId streng Ja Det entydige id for denne udgiver. Brug dette id til at identificere denne udgiver, hver gang du opretter eller opdaterer et katalogelement for denne udgiver. Katalogelementer kan kun knyttes til én udgiver ad gangen. Værdien kan være et GUID eller en streng. Når den er indstillet, skal den vedligeholdes.
publisherDisplayName streng Ja Forbrugerne kan se disse data i kataloggalleriet.
publisherUpnList CatalogUPNOperation[] Nej Personer, der kan sende nye eller opdatere katalogelementer som denne udgiver. Medtager altid den bruger, der indsender, første gang Publisher oprettes.
publisherAADGroupOIDS CatalogGroupOperation[] Nej Entra ID Grupper, hvis medlemmer har tilladelse til at få adgang til denne udgiver.

CatalogUPNOperation

Brug disse data til at angive egenskaben PublisherpublisherUpnList .

Definerer en handling for at tilføje eller fjerne personer, der kan sende nye eller opdatere katalogelementer som denne udgiver.

Egenskab Type Påkrævet Beskrivelse
action streng Ja Den handling, der skal udføres med dette UPN. Gyldige værdier: Add eller Remove.
upn streng Ja Brugerens hovednavn (UPN).
userOid guid Ja Objekt-id for brugeren.

CatalogGroupOperation

Brug disse data til at angive egenskaben PublisherpublisherAADGroupOIDS .

Definerer en handling for at tilføje eller fjerne en entra-id-gruppe, der kan få adgang til denne udgiver.

Egenskab Type Påkrævet Beskrivelse
action streng Ja Den handling, der skal udføres med dette UPN. Gyldige værdier: Add eller Remove.
groupName streng Ja Navnet på gruppen.
groupOid guid Ja Objekt-id for gruppe.
groupType streng Ja Type af gruppe, der behandles. Gyldige værdier er Security og Modern.

CatalogItemDefinition

Brug disse data til at angive egenskaben for elementet til indsendelse af catalogItemDefinition kataloger.

Disse egenskaber definerer det katalogelement, der sendes. Dette er den faktiske Power Platform-løsning. En pakke er det, der er gemt i kataloget.

Her er et eksempel på et katalogelement, herunder dets engineeringName og supportName kontakter, der er obligatoriske.

"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"
   }
   }
}
Egenskab Type Påkrævet Beskrivelse
id guid Ja Det entydige id for katalogelementet. Brug dette id, når katalogelementet opdateres eller installeres.
displayName streng Ja Navn, der vises for forbrugere i kataloggallerierne.
description streng Nej Beskrivelse, der vises for forbrugere i kataloggallerierne.
offer OfferDetails Ja Oplysningerne om afsendelsen af katalogelementet.
packageFile CatalogFileAsset Ja Beskriver, hvor katalogpakkefilen til afsendelsen skal hentes.

OfferDetails

Brug disse data til at angive egenskaben CatalogItemDefinitionoffer .

Disse egenskaber definerer detaljerne for afsendelsen af katalogelementet.

Egenskab Type Påkrævet Beskrivelse
businessCategories int[] Nej Liste over valgindstillingsværdier, der respekteres af destinationskataloget. Identificerer de virksomhedskategorier, der skal knyttes til dette katalogelement. Se Forretningskategorier for at få vist de gyldige værdier, der skal bruges.
type streng Ja Katalogelementets type. Gyldige værdier:
- Application
- Component_Collection
supportsApplicationTypes string[] Nej Liste over understøttede programtyper. Gyldige værdier:
- CanvasApps
- ModelApps
- PowerPortals
- PowerAutomate
deploymentType streng Ja Angiver den installationstype, der skal installere dette katalogelement. Gyldige værdier:
- Normal repræsenterer et administreret element.
- Template En kopi af din ikke-administrerede løsning, som andre oprettere kan redigere, som de vælger.
Få mere at vide om katalogelementtyper
searchKeywords string[] Nej Ord, som andre kan bruge til at finde dette katalogelement.
small48x48Image CatalogFileAsset Nej Billede til gallerivisning. Hvis du ikke angiver dette billede, bruges der et systemstandardikon.
large216x216Image CatalogFileAsset Nej Billede til detaljevisning. Angiv et ikon, der skal vises i udviklerens eller en anden registreringsbrugergrænseflade. Nogle brugeroplevelser bruger større ikoner til at gengive kort til registrering.
useCaseDocument CatalogFileAsset Nej Brug sagsbeskrivelse og forklaring til godkendere.
videos CatalogFileAsset[] Nej I detaljevisning vises links til disse video-/gif-filer.
documents CatalogFileAsset[] Nej I detaljevisning vises links til disse filer.
screenshots CatalogFileAsset[] Nej Disse billeder vises i detaljevisning. Du kan overføre skærmbilleder her af dit program for at hjælpe oprettere med at identificere, om denne app indeholder den funktionalitet eller funktionalitet, de leder efter. Det mest almindelige, folk foretager sig, før de downloader en app eller skabelon, er at se på dens billeder og skærmbilleder for at forstå egenskaberne i stedet for at læse beskrivelsen.
helpLink uri Nej Link til dokumentation. Disse URL-adresser kan være links til interne dokumenter eller SharePoint-ressourcer.
privacyPolicyLink uri Nej Link til dokumentet om beskyttelse af personlige oplysninger. Politikker vedrørende omhyggelig brug af den komponent eller det program, der sendes.
legalTermsLink uri Nej Link til dokumentet Vilkår og betingelser. Eventuelle juridiske vilkår eller intern vejledning til evaluering af forbrugeren af katalogelementet.
legalTerms streng Nej Markdown, HTML eller tekstversion af dokumentet Vilkår og betingelser. Eventuelle juridiske vilkår eller intern vejledning til evaluering af forbrugeren af katalogelementet.
sourceCodeRepositoryLink uri Nej Link til kildekodelageret
engineeringName PersonContactInformation Ja Kontaktoplysninger for tekniker eller gruppe, der har udviklet dette katalogelement.
supportName PersonContactInformation Nej Kontaktoplysninger for support eller gruppe, der understøtter dette katalogelement. Kan være den samme som den tekniske kontakt, som forbrugeren af et katalogelement kan kontakte, hvis der er problemer med programmet.

Virksomhedskategorier

Angiv egenskaben OfferDetailsbusinessCategories til en eller flere af disse virksomhedskategorier:

Kode Beskrivelse
526430000 Kundeservice
526430001 Projektstyring
526430002 Kalenderstyring og planlægning
526430003 Mailadministration
526430004 Filer og dokumentation
526430005 Meddelelse & påmindelser
526430006 Analyse
526430007 Samarbejde
526430008 Handel
526430009 Finanser
526430010 Overholdelse & juridisk
526430011 Sales
526430012 It-værktøjer
526430013 Marketing
526430014 Handlinger & Forsyningskæde
526430015 Tingenes internet
526430016 AI Machine Learning
526430017 Geoplacering
526430018 Menneskelige ressourcer

Nye virksomhedskategorier kan i øjeblikket ikke konfigureres, men de kan hentes fra det globale valg Katalog over forretningskategori (mspcat_catalogbusinesscategory).

CatalogFileAsset

Disse egenskaber definerer en fil, der refereres til i CatalogItemDefinitionpackageFile og egenskaberne OfferDetailssmall48x48Image, large216x216Image, useCaseDocument, videos, documentsog screenshots .

Egenskab Type Påkrævet Beskrivelse
name streng Ja Navnet på filen.
filesaslink uri Ja Link til download af filen. Hvis linket kræver godkendelse, skal du angive en SAS-URL-adresse (Shared Access Signature).

PersonContactInformation

Disse egenskaber definerer personer i katalogelementet OfferDetailsengineeringName og supportName egenskaber.

Egenskab Type Påkrævet Beskrivelse
firstName streng Nej Person fornavn.
lastName streng Ja Personfamilienavn.
email streng Ja Personmailadresse.
phoneNumber streng Nej Personnummer.
  • Last updated on