Referência de documento de envio de item de catálogo

Você deve incluir dados no formato JSON ao enviar um item para o catálogo. Este artigo descreve as propriedades válidas para esse documento. Este JSON é um exemplo:

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

Esta tabela descreve as propriedades do documento de envio:

Publicador

Use esses dados para especificar a propriedade do item publisherDetails de envio do catálogo.

Cria um registro de editor que pode ser associado a um ou mais grupos de ID do Microsoft Entra que contêm usuários autorizados que podem fazer atualizações no item de catálogo daqui para frente.

Você precisa fornecer no publisherDisplayName mínimo. publisherId pode ser qualquer valor de cadeia de caracteres. O sistema verifica se esse editor existe, caso contrário, o cria e atribui um publisherId.

Por exemplo, a equipe de TI de RH dos desenvolvedores pode criar um publicador e uma ID dos desenvolvedores usando um grupo de IDs do Microsoft Entra.

Aqui está um exemplo de um registro do editor que inclui operações para adicionar uma pessoa e um grupo de IDs do 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"
      }
   ]
}

CatalogUPNOperation

Use esses dados para especificar a propriedade PublisherpublisherUpnList .

Define uma operação para adicionar ou remover pessoas que podem enviar itens de catálogo novos ou atualizados como este editor.

CatalogGroupOperation

Use esses dados para especificar a propriedade PublisherpublisherAADGroupOIDS .

Define uma operação para adicionar ou remover um Grupo de IDs do Entra que pode acessar esse publicador.

CatalogItemDefinition

Use esses dados para especificar a propriedade do item catalogItemDefinition de envio do catálogo.

Essas propriedades definem o item de catálogo que está sendo enviado. Esta é a solução real do Power Platform. Um pacote é o que é armazenado no catálogo.

Aqui está um exemplo de um item de catálogo, incluindo seus engineeringName contatos e supportName que são obrigatórios.

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

Detalhes da oferta

Use esses dados para especificar a propriedade CatalogItemDefinitionoffer .

Essas propriedades definem os detalhes do envio de item de catálogo.

Categorias de negócios

Defina a propriedade OfferDetailsbusinessCategories como uma ou mais dessas categorias de negócios:

Atualmente, novas categorias de negócios não podem ser configuradas, mas podem ser recuperadas da opção global Categoria de Negócios do Catálogo (mspcat_catalogbusinesscategory).

CatalogFileAsset

Essas propriedades definem um arquivo referenciado no CatalogItemDefinitionpackageFile e nas propriedades OfferDetailssmall48x48Image, large216x216Image, useCaseDocument, videosdocumentsescreenshots.

PersonContactInformation

Essas propriedades definem as pessoas no item de catálogo OfferDetailsengineeringName e supportName propriedades.