Catalog item submission document reference

You must include data in JSON format when you submit an item to the catalog. This article describes the valid properties for that document. This JSON is an example:

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

This table describes the properties for the submission document:

Publisher

Use this data to specify the catalog submission item publisherDetails property.

Creates a publisher record that can be associated to one or more Microsoft Entra ID groups containing authorized users who can make updates to the catalog item going forward.

You need to provide the publisherDisplayName at a minimum. publisherId can be any string value. The system checks if that publisher exists, else creates it and assigns an publisherId.

For example, HR IT team of developers can create a publisher and ID the developers using a Microsoft Entra ID group.

Here's a sample of a publisher record that includes operations to add a person and an Entra ID group

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

CatalogUPNOperation

Use this data to specify the Publisher publisherUpnList property.

Defines an operation to add or remove people that can submit new or update catalog items as this publisher.

CatalogGroupOperation

Use this data to specify the Publisher publisherAADGroupOIDS property.

Defines an operation to add or remove an Entra ID Group that can access this publisher.

CatalogItemDefinition

Use this data to specify the catalog submission item catalogItemDefinition property.

These properties define the catalog item being submitted. This is the actual Power Platform solution. A package is what is stored in the catalog.

Here's an example of a catalog item including its engineeringName and supportName contacts that are mandatory.

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

OfferDetails

Use this data to specify the CatalogItemDefinition offer property.

These properties define the details of the catalog item submission.

Business categories

Set the OfferDetails businessCategories property to one or more of these business categories:

Currently, new business categories can't be configured, but they can be retrieved from the Catalog Business Category (mspcat_catalogbusinesscategory) global choice.

CatalogFileAsset

These properties define a file referenced in the CatalogItemDefinition packageFile and the OfferDetails small48x48Image, large216x216Image, useCaseDocument, videos, documents, and screenshots properties.

PersonContactInformation

These properties define people in the catalog item OfferDetails engineeringName and supportName properties.