Compartilhar via

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:

Propriedade Tipo Obrigatório Description
modelVersion cadeia Não Número de versão do documento de envio. O padrão é 1.0.0.0.
sourcePortal int Não Identifica a origem dessa solicitação. O padrão é a 526430005 CLI do PAC. Para outras fontes, use 526430000. A mspcat_GetPowerCatalogDetails função retorna a lista completa. A mspcat_GetPowerCatalogDetailsResponse.CatalogDetails.sourceOptions propriedade lista as opções disponíveis.
submissionId guid Não Guid para identificar o envio. Esse valor é uma chave estrangeira para permitir a vinculação da solicitação a outros sistemas.
operation cadeia Yes Para expansão futura e não é respeitada no momento. O tipo de operação a ser usada. Valores válidos:
- CreateOrUpdate (Padrão)
- Create
- Update
- Disabled
businessJustification cadeia Não Descreve o valor comercial do envio ao aprovador. Esse valor pode conter HTML ou RTF (Rich Text Format). Essas informações aparecem na experiência de consumo planejada na experiência do usuário de descoberta do criador. Os usuários podem dizer que seu envio ajuda na redução de custos ou produtividade, por exemplo. Algumas organizações exigem determinadas classes de valor e esses valores podem ser inseridos aqui.
publisherDetails Publicador Yes O publicador associado a este envio de item.
catalogItemDefinition CatalogItemDefinition Yes Define o item de catálogo que está sendo enviado.

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.

Observação

Não confunda esse termo com o Solution Publisher. O editor de itens de catálogo não é usado com soluções.

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"
      }
   ]
}
Propriedade Tipo Obrigatório Description
publisherId cadeia Yes A ID exclusiva deste editor. Use essa ID para identificar esse editor sempre que você estiver criando ou atualizando um item de catálogo para este publicador. Os Itens de Catálogo só podem ser associados a um editor por vez. O valor pode ser um GUID ou uma cadeia de caracteres. Uma vez definido, ele deve ser mantido.
publisherDisplayName cadeia Yes Os consumidores veem esses dados na galeria de catálogos.
publisherUpnList CatalogUPNOperation[] Não Pessoas que podem enviar itens de catálogo novos ou atualizados como este editor. Sempre inclui o usuário que está enviando na primeira vez em que o Publicador é criado.
publisherAADGroupOIDS CatalogGroupOperation[] Não Grupos de ID do Entra cujos membros têm permissão para acessar este editor.

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.

Propriedade Tipo Obrigatório Description
action cadeia Yes A ação a ser tomada com este UPN. Valores válidos: Add ou Remove.
upn cadeia Yes Nome upn (nome de entidade de usuário) do usuário.
userOid guid Yes Identificador de objeto para o usuário.

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.

Propriedade Tipo Obrigatório Description
action cadeia Yes A ação a ser tomada com este UPN. Valores válidos: Add ou Remove.
groupName cadeia Yes Nome do grupo.
groupOid guid Yes Identificador de objeto para grupo.
groupType cadeia Yes Tipo de grupo que está sendo endereçado. Valores válidos são Security e Modern.

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"
   }
   }
}
Propriedade Tipo Obrigatório Description
id guid Yes A ID exclusiva do item de catálogo. Use essa ID ao atualizar ou instalar o item de catálogo.
displayName cadeia Yes Nome mostrado aos consumidores nas galerias do catálogo.
description cadeia Não Descrição mostrada aos consumidores nas galerias do catálogo.
offer OfferDetails Yes Os detalhes do envio do item de catálogo.
packageFile CatalogFileAsset Yes Descreve onde obter o arquivo de pacote do catálogo para o envio.

Detalhes da oferta

Use esses dados para especificar a propriedade CatalogItemDefinitionoffer .

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

Propriedade Tipo Obrigatório Description
businessCategories int[] Não Lista de valores de opção de escolha respeitados pelo catálogo de destino. Identifica as categorias de negócios a serem associadas a este item de catálogo. Consulte categorias de Negócios para obter os valores válidos a serem usados.
type cadeia Yes Tipo de item de catálogo. Valores válidos:
- Application
- Component_Collection
supportsApplicationTypes cadeia de caracteres[] Não Lista dos tipos de aplicativo com suporte. Valores válidos:
- CanvasApps
- ModelApps
- PowerPortals
- PowerAutomate
deploymentType cadeia Yes Indica o tipo de implantação para implantar este item de catálogo. Valores válidos:
- Normal representa um item gerenciado.
- Template Uma cópia da sua solução não gerenciada que outros criadores podem editar como quiserem.
Saiba mais sobre os tipos de item de catálogo
searchKeywords cadeia de caracteres[] Não Palavras que as pessoas podem usar para encontrar este item de catálogo.
small48x48Image CatalogFileAsset Não Imagem para exibição da galeria. Se você não fornecer essa imagem, um ícone padrão do sistema será usado.
large216x216Image CatalogFileAsset Não Imagem para exibição de detalhes. Forneça um ícone a ser exibido no criador ou em outra interface do usuário de descoberta. Algumas experiências do usuário usam ícones maiores para renderizar cartões para descoberta.
useCaseDocument CatalogFileAsset Não Use a descrição do caso e a explicação para aprovadores.
videos CatalogFileAsset[] Não A exibição de detalhes exibe links para esses arquivos de vídeo/gif.
documents CatalogFileAsset[] Não A exibição de detalhes exibe links para esses arquivos.
screenshots CatalogFileAsset[] Não A exibição de detalhes exibe essas imagens. Você pode passar capturas de tela aqui do seu aplicativo para ajudar os criadores a identificar se esse aplicativo fornece a funcionalidade ou a funcionalidade que eles estão procurando. A coisa mais comum que as pessoas fazem antes de baixar um aplicativo ou modelo é examinar suas imagens e capturas de tela para entender os recursos em vez de ler a descrição.
helpLink uri Não Link para documentação. Essas URLs podem ser links para documentos internos ou recursos do sharepoint.
privacyPolicyLink uri Não Link para o documento de privacidade. Políticas relativas ao uso cuidadoso do componente ou aplicativo que está sendo enviado.
legalTermsLink uri Não Link para o documento Termos e Condições. Quaisquer termos legais ou diretrizes internas para avaliação do consumidor do item de catálogo.
legalTerms cadeia Não Markdown, HTML ou versão de texto do documento Termos e Condições. Quaisquer termos legais ou diretrizes internas para avaliação do consumidor do item de catálogo.
sourceCodeRepositoryLink uri Não Link para o repositório de código-fonte
engineeringName PersonContactInformation Yes Informações de contato para engenheiro ou grupo que desenvolveu este item de catálogo.
supportName PersonContactInformation Não Entre em contato com informações para suporte ou grupo que dá suporte a este item de catálogo. Pode ser igual ao contato de engenharia que o consumidor de um item de catálogo pode entrar em contato se tiver problemas com o aplicativo.

Categorias de negócios

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

Code Description
526430000 Atendimento ao Cliente
526430001 Gerenciamento de Projetos
526430002 Gerenciamento de Calendário & Agendamento
526430003 Gerenciamento de email
526430004 Arquivos &documentação
526430005 Notificação & Lembretes
526430006 Análises de dados
526430007 Colaboração
526430008 Commerce
526430009 Finanças
526430010 Conformidade e jurídico
526430011 Sales
526430012 Ferramentas de TI
526430013 Marketing
526430014 Operações e cadeia de fornecedores
526430015 Internet das Coisas
526430016 Machine Learning de IA
526430017 Geolocalização
526430018 Recursos Humanos

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.

Propriedade Tipo Obrigatório Description
name cadeia Yes Nome do arquivo.
filesaslink uri Yes Link para baixar o arquivo. Se o link exigir autenticação, forneça uma URL de SAS (assinatura de acesso compartilhado).

PersonContactInformation

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

Propriedade Tipo Obrigatório Description
firstName cadeia Não Nome da pessoa.
lastName cadeia Yes Nome da família da pessoa.
email cadeia Yes Endereço de email da pessoa.
phoneNumber cadeia Não Número de telefone da pessoa.
  • Last updated on