Freigeben über


Referenz zum Katalogelement-Übermittlungsdokument

Sie müssen Daten im JSON-Format einschließen, wenn Sie ein Element an den Katalog übermitteln. In diesem Artikel werden die gültigen Eigenschaften für dieses Dokument beschrieben. Diese JSON ist ein Beispiel:

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

Diese Tabelle beschreibt die Eigenschaften für das Übermittlungsdokument:

Eigenschaften typ Erforderlich Beschreibung
modelVersion string Nein Versionsnummer des Übermittlungsdokuments. Die Standardeinstellung ist 1.0.0.0.
sourcePortal Int Nein Gibt die Quelle dieser Anforderung an. Die Standardeinstellung ist 526430005, wobei es sich um die PAC-CLI handelt. Verwenden Sie für andere Quellen 526430000. Die mspcat_GetPowerCatalogDetails-Funktion gibt die vollständige Liste zurück. Die mspcat_GetPowerCatalogDetailsResponse.CatalogDetails.sourceOptions-Eigenschaft führt die verfügbaren Optionen auf.
submissionId guid Nein GUID, um die Übermittlung zu identifizieren. Dieser Wert ist ein Fremdschlüssel, um die Verknüpfung der Anforderung mit anderen Systemen zu ermöglichen.
operation string Ja Für zukünftige Erweiterungen; wird derzeit nicht berücksichtigt. Der Typ des zu verwendenden Vorgangs. Gültige Werte:
- CreateOrUpdate (Standard)
- Create
- Update
- Disabled
businessJustification string Nein Beschreibt den Geschäftswert der Übermittlung an die genehmigende Person. Dieser Wert kann HTML oder RTF (Rich Text Format) enthalten. Diese Informationen werden im geplanten Verbrauchserlebnis in der Discovery-Benutzererfahrung für Erstellende angezeigt. Benutzer könnten beispielsweise sagen, dass ihre Einreichung zur Kostensenkung oder Produktivität beiträgt. Einige Organisationen verlangen bestimmte Werteklassen und diese Werte können hier eingegeben werden.
publisherDetails Publisher Ja Der Herausgeber, der dieser Elementübermittlung zugeordnet ist.
catalogItemDefinition CatalogItemDefinition Ja Definiert das übermittelte Katalogelement.

Verleger

Verwenden Sie diese Daten, um die publisherDetails-Eigenschaft des zu übermittelnden Katalogelements anzugeben.

Erstellt einen Herausgeberdatensatz, der einer oder mehreren Microsoft Entra ID-Gruppen mit autorisierten Benutzenden zugeordnet werden kann, die künftig Aktualisierungen am Katalogelement vornehmen können.

Anmerkung

Verwechseln Sie diesen Begriff nicht mit Lösungsherausgeber. Der Katalogelementherausgeber wird nicht mit Lösungen verwendet.

Sie müssen mindestens den publisherDisplayName angeben. Bei publisherId darf es sich um einen Zeichenfolgenwert handeln. Das System prüft, ob dieser Herausgeber existiert. Falls nicht, erstellt es ihn und weist ihm eine publisherId zu.

Beispielsweise kann das HR-IT-Entwicklungsteam einen Herausgeber erstellen und die Entwicklungsfachkräfte mithilfe einer Microsoft Entra ID-Gruppe identifizieren.

Hier ist ein Beispiel für einen Herausgeberdatensatz, der Vorgänge zum Hinzufügen einer Person und einer Entra ID-Gruppe enthält

{
   "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"
      }
   ]
}
Eigenschaften typ Erforderlich Beschreibung
publisherId string Ja Die eindeutige ID für diesen Herausgeber. Verwenden Sie diese ID, um diesen Herausgeber jedes Mal zu identifizieren, wenn Sie ein Katalogelement für ihn erstellen oder aktualisieren. Katalogelemente können jeweils nur einem Publisher zugeordnet werden. Bei dem Wert kann es sich um eine GUID oder eine Zeichenfolge handeln. Ist er einmal festgelegt, muss er gepflegt werden.
publisherDisplayName string Ja Verbrauchernde sehen diese Daten in der Kataloggalerie.
publisherUpnList CatalogUPNOperation[] Nein Personen, die als dieser Herausgeber neue Katalogelemente einreichen oder aktualisieren können. Der übermittelnde Benutzende ist immer enthalten, wenn der Herausgeber zum ersten Mal erstellt wird.
publisherAADGroupOIDS CatalogGroupOperation[] Nein Entra ID-Gruppen, deren Mitglieder auf diesen Herausgeber zugreifen dürfen.

CatalogUPNOperation

Verwenden Sie diese Daten, um die Herausgebereigenschaft publisherUpnList anzugeben.

Definiert einen Vorgang zum Hinzufügen oder Entfernen von Personen, die als dieser Herausgeber neue Katalogelemente übermitteln oder aktualisieren können.

Eigenschaften typ Erforderlich Beschreibung
action string Ja Die Aktion, die mit diesem UPN ausgeführt werden soll. Gültige Werte: Add oder Remove.
upn string Ja Benutzerprinzipalname (UPN) des Benutzenden.
userOid guid Ja Objektbezeichner des Benutzenden.

CatalogGroupOperation

Verwenden Sie diese Daten, um die Eigenschaft PubisherpublisherAADGroupOIDS anzugeben.

Legt einen Vorgang zum Hinzufügen oder Entfernen einer Entra ID-Gruppe fest, die auf diesen Herausgeber zugreifen kann.

Eigenschaften typ Erforderlich Beschreibung
action string Ja Die Aktion, die mit diesem UPN ausgeführt werden soll. Gültige Werte: Add oder Remove.
groupName string Ja Name der Gruppe.
groupOid guid Ja Objektbezeichner für die Gruppe.
groupType string Ja Typ der angesprochenen Gruppe. Gültige Werte sind Security und Modern.

CatalogItemDefinition

Verwenden Sie diese Daten, um die catalogItemDefinition-Eigenschaft des zu übermittelnden Katalogelements anzugeben.

Diese Eigenschaften definieren das übermittelte Katalogelement. Dies ist die eigentliche Power Platform-Lösung. Ein Paket ist das, was im Katalog gespeichert ist.

Hier ist ein Beispiel für ein Katalogelement einschließlich seiner Kontakte engineeringName und supportName, die obligatorisch sind.

"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"
   }
   }
}
Eigenschaften typ Erforderlich Beschreibung
id guid Ja Die eindeutige ID des Katalogelements. Verwenden Sie diese ID, wenn Sie das Katalogelement aktualisieren oder installieren.
displayName string Ja Name, der Verbrauchenden in den Kataloggalerien angezeigt wird.
description string Nein Beschreibung, die Verbrauchenden in den Kataloggalerien angezeigt wird.
offer Angebotsdetails Ja Die Details der Katalogelementübermittlung.
packageFile CatalogFileAsset Ja Beschreibt, wo man die Katalogpaketdatei für die Übermittlung findet.

Angebotsdetails

Verwenden Sie diese Daten, um die Eigenschaft CatalogItemDefinitionoffer anzugeben.

Diese Eigenschaften definieren die Details der Katalogelementübermittlung.

Eigenschaften typ Erforderlich Beschreibung
businessCategories int[] Nein Liste der Auswahloptionswerte, die vom Zielkatalog berücksichtigt werden. Gibt die Geschäftskategorien an, die diesem Katalogelement zugeordnet werden sollen. Unter Geschäftskategorien finden Sie die zu verwendenden gültigen Werte.
type string Ja Die Art des Katalogelements. Gültige Werte:
- Application
- Component_Collection
supportsApplicationTypes string[] Nein Liste der unterstützten Anwendungstypen. Gültige Werte:
- CanvasApps
- ModelApps
- PowerPortals
- PowerAutomate
deploymentType string Ja Gibt den Typ der Bereitstellung für dieses Katalogelement an. Gültige Werte:
- Normal stellt ein verwaltetes Element dar.
- Template Eine Kopie Ihrer nicht verwalteten Lösung, die andere Ersteller nach Belieben bearbeiten können.
Weitere Informationen zu Katalogelementtypen
searchKeywords string[] Nein Wörter, die Benutzer verwenden könnten, um dieses Katalogelement zu finden.
small48x48Image CatalogFileAsset Nein Bild für die Galerieansicht. Wenn Sie dieses Bild nicht bereitstellen, wird ein Systemstandardsymbol verwendet.
large216x216Image CatalogFileAsset Nein Bild für die Detailansicht. Stellen Sie ein Symbol bereit, das in der Erstellenden oder einer anderen Discovery-Benutzeroberfläche angezeigt werden soll. Bei manchen Benutzeroberflächen werden größere Symbole zum Rendern von Karten zur Entdeckung verwendet.
useCaseDocument CatalogFileAsset Nein Anwendungsfallbeschreibung und Erläuterungen für Genehmigende.
videos CatalogFileAsset[] Nein In der Detailansicht werden Links zu diesen Video-/GIF-Dateien angezeigt.
documents CatalogFileAsset[] Nein In der Detailansicht werden Links zu diesen Dateien angezeigt.
screenshots CatalogFileAsset[] Nein In der Detailansicht werden diese Bilder angezeigt. Sie können hier Screenshots Ihrer Anwendung weitergeben, damit Erstellende leichter erkennen können, ob die App die gewünschte Funktionalität oder Fähigkeiten bietet. Bevor Benutzende eine App oder Vorlage herunterladen, sehen sie sich in der Regel Bilder und Screenshots an, um sich ein Bild von den Funktionen zu machen, anstatt die Beschreibung zu lesen.
helpLink URI Nein Link zur Dokumentation. Diese URLs können Links zu internen Dokumenten oder Sharepoint-Ressourcen sein.
privacyPolicyLink URI Nein Link zum Datenschutzdokument. Richtlinien zur sorgfältigen Verwendung der übermittelten Komponente oder Anwendung.
legalTermsLink URI Nein Link zum Dokument mit den Geschäftsbedingungen. Etwaige rechtliche Hinweise oder interne Richtlinien zur Bewertung des Katalogartikels durch Benutzende.
legalTerms string Nein Markdown, HTML- oder Textversion des Dokuments der allgemeinen Geschäftsbedingungen. Etwaige rechtliche Hinweise oder interne Richtlinien zur Bewertung des Katalogartikels durch Benutzende.
sourceCodeRepositoryLink URI Nein Link zum Open-Source-Repository
engineeringName PersonContactInformation Ja Kontaktinformationen für technische Fachkraft oder Gruppe, die dieses Katalogelement entwickelt hat.
supportName PersonContactInformation Nein Kontaktinformationen für Support oder Gruppe, die dieses Katalogelement unterstützt. Kann derselbe technische Kontakt sein, den Benutzende eines Katalogelements kontaktieren können, wenn sie Probleme mit der Anwendung haben.

Geschäftskategorien

Legen Sie die OfferDetailsbusinessCategories-Eigenschaft auf eine oder mehrere dieser Geschäftskategorien fest:

Code Beschreibung
526430000 Customer Service
526430001 Projektmanagement
526430002 Kalenderverwaltung und -planung
526430003 E-Mail-Verwaltung
526430004 Dateien und Dokumentation
526430005 Benachrichtigungen und Erinnerungen
526430006 Analysen
526430007 Zusammenarbeit
526430008 Commerce
526430009 Finanzen
526430010 Konformität und Rechtliches
526430011 Vertrieb
526430012 IT-Tools
526430013 Marketing
526430014 Betriebsabläufe und Lieferkette
526430015 Das Internet der Dinge
526430016 KI/Maschinelles Lernen
526430017 Geolocation
526430018 Human Resources

Derzeit können keine neuen Geschäftskategorien konfiguriert werden, sie können aber über die globale Auswahl „Kataloggeschäftskategorie“ (mspcat_catalogbusinesscategory) abgerufen werden.

CatalogFileAsset

Diese Eigenschaften legen eine Datei fest, auf die in den CatalogItemDefinitionpackageFile- sowie den OfferDetailssmall48x48Image-, large216x216Image-, useCaseDocument-, videos-, documents- und screenshots-Eigenschaften verwiesen wird.

Eigenschaften typ Erforderlich Beschreibung
name string Ja Name der Datei.
filesaslink URI Ja Link, über den die Datei heruntergeladen werden kann. Wenn der Link eine Authentifizierung erfordert, geben Sie eine SAS-URL (Shared Access Signature) an.

PersonContactInformation

Diese Eigenschaften legen Personen in den Katalogelementeigenschaft OfferDetailsengineeringName und supportName fest.

Eigenschaften typ Erforderlich Beschreibung
firstName string Nein Vorname der Person.
lastName string Ja Nachname der Person.
email string Ja E-Mail-Adresse der Person.
phoneNumber string Nein Telefonnummer der Person.