Condividi tramite

Informazioni di riferimento sul documento per l'invio di elementi del catalogo

È necessario includere i dati in formato JSON quando si invia un elemento al catalogo. Questo articolo descrive le proprietà valide per il documento. Questo codice JSON è un esempio:

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

Questa tabella descrive le proprietà per il documento di invio:

Proprietà TIPO Obbligatorio Description
modelVersion corda NO Numero di versione del documento di invio. Il valore predefinito è 1.0.0.0.
sourcePortal int NO Identifica l'origine della richiesta. 526430005 Il valore predefinito è l'interfaccia della riga di comando pac. Per altre origini, usare 526430000. La mspcat_GetPowerCatalogDetails funzione restituisce l'elenco completo. La mspcat_GetPowerCatalogDetailsResponse.CatalogDetails.sourceOptions proprietà elenca le opzioni disponibili.
submissionId guida NO GUID per identificare l'invio. Questo valore è una chiave esterna per consentire il collegamento della richiesta ad altri sistemi.
operation corda Yes Per l'espansione futura e non è attualmente rispettata. Tipo di operazione da utilizzare. Valori validi:
- CreateOrUpdate (Impostazione predefinita)
- Create
- Update
- Disabled
businessJustification corda NO Descrive il valore aziendale dell'invio al responsabile approvazione. Questo valore può contenere HTML o RTF (Rich Text Format). Queste informazioni vengono visualizzate nell'esperienza di utilizzo pianificata nell'esperienza utente di individuazione degli autori. Gli utenti potrebbero dire che l'invio aiuta a ridurre i costi o la produttività, ad esempio. Alcune organizzazioni richiedono alcune classi di valore e questi valori possono essere immessi qui.
publisherDetails Publisher Yes Autore associato all'invio di questo elemento.
catalogItemDefinition CatalogItemDefinition Yes Definisce l'elemento del catalogo inviato.

Editore

Usare questi dati per specificare la proprietà dell'elemento publisherDetails di invio del catalogo.

Crea un record dell'editore che può essere associato a uno o più gruppi di ID Entra di Microsoft contenenti utenti autorizzati che possono apportare aggiornamenti all'elemento del catalogo in futuro.

Annotazioni

Non confondere questo termine con Solution Publisher. L'editore di elementi del catalogo non viene usato con le soluzioni.

È necessario specificare almeno .publisherDisplayName publisherId può essere qualsiasi valore stringa. Il sistema controlla se tale autore esiste, altrimenti lo crea e assegna un oggetto publisherId.

Ad esempio, il team IT delle risorse umane degli sviluppatori può creare un editore e id gli sviluppatori usando un gruppo di ID Microsoft Entra.

Di seguito è riportato un esempio di record dell'editore che include operazioni per aggiungere una persona e un gruppo 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"
      }
   ]
}
Proprietà TIPO Obbligatorio Description
publisherId corda Yes ID univoco per questo server di pubblicazione. Usare questo ID per identificare questo editore ogni volta che si sta creando o aggiornando un elemento del catalogo per questo editore. Gli elementi del catalogo possono essere associati a un solo server di pubblicazione alla volta. Il valore può essere un GUID o una stringa. Una volta impostata, deve essere mantenuta.
publisherDisplayName corda Yes I consumer visualizzano questi dati nella raccolta di cataloghi.
publisherUpnList CatalogUPNOperation[] NO Utenti che possono inviare elementi del catalogo nuovi o aggiornati come editore. Include sempre l'utente che invia la prima volta che viene creato il server di pubblicazione.
publisherAADGroupOIDS CatalogGroupOperation[] NO Entra ID Gruppi i cui membri sono autorizzati ad accedere a questo editore.

CatalogUPNOperation

Utilizzare questi dati per specificare la proprietà PublisherpublisherUpnList .

Definisce un'operazione per aggiungere o rimuovere persone che possono inviare elementi del catalogo nuovi o aggiornati come editore.

Proprietà TIPO Obbligatorio Description
action corda Yes Azione da eseguire con questo UPN. Valori validi: Add o Remove.
upn corda Yes Nome dell'entità utente (UPN) dell'utente.
userOid guida Yes Identificatore dell'oggetto per l'utente.

CatalogGroupOperation

Utilizzare questi dati per specificare la proprietà PublisherpublisherAADGroupOIDS .

Definisce un'operazione per aggiungere o rimuovere un gruppo di ID Entra che può accedere a questo editore.

Proprietà TIPO Obbligatorio Description
action corda Yes Azione da eseguire con questo UPN. Valori validi: Add o Remove.
groupName corda Yes Nome del gruppo.
groupOid guida Yes Identificatore dell'oggetto per il gruppo.
groupType corda Yes Tipo di gruppo da risolvere. I valori validi sono Security e Modern.

CatalogItemDefinition

Usare questi dati per specificare la proprietà dell'elemento catalogItemDefinition di invio del catalogo.

Queste proprietà definiscono l'elemento del catalogo inviato. Questa è la soluzione Power Platform effettiva. Un pacchetto è ciò che viene archiviato nel catalogo.

Di seguito è riportato un esempio di elemento del catalogo, inclusi i relativi engineeringName contatti e supportName obbligatori.

"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"
   }
   }
}
Proprietà TIPO Obbligatorio Description
id guida Yes ID univoco dell'elemento del catalogo. Usare questo ID durante l'aggiornamento o l'installazione dell'elemento del catalogo.
displayName corda Yes Nome visualizzato per i consumer nelle raccolte di cataloghi.
description corda NO Descrizione mostrata ai consumer nelle raccolte di cataloghi.
offer OfferDetails Yes Dettagli dell'invio dell'elemento del catalogo.
packageFile CatalogFileAsset Yes Descrive dove ottenere il file del pacchetto di catalogo per l'invio.

OffertaDettagli

Utilizzare questi dati per specificare la proprietà CatalogItemDefinitionoffer .

Queste proprietà definiscono i dettagli dell'invio di elementi del catalogo.

Proprietà TIPO Obbligatorio Description
businessCategories int[] NO Elenco dei valori delle opzioni di scelta rispettati dal catalogo di destinazione. Identifica le categorie aziendali da associare a questo elemento del catalogo. Per i valori validi da usare, vedere Categorie business .
type corda Yes Tipo di elemento del catalogo. Valori validi:
- Application
- Component_Collection
supportsApplicationTypes string[] NO Elenco dei tipi di applicazione supportati. Valori validi:
- CanvasApps
- ModelApps
- PowerPortals
- PowerAutomate
deploymentType corda Yes Indica il tipo di distribuzione per distribuire l'elemento del catalogo. Valori validi:
- Normal rappresenta un elemento gestito.
- Template Una copia della soluzione non gestita che altri produttori possono modificare, tuttavia scelgono.
Altre informazioni sui tipi di elementi del catalogo
searchKeywords string[] NO Parole che gli utenti potrebbero usare per trovare l'elemento del catalogo.
small48x48Image CatalogFileAsset NO Immagine per la visualizzazione della raccolta. Se non si specifica questa immagine, viene usata un'icona predefinita del sistema.
large216x216Image CatalogFileAsset NO Immagine per la visualizzazione dei dettagli. Specificare un'icona da visualizzare nel creatore o in un'altra interfaccia utente di individuazione. Alcune esperienze utente usano icone più grandi per eseguire il rendering delle schede per l'individuazione.
useCaseDocument CatalogFileAsset NO Descrizione del caso d'uso e spiegazione per i responsabili approvazione.
videos CatalogFileAsset[] NO Visualizzazione dettagli visualizza i collegamenti a questi file video/gif.
documents CatalogFileAsset[] NO La visualizzazione Dettagli visualizza i collegamenti a questi file.
screenshots CatalogFileAsset[] NO La visualizzazione dettagli visualizza queste immagini. È possibile passare screenshot qui dell'applicazione per aiutare gli autori a identificare se questa app fornisce la funzionalità o la funzionalità che stanno cercando. La cosa più comune che le persone fanno prima di scaricare un'app o un modello è esaminare le immagini e gli screenshot per comprendere le funzionalità invece di leggere la descrizione.
helpLink URI NO Collegamento alla documentazione. Questi URL possono essere collegamenti a documenti interni o risorse di SharePoint.
privacyPolicyLink URI NO Collegamento al documento sulla privacy. Criteri relativi all'utilizzo accurato del componente o dell'applicazione inviata.
legalTermsLink URI NO Collegamento al documento Termini e condizioni. Eventuali termini legali o linee guida interne per la valutazione dell'utente dell'elemento del catalogo.
legalTerms corda NO Markdown, HTML o versione di testo del documento Termini e condizioni. Eventuali termini legali o linee guida interne per la valutazione dell'utente dell'elemento del catalogo.
sourceCodeRepositoryLink URI NO Collegamento al repository del codice sorgente
engineeringName PersonContactInformation Yes Informazioni di contatto per tecnici o gruppi che hanno sviluppato l'elemento del catalogo.
supportName PersonContactInformation NO Informazioni di contatto per il supporto o il gruppo che supporta questo elemento del catalogo. Può essere uguale al contatto tecnico che il consumer di un elemento del catalogo può contattare se si verificano problemi con l'applicazione.

Categorie aziendali

Impostare la proprietà OfferDetailsbusinessCategories su una o più di queste categorie di business:

Codice Description
526430000 Servizio clienti
526430001 Gestione progetti
526430002 Gestione e pianificazione del calendario
526430003 Gestione della posta elettronica
526430004 File e documentazione
526430005 Notifiche e promemoria
526430006 Analytics
526430007 Collaborazione
526430008 Commercio
526430009 Dati finanziari
526430010 Conformità e legale
526430011 Vendite
526430012 Strumenti IT
526430013 Commercializzazione
526430014 Operazioni e supply chain
526430015 Internet delle cose
526430016 Machine Learning per intelligenza artificiale
526430017 Geolocalizzazione
526430018 Risorse umane

Attualmente non è possibile configurare nuove categorie di business, ma possono essere recuperate dalla scelta globale Catalog Business Category (mspcat_catalogbusinesscategory).

CatalogFileAsset

Queste proprietà definiscono un file a cui si fa riferimento nelle proprietà CatalogItemDefinitionpackageFile e OfferDetailssmall48x48Image, large216x216Image, useCaseDocumentvideosdocuments, , e .screenshots

Proprietà TIPO Obbligatorio Description
name corda Yes Nome del file.
filesaslink URI Yes Collegamento per scaricare il file. Se il collegamento richiede l'autenticazione, specificare un URL di firma di accesso condiviso.If the link requires authentication, provide a shared access signature (SAS) URL.

PersonContactInformation

Queste proprietà definiscono le persone nell'elemento del catalogo OfferDetailsengineeringName e supportName proprietà.

Proprietà TIPO Obbligatorio Description
firstName corda NO Nome della persona.
lastName corda Yes Nome della famiglia di persone.
email corda Yes Indirizzo di posta elettronica della persona.
phoneNumber corda NO Numero di telefono della persona.
  • Last updated on