Поделиться через

Справочник по документу отправки элемента каталога

При отправке элемента в каталог необходимо включить данные в формат 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"
      }
  }
}

В этой таблице описываются свойства документа отправки:

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

Publisher

Используйте эти данные для указания свойства элемента publisherDetails отправки каталога.

Создает запись издателя, которая может быть связана с одной или несколькими группами идентификаторов Microsoft Entra, содержащими авторизованных пользователей, которые могут вносить обновления в элемент каталога.

Замечание

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

Необходимо предоставить publisherDisplayName как минимум. publisherId может быть любым строковым значением. Система проверяет, существует ли этот издатель, а также создает его и назначает .publisherId

Например, ИТ-отдел отдела кадров разработчиков может создать издателя и идентификатор разработчиков с помощью группы идентификаторов Microsoft Entra ID.

Ниже приведен пример записи издателя, включающей операции добавления пользователя и группы идентификаторов 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"
      }
   ]
}
Недвижимость Тип Обязательно Description
publisherId струна Да Уникальный идентификатор для этого издателя. Используйте этот идентификатор для идентификации этого издателя в любое время, когда вы создаете или обновляете элемент каталога для этого издателя. Элементы каталога могут быть связаны только с одним издателем одновременно. Значение может быть GUID или строкой. После установки его необходимо сохранить.
publisherDisplayName струна Да Потребители видят эти данные в коллекции каталогов.
publisherUpnList CatalogUPNOperation[] нет Пользователи, которые могут отправлять новые или обновлять элементы каталога в качестве этого издателя. Всегда включает отправляющего пользователя при первом создании издателя.
publisherAADGroupOIDS CatalogGroupOperation[] нет Группы идентификаторов записей, члены которых могут получить доступ к этому издателю.

CatalogUPNOperation

Используйте эти данные для указания свойства PublisherpublisherUpnList .

Определяет операцию добавления или удаления пользователей, которые могут отправлять новые или обновлять элементы каталога в качестве этого издателя.

Недвижимость Тип Обязательно Description
action струна Да Действия, которые необходимо предпринять с помощью этого имени участника-участника-участника. Допустимые значения: Add или Remove.
upn струна Да Имя участника-пользователя (UPN) пользователя.
userOid гид Да Идентификатор объекта для пользователя.

CatalogGroupOperation

Используйте эти данные для указания свойства PublisherpublisherAADGroupOIDS .

Определяет операцию для добавления или удаления группы идентификаторов Записи, которая может получить доступ к этому издателю.

Недвижимость Тип Обязательно Description
action струна Да Действия, которые необходимо предпринять с помощью этого имени участника-участника-участника. Допустимые значения: Add или Remove.
groupName струна Да Имя группы.
groupOid гид Да Идентификатор объекта для группы.
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"
   }
   }
}
Недвижимость Тип Обязательно Description
id гид Да Уникальный идентификатор элемента каталога. Используйте этот идентификатор при обновлении или установке элемента каталога.
displayName струна Да Имя, отображаемое потребителям в коллекциях каталогов.
description струна нет Описание, отображаемое потребителям в коллекциях каталогов.
offer ПредложениеDetails Да Сведения о отправке элемента каталога.
packageFile CatalogFileAsset Да Описывает, где получить файл пакета каталога для отправки.

ПредложениеDetails

Используйте эти данные для указания свойства CatalogItemDefinitionoffer .

Эти свойства определяют сведения о отправке элемента каталога.

Недвижимость Тип Обязательно Description
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 УРИ нет Ссылка на документацию. Эти URL-адреса могут быть ссылками на внутренние документы или ресурсы SharePoint.
privacyPolicyLink УРИ нет Ссылка на документ конфиденциальности. Политики, касающиеся тщательного использования компонента или приложения, отправляемого.
legalTermsLink УРИ нет Ссылка на документ "Условия". Любые юридические условия или внутренние рекомендации по оценке потребителя элемента каталога.
legalTerms струна нет Markdown, HTML или текстовая версия документа "Условия". Любые юридические условия или внутренние рекомендации по оценке потребителя элемента каталога.
sourceCodeRepositoryLink УРИ нет Ссылка на репозиторий исходного кода
engineeringName PersonContactInformation Да Контактные данные инженера или группы, которые разработали этот элемент каталога.
supportName PersonContactInformation нет Контактные данные для поддержки или группы, поддерживающие этот элемент каталога. Может быть таким же, как и инженерный контакт, к которому может обратиться потребитель элемента каталога, если они могут столкнуться с проблемами с приложением.

Категории бизнеса

Задайте свойству OfferDetailsbusinessCategories одно или несколько из следующих бизнес-категорий:

Code Description
526430000 Обслуживание клиентов
526430001 Управление проектами
526430002 Управление календарями и планирование
526430003 Управление электронной почтой
526430004 Файлы и документация
526430005 Уведомления и напоминания
526430006 Аналитика
526430007 Сотрудничество
526430008 Commerce
526430009 Финансы
526430010 Соответствие требованиям и юридические аспекты
526430011 Продажи
526430012 ИТ-инструменты
526430013 Маркетинг
526430014 Операции и логистические цепочки
526430015 Интернет вещей
526430016 Машинное обучение ИИ
526430017 Геолокация
526430018 Кадровые ресурсы

В настоящее время новые бизнес-категории не могут быть настроены, но их можно получить из глобального выбора категории каталога (mspcat_catalogbusinesscategory).

CatalogFileAsset

Эти свойства определяют файл, на который ссылается CatalogItemDefinitionpackageFile и offerDetailssmall48x48Image, large216x216Image, , useCaseDocumentvideosdocumentsи screenshots свойства.

Недвижимость Тип Обязательно Description
name струна Да Имя файла.
filesaslink УРИ Да Ссылка на скачивание файла. Если для ссылки требуется проверка подлинности, укажите URL-адрес подписанного URL-адреса url-адреса подписанного URL-адреса.

PersonContactInformation

Эти свойства определяют людей в элементе каталога OfferDetailsengineeringName и supportName свойствах.

Недвижимость Тип Обязательно Description
firstName струна нет Имя пользователя.
lastName струна Да Имя семьи человека.
email струна Да Адрес электронной почты пользователя.
phoneNumber струна нет Номер телефона пользователя.
  • Last updated on