Tablas CustomAPI

Artículo
03/14/2024

Los datos que definen las API personalizadas se encuentran en las siguientes tablas/entidades:

Las secciones de este artículo brindan información detallada sobre los valores de columna que usará con más frecuencia.

Columnas de tabla personalizadas
Columnas de la tabla CustomAPIRequestParameter
Columnas de la tabla CustomAPIResponseProperty

Este diagrama muestra cómo se relacionan las tablas con estas tablas y con otras:

Diagrama que muestra relaciones entre tablas.

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

Recuperar datos sobre API personalizadas

Puede utilizar las siguientes consultas para recuperar datos sobre 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: Usar SQL para consultar datos (Vista previa)

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

La tabla siguiente incluye columnas seleccionadas de una tabla de API personalizada que puede establecer.

Nombre Nombre de esquema Nombre lógico	Tipo	Descripción
Tipo de paso de procesamiento personalizado permitido `AllowedCustomProcessingStepType` `allowedcustomprocessingsteptype`	Opción Los atributos de lista desplegable	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 personalizados asincrónicos. Valor: 2 Etiqueta: sincrónico y asincrónico Sentido : Sin restricción. Los complementos de terceros pueden agregar lógica asincrónica para cambiar el comportamiento del mensaje. Consulte Seleccionar un tipo de paso de procesamiento personalizado No se pueden cambiar después de guardarlos.
Tipo de enlace `BindingType` `bindingtype`	Opción Los atributos de lista desplegable	Valor: 0 Etiqueta: Global Valor: 1 Etiqueta: Entity Valor: 2 Etiqueta: EntityCollection Consulte Seleccionar un tipo de enlace No se pueden cambiar después de guardarlos.
Nombre lógico de la entidad enlazada `BoundEntityLogicalName` `boundentitylogicalname`	Texto Cadena	El nombre lógico de la tabla vinculada a la API personalizada si no es Global. No se pueden cambiar después de guardarlos.
API personalizada `CustomAPIId` `customapiid`	Identificador único GUID	Identificador único de instancias de API personalizada No se pueden cambiar después de guardarlos.
Descripción `Description` `description`	Texto Cadena	Descripción localizada para esta API personalizada. Utilice este valor cuando el mensaje sea visible en una aplicación. Por ejemplo, como Información sobre herramientas.
Display Name `DisplayName` `displayname`	Texto Cadena	Nombre para mostrar localizado para esta API personalizada. Utilice este valor cuando el mensaje sea visible en una aplicación.
Nombre del privilegio de ejecución `ExecutePrivilegeName` `executeprivilegename`	Texto Cadena	(Opcional) Nombre del privilegio que permite la ejecución de la API personalizada. Consulte: Proteger su API personalizada con un privilegio
Is Customizable `IsCustomizable` `iscustomizable`	ManagedProperty	Si la API personalizada se puede personalizar o eliminar cuando forma parte de un solución administrada.
Is Function `IsFunction` `isfunction`	Sí/No Booleana	Valor: 0 Etiqueta: No Valor: 1 Etiqueta: Sí Consulte Cuándo crear una función No se pueden cambiar después de guardarlos.
Is Private `IsPrivate` `isprivate`	Sí/No Booleana	Valor: 0 Etiqueta: No Valor: 1 Etiqueta: Sí Consulte Cuándo hacer que su API personalizada sea privada
Name `Name` `name`	Texto Cadena	El nombre principal de la API personalizada. Este valor se muestra en la lista de API personalizadas cuando se visualice en la solución.
Propietario `OwnerId` `ownerid`	Owner	Una referencia al usuario o equipo propietario de la API.
Tipo de complemento `PluginTypeId` `plugintypeid`	Búsqueda	Una referencia al tipo de complemento que proporciona la operación principal de esta API personalizada. Consulte Usar un complemento para incluir lógica en la API personalizada
Unique Name `UniqueName` `uniquename`	Texto Cadena	Nombre único para la API personalizada. Este valor será el nombre del mensaje creado. Este valor debe incluir un prefijo de personalización que coincida con el prefijo establecido para su editor de soluciones. Este valor no puede contener caracteres especiales. No se pueden cambiar después de guardarlos.
Habilitada para flujo de trabajo `WorkflowSdkStepEnabled` `workflowsdkstepenabled`	Sí/No Booleana	Indica si la API personalizada está habilitada como una acción de flujo de trabajo. Consulte: Usar una API personalizada en un flujo de trabajo No se pueden cambiar después de guardarlos.

Columnas de la tabla CustomAPIRequestParameter

No se requiere que una API personalizada tenga parámetros. No hay un orden específico para los parámetros. Están identificados por su nombre.

Un parámetro está relacionado con una única API personalizada. No puede definir varias API personalizadas para utilizar la misma definición de parámetro. Puede definir varios parámetros de solicitud con el mismo valor UniqueName si los utilizan diferentes API personalizadas.

Nota

Si define una tabla vinculada para su acción de 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á vinculada a una tabla. Más información: Seleccionar un tipo de enlace

La tabla siguiente incluye columnas (atributos) de la tabla de parámetros de solicitud de API personalizada que puede establecer.

Nombre Nombre de esquema Nombre lógico	Tipo	Descripción
Parámetro de solicitud de API personalizada `CustomAPIRequestParameterId` `customapirequestparameterid`	Identificador único GUID	Identificador único de instancias del parámetro de solicitud de la API personalizada. No se pueden cambiar después de guardarlos.
API personalizada `CustomAPIId` `customapiid`	Lookup	Identificador único de la API personalizada con la que este parámetro de solicitud está asociado. No se pueden cambiar después de guardarlos.
Descripción `Description` `description`	Texto Cadena	Descripción localizada de instancias del parámetro de solicitud de la API personalizada. Utilice este valor cuando el parámetro del mensaje sea visible en una aplicación. Por ejemplo, como Información sobre herramientas.
Display Name `DisplayName` `displayname`	Texto Cadena	Nombre para mostrar localizado de instancias del parámetro de solicitud de la API personalizada. Utilice este valor cuando el parámetro del mensaje sea visible en una aplicación.
Is Customizable `IsCustomizable` `iscustomizable`	ManagedProperty	Si el parámetro de solicitud de API personalizada se puede personalizar o eliminar cuando forma parte de un solución administrada. Ver Personalización de API personalizada
Is Optional `IsOptional` `isoptional`	Sí/No Booleana	Indica si el parámetro de solicitud de la API personalizada es opcional. Si no es opcional, es necesario pasar un valor para este parámetro al usar el mensaje. Valor: 0 Etiqueta: No Valor: 1 Etiqueta: Sí No se pueden cambiar después de guardarlos.
Nombre lógico de entidad `LogicalEntityName` `logicalentityname`	Texto Cadena	Nombre lógico de la tabla enlazada al parámetro de solicitud de la API personalizada. No se pueden cambiar después de guardarlos.
Nombre `Name` `name`	Texto Cadena	Nombre principal del parámetro de solicitud de la API personalizada. Este valor se muestra en la lista de parámetros de solicitud de API personalizadas cuando se visualice en la solución. Utilice 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}`
Propietario `OwnerId` `ownerid`	Propietario	Una referencia al usuario o equipo propietario de la API.
Tipo `Type` `type`	Opción Picklist	Tipo de datos del parámetro de solicitud de la API personalizada. Valor: 0 Etiqueta: Booleano Valor: 1 Etiqueta: DateTime Valor: 2 Etiqueta: Decimal Valor: 3 Etiqueta: entidad Valor: 4 Etiqueta: EntityCollection Valor: 5 Etiqueta: EntityReference Valor: 6 Etiqueta: Float 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 pueden cambiar después de guardarlos.
Nombre único `UniqueName` `uniquename`	Texto Cadena	Nombre único del parámetro de solicitud de la API personalizada. Este valor es el nombre del parámetro cuando llame a la API personalizada. Este valor no puede contener caracteres especiales. No se pueden cambiar después de guardarlos.

Columnas de la tabla CustomAPIResponseProperty

El objeto devuelto para su mensaje de API personalizada 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 más 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 su API personalizada es sample_CustomAPIExample, devuelve un tipo complejo llamado sample_CustomAPIExampleResponse con propiedades para cada propiedad de respuesta que defina.

La tabla siguiente incluye columnas (atributos) seleccionados de una tabla de propiedad de respuesta de API personalizada.

Nombre Nombre de esquema Nombre lógico	Tipo	Descripción
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 pueden cambiar después de guardarlos.
API personalizada `CustomAPIId` `customapiid`	Lookup	Identificador único de la API personalizada con la que esta propiedad de respuesta está asociada. No se pueden cambiar después de guardarlos.
Descripción `Description` `description`	Texto Cadena	Descripción localizada para instancias de la propiedad de respuesta de la API personalizada. Utilice este valor cuando el parámetro del mensaje sea visible en una aplicación. Por ejemplo, como Información sobre herramientas.
Display Name `DisplayName` `displayname`	Texto Cadena	Nombre para mostrar localizado para instancias de la propiedad de respuesta de la API personalizada. Utilice este valor cuando el parámetro del mensaje sea visible en una aplicación.
Is Customizable `IsCustomizable` `iscustomizable`	ManagedProperty	Si la propiedad de respuesta de API personalizada se puede personalizar o eliminar cuando forma parte de un solución administrada.
Logical Entity Name `LogicalEntityName` `logicalentityname`	Texto Cadena	Cuando Entity o EntityReference se seleccionan como Type, puede especificar el nombre lógico de la tabla vinculada a la propiedad de respuesta de la API personalizada. No puede especificar un Nombre de entidad lógica cuando elige EntityCollection como Tipo. No se pueden cambiar después de guardarlos.
Name `Name` `name`	Cadena	Nombre principal de la propiedad de respuesta de la API personalizada. Este valor se muestra en la lista de parámetros de solicitud de API personalizadas cuando se visualice en la solución. Utilice 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}`
Propietario `OwnerId` `ownerid`	Propietario	Una referencia al usuario o equipo propietario de la API.
Tipo `Type` `type`	Picklist	Tipo de datos de la propiedad de respuesta de la API personalizada Valor: 0 Etiqueta: Booleano Valor: 1 Etiqueta: DateTime Valor: 2 Etiqueta: Decimal Valor: 3 Etiqueta: entidad Valor: 4 Etiqueta: EntityCollection Valor: 5 Etiqueta: EntityReference Valor: 6 Etiqueta: Float 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 pueden cambiar después de guardarlos.
Nombre único `UniqueName` `uniquename`	Texto Cadena	Nombre único de la propiedad de respuesta de la API personalizada. Este valor es el nombre del parámetro cuando llame a la API personalizada. Este valor no puede contener caracteres especiales. No se pueden cambiar después de guardarlos.

Consulte también

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

Nota

¿Puede indicarnos sus preferencias de idioma de documentación? Realice una breve encuesta. (tenga en cuenta que esta encuesta está en inglés)

La encuesta durará unos siete minutos. No se recopilan datos personales (declaración de privacidad).

Compartir a través de