通过

目录项提交文档参考

将项提交到目录时，必须采用 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 int 否 标识此请求的源。 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 ID 组，其中包含可对目录项进行更新的授权用户。

注释

不要将此术语与 解决方案发布者混淆。 目录项发布者不与解决方案一起使用。

需要至少提供 publisherDisplayName 一个。 publisherId 可以是任何字符串值。 系统检查该发布服务器是否存在，否则会创建它并分配一个 publisherId。

例如，HR IT 开发人员团队可以使用 Microsoft Entra ID 组创建发布者和 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"
      }
   ]
}
资产 类型 必选 Description
publisherId 字符串 是的 此发布者的唯一 ID。 使用此 ID 标识此发布者，只要你正在为此发布者创建或更新目录项。 目录项一次只能关联到一个发布者。 该值可以是 GUID 或字符串。 设置后，必须维护它。
publisherDisplayName 字符串 是的 使用者在目录库中看到此数据。
publisherUpnList CatalogUPNOperation[] 否 可以以此发布者身份提交新目录项或更新目录项的人员。 始终在首次创建发布服务器时包括提交用户。
publisherAADGroupOIDS CatalogGroupOperation[] 否 允许其成员访问此发布者的条目 ID 组。

CatalogUPNOperation

使用此数据指定 PublisherpublisherUpnList 属性。

定义一个作，用于添加或删除可以作为此发布者提交新目录项或更新目录项的人员。

资产 类型 必选 Description
action 字符串 是的 要对此 UPN 执行的作。 有效值： Add 或 Remove。
upn 字符串 是的 用户的用户主体名称（UPN）。
userOid guid 是的 用户的对象标识符。

CatalogGroupOperation

使用此数据指定 PublisherpublisherAADGroupOIDS 属性。

定义用于添加或删除可访问此发布者的 Entra ID 组的作。

资产 类型 必选 Description
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"
   }
   }
}
资产 类型 必选 Description
id guid 是的 目录项的唯一 ID。 更新或安装目录项时使用此 ID。
displayName 字符串 是的 向目录库中的使用者显示的名称。
description 字符串 否 向目录库中的使用者显示的说明。
offer OfferDetails 是的 目录项提交的详细信息。
packageFile CatalogFileAsset 是的 描述在何处获取提交的目录包文件。

优惠详情

使用此数据指定 CatalogItemDefinitionoffer 属性。

这些属性定义目录项提交的详细信息。

资产 类型 必选 Description
businessCategories int[] 否 目标目录所遵循的选择选项值列表。 标识与此目录项关联的业务类别。 有关要使用的有效值，请参阅 业务类别 。
type 字符串 是的 目录项的类型。 有效值：
- Application
- Component_Collection
supportsApplicationTypes 字符串[] 否 支持的应用程序类型的列表。 有效值：
- CanvasApps
- ModelApps
- PowerPortals
- PowerAutomate
deploymentType 字符串 是的 指示部署此目录项的部署类型。 有效值：
- Normal 表示 托管项。
- Template 其他创建者可以选择编辑的非托管解决方案的副本。
详细了解目录项类型
searchKeywords 字符串[] 否 人们可能用来查找此目录项的字词。
small48x48Image CatalogFileAsset 否 库视图的图像。 如果未提供此映像，将使用系统默认图标。
large216x216Image CatalogFileAsset 否 详细信息视图的图像。 提供要显示在创建者或其他发现 UI 中的图标。 某些用户体验使用较大的图标来呈现卡片进行发现。
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 属性设置为以下一个或多个业务类别：

Code Description
526430000 顾客服务
526430001 项目管理
526430002 日历管理和日程安排
526430003 电子邮件管理
526430004 文件和文档
526430005 通知和提醒
526430006 Analytics
526430007 协作
526430008 商业
526430009 金融
526430010 符合性和法律
526430011 Sales
526430012 IT 工具
526430013 Marketing
526430014 运营和供应链
526430015 物联网
526430016 AI 机器学习
526430017 地理位置
526430018 人力资源

目前，无法配置新的业务类别，但可以从目录业务类别（mspcat_catalogbusinesscategory）全局选择中检索它们。

CatalogFileAsset

这些属性定义 CatalogItemDefinitionpackageFile 和 OfferDetailssmall48x48Image、、large216x216Image、useCaseDocument、 videosdocuments和screenshots属性中引用的文件。

资产 类型 必选 Description
name 字符串 是的 文件的名称。
filesaslink uri 是的 用于下载文件的链接。 如果链接需要身份验证，请提供 共享访问签名 （SAS） URL。

PersonContactInformation

这些属性定义目录项 OfferDetailsengineeringName 和 supportName 属性中的人员。

资产 类型 必选 Description
firstName 字符串 否 人员名字。
lastName 字符串 是的 人员姓氏。
email 字符串 是的 人员电子邮件地址。
phoneNumber 字符串 否 人员电话号码。
  • Last updated on