Tabelas CustomAPI

Os dados que definem APIs personalizadas estão nas seguintes tabelas/entidades:

As seções deste artigo fornecem informações detalhadas sobre os valores de coluna que você mais usa.

colunas de tabela de API personalizadas
Colunas da tabela CustomAPIRequestParameter
Colunas da tabela CustomAPIResponseProperty

Este diagrama mostra como as tabelas estão relacionadas a essas tabelas e a outras:

Diagrama mostrando relações entre tabelas.

A relação com a tabela CatalogAssignment permite usar a API personalizada com eventos de negócios do Microsoft Dataverse. Mais informações: tabelas Catalog e CatalogAssignment.

Recuperar dados sobre APIs personalizadas

Você pode usar as consultas a seguir para recuperar dados sobre APIs personalizadas.

Mais informações: Consultar dados usando a API Web

GET [Organization URI]/api/data/v9.1/customapis?$select=
    uniquename,
    allowedcustomprocessingsteptype,
    bindingtype,
    boundentitylogicalname,
    description,
    displayname,
    executeprivilegename,
    iscustomizable,
    isfunction,
    isprivate,
    workflowsdkstepenabled
  &$expand=
  CustomAPIRequestParameters($select=
    uniquename,
    name,
    description,
    displayname,
    type,
    logicalentityname,
    iscustomizable,
    isoptional),
  CustomAPIResponseProperties($select=
    uniquename,
    name,
    description,
    displayname,
    iscustomizable,
    type,
    logicalentityname),
  PluginTypeId($select=
    plugintypeid,
    typename,
    version,
    name,
    assemblyname)

Mais informações: Criar consultas com QueryExpression

string conn = $@"
    Url = {url};
    AuthType = OAuth;
    UserName = {userName};
    Password = {password};
    AppId = 51f81489-12ee-4a9e-aaae-a2591f45987d;
    RedirectUri = app://58145B91-0C36-4500-8554-080854F2AC97;
    LoginPrompt=Auto;
    RequireNewInstance = True";

// using (var svc = new ServiceClient(conn))
using (var svc = new CrmServiceClient(conn))
{

    // Instantiate QueryExpression query
    var query = new QueryExpression("customapi");

    // Add columns to query.ColumnSet
    query.ColumnSet.AddColumns("isprivate",
    "description",
    "displayname",
    "executeprivilegename",
    "iscustomizable",
    "isfunction",
    "allowedcustomprocessingsteptype",
    "boundentitylogicalname",
    "bindingtype",
    "uniquename",
    "workflowsdkstepenabled");

    // Add link-entity req
    var req = query.AddLink("customapirequestparameter",
    "customapiid",
    "customapiid",
    JoinOperator.LeftOuter);
    req.EntityAlias = "req";

    // Add columns to req.Columns
    req.Columns.AddColumns("description",
    "displayname",
    "iscustomizable",
    "logicalentityname",
    "name",
    "uniquename",
    "type",
    "isoptional");

    // Add link-entity query_customapiresponseproperty
    var query_customapiresponseproperty = query
        .AddLink("customapiresponseproperty",
    "customapiid",
    "customapiid",
    JoinOperator.LeftOuter);

    // Add columns to query_customapiresponseproperty.Columns
    query_customapiresponseproperty.Columns
        .AddColumns("description",
    "displayname",
    "iscustomizable",
    "logicalentityname",
    "name",
    "uniquename",
    "type");

    // Add link-entity plugintype
    var plugintype = query.AddLink("plugintype",
    "plugintypeid",
    "plugintypeid",
    JoinOperator.LeftOuter);

    plugintype.EntityAlias = "plugintype";

    // Add columns to plugintype.Columns
    plugintype.Columns.AddColumns("name",
    "assemblyname",
    "version",
    "plugintypeid",
    "typename");

    EntityCollection results = svc.RetrieveMultiple(query);

    Console.WriteLine("Press any key to exit.");
    Console.ReadLine();
}

Mais informações: Consultar dados usando FetchXml

<fetch>
  <entity name='customapi' >
    <attribute name='isprivate' />
    <attribute name='description' />
    <attribute name='displayname' />
    <attribute name='executeprivilegename' />
    <attribute name='iscustomizable' />
    <attribute name='isfunction' />
    <attribute name='allowedcustomprocessingsteptype' />
    <attribute name='boundentitylogicalname' />
    <attribute name='bindingtype' />
    <attribute name='uniquename' />
    <attribute name='workflowsdkstepenabled' />
    <link-entity name='customapirequestparameter' from='customapiid' to='customapiid' link-type='outer' alias='req' >
      <attribute name='description' />
      <attribute name='displayname' />
      <attribute name='iscustomizable' />
      <attribute name='logicalentityname' />
      <attribute name='name' />
      <attribute name='uniquename' />
      <attribute name='type' />
      <attribute name='isoptional' />
    </link-entity>
    <link-entity name='customapiresponseproperty' from='customapiid' to='customapiid' link-type='outer' >
      <attribute name='description' />
      <attribute name='displayname' />
      <attribute name='iscustomizable' />
      <attribute name='logicalentityname' />
      <attribute name='name' />
      <attribute name='uniquename' />
      <attribute name='type' />
    </link-entity>
    <link-entity name='plugintype' from='plugintypeid' to='plugintypeid' link-type='outer' alias='plugintype' >
      <attribute name='name' />
      <attribute name='assemblyname' />
      <attribute name='version' />
      <attribute name='plugintypeid' />
      <attribute name='typename' />
    </link-entity>
  </entity>
</fetch>

Mais informações: Usar o SQL para consultar dados (versão prévia)

SELECT api.customapiid,
       api.uniquename,
       api.allowedcustomprocessingsteptype,
       api.bindingtype,
       api.boundentitylogicalname,
       api.description,
       api.displayname,
       api.executeprivilegename,
       api.iscustomizable,
       api.isfunction,
       api.isprivate,
       api.workflowsdkstepenabled,
       req.customapirequestparameterid,
       req.uniquename,
       req.name,
       req.description,
       req.displayname,
       req.type,
       req.logicalentityname,
       req.iscustomizable,
       req.isoptional,
       resp.customapiresponsepropertyid,
       resp.uniquename,
       resp.name,
       resp.description,
       resp.iscustomizable,
       resp.type,
       resp.logicalentityname,
       type.plugintypeid,
       type.typename,
       type.version,
       type.name,
       type.assemblyname
FROM   customapi AS api
       LEFT JOIN
       customapirequestparameter AS req
       ON api.customapiid = req.customapiid
       LEFT JOIN
       customapiresponseproperty AS resp
       ON api.customapiid = resp.customapiid
       LEFT JOIN
       plugintype AS type
       ON api.plugintypeid = type.plugintypeid

Colunas de tabela de API personalizadas

A tabela a seguir inclui colunas selecionadas de uma tabela de API personalizada que você pode definir.

Nome de exibição Nome do esquema Nome Lógico	Tipo	Description
Tipo de Etapa de Processamento Personalizada Permitido `AllowedCustomProcessingStepType` `allowedcustomprocessingsteptype`	Opção Lista de seleção	Valor: 0 Rótulo: Nenhum Significado: nenhuma etapa de processamento personalizada permitida. Valor: 1 Rótulo: Somente Assíncrono Significado: somente etapas de processamento personalizadas assíncronas permitidas Valor: 2 Rótulo: Síncrono e Assíncrono Ou seja: nenhuma restrição. Plug-ins de terceiros podem adicionar lógica síncrona para alterar o comportamento da mensagem. Consulte Selecionar um tipo de etapa de processamento personalizado Não é possível alterar depois que ele é salvo.
Tipo de Associação `BindingType` `bindingtype`	Opção Lista de seleção	Valor: 0 Rótulo: Global Valor: 1 Rótulo: Entidade Valor: 2 Etiqueta: EntityCollection Consulte Selecionar um Tipo de Vinculação Não é possível alterar depois que ele é salvo.
Nome Lógico da Entidade Associada `BoundEntityLogicalName` `boundentitylogicalname`	Texto String	O nome lógico da tabela vinculada à API personalizada se ela não for Global. Não é possível alterar depois que ele é salvo.
API personalizada `CustomAPIId` `customapiid`	Identificador Exclusivo Guid	Identificador exclusivo para instâncias de API personalizadas Não é possível alterar depois que ele é salvo.
Descrição `Description` `description`	Texto String	Descrição localizada para esta API personalizada. Use esse valor quando a mensagem estiver visível em um aplicativo. Por exemplo, como uma Dica de Ferramenta.
Nome de Exibição `DisplayName` `displayname`	Texto String	Nome de exibição localizado para esta API personalizada. Use esse valor quando a mensagem estiver visível em um aplicativo.
Executar Nome do Privilégio `ExecutePrivilegeName` `executeprivilegename`	Texto String	(Opcional) Nome do privilégio que permite a execução da API personalizada. Veja: Proteger sua API personalizada exigindo um privilégio
É Personalizável `IsCustomizable` `iscustomizable`	ManagedProperty	Se a API personalizada pode ser personalizada ou excluída quando parte de uma solução gerenciada.
É Função `IsFunction` `isfunction`	Sim/Não booleano	Valor: 0 Rótulo: Não Valor: 1 Rótulo: Sim Ver quando criar uma função Não é possível alterar depois que ele é salvo.
É Particular `IsPrivate` `isprivate`	Sim/Não booleano	Valor: 0 Rótulo: Não Valor: 1 Rótulo: Sim Veja quando tornar sua API personalizada privada
Nome `Name` `name`	Texto String	O nome principal da API personalizada. Esse valor é exibido na lista de APIs personalizadas quando exibido na solução.
Owner `OwnerId` `ownerid`	Proprietário	Uma referência ao usuário ou à equipe que possui a API.
Tipo de Plug-in `PluginTypeId` `plugintypeid`	Pesquisar	Uma referência ao tipo de plug-in que fornece a operação principal para essa API personalizada. Veja: Usar um plug-in para incluir lógica em sua API personalizada
Nome exclusivo `UniqueName` `uniquename`	Texto String	Nome exclusivo para a API personalizada. Esse valor é o nome da mensagem criada. Esse valor deve incluir um prefixo de personalização que corresponda ao conjunto de prefixos do editor de soluções. Esse valor não pode conter caracteres especiais. Não é possível alterar depois que ele é salvo.
Habilitada para Fluxo de Trabalho `WorkflowSdkStepEnabled` `workflowsdkstepenabled`	Sim/Não booleano	Indica se a API personalizada está habilitada como uma ação de fluxo de trabalho. Veja: Usar uma API personalizada em um fluxo de trabalho Não é possível alterar depois que ele é salvo.

Colunas da tabela CustomAPIRequestParameter

Uma API personalizada não precisa ter parâmetros. Não há nenhuma ordem especificada para os parâmetros. Eles são identificados pelo nome.

Um parâmetro está relacionado a uma única API personalizada. Você não pode definir várias APIs personalizadas para usar a mesma definição de parâmetro. Você pode definir vários parâmetros de solicitação com o mesmo UniqueName valor se eles forem usados por APIs personalizadas diferentes.

Observação

Se você definir uma tabela vinculada para sua API personalizada, o parâmetro da solicitação será gerado para você. Você não precisa criar um parâmetro de entrada para a tabela quando a API personalizada está associada a uma tabela. Mais informações: Selecionar um tipo de associação

A tabela a seguir inclui colunas (atributos) da tabela parâmetro de solicitação de API personalizada que você pode definir.

Nome de exibição Nome do esquema Nome Lógico	Tipo	Description
Parâmetro de solicitação de API personalizada `CustomAPIRequestParameterId` `customapirequestparameterid`	Identificador Exclusivo Guid	Identificador exclusivo das instâncias de parâmetro da API personalizada. Não é possível alterar depois que ele é salvo.
API personalizada `CustomAPIId` `customapiid`	Pesquisar	Identificador exclusivo para a API personalizada à qual esse parâmetro de solicitação de API personalizada está associado. Não é possível alterar depois que ele é salvo.
Descrição `Description` `description`	Texto String	Descrição localizada para instâncias de parâmetro de solicitação de API personalizadas. Use esse valor quando o parâmetro de mensagem estiver visível em um aplicativo. Por exemplo, como um Tooltip.
Nome de Exibição `DisplayName` `displayname`	Texto String	Nome de exibição localizado para instâncias de parâmetros personalizados de solicitação de API. Use esse valor quando o parâmetro de mensagem estiver visível em um aplicativo.
É Personalizável `IsCustomizable` `iscustomizable`	ManagedProperty	Se o parâmetro de solicitação de API personalizado pode ser personalizado ou excluído quando parte de uma solução gerenciada. Consulte Customização da API
É Opcional `IsOptional` `isoptional`	Sim/Não booleano	Indica se o parâmetro de solicitação de API personalizada é opcional. Se não for opcional, será necessário passar um valor para esse parâmetro ao usar a mensagem. Valor: 0 Rótulo: Não Valor: 1 Rótulo: Sim Não é possível alterar depois que ele é salvo.
Nome da entidade lógica `LogicalEntityName` `logicalentityname`	Texto String	O nome lógico da tabela associada ao parâmetro de solicitação de API personalizada. Não é possível alterar depois que ele é salvo.
Nome `Name` `name`	Texto String	O nome principal do parâmetro de solicitação de API personalizada. Esse valor é exibido na lista de parâmetros de solicitação de API personalizados quando exibido na solução. Use esse valor para diferenciar esse parâmetro de outras pessoas que compartilham um Nome Exclusivo comum. Essa convenção de nomenclatura é recomendada: `{custom API Unique Name}.{Parameter UniqueName}`
Owner `OwnerId` `ownerid`	Proprietário	Uma referência ao usuário ou à equipe que possui a API.
Tipo `Type` `type`	Opção Lista de seleção	O tipo de dados do parâmetro de solicitação de API personalizada. Valor: 0 Rótulo: Boolean Valor: 1 Rótulo: DateTime Valor: 2 Etiqueta: Decimal Valor: 3 Rótulo: Entidade Valor: 4 Etiqueta: EntityCollection Valor: 5 Rótulo: EntityReference Valor: 6 Rótulo: Flutuante Valor: 7 Rótulo: Inteiro Valor: 8 Rótulo: Dinheiro Valor: 9 Rótulo: Lista de seleção Valor: 10 Rótulo: Cadeia de caracteres Valor: 11 Rótulo: StringArray Valor: 12 Rótulo: Guid Não é possível alterar depois que ele é salvo.
Nome exclusivo `UniqueName` `uniquename`	Texto String	Nome exclusivo para o parâmetro de solicitação de API personalizada. Esse valor é o nome do parâmetro quando você chama a API personalizada. Esse valor não pode conter caracteres especiais. Não é possível alterar depois que ele é salvo.

Colunas da tabela CustomAPIResponseProperty

O objeto retornado para sua mensagem de API personalizada inclui todas as propriedades de resposta que você definir. Não é necessário que uma AÇÃO de API personalizada retorne qualquer valor, mas deve retornar um valor se definido como uma função.

Se houver apenas uma única propriedade de resposta Entity ou EntityCollection definida, a resposta será desse tipo. Se houver vários parâmetros ou um ou mais parâmetros de um tipo simples, a API retornará um tipo complexo em que cada propriedade de resposta é uma propriedade desse tipo complexo.

Por exemplo, se o nome exclusivo da API personalizada for sample_CustomAPIExample, ele retornará um tipo complexo nomeado sample_CustomAPIExampleResponse com propriedades para cada propriedade de resposta que você definir.

A tabela a seguir inclui colunas, como atributos, da tabela de propriedades de resposta de API personalizada que você pode definir.

Nome de exibição Nome do esquema Nome Lógico	Tipo	Description
Propriedade de resposta de API personalizada `CustomAPIResponsePropertyId` `customapiresponsepropertyid`	Identificador Exclusivo Guid	Identificador exclusivo das instâncias de propriedade da resposta da API personalizada. Não é possível alterar depois que ele é salvo.
API personalizada `CustomAPIId` `customapiid`	Pesquisar	Identificador exclusivo para a API personalizada à qual essa propriedade de resposta de API personalizada está associada. Não é possível alterar depois que ele é salvo.
Descrição `Description` `description`	Texto String	Descrição traduzida para instâncias de propriedade da resposta da API personalizada. Use esse valor quando o parâmetro de mensagem estiver visível em um aplicativo. Por exemplo, como um Tooltip.
Nome de Exibição `DisplayName` `displayname`	Texto String	Nome de exibição localizado para instâncias de propriedade de resposta de API personalizadas. Use esse valor quando o parâmetro de mensagem estiver visível em um aplicativo.
É Personalizável `IsCustomizable` `iscustomizable`	ManagedProperty	Se a propriedade de resposta da API personalizada pode ser modificada ou excluída quando parte de uma solução gerenciada.
Nome da entidade lógica `LogicalEntityName` `logicalentityname`	Texto String	Quando Entity ou EntityReference são selecionados como o Tipo, você pode especificar o nome lógico da tabela associada à propriedade de resposta da API personalizada. Você não pode especificar um Nome de Entidade Lógica ao escolher EntityCollection como o Tipo. Não é possível alterar depois que ele é salvo.
Nome `Name` `name`	String	O nome principal da propriedade da resposta da API personalizada. Esse valor é exibido na lista de parâmetros de solicitação de API personalizados quando exibido na solução. Use esse valor para diferenciar esse parâmetro de outras pessoas que compartilham um Nome Exclusivo comum. Essa convenção de nomenclatura é recomendada: `{custom API Unique Name}.{Property UniqueName}`
Owner `OwnerId` `ownerid`	Proprietário	Uma referência ao usuário ou à equipe que possui a API.
Tipo `Type` `type`	Lista de seleção	O tipo de dados da propriedade de resposta da API personalizada Valor: 0 Rótulo: Boolean Valor: 1 Rótulo: DateTime Valor: 2 Rótulo: Decimal Valor: 3 Rótulo: Entidade Valor: 4 Etiqueta: EntityCollection Valor: 5 Rótulo: EntityReference Valor: 6 Rótulo: Flutuante Valor: 7 Rótulo: Inteiro Valor: 8 Rótulo: Dinheiro Valor: 9 Rótulo: Lista de seleção Valor: 10 Rótulo: Cadeia de caracteres Valor: 11 Rótulo: StringArray Valor: 12 Rótulo: Guid Não é possível alterar depois que ele é salvo.
Nome exclusivo `UniqueName` `uniquename`	Texto String	Nome exclusivo para a propriedade de resposta da API personalizada. Esse valor é o nome do parâmetro quando você chama a API personalizada. Esse valor não pode conter caracteres especiais. Não é possível alterar depois que ele é salvo.

Consulte também

Criar e usar APIs personalizadas
Criar uma API personalizada usando a ferramenta de registro de plug-in
Criar uma API personalizada no Power Apps
Criar uma API personalizada com código
Criar uma API personalizada com arquivos de solução
Criar suas próprias mensagens

Comentários

Esta página foi útil?

Last updated on 2026-01-19