Tablas de API personalizada

Los datos que definen las API personalizadas se incluyen en las tablas o entidades siguientes:

En las secciones de este artículo se proporciona información detallada sobre los valores de columna que se usan más.

columnas de tabla de API personalizadas
Columnas de tabla CustomAPIRequestParameter
Columnas de tabla CustomAPIResponseProperty

En este diagrama se muestra cómo las tablas están relacionadas con estas tablas y otras:

Diagrama que muestra las relaciones entre tablas.

La relación con la tabla CatalogAssignment permite el uso de una API personalizada con eventos de negocio de Microsoft Dataverse. Más información: Tablas Catalog y CatalogAssignment.

Recuperación de datos sobre las API personalizadas

Puede usar las siguientes consultas para recuperar datos sobre las API personalizadas.

Más información: Consulta de datos mediante la 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)

Más información: Crear consultas con 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();
}

Más información: Consultar datos mediante 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>

Más información: Uso de SQL para consultar datos (versión preliminar)

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

Columnas de tabla de API personalizadas

En la tabla siguiente se incluyen columnas seleccionadas de una tabla de API personalizada que puede establecer.

Nombre Nombre de esquema Nombre lógico	Tipo	Description
Tipo de paso de procesamiento personalizado permitido `AllowedCustomProcessingStepType` `allowedcustomprocessingsteptype`	Opción Lista de selección	Valor: 0 Etiqueta: Ninguna Significado: no se permiten pasos de procesamiento personalizados. Valor: 1 Etiqueta solo asincrónico Significado: Solo se permiten pasos de procesamiento personalizado asincrónicos Valor: 2 Etiqueta: Sincronización y asincronización Significado: Sin restricción. Los complementos de terceros pueden agregar lógica sincrónica para cambiar el comportamiento del mensaje. Consulte Seleccionar un tipo de paso de procesamiento personalizado. No se puede cambiar después de guardarlo.
Tipo de enlace `BindingType` `bindingtype`	Opción Lista de selección	Valor: 0 Etiqueta: Global Valor: 1 etiqueta: entidad Valor: 2 Etiqueta: ColecciónDeEntidades Consulte Seleccionar un tipo de enlace. No se puede cambiar después de guardarlo.
Nombre lógico de entidad enlazada `BoundEntityLogicalName` `boundentitylogicalname`	Mensaje de texto String	Nombre lógico de la tabla enlazada a la API personalizada si no es Global. No se puede cambiar después de guardarlo.
API personalizada `CustomAPIId` `customapiid`	Identificador único GUID	Identificador único para instancias de API personalizadas No se puede cambiar después de guardarlo.
Descripción `Description` `description`	Mensaje de texto String	Descripción localizada de esta API personalizada. Use este valor cuando el mensaje esté visible en una aplicación. Por ejemplo, como una sugerencia.
Nombre para mostrar `DisplayName` `displayname`	Mensaje de texto String	Nombre mostrado localmente para esta API personalizada. Use este valor cuando el mensaje esté visible en una aplicación.
Nombre del privilegio de ejecución `ExecutePrivilegeName` `executeprivilegename`	Mensaje de texto String	(Opcional) Nombre del privilegio que permite la ejecución de la API personalizada. Consulte: Protección de la API personalizada con un privilegio
Es personalizable `IsCustomizable` `iscustomizable`	ManagedProperty	Si la API personalizada se puede personalizar o eliminar cuando forma parte de una solución administrada.
Is Function `IsFunction` `isfunction`	Sí/No Boolean	Valor: 0 Etiqueta: No Valor: 1 Etiqueta: Sí Consulte Cuándo crear una función. No se puede cambiar después de guardarlo.
Is Private `IsPrivate` `isprivate`	Sí/No Boolean	Valor: 0 Etiqueta: No Valor: 1 Etiqueta: Sí Consulte Cuándo hacer que la API personalizada sea privada.
Nombre `Name` `name`	Mensaje de texto String	Nombre principal de la API personalizada. Este valor se muestra en la lista de API personalizadas cuando se ven en la solución.
Owner `OwnerId` `ownerid`	Propietario	Referencia al usuario o equipo que posee la API.
Tipo de complemento `PluginTypeId` `plugintypeid`	Lookup	Referencia al tipo de complemento que proporciona la operación principal para esta API personalizada. Consulte: Uso de un complemento para incluir lógica en la API personalizada
Nombre único `UniqueName` `uniquename`	Mensaje de texto String	Nombre único de la API personalizada. Este valor es el nombre del mensaje creado. Este valor debe incluir un prefijo de personalización que coincida con el prefijo establecido para el publicador de soluciones. Este valor no puede contener ningún carácter especial. No se puede cambiar después de guardarlo.
Habilitada para flujo de trabajo `WorkflowSdkStepEnabled` `workflowsdkstepenabled`	Sí/No Boolean	Indica si la API personalizada está habilitada como una acción de flujo de trabajo. Consulte: Uso de una API personalizada en un flujo de trabajo No se puede cambiar después de guardarlo.

Columnas de la tabla CustomAPIRequestParameter

No es necesario que una API personalizada tenga ningún parámetro. No hay ningún orden especificado para los parámetros. Se identifican por nombre.

Un parámetro está relacionado con una sola API personalizada. No se pueden definir varias API personalizadas para usar la misma definición de parámetro. Puede definir varios parámetros de solicitud con el mismo UniqueName valor si se usan en distintas API personalizadas.

Nota:

Si define una tabla enlazada para la API personalizada, el parámetro de solicitud se generará automáticamente. No es necesario crear un parámetro de entrada para la tabla cuando la API personalizada está enlazada a una tabla. Más información: Seleccionar un tipo de enlace

En la tabla siguiente se incluyen columnas (atributos) de la tabla de parámetros de solicitud de API personalizada que puede establecer.

Nombre Nombre de esquema Nombre lógico	Tipo	Description
Parámetro de solicitud de API personalizado `CustomAPIRequestParameterId` `customapirequestparameterid`	Identificador único GUID	Identificador único para instancias de parámetros de solicitud de API personalizadas. No se puede cambiar después de guardarlo.
API personalizada `CustomAPIId` `customapiid`	Lookup	Identificador único de la API personalizada a la que está asociado este parámetro de solicitud de API personalizada. No se puede cambiar después de guardarlo.
Descripción `Description` `description`	Mensaje de texto String	Descripción localizada de las instancias de parámetros de solicitud de API personalizadas. Use este valor cuando el parámetro de mensaje esté visible en una aplicación. Por ejemplo, como una sugerencia.
Nombre para mostrar `DisplayName` `displayname`	Mensaje de texto String	Nombre de visualización localizado para instancias de parámetros de solicitud de API personalizados. Use este valor cuando el parámetro de mensaje esté visible en una aplicación.
Es personalizable `IsCustomizable` `iscustomizable`	ManagedProperty	Si el parámetro de solicitud de API personalizada se puede personalizar o eliminar cuando forma parte de una solución administrada. Consulte Personalización de la API a medida.
Es opcional `IsOptional` `isoptional`	Sí/No Boolean	Indica si el parámetro de solicitud de API personalizada es opcional. Si no es opcional, es necesario pasar un valor para este parámetro cuando se usa el mensaje. Valor: 0 Etiqueta: No Valor: 1 Etiqueta: Sí No se puede cambiar después de guardarlo.
Nombre de entidad lógica `LogicalEntityName` `logicalentityname`	Mensaje de texto String	Nombre lógico de la tabla enlazada al parámetro de solicitud de API personalizada. No se puede cambiar después de guardarlo.
Nombre `Name` `name`	Mensaje de texto String	Nombre principal del parámetro de solicitud de API personalizada. Este valor se muestra en la lista de parámetros de solicitud de API personalizados al ser visto en la solución. Use este valor para diferenciar este parámetro de otros que comparten un nombre único común. Se recomienda esta convención de nomenclatura: `{custom API Unique Name}.{Parameter UniqueName}`
Owner `OwnerId` `ownerid`	Propietario	Referencia al usuario o equipo que posee la API.
Tipo `Type` `type`	Opción Lista de selección	Tipo de datos del parámetro de solicitud de API personalizada. Valor: 0 Etiqueta: Boolean Valor: 1 Etiqueta: DateTime Valor: 2 Etiqueta: Decimal Valor: 3 Etiqueta: Entidad Valor: 4 Etiqueta: EntityCollection Valor: 5 Etiqueta: EntityReference Valor: 6 Etiqueta: Flotante Valor: 7 Etiqueta: entero Valor: 8 Etiqueta: Dinero Valor: 9 Etiqueta: Lista de selección Valor: 10 Etiqueta: Cadena Valor: 11 Etiqueta: StringArray Valor: 12 Etiqueta: Guid No se puede cambiar después de guardarlo.
Nombre único `UniqueName` `uniquename`	Mensaje de texto String	Nombre único para el parámetro de solicitud de API personalizada. Este valor es el nombre del parámetro cuando se llama a la API personalizada. Este valor no puede contener ningún carácter especial. No se puede cambiar después de guardarlo.

Columnas de la tabla CustomAPIResponseProperty

El objeto devuelto para el mensaje de API personalizado incluye las propiedades de respuesta que defina. No es necesario que una acción de API personalizada devuelva ningún valor, pero debe devolver un valor si se define como una función.

Si solo hay una propiedad de respuesta Entity o EntityCollection definida, la respuesta es de ese tipo. Si hay varios parámetros, o uno o varios parámetros de un tipo simple, la API devuelve un tipo complejo donde cada propiedad de respuesta es una propiedad de ese tipo complejo.

Por ejemplo, si el nombre único de la API personalizada es sample_CustomAPIExample, devuelve un tipo complejo denominado sample_CustomAPIExampleResponse con propiedades para cada propiedad de respuesta que defina.

En la tabla siguiente se incluyen columnas (atributos) de la tabla de propiedades de respuesta de API personalizada que puede establecer.

Nombre Nombre de esquema Nombre lógico	Tipo	Description
Propiedad de respuesta de API personalizada `CustomAPIResponsePropertyId` `customapiresponsepropertyid`	Identificador único GUID	Identificador único de instancias de propiedad de respuesta de la API personalizada. No se puede cambiar después de guardarlo.
API personalizada `CustomAPIId` `customapiid`	Lookup	Identificador único de la API personalizada a la que está asociada esta propiedad de respuesta de API personalizada. No se puede cambiar después de guardarlo.
Descripción `Description` `description`	Mensaje de texto String	Descripción localizada de las instancias de propiedades de respuesta de API personalizada. Use este valor cuando el parámetro de mensaje esté visible en una aplicación. Por ejemplo, como una sugerencia.
Nombre para mostrar `DisplayName` `displayname`	Mensaje de texto String	Nombre para mostrar localizado para instancias de la propiedad de respuesta de la API personalizada. Use este valor cuando el parámetro de mensaje esté visible en una aplicación.
Es personalizable `IsCustomizable` `iscustomizable`	ManagedProperty	Si la propiedad de respuesta de api personalizada se puede personalizar o eliminar cuando forma parte de una solución administrada.
Nombre de entidad lógica `LogicalEntityName` `logicalentityname`	Mensaje de texto String	Cuando se selecciona Entity o EntityReference como Tipo, puede especificar el nombre lógico de la tabla vinculada a la propiedad de respuesta de la API personalizada. No se puede especificar un nombre de entidad lógica al elegir EntityCollection como Tipo. No se puede cambiar después de guardarlo.
Nombre `Name` `name`	String	Nombre principal de la propiedad de respuesta de la API personalizada. Este valor se muestra en la lista de parámetros personalizados de solicitud de API cuando se visualiza en la solución. Use este valor para diferenciar este parámetro de otros que comparten un nombre único común. Se recomienda esta convención de nomenclatura: `{custom API Unique Name}.{Property UniqueName}`
Owner `OwnerId` `ownerid`	Propietario	Referencia al usuario o equipo que posee la API.
Tipo `Type` `type`	Lista de selección	Tipo de datos de la propiedad de respuesta de API personalizada Valor: 0 Etiqueta: Boolean Valor: 1 Etiqueta: DateTime Valor: 2 Etiqueta: Decimal Valor: 3 Etiqueta: Entidad Valor: 4 Etiqueta: EntityCollection Valor: 5 Etiqueta: EntityReference Valor: 6 Etiqueta: Flotante Valor: 7 Etiqueta: entero Valor: 8 Etiqueta: Dinero Valor: 9 Etiqueta: Lista de selección Valor: 10 Etiqueta: Cadena Valor: 11 Etiqueta: StringArray Valor: 12 Etiqueta: Guid No se puede cambiar después de guardarlo.
Nombre único `UniqueName` `uniquename`	Mensaje de texto String	Nombre único de la propiedad de respuesta de API personalizada. Este valor es el nombre del parámetro cuando se llama a la API personalizada. Este valor no puede contener ningún carácter especial. No se puede cambiar después de guardarlo.

Consulte también

Crear y usar API personalizadas
Creación de una API personalizada mediante la herramienta de registro de complementos
Creación de una API personalizada en Power Apps
Creación de una API personalizada con código
Creación de una API personalizada con archivos de solución
Crear sus propios mensajes

Comentarios

¿Le ha resultado útil esta página?

Last updated on 2025-10-04