Partager via

Référence du document de soumission d’élément de catalogue

  • Article

Vous devez inclure les données au format JSON lorsque vous envoyez un élément au catalogue. Cet article décrit les propriétés valides de ce document. Ce JSON est un exemple :

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

Ce tableau décrit les propriétés définies dans le document d’envoi :

Property Type Requise Description
modelVersion chaine Non Numéro de version du document d’envoi. La valeur par défaut est 1.0.0.0.
sourcePortal int Non Identifie la source de cette demande. Par défaut, il s’agit de 526430005 qui est le PAC CLI. Pour les autres sources, utilisez 526430000. La mspcat_GetPowerCatalogDetails fonction renvoie la liste complète. La mspcat_GetPowerCatalogDetailsResponse.CatalogDetails.sourceOptions propriété répertorie les options disponibles.
submissionId GUID Non GUID pour identifier la soumission. Cette valeur est une clé étrangère permettant de lier la requête à d’autres systèmes.
operation chaine Oui Pour développement à venir, actuellement non pris en compte. Type d’opération à utiliser. Valeurs correctes :
- CreateOrUpdate (par défaut)
- Create
- Update
- Disabled
businessJustification chaine Non Décrit la valeur métier de la soumission à l’approbateur. Cette valeur peut contenir HTML ou RTF (Rich Text Format). Ces informations apparaissent dans l’expérience de consommation planifiée dans l’expérience utilisateur détection créateur. Les utilisateurs peuvent dire que leur soumission contribue à la réduction des coûts ou à la productivité, par exemple. Certaines organisations exigent certaines classes de valeur et ces valeurs peuvent être saisies ici.
publisherDetails Publisher Oui Éditeur associé à l’envoi de cet élément.
catalogItemDefinition CatalogItemDefinition Oui Définit l’élément de catalogue en cours d’envoi.

Serveur de publication

Utilisez ces données pour spécifier la propriété publisherDetails de l’élément d’envoi de catalogue.

Crée un enregistrement d’éditeur qui peut être associé à un ou plusieurs groupes Microsoft Entra ID contenant des utilisateurs autorisés qui peuvent apporter des mises à jour à l’élément du catalogue ultérieurement.

Note

Ne confondez pas ce terme avec l’éditeur de solutions. L’éditeur d’éléments de catalogue n’est pas utilisé avec les solutions.

Vous devez fournir au moins le publisherDisplayName. publisherId peut être une valeur de chaîne. Le système vérifie si cet éditeur existe, sinon le crée et lui attribue un publisherId.

Par exemple, l’équipe de développeurs informatiques RH peut créer un éditeur et identifier les développeurs à l’aide d’un Microsoft Entra ID Groupe.

Voici un exemple d’enregistrement d’éditeur qui inclut des opérations d’ajout d’une personne et d’un groupe Entra ID

{
   "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"
      }
   ]
}
Property Type Requise Description
publisherId chaine Oui ID unique pour cet éditeur. Utilisez cet ID pour identifier cet éditeur chaque fois que vous créez ou mettez à jour un élément de catalogue pour cet éditeur. Les éléments du catalogue ne peuvent être associés qu’à un seul éditeur à la fois. La valeur peut être un GUID ou une chaîne. Une fois définie, elle doit être conservée.
publisherDisplayName chaine Oui Les consommateurs voient ces données dans la galerie du catalogue.
publisherUpnList CatalogUPNOperation[] Non Personnes autorisées à envoyer de nouveaux éléments de catalogue ou des éléments mis à jour en tant que cet éditeur. Inclut toujours l’utilisateur qui soumet la demande la première fois que l’éditeur est créé.
publisherAADGroupOIDS CatalogGroupOperation[] Non Groupes Entra ID dont les membres sont autorisés à accéder à cet éditeur.

CatalogUPNOperation

Utilisez ces données pour spécifier la propriété ÉditeurpublisherUpnList.

Définit une opération permettant d’ajouter ou de supprimer des personnes autorisées à envoyer de nouveaux éléments de catalogue ou des éléments mis à jour en tant que cet éditeur.

Property Type Requise Description
action chaine Oui L’action à effectuer avec cet UPN. Les valeurs valides sont : Add ou Remove.
upn chaine Oui Nom d’utilisateur principal (UPN) de l’utilisateur.
userOid GUID Oui Identificateur d’objet de l’utilisateur.

CatalogGroupOperation

Utilisez ces données pour spécifier la propriété ÉditeurpublisherAADGroupOIDS.

Définit une opération d’ajout ou de suppression d’un groupe Entra ID pouvant accéder à cet éditeur.

Property Type Requise Description
action chaine Oui L’action à effectuer avec cet UPN. Les valeurs valides sont : Add ou Remove.
groupName chaine Oui Nom du groupe.
groupOid GUID Oui Identificateur d’objet pour un groupe.
groupType chaine Oui Type de groupe ciblé. Les valeurs valides sont Security et Modern.

CatalogItemDefinition

Utilisez ces données pour spécifier la propriété catalogItemDefinition de l’élément d’envoi de catalogue.

Ces propriétés définissent l’élément de catalogue en cours d’envoi. Il s’agit de la solution Power Platform réelle. Un package est ce qui est stocké dans le catalogue.

Voici un exemple d’élément du catalogue incluant ses contacts engineeringName et supportName qui sont obligatoires.

"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"
   }
   }
}
Property Type Requise Description
id GUID Oui L’ID unique de l’élément du catalogue. Utilisez cet ID lors de la mise à jour ou de l’installation de l’élément de catalogue.
displayName chaine Oui Nom présenté aux consommateurs dans les galeries du catalogue.
description chaine Non Description présentée aux consommateurs dans les galeries du catalogue.
offer Détails de l’offre Oui Détails de l’envoi de l’élément du catalogue.
packageFile CatalogFileAsset Oui Décrit où obtenir le fichier de package de catalogue pour l’envoi.

Détails de l’offre

Utilisez ces données pour spécifier la propriété CatalogItemDefinitionoffer.

Ces propriétés définissent les détails de l’envoi de l’élément de catalogue.

Property Type Requise Description
businessCategories int[] Non Liste des valeurs d’options de choix acceptées par le catalogue cible. Identifie les catégories d’entreprises à associer à cet élément de catalogue. Consultez la section Catégories métier pour connaître les valeurs valides à utiliser.
type chaine Oui Type d’élément du catalogue. Valeurs correctes :
- Application
- Component_Collection
supportsApplicationTypes string[] Non Liste des types d’applications pris en charge. Valeurs correctes :
- CanvasApps
- ModelApps
- PowerPortals
- PowerAutomate
deploymentType chaine Oui Indique le type de déploiement pour déployer cet élément de catalogue. Valeurs correctes :
- Normal représente un élément géré.
- Template Une copie de votre solution non gérée que les autres créateurs peuvent modifier comme bon leur semble.
En savoir plus sur les types d’éléments de catalogue
searchKeywords string[] Non Mots que les gens peuvent utiliser pour trouver cet élément du catalogue.
small48x48Image CatalogFileAsset Non Image pour la vue de la galerie. Si vous ne fournissez pas cette image, une icône par défaut du système est utilisée.
large216x216Image CatalogFileAsset Non Image pour la vue détaillée. Fournissez une icône à afficher dans l’interface utilisateur du créateur ou dans une autre interface de découverte. Certaines expériences utilisateur utilisent des icônes plus grandes pour afficher les cartes pour la découverte.
useCaseDocument CatalogFileAsset Non Description et explication des cas d’utilisation pour les approbateurs.
videos CatalogFileAsset[] Non La vue détaillée affiche les liens vers ces fichiers vidéo/gif.
documents CatalogFileAsset[] Non La vue détaillée affiche les liens vers ces fichiers.
screenshots CatalogFileAsset[] Non La vue détaillée affiche ces images. Vous pouvez transmettre ici des captures d’écran de votre application pour aider les créateurs à identifier si cette application fournit la fonctionnalité ou la capacité qu’ils recherchent. La chose la plus courante que font les gens avant de télécharger une application ou un modèle est de regarder ses images et ses captures d’écran pour comprendre les fonctionnalités au lieu de lire la description.
helpLink uri Non Lien vers la documentation. Ces URL peuvent être des liens vers des documents internes ou des ressources SharePoint.
privacyPolicyLink uri Non Lien vers le document confidentiel. Politiques concernant l’utilisation prudente du composant ou de l’application soumis.
legalTermsLink uri Non Lien vers le document Conditions générales. Tous termes juridiques ou directives internes pour l’évaluation du consommateur de l’article du catalogue.
legalTerms chaine Non Markdown, HTML ou version texte du document des Conditions générales. Tous termes juridiques ou directives internes pour l’évaluation du consommateur de l’article du catalogue.
sourceCodeRepositoryLink uri Non Lien vers le référentiel de code source
engineeringName PersonContactInformation Oui Coordonnées de l’ingénieur ou du groupe qui a développé cet élément de catalogue.
supportName PersonContactInformation Non Coordonnées du support ou du groupe qui prend en charge cet élément du catalogue. Peut être identique au contact technique que le consommateur d’un élément de catalogue peut contacter s’il rencontre des problèmes avec l’application.

Catégories métier

Définissez la propriété OfferDetailsbusinessCategories sur au moins une des catégories métier suivantes :

Code Description
526430000 Customer Service
526430001 Gestion du projet
526430002 Planification et gestion du calendrier
526430003 Gestion du courrier électronique
526430004 Fichiers et documentation
526430005 Notification et rappels
526430006 Analyses
526430007 Collaboration
526430008 Commerce
526430009 Finance
526430010 Conformité et informations légales
526430011 Vente
526430012 Outils informatiques
526430013 Marketing
526430014 Opérations et chaîne d’approvisionnement
526430015 Internet des objets
526430016 Machine Learning d’IA
526430017 Géolocalisation
526430018 Ressources humaines

Actuellement, il n’est pas possible de configurer de nouvelles catégories métier, mais elles peuvent être extraites du choix global Catégorie métier du catalogue (mspcat_catalogbusinesscategory).

CatalogFileAsset

Ces propriétés définissent un fichier référencé dans les propriétés CatalogItemDefinitionpackageFile et OfferDetailssmall48x48Image, large216x216Image, useCaseDocument, videos, documents, et screenshots .

Property Type Requise Description
name chaine Oui Nom de fichier.
filesaslink uri Oui Lien vers le téléchargement du fichier. Si le lien nécessite une authentification, fournissez une URL de signature d’accès partagé (SAS).

PersonContactInformation

Ces propriétés définissent des personnes dans les propriétés OfferDetailsengineeringName et supportName de l’élément du catalogue.

Property Type Requise Description
firstName chaine Non Prénom de la personne.
lastName chaine Oui Nom de famille de la personne.
email chaine Oui Adresse e-mail de la personne.
phoneNumber chaine Non Numéro de téléphone de la personne.