Препратка към документ за подаване на елемент на каталог

Трябва да включите данни в JSON формат, когато подавате елемент към каталога. Тази статия описва валидните свойства за този документ. Този JSON е пример:

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

Тази таблица описва свойствата на документа за подаване:

Свойство Вид Необходимо Описание
modelVersion низ Не Номер на версията на документа за подаване. По подразбиране е 1.0.0.0.
sourcePortal целочислен Не Идентифицира източника на това искане. По подразбиране за 526430005 коя е PAC CLI. За други източници използвайте 526430000. Функцията mspcat_GetPowerCatalogDetails връща пълния списък. Свойството mspcat_GetPowerCatalogDetailsResponse.CatalogDetails.sourceOptions показва наличните опции.
submissionId guid Не Guid за идентифициране на подаването. Тази стойност е външен ключ, който позволява свързване на искането с други системи.
operation низ Да За бъдещо разширяване и в момента не се спазва. Типът операция, която трябва да се използва. Валидни стойности:
- CreateOrUpdate (По подразбиране)
- Create
- Update
- Disabled
businessJustification низ Не Описва бизнес стойността на подаването до одобряващия. Тази стойност може да съдържа HTML или RTF формат. Тази информация се появява в планираното използване в потребителското изживяване при откриването на създателя. Потребителите може да кажат, че подаденото от тях съдържание помага например за намаляване на разходите или продуктивност. Някои организации изискват определени класове стойност и тези стойности могат да бъдат въведени тук.
publisherDetails Издателство Да Издателят, свързан с подаването на този елемент.
catalogItemDefinition CatalogItemDefinition Да Определя елемента на каталога, който се подава.

Издател

Използвайте тези данни, за да зададете свойството на елемента publisherDetails за подаване на каталог.

Създава запис на издател, който може да бъде свързан с една или повече групи ИД на Microsoft Entra, съдържащи упълномощени потребители, които могат да правят актуализации на каталожния елемент от този момент нататък.

Бележка

Не бъркайте този израз с издателя на решението. Издателят на елемент на каталог не се използва с решения.

Трябва да предоставите най-малко publisherDisplayName . publisherId може да бъде всяка стойност на низ. Системата проверява дали този издател съществува, в противен случай го създава и присвоява publisherId.

Например HR ИТ екип от разработчици може да създаде издател и ИД на разработчиците с помощта на ИД група на Microsoft Entra.

Ето извадка от запис на издател, който включва операции за добавяне на лице и група "ИД на entra"

{
   "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"
      }
   ]
}
Свойство Вид Необходимо Описание
publisherId низ Да Уникалният ИД за този издател. Използвайте този ИД, за да идентифицирате този издател всеки път, когато създавате или актуализирате елемент на каталог за този издател. Елементите на каталога могат да се свързват само с един издател в даден момент. Стойността може да бъде GUID или низ. След като бъде зададено, то трябва да се поддържа.
publisherDisplayName низ Да Потребителите виждат тези данни в галерията с каталози.
publisherUpnList CatalogUPNOperation[] Не Хора, които могат да подават нови или да актуализират каталожни елементи като този издател. Винаги включва подаване на потребител при първото създаване на Publisher.
publisherAADGroupOIDS CatalogGroupOperation[] Не Entra ID Groups, чиито членове имат разрешение за достъп до този издател.

CatalogUPNOperation

Използвайте тези данни, за да зададете свойството PublisherpublisherUpnList .

Определя операция за добавяне или премахване на хора, които могат да подават нови или да актуализират каталожни елементи като този издател.

Свойство Вид Необходимо Описание
action низ Да Действието, което трябва да се предприеме с това UPN. Валидни стойности: Add или Remove.
upn низ Да Основно потребителско име (UPN) на потребителя.
userOid guid Да Идентификатор на обект за потребителя.

Операция "Група каталози"

Използвайте тези данни, за да зададете свойството PublisherpublisherAADGroupOIDS .

Дефинира операция за добавяне или премахване на група ИД на Entra, която има достъп до този издател.

Свойство Вид Необходимо Описание
action низ Да Действието, което трябва да се предприеме с това UPN. Валидни стойности: Add или Remove.
groupName низ Да Име на групата.
groupOid guid Да Идентификатор на обект за група.
groupType низ Да Тип на адресираната група. Валидните стойности са Security и Modern.

CatalogItemDefinition

Използвайте тези данни, за да зададете свойството на елемента catalogItemDefinition за подаване на каталог.

Тези свойства дефинират каталожния елемент, който се подава. Това е действителното решение на Power Platform. Пакетът е това, което се съхранява в каталога.

Ето пример за каталожен елемент, включително неговия engineeringName и supportName контактите, които са задължителни.

"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"
   }
   }
}
Свойство Вид Необходимо Описание
id guid Да Уникалният ИД на каталожния елемент. Използвайте този ИД, когато актуализирате или инсталирате елемента на каталога.
displayName низ Да Име, показано на потребителите в галериите с каталози.
description низ Не Описание, показано на потребителите в галериите с каталози.
offer Подробни данни за предложението Да Подробностите за подаване на каталожен елемент.
packageFile CatalogFileAsset Да Описва къде да се получи файлът на каталожния пакет за подаването.

Подробни данни за предложението

Използвайте тези данни, за да зададете свойството CatalogItemDefinitionoffer .

Тези свойства дефинират подробностите за подаване на каталожен елемент.

Свойство Вид Необходимо Описание
businessCategories int[] Не Списък със стойности на опции за избор, спазвани от целевия каталог. Идентифицира бизнес категориите, които да се асоциират с този каталожен елемент. Вижте Бизнес категории за валидните стойности, които трябва да използвате.
type низ Да Тип на елемента на каталога. Валидни стойности:
- Application
- Component_Collection
supportsApplicationTypes низ[] Не Списък на поддържаните типове приложения. Валидни стойности:
- CanvasApps
- ModelApps
- PowerPortals
- PowerAutomate
deploymentType низ Да Показва типа на разполагане за разполагане на този каталожен елемент. Валидни стойности:
- Normal представлява управляван елемент.
- Template Копие на вашето неуправлявано решение, което другите създатели могат да редактират, както изберат.
Научете повече за типовете елементи на каталог
searchKeywords низ[] Не Думи, които хората могат да използват, за да намерят този каталожен елемент.
small48x48Image CatalogFileAsset Не Изображение за изглед на галерия. Ако не предоставите това изображение, се използва икона по подразбиране за системата.
large216x216Image CatalogFileAsset Не Изображение за подробен изглед. Предоставете икона, която да се показва в създателя или друг пи за откриване. Някои потребителски изживявания използват по-големи икони, за да рендират карти за откриване.
useCaseDocument CatalogFileAsset Не Използвайте описание на случая и обяснение за одобряващите.
videos CatalogFileAsset[] Не Изгледът с подробни данни показва връзки към тези видео/gif файлове.
documents CatalogFileAsset[] Не Изгледът с подробни данни показва връзки към тези файлове.
screenshots CatalogFileAsset[] Не Изгледът с подробни данни показва тези изображения. Можете да изпратите екранни снимки тук на вашето приложение, за да помогнете на създателите да разберат дали това приложение предоставя функционалността или възможностите, които търсят. Най-често срещаното нещо, което хората правят, преди да изтеглят приложение или шаблон, е да прегледат неговите изображения и екранни снимки, за да разберат възможностите, вместо да четат описанието.
helpLink uri Не Връзка към документацията. Тези URL адреси могат да бъдат връзки към вътрешни документи или ресурси на SharePoint.
privacyPolicyLink uri Не Връзка към документ за поверителност. Правила относно внимателното използване на компонента или приложението, което се подава.
legalTermsLink uri Не Връзка към документа "Правила и условия". Всички правни условия или вътрешни указания за оценка на потребителя на каталожния елемент.
legalTerms низ Не Markdown, HTML или текстова версия на документа "Правила и условия". Всички правни условия или вътрешни указания за оценка на потребителя на каталожния елемент.
sourceCodeRepositoryLink uri Не Връзка към хранилището за първичен програмен текст
engineeringName PersonContactInformation Да Информация за връзка за инженер или група, разработили този каталожен елемент.
supportName PersonContactInformation Не Информация за връзка за поддръжка или група, която поддържа този каталожен елемент. Може да бъде същият като инженерния контакт, с който потребителят на даден каталожен елемент може да се свърже, ако се сблъска с проблеми с приложението.

Бизнес категории

Задайте свойството OfferDetailsbusinessCategories на една или повече от тези бизнес категории:

Код Описание
526430000 Обслужване на клиенти
526430001 Управление на проекти
526430002 Управление на календари и планиране
526430003 Управление на имейл
526430004 Файлове & документация
526430005 Известия и напомняния
526430006 Анализ
526430007 Сътрудничество
526430008 Commerce
526430009 Финанси
526430010 Съответствие & legal
526430011 Sales
526430012 ИТ инструменти
526430013 Marketing
526430014 Операции и верига на доставки
526430015 Интернет на нещата
526430016 Машинно обучение на AI
526430017 Геопозициониране
526430018 Човешки ресурси

В момента не могат да бъдат конфигурирани нови бизнес категории, но те могат да бъдат извлечени от глобалния избор на каталога за бизнес категория (mspcat_catalogbusinesscategory).

CatalogFileAsset

Тези свойства дефинират файл, към който има препратка в CatalogItemDefinitionpackageFile и OfferDetailssmall48x48Image, large216x216Image, useCaseDocumentvideos, documents, и screenshots свойства.

Свойство Вид Необходимо Описание
name низ Да Име на файла.
filesaslink uri Да Връзка за изтегляне на файла. Ако връзката изисква удостоверяване, предоставете URL адрес на подпис за споделен достъп (SAS).

PersonContactInformation

Тези свойства дефинират хора в каталогния елемент OfferDetailsengineeringName и supportName свойства.

Свойство Вид Необходимо Описание
firstName низ Не Собствено име на лицето.
lastName низ Да Фамилно име на човек.
email низ Да Имейл адрес на човек.
phoneNumber низ Не Телефонен номер на човек.
  • Последна актуализация: