Share via

Naslaginformatie over het indienen van catalogusitems

U moet gegevens opnemen in JSON-indeling wanneer u een item naar de catalogus verzendt. In dit artikel worden de geldige eigenschappen voor dat document beschreven. Deze JSON is een voorbeeld:

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

In deze tabel worden de eigenschappen voor het indieningsdocument beschreven:

Vastgoed Typologie Verplicht Description
modelVersion touw Nee. Versienummer van het inzendingsdocument. De standaardwaarde is 1.0.0.0.
sourcePortal int Nee. Identificeert de bron van deze aanvraag. 526430005 De standaardinstelling is de PAC CLI. Gebruik 526430000voor andere bronnen . De mspcat_GetPowerCatalogDetails functie retourneert de volledige lijst. De mspcat_GetPowerCatalogDetailsResponse.CatalogDetails.sourceOptions eigenschap bevat de beschikbare opties.
submissionId Richtlijn Nee. Guid om de inzending te identificeren. Deze waarde is een refererende sleutel waarmee de aanvraag kan worden gekoppeld aan andere systemen.
operation touw Yes Voor toekomstige uitbreiding en wordt momenteel niet gerespecteerd. Het type bewerking dat moet worden gebruikt. Geldige waarden:
- CreateOrUpdate (Standaard)
- Create
- Update
- Disabled
businessJustification touw Nee. Beschrijft de bedrijfswaarde van de inzending aan de fiatteur. Deze waarde kan HTML- of RTF-indeling (Rich Text Format) bevatten. Deze informatie wordt weergegeven in de geplande verbruikservaring in de gebruikerservaring van makerdetectie. Gebruikers kunnen bijvoorbeeld zeggen dat hun inzending helpt bij het verlagen van de kosten of productiviteit. Sommige organisaties vereisen bepaalde waardeklassen en deze waarden kunnen hier worden ingevoerd.
publisherDetails Publisher Yes De uitgever die aan dit item is gekoppeld.
catalogItemDefinition CatalogItemDefinition Yes Hiermee definieert u het catalogusitem dat wordt verzonden.

Uitgever

Gebruik deze gegevens om de eigenschap van het catalogusitem op publisherDetails te geven.

Hiermee maakt u een uitgeversrecord die kan worden gekoppeld aan een of meer Microsoft Entra ID-groepen met geautoriseerde gebruikers die in de toekomst updates voor het catalogusitem kunnen aanbrengen.

Opmerking

Verwar deze term niet met Solution Publisher. Uitgever van catalogusitems wordt niet gebruikt met oplossingen.

U moet het publisherDisplayName minimaal opgeven. publisherId kan elke tekenreekswaarde zijn. Het systeem controleert of die uitgever bestaat, maakt deze anders en wijst een publisherId.

Het HR IT-team van ontwikkelaars kan bijvoorbeeld een uitgever en id maken voor de ontwikkelaars met behulp van een Microsoft Entra ID-groep.

Hier volgt een voorbeeld van een uitgeversrecord met bewerkingen voor het toevoegen van een persoon en een Entra-id-groep

{
   "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"
      }
   ]
}
Vastgoed Typologie Verplicht Description
publisherId touw Yes De unieke id voor deze uitgever. Gebruik deze id om deze uitgever te identificeren wanneer u een catalogusitem voor deze uitgever maakt of bijwerkt. Catalogusitems kunnen slechts aan één uitgever tegelijk worden gekoppeld. De waarde kan een GUID of tekenreeks zijn. Zodra deze is ingesteld, moet deze worden onderhouden.
publisherDisplayName touw Yes Consumenten zien deze gegevens in de catalogusgalerie.
publisherUpnList CatalogUPNOperation[] Nee. Personen die nieuwe catalogusitems kunnen indienen of bijwerken als deze uitgever. Neemt altijd de inzender op wanneer de uitgever voor het eerst wordt gemaakt.
publisherAADGroupOIDS CatalogGroupOperation[] Nee. Entra ID-groepen waarvan leden toegang hebben tot deze uitgever.

CatalogUPNOperation

Gebruik deze gegevens om de eigenschap PublisherpublisherUpnList op te geven.

Hiermee definieert u een bewerking om personen toe te voegen of te verwijderen die nieuwe catalogusitems kunnen verzenden of bijwerken als deze uitgever.

Vastgoed Typologie Verplicht Description
action touw Yes De actie die moet worden uitgevoerd met deze UPN. Geldige waarden: Add of Remove.
upn touw Yes User Principal Name (UPN) van de gebruiker.
userOid Richtlijn Yes Object-id voor de gebruiker.

CatalogGroupOperation

Gebruik deze gegevens om de eigenschap PublisherpublisherAADGroupOIDS op te geven.

Hiermee definieert u een bewerking voor het toevoegen of verwijderen van een Entra-id-groep die toegang heeft tot deze uitgever.

Vastgoed Typologie Verplicht Description
action touw Yes De actie die moet worden uitgevoerd met deze UPN. Geldige waarden: Add of Remove.
groupName touw Yes Naam van groep.
groupOid Richtlijn Yes Object-id voor groep.
groupType touw Yes Type groep dat wordt geadresseerd. Geldige waarden zijn Security en Modern.

CatalogItemDefinition

Gebruik deze gegevens om de eigenschap van het catalogusitem op catalogItemDefinition te geven.

Deze eigenschappen definiëren het catalogusitem dat wordt verzonden. Dit is de werkelijke Power Platform-oplossing. Een pakket is wat wordt opgeslagen in de catalogus.

Hier volgt een voorbeeld van een catalogusitem, inclusief de bijbehorende engineeringName contactpersonen en supportName contactpersonen die verplicht zijn.

"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"
   }
   }
}
Vastgoed Typologie Verplicht Description
id Richtlijn Yes De unieke id van het catalogusitem. Gebruik deze id bij het bijwerken of installeren van het catalogusitem.
displayName touw Yes De naam die wordt weergegeven aan consumenten in de catalogusgalerieën.
description touw Nee. Beschrijving die wordt weergegeven aan consumenten in de catalogusgalerieën.
offer OfferDetails Yes De details van het verzenden van catalogusitems.
packageFile CatalogFileAsset Yes Hierin wordt beschreven waar u het cataloguspakketbestand voor de inzending kunt ophalen.

Details van de aanbieding

Gebruik deze gegevens om de eigenschap CatalogItemDefinitionoffer op te geven.

Deze eigenschappen definiëren de details van het verzenden van catalogusitems.

Vastgoed Typologie Verplicht Description
businessCategories int[] Nee. Lijst met keuzeoptiewaarden die worden gerespecteerd door de doelcatalogus. Identificeert de bedrijfscategorieën die aan dit catalogusitem moeten worden gekoppeld. Zie Bedrijfscategorieën voor de geldige waarden die u wilt gebruiken.
type touw Yes Type catalogusitem. Geldige waarden:
- Application
- Component_Collection
supportsApplicationTypes string[] Nee. Lijst met ondersteunde toepassingstypen. Geldige waarden:
- CanvasApps
- ModelApps
- PowerPortals
- PowerAutomate
deploymentType touw Yes Geeft het type implementatie aan dat dit catalogusitem moet worden geïmplementeerd. Geldige waarden:
- Normal vertegenwoordigt een beheerd item.
- Template Een kopie van uw onbeheerde oplossing die andere makers kunnen bewerken, maar ze kiezen.
Meer informatie over catalogusitemtypen
searchKeywords string[] Nee. Woorden die mensen kunnen gebruiken om dit catalogusitem te vinden.
small48x48Image CatalogFileAsset Nee. Afbeelding voor galerieweergave. Als u deze installatiekopieën niet opgeeft, wordt er een standaardpictogram van het systeem gebruikt.
large216x216Image CatalogFileAsset Nee. Afbeelding voor detailweergave. Geef een pictogram op dat moet worden weergegeven in de maker of andere gebruikersinterface voor detectie. Sommige gebruikerservaringen gebruiken grotere pictogrammen om kaarten weer te geven voor detectie.
useCaseDocument CatalogFileAsset Nee. Gebruiksvoorbeeldbeschrijving en uitleg voor goedkeurders.
videos CatalogFileAsset[] Nee. In de detailweergave worden koppelingen naar deze video-/GIF-bestanden weergegeven.
documents CatalogFileAsset[] Nee. In de detailweergave worden koppelingen naar deze bestanden weergegeven.
screenshots CatalogFileAsset[] Nee. In de detailweergave worden deze afbeeldingen weergegeven. U kunt hier schermopnamen van uw toepassing doorgeven om makers te helpen bepalen of deze app de functionaliteit of mogelijkheid biedt die ze zoeken. Het meest voorkomende wat mensen doen voordat een app of sjabloon wordt gedownload, is het bekijken van de afbeeldingen en schermopnamen om inzicht te hebben in de mogelijkheden in plaats van de beschrijving te lezen.
helpLink URI Nee. Koppeling naar documentatie. Deze URL's kunnen koppelingen zijn naar interne documenten of SharePoint-resources.
privacyPolicyLink URI Nee. Koppeling naar privacydocument. Beleid met betrekking tot zorgvuldig gebruik van het onderdeel of de toepassing die wordt verzonden.
legalTermsLink URI Nee. Koppeling naar het document Voorwaarden. Alle juridische voorwaarden of interne richtlijnen voor de evaluatie van de consument van het catalogusitem.
legalTerms touw Nee. Markdown, HTML of tekstversie van het document Voorwaarden. Alle juridische voorwaarden of interne richtlijnen voor de evaluatie van de consument van het catalogusitem.
sourceCodeRepositoryLink URI Nee. Koppeling naar de opslagplaats met broncode
engineeringName PersonContactInformation Yes Contactgegevens voor technicus of groep die dit catalogusitem hebben ontwikkeld.
supportName PersonContactInformation Nee. Contactgegevens voor ondersteuning of groep die dit catalogusitem ondersteunen. Kan hetzelfde zijn als de technische contactpersoon die de consument van een catalogusitem kan bereiken als er problemen met de toepassing zijn.

Bedrijfscategorieën

Stel de eigenschap OfferDetailsbusinessCategories in op een of meer van deze bedrijfscategorieën:

Code Description
526430000 Klantenservice
526430001 Projectbeheer
526430002 Agendabeheer en planning
526430003 E-mailbeheer
526430004 Bestanden en documentatie
526430005 Meldingen en herinneringen
526430006 Gegevensanalyse
526430007 Samenwerking
526430008 Commerce
526430009 Finance
526430010 Compliance & Juridisch
526430011 Verkoop
526430012 IT-hulpprogramma's
526430013 Marketing
526430014 Operations & Supply Chain
526430015 Internet of Things
526430016 AI Machine Learning
526430017 Geolocatie
526430018 Personeel

Op dit moment kunnen nieuwe bedrijfscategorieën niet worden geconfigureerd, maar ze kunnen worden opgehaald uit de globale cataloguscategorie (mspcat_catalogbusinesscategory) van de globale keuze.

CatalogFileAsset

Deze eigenschappen definiëren een bestand waarnaar wordt verwezen in de CatalogItemDefinitionpackageFile en de OfferDetailssmall48x48Image, large216x216Image, useCaseDocument, videos, en documentsscreenshotseigenschappen.

Vastgoed Typologie Verplicht Description
name touw Yes Naam van het bestand.
filesaslink URI Yes Koppeling om het bestand te downloaden. Als voor de koppeling verificatie is vereist, geeft u een SAS-URL (Shared Access Signature) op.

PersonContactInformation

Deze eigenschappen definiëren personen in het catalogusitem OfferDetailsengineeringName en supportName eigenschappen.

Vastgoed Typologie Verplicht Description
firstName touw Nee. Voornaam van persoon.
lastName touw Yes Familienaam van persoon.
email touw Yes E-mailadres van persoon.
phoneNumber touw Nee. Telefoonnummer van persoon.
  • Last updated on