Referenz zum Katalogelement-Übermittlungsdokument

Sie müssen Daten im JSON-Format einschließen, wenn Sie einen Artikel an den Katalog übermitteln. Dieser Artikel beschreibt die gültigen Eigenschaften für dieses Dokument. 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:

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.

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 Publisher-Datensatz, der Operationen 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"
      }
   ]
}

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.

KatalogGruppenoperation

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.

Katalogartikeldefinition

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

Angebotsdetails

Verwenden Sie diese Daten, um die Eigenschaft CatalogItemDefinitionoffer anzugeben.

Diese Eigenschaften definieren die Details der Katalogelementübermittlung.

Geschäftskategorien

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

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

KatalogdateiAsset

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

PersonContactInformation

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