Dela via

Referens för dokumentöverföring av katalogobjekt

Du måste inkludera data i JSON-format när du skickar ett objekt till katalogen. I den här artikeln beskrivs de giltiga egenskaperna för dokumentet. Den här JSON-filen är ett exempel:

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

I den här tabellen beskrivs egenskaperna för det skickade dokumentet:

Fastighet Typ Krävs Description
modelVersion snöre Nej Versionsnummer för det inskickade dokumentet. Standardvärdet är 1.0.0.0.
sourcePortal int Nej Identifierar källan för den här begäran. Standardvärden 526430005 som är PAC CLI. För andra källor använder du 526430000. Funktionen mspcat_GetPowerCatalogDetails returnerar den fullständiga listan. Egenskapen mspcat_GetPowerCatalogDetailsResponse.CatalogDetails.sourceOptions visar de tillgängliga alternativen.
submissionId guid Nej Guid för att identifiera sändningen. Det här värdet är en sekundärnyckel som gör det möjligt att länka begäran till andra system.
operation snöre Yes För framtida expansion och är för närvarande inte respekterad. Vilken typ av åtgärd som ska användas. Giltiga värden:
- CreateOrUpdate (Standard)
- Create
- Update
- Disabled
businessJustification snöre Nej Beskriver affärsvärdet för överföringen till godkännaren. Det här värdet kan innehålla HTML- eller RTF-format (RTF). Den här informationen visas i den planerade förbrukningsupplevelsen i användarupplevelsen för maker discovery. Användarna kan till exempel säga att deras inlämning hjälper till med kostnadsminskning eller produktivitet. Vissa organisationer kräver vissa värdeklasser och dessa värden kan anges här.
publisherDetails Publisher Yes Utgivaren som är associerad med den här objektöverföringen.
catalogItemDefinition CatalogItemDefinition Yes Definierar katalogobjektet som skickas.

Utgivare

Använd dessa data för att ange egenskapen för katalogöverföringsobjektet publisherDetails .

Skapar en utgivarpost som kan associeras till en eller flera Microsoft Entra-ID-grupper som innehåller behöriga användare som kan göra uppdateringar av katalogobjektet framöver.

Anmärkning

Blanda inte ihop den här termen med Solution Publisher. Katalogobjektutgivare används inte med lösningar.

Du måste ange publisherDisplayName minst. publisherId kan vara valfritt strängvärde. Systemet kontrollerar om utgivaren finns, annars skapas den och tilldelas en publisherId.

Hr IT-teamet med utvecklare kan till exempel skapa en utgivare och ID för utvecklarna med hjälp av en Microsoft Entra-ID-grupp.

Här är ett exempel på en utgivarpost som innehåller åtgärder för att lägga till en person och en Entra-ID-grupp

{
   "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"
      }
   ]
}
Fastighet Typ Krävs Description
publisherId snöre Yes Det unika ID:t för den här utgivaren. Använd det här ID:t för att identifiera utgivaren när du skapar eller uppdaterar ett katalogobjekt för den här utgivaren. Katalogobjekt kan bara associeras till en utgivare i taget. Värdet kan vara ett GUID eller en sträng. När den har angetts måste den underhållas.
publisherDisplayName snöre Yes Konsumenter ser dessa data i kataloggalleriet.
publisherUpnList CatalogUPNOperation[] Nej Personer som kan skicka nya eller uppdatera katalogobjekt som den här utgivaren. Inkluderar alltid den skickande användaren första gången utgivaren skapas.
publisherAADGroupOIDS CatalogGroupOperation[] Nej Entra-ID-grupper vars medlemmar har åtkomst till den här utgivaren.

CatalogUPNOperation

Använd dessa data för att ange egenskapen PublisherpublisherUpnList .

Definierar en åtgärd för att lägga till eller ta bort personer som kan skicka nya eller uppdatera katalogobjekt som den här utgivaren.

Fastighet Typ Krävs Description
action snöre Yes Åtgärden som ska vidtas med detta UPN. Giltiga värden: Add eller Remove.
upn snöre Yes Användarens huvudnamn (UPN).
userOid guid Yes Objektidentifierare för användaren.

CatalogGroupOperation

Använd dessa data för att ange egenskapen PublisherpublisherAADGroupOIDS .

Definierar en åtgärd för att lägga till eller ta bort en Entra-ID-grupp som kan komma åt utgivaren.

Fastighet Typ Krävs Description
action snöre Yes Åtgärden som ska vidtas med detta UPN. Giltiga värden: Add eller Remove.
groupName snöre Yes Gruppens namn.
groupOid guid Yes Objektidentifierare för grupp.
groupType snöre Yes Typ av grupp som behandlas. Giltiga värden är Security och Modern.

CatalogItemDefinition

Använd dessa data för att ange egenskapen för katalogöverföringsobjektet catalogItemDefinition .

Dessa egenskaper definierar katalogobjektet som skickas. Det här är den faktiska Power Platform-lösningen. Ett paket är det som lagras i katalogen.

Här är ett exempel på ett katalogobjekt, inklusive dess engineeringName och supportName kontakter som är obligatoriska.

"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"
   }
   }
}
Fastighet Typ Krävs Description
id guid Yes Katalogobjektets unika ID. Använd det här ID:t när du uppdaterar eller installerar katalogobjektet.
displayName snöre Yes Namn som visas för konsumenter i kataloggallerierna.
description snöre Nej Beskrivning som visas för konsumenter i kataloggallerierna.
offer OfferDetails Yes Information om insändningen av katalogobjektet.
packageFile CatalogFileAsset Yes Beskriver var du hämtar katalogpaketfilen för sändningen.

ErbjudandeDetaljer

Använd dessa data för att ange egenskapen CatalogItemDefinitionoffer .

Dessa egenskaper definierar information om sändningen av katalogobjektet.

Fastighet Typ Krävs Description
businessCategories int[] Nej Lista över alternativvärden som respekteras av målkatalogen. Identifierar de affärskategorier som ska associeras med det här katalogobjektet. Se Affärskategorier för de giltiga värden som ska användas.
type snöre Yes Typ av katalogobjekt. Giltiga värden:
- Application
- Component_Collection
supportsApplicationTypes string[] Nej Lista över de programtyper som stöds. Giltiga värden:
- CanvasApps
- ModelApps
- PowerPortals
- PowerAutomate
deploymentType snöre Yes Anger vilken typ av distribution som ska distribuera det här katalogobjektet. Giltiga värden:
- Normal representerar ett hanterat objekt.
- Template En kopia av din ohanterade lösning som andra tillverkare kan redigera, hur de än väljer.
Läs mer om katalogobjekttyper
searchKeywords string[] Nej Ord som personer kan använda för att hitta det här katalogobjektet.
small48x48Image CatalogFileAsset Nej Bild för gallerivy. Om du inte anger den här avbildningen används en systemstandardikon.
large216x216Image CatalogFileAsset Nej Bild för detaljvyn. Ange en ikon som ska visas i tillverkaren eller annat identifieringsgränssnitt. Vissa användarupplevelser använder större ikoner för att återge kort för identifiering.
useCaseDocument CatalogFileAsset Nej Använd ärendebeskrivning och förklaring för godkännare.
videos CatalogFileAsset[] Nej I detaljvyn visas länkar till dessa video-/gif-filer.
documents CatalogFileAsset[] Nej I detaljvyn visas länkar till dessa filer.
screenshots CatalogFileAsset[] Nej I detaljvyn visas dessa bilder. Du kan skicka skärmbilder här av ditt program för att hjälpa skaparna att identifiera om den här appen tillhandahåller de funktioner eller funktioner som de letar efter. Det vanligaste folk gör innan de laddar ned en app eller mall är att titta på dess bilder och skärmbilder för att förstå funktionerna i stället för att läsa beskrivningen.
helpLink URI Nej Länk till dokumentation. Dessa URL:er kan vara länkar till interna dokument eller sharepoint-resurser.
privacyPolicyLink URI Nej Länk till sekretessdokument. Principer för noggrann användning av komponenten eller programmet som skickas.
legalTermsLink URI Nej Länka till dokumentet Allmänna villkor. Juridiska villkor eller interna riktlinjer för utvärdering av katalogobjektets konsument.
legalTerms snöre Nej Markdown, HTML eller textversion av dokumentet Allmänna villkor. Juridiska villkor eller interna riktlinjer för utvärdering av katalogobjektets konsument.
sourceCodeRepositoryLink URI Nej Länka till källkodslagringsplatsen
engineeringName PersonContactInformation Yes Kontaktuppgifter för tekniker eller grupp som har utvecklat det här katalogobjektet.
supportName PersonContactInformation Nej Kontaktuppgifter för support eller grupp som stöder det här katalogobjektet. Kan vara samma som den tekniska kontakt som konsumenten av ett katalogobjekt kan kontakta om de stöter på problem med programmet.

Företagskategorier

Ange egenskapen OfferDetailsbusinessCategories till en eller flera av dessa affärskategorier:

Kod Description
526430000 Kundtjänst
526430001 Projektledning
526430002 Kalenderhantering och schemaläggning
526430003 E-posthantering
526430004 Filer och dokumentation
526430005 Meddelanden och påminnelser
526430006 Analytics
526430007 Samarbete
526430008 Commerce
526430009 Ekonomi
526430010 Efterlevnad och juridik
526430011 Försäljning
526430012 IT-verktyg
526430013 Marknadsföring
526430014 Åtgärder och leveranskedja
526430015 Sakernas Internet
526430016 AI Machine Learning
526430017 Geolokalisering
526430018 Personal

För närvarande kan nya affärskategorier inte konfigureras, men de kan hämtas från det globala valet Katalogföretagskategori (mspcat_catalogbusinesscategory).

CatalogFileAsset

Dessa egenskaper definierar en fil som refereras till i egenskaperna CatalogItemDefinitionpackageFile och OfferDetailssmall48x48Image, large216x216Image, useCaseDocument, videosdocumentsoch screenshots .

Fastighet Typ Krävs Description
name snöre Yes Namnet på filen.
filesaslink URI Yes Länka för att ladda ned filen. Om länken kräver autentisering anger du en URL för signatur för delad åtkomst (SAS).

PersonContactInformation

Dessa egenskaper definierar personer i katalogobjektet OfferDetailsengineeringName och supportName egenskaper.

Fastighet Typ Krävs Description
firstName snöre Nej Personens förnamn.
lastName snöre Yes Personfamiljenamn.
email snöre Yes Personens e-postadress.
phoneNumber snöre Nej Persontelefonnummer.
  • Last updated on