Посилання на документ надсилання елемента каталогу

Під час надсилання елемента до каталогу необхідно включити дані у форматі 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 int Ні Визначає джерело цього запиту. За замовчуванням, до 526430005 якого використовується pac CLI. Для інших джерел використовуйте .526430000 Функція mspcat_GetPowerCatalogDetails повертає повний список. Властивість mspcat_GetPowerCatalogDetailsResponse.CatalogDetails.sourceOptions містить список доступних параметрів.
submissionId guid Ні Guid, щоб визначити надсилання. Це значення – зовнішній ключ, який дозволяє зв'язувати запит з іншими системами.
operation рядок Так Для майбутнього розширення і в даний час не дотримується. Тип операції, яка використовується. Припустимі значення:
- CreateOrUpdate (За замовчуванням)
- Create
- Update
- Disabled
businessJustification рядок Ні Опис бізнес-вартості надсилання затверджувачу. Це значення може містити формат HTML або RTF. Ці відомості відображаються в запланованому досвіді використання в засобі виявлення користувача. Користувачі можуть сказати, що їх надсилання допомагає, наприклад, зниження витрат або продуктивності. Для деяких організацій потрібні певні класи вартості, і ці значення можна ввести тут.
publisherDetails Видавець Так Видавця, пов'язаного з надсиланням цього елемента.
catalogItemDefinition Стандартна умова каталогу Так Визначає елемент каталогу, який надсилається.

Видавець

Використовуйте ці дані, щоб указати властивість елемента надсилання каталогу publisherDetails .

Створює запис видавця, який можна пов'язати з однією або кількома групами ідентифікаторів Microsoft Entra з авторизованими користувачами, які можуть оновлювати елемент каталогу в майбутньому.

Нотатка

Не плутайте цей термін із видавцем рішення. Видавець елемента каталогу не використовується з рішеннями.

Ви повинні надати publisherDisplayName принаймні. publisherId може бути будь-яким рядком. Система перевіряє, чи існує цей видавець, інакше створює його та призначає publisherId.

Наприклад, HR IT-команда розробників може створити видавця та ідентифікатор розробника за допомогою групи Microsoft Entra ID.

Ось зразок запису видавця, який містить операції з додавання особи та групи 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"
      }
   ]
}
Властивість Ввести Обов'язковий Опис
publisherId рядок Так Унікальний ідентифікатор для цього видавця. Цей ідентифікатор використовується для визначення видавця в будь-який час, коли ви створюєте або оновлюєте елемент каталогу для цього видавця. Елементи каталогу можна одночасно пов'язати лише з одним видавцем. Значення може бути ІДЕНТИФІКАТОРОМ GUID або рядком. Після встановлення він має підтримуватися.
publisherDisplayName рядок Так Споживачі бачать ці дані в колекції каталогів.
publisherUpnList CatalogUPNOperation[] Ні Користувачі, які можуть надсилати нові або оновлювати елементи каталогу як цей видавець. Завжди включає користувача, який надсилає дані під час першого створення Publisher.
publisherAADGroupOIDS Відкриття групи каталогів[] Ні Групи ідентифікаторів Entra, учасникам яких дозволено доступ до цього видавця.

КаталогUPNOperation

Використовуйте ці дані, щоб указати властивість PublisherpublisherUpnList .

Визначає операцію додавання або видалення користувачів, які можуть надсилати нові або оновлювати елементи каталогу як цей видавець.

Властивість Ввести Обов'язковий Опис
action рядок Так Дія, яка потрібно виконати з цим UPN. Припустимі значення: Add або Remove.
upn рядок Так Ім'я учасника-користувача (UPN) користувача.
userOid guid Так Ідентифікатор об'єкта для користувача.

Відкриття групи каталогів

Використовуйте ці дані, щоб указати властивість PublisherpublisherAADGroupOIDS .

Визначає операцію додавання або видалення групи ідентифікаторів Entra, яка може отримати доступ до цього видавця.

Властивість Ввести Обов'язковий Опис
action рядок Так Дія, яка потрібно виконати з цим UPN. Припустимі значення: Add або Remove.
groupName рядок Так Ім'я групи.
groupOid guid Так Ідентифікатор об'єкта для групи.
groupType рядок Так Тип групи, що вирішується. Припустимі значення: Security і Modern.

Стандартна умова каталогу

Використовуйте ці дані, щоб указати властивість елемента надсилання каталогу 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 (uri) Ні Посилання на документацію. Ці URL-адреси можуть бути посиланнями на внутрішні документи або ресурси SharePoint.
privacyPolicyLink uri (uri) Ні Посилання на документ конфіденційності. Політики щодо ретельного використання компонента або програми, що надсилається.
legalTermsLink uri (uri) Ні Посилання на документ "Умови та положення". Будь-які юридичні умови або внутрішні вказівки для оцінки споживача елемента каталогу.
legalTerms рядок Ні Markdown, HTML або text version of the Terms document. Будь-які юридичні умови або внутрішні вказівки для оцінки споживача елемента каталогу.
sourceCodeRepositoryLink uri (uri) Ні Посилання на сховище вихідного коду
engineeringName PersonContactInformation Так Контактна інформація для інженера або групи, яка розробила цей елемент каталогу.
supportName PersonContactInformation Ні Контактна інформація для підтримки або групи, яка підтримує цей елемент каталогу. Може бути так само, як інженерний контакт, що споживач елемента каталогу може зв'язатися з, якщо вони зіткнулися з проблемами з програмою.

Бізнес-категорії

Установіть для властивості OfferDetailsbusinessCategories одну або кілька з цих бізнес-категорій:

Код Опис
526430000 Обслуговування клієнтів
526430001 Керування проектами
526430002 Керування календарем і планування
526430003 Керування електронною поштою
526430004 Файли та документація
526430005 Сповіщення та нагадування
526430006 Аналітика
526430007 Співпраця
526430008 Комерція
526430009 Фінанси
526430010 Дотримання нормативно-правових вимог
526430011 Sales
526430012 ІТ-інструменти
526430013 Marketing
526430014 Операції та ланцюжок поставок
526430015 Інтернет речей
526430016 Машинне навчання зі ШІ
526430017 Геолокація
526430018 Відділ кадрів

Наразі не можна настроїти нові бізнес-категорії, але їх можна отримати з глобального вибору бізнес-категорії каталогу (mspcat_catalogbusinesscategory).

CatalogFileAsset

Ці властивості визначають файл, на який посилається параметр CatalogItemDefinitionpackageFile , OfferDetailssmall48x48Image, large216x216Image, useCaseDocument, videos, documentsі screenshots властивості.

Властивість Ввести Обов'язковий Опис
name рядок Так Ім'я файлу.
filesaslink uri (uri) Так Посилання для завантаження файлу. Якщо для посилання потрібна автентифікація, укажіть URL-адресу підпису спільного доступу (SAS).

PersonContactInformation

Ці властивості визначають користувачів у елементі каталогу OfferDetails і engineeringName властивостяхsupportName.

Властивість Ввести Обов'язковий Опис
firstName рядок Ні Ім'я особи.
lastName рядок Так Ім'я родини особи.
email рядок Так Адреса електронної пошти користувача.
phoneNumber рядок Ні Номер телефону користувача.
  • Last updated on