Partajați prin

Referință document remitere elemente catalog

Trebuie să includeți date în format JSON atunci când trimiteți un element în catalog. Acest articol descrie proprietățile valide pentru acel document. Acest JSON este un exemplu:

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

Acest tabel descrie proprietățile documentului de remitere:

Proprietate Tip Obligatoriu Descriere
modelVersion string Nu Numărul de versiune al documentului de remitere. Valoarea implicită este 1.0.0.0.
sourcePortal int Nu Identifică sursa acestei solicitări. Implicit, 526430005 care este PAC CLI. Pentru alte surse, utilizați 526430000. Funcția mspcat_GetPowerCatalogDetails returnează lista completă. Proprietatea mspcat_GetPowerCatalogDetailsResponse.CatalogDetails.sourceOptions listează opțiunile disponibile.
submissionId guid Nu GUID pentru a identifica remiterea. Această valoare este o cheie străină pentru a permite legarea solicitării la alte sisteme.
operation string Da Pentru extinderea viitoare și nu este respectată în prezent. Tipul de operațiune care va fi utilizată. Valori valide:
- CreateOrUpdate (Implicit)
- Create
- Update
- Disabled
businessJustification string Nu Descrie valoarea de afaceri a remiterii către aprobator. Această valoare poate conține FORMAT HTML sau Text îmbogățit (RTF). Aceste informații apar în experiența de consum planificată în experiența utilizatorului de descoperire a creatorului. Utilizatorii pot spune că remiterea lor ajută la reducerea costurilor sau productivitate, de exemplu. Unele organizații necesită anumite clase de valori, iar aceste valori pot fi introduse aici.
publisherDetails Editor Da Editorul asociat cu remiterea acestui element.
catalogItemDefinition CatalogItemDefinition Da Definește elementul de catalog remis.

Editor

Utilizați aceste date pentru a specifica proprietatea elementului publisherDetails de remitere catalog.

Creează o înregistrare editor care poate fi asociată cu unul sau mai multe grupuri Microsoft Entra ID care conțin utilizatori autorizați care pot face actualizări la elementul de catalog în viitor.

Notă

Nu confundați acest termen cu Editorul soluției. Editorul elementului de catalog nu este utilizat cu soluții.

Trebuie să furnizați publisherDisplayName cel puțin. publisherId poate fi orice valoare șir. Sistemul verifică dacă editorul există, altfel îl creează și atribuie un publisherId.

De exemplu, echipa IT de resurse umane poate crea un editor și un ID pentru dezvoltatori utilizând un grup Microsoft Entra ID.

Iată un eșantion de înregistrare editor care include operațiuni pentru a adăuga o persoană și un grup 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"
      }
   ]
}
Proprietate Tip Obligatoriu Descriere
publisherId string Da ID-ul unic pentru acest editor. Utilizați acest ID pentru a identifica editorul oricând creați sau actualizați un element de catalog pentru acest editor. Elementele de catalog pot fi asociate numai unui singur editor o dată. Valoarea poate fi un GUID sau un șir. Odată stabilit, acesta trebuie menținut.
publisherDisplayName string Da Consumatorii văd aceste date în galeria de catalog.
publisherUpnList CatalogUPNOperation[] Nu Persoane care pot remite elemente de catalog noi sau actualizați ca editor. Include întotdeauna utilizatorul care remite prima dată când se creează Publisher.
publisherAADGroupOIDS CatalogGroupOperation[] Nu Entra ID Groups ale căror membri au permisiunea de a accesa acest editor.

CatalogUPNOperation

Utilizați aceste date pentru a specifica proprietatea PublisherpublisherUpnList .

Definește o operațiune pentru a adăuga sau a elimina persoane care pot remite elemente de catalog noi sau actualizați ca editor.

Proprietate Tip Obligatoriu Descriere
action string Da Acțiunea de efectuat cu acest UPN. Valori valide: Add sau Remove.
upn string Da Nume principal utilizator (UPN) al utilizatorului.
userOid guid Da Identificator obiect pentru utilizator.

CatalogGroupOperation

Utilizați aceste date pentru a specifica proprietatea PublisherpublisherAADGroupOIDS .

Definește o operațiune pentru adăugarea sau eliminarea unui grup Entra ID care poate accesa acest editor.

Proprietate Tip Obligatoriu Descriere
action string Da Acțiunea de efectuat cu acest UPN. Valori valide: Add sau Remove.
groupName string Da Numele grupului.
groupOid guid Da Identificator de obiect pentru grup.
groupType string Da Tipul de grup adresat. Valorile valide sunt Security și Modern.

CatalogItemDefinition

Utilizați aceste date pentru a specifica proprietatea elementului catalogItemDefinition de remitere catalog.

Aceste proprietăți definesc elementul de catalog remis. Aceasta este soluția reală pentru Power Platform. Un pachet este ceea ce este stocat în catalog.

Iată un exemplu de element de catalog, inclusiv persoanele sale engineeringName de contact și persoanele supportName de contact obligatorii.

"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"
   }
   }
}
Proprietate Tip Obligatoriu Descriere
id guid Da ID-ul unic al elementului de catalog. Utilizați acest ID atunci când actualizați sau instalați elementul de catalog.
displayName string Da Numele afișat consumatorilor în galeriile catalog.
description string Nu Descriere afișată consumatorilor în galeriile catalog.
offer OfferDetails Da Detaliile remiterii elementelor de catalog.
packageFile CatalogFileAsset Da Descrie unde se obține fișierul pachet catalog pentru remitere.

OfferDetails

Utilizați aceste date pentru a specifica proprietatea CatalogItemDefinitionoffer .

Aceste proprietăți definesc detaliile remiterii elementelor de catalog.

Proprietate Tip Obligatoriu Descriere
businessCategories int[] Nu Lista valorilor opțiunilor de alegere respectate de catalogul țintă. Identifică categoriile de firmă de asociat cu acest element de catalog. Consultați Categorii de firmă pentru valorile valide de utilizat.
type string Da Tipul de element de catalog. Valori valide:
- Application
- Component_Collection
supportsApplicationTypes șir[] Nu Lista tipurilor de aplicații acceptate. Valori valide:
- CanvasApps
- ModelApps
- PowerPortals
- PowerAutomate
deploymentType string Da Indică tipul de implementare pentru a implementa acest element de catalog. Valori valide:
- Normal reprezintă un element gestionat.
- Template O copie a soluției negestionate pe care alți utilizatori o pot edita, totuși, pe care o pot edita.
Aflați mai multe despre tipurile de elemente de catalog
searchKeywords șir[] Nu Cuvinte pe care utilizatorii le pot utiliza pentru a găsi acest element de catalog.
small48x48Image CatalogFileAsset Nu Imagine pentru vizualizarea galerie. Dacă nu furnizați această imagine, se utilizează o pictogramă implicită de sistem.
large216x216Image CatalogFileAsset Nu Imagine pentru vizualizarea detaliată. Furnizați o pictogramă care să fie afișată în creator sau în altă interfață de utilizator de descoperire. Unele experiențe de utilizator utilizează pictograme mai mari pentru a reda fișe pentru descoperire.
useCaseDocument CatalogFileAsset Nu Utilizați descrierea cazului și explicația pentru aprobatori.
videos CatalogFileAsset[] Nu Vizualizarea detaliată afișează linkuri către aceste fișiere video/gif.
documents CatalogFileAsset[] Nu Vizualizarea detaliu afișează linkuri la aceste fișiere.
screenshots CatalogFileAsset[] Nu Vizualizarea detaliu afișează aceste imagini. Puteți transmite aici capturi de ecran ale aplicației, pentru a-i ajuta pe utilizatori să identifice dacă această aplicație oferă funcționalitatea sau capacitatea pe care o caută. Cel mai obișnuit lucru pe care îl fac utilizatorii înainte de a descărca o aplicație sau un șablon este să priviți imaginile și capturile de ecran pentru a înțelege capacitățile în loc să citiți descrierea.
helpLink uri Nu Link la documentație. Aceste URL-uri pot fi linkuri către documente interne sau resurse SharePoint.
privacyPolicyLink uri Nu Link la documentul de confidențialitate. Politici privind utilizarea atentă a componentei sau a aplicației remise.
legalTermsLink uri Nu Link la documentul Termeni și condiții. Orice termeni legali sau instrucțiuni interne pentru evaluarea consumatorului articolului de catalog.
legalTerms string Nu Markdown, HTML sau versiunea de text a documentului Termeni și condiții. Orice termeni legali sau instrucțiuni interne pentru evaluarea consumatorului articolului de catalog.
sourceCodeRepositoryLink uri Nu Link la depozitul de cod sursă
engineeringName PersonContactInformation Da Informații de contact pentru inginer sau grup care a dezvoltat acest element de catalog.
supportName PersonContactInformation Nu Informații de contact pentru asistență sau grup care acceptă acest element de catalog. Poate fi la fel ca persoana de contact de inginerie la care poate lua legătura consumatorul unui element de catalog dacă se confrunta cu probleme cu aplicația.

Categorii de afaceri

Setați proprietatea OfferDetailsbusinessCategories la una sau mai multe dintre aceste categorii de afaceri:

Cod Descriere
526430000 Serviciu clienți
526430001 Gestionare de proiect
526430002 Gestionare calendar și planificare
526430003 Gestionarea e-mailului
526430004 Fișiere și documentație
526430005 Notificări și mementouri
526430006 Analiza
526430007 Colaborarea
526430008 Commerce
526430009 Finanțe
526430010 Conformitate & Legal
526430011 Vânzări
526430012 Instrumente IT
526430013 Marketing
526430014 Operațiuni și lanț de aprovizionare
526430015 Internetul lucrurilor
526430016 Învățare programată ai
526430017 Locație geografică
526430018 Resurse umane

În prezent, noile categorii de afaceri nu pot fi configurate, dar pot fi regăsite din opțiunea globală Categorie de afaceri catalog (mspcat_catalogbusinesscategory).

CatalogFileAsset

Aceste proprietăți definesc un fișier la care se face referire în CatalogItemDefinitionpackageFile și offerDetailssmall48x48Image, large216x216Image, useCaseDocumentvideos, documents, și screenshots proprietățile.

Proprietate Tip Obligatoriu Descriere
name string Da Numele fișierului.
filesaslink uri Da Link pentru a descărca fișierul. Dacă linkul necesită autentificare, furnizați un URL de semnătură de acces partajat (SAS).

PersonContactInformation

Aceste proprietăți definesc persoanele din elementul catalog OfferDetailsengineeringName și supportName proprietățile.

Proprietate Tip Obligatoriu Descriere
firstName string Nu Persoană pe prenume.
lastName string Da Nume familie persoană.
email string Da Adresa de e-mail a persoanei.
phoneNumber string Nu Persoană număr de telefon.
  • Last updated on