Acciones de la API web
En el documento $metadata de CSDL, encontrará elementos Action que describen operaciones que modifican datos.
Toda acción tiene un atributo Name. Este nombre formará parte de la URL cuando utilice HTTP``POST, enviando cualquier parámetro definido para la acción en el cuerpo de la solicitud. Más infomación: Usar acciones web API.
Acciones enlazadas
Las acciones pueden tener un atributo IsBound="true". Esto significa que es una acción enlazada. Las acciones sin el atributo IsBound están sin enlazar. Una acción enlazada significa que el primer parámetro es una referencia a un registro de tabla o a un conjunto de entidades.
Cuando se enlaza una acción, tendrá una referencia a un elemento específico dentro del espacio de nombres del servicio. Para utilizar la acción, debe utilizar el nombre completo, incluido el espacio de nombres Microsoft.Dynamics.CRM. Más información: Espacio de nombres de servicio.
Parámetros
Las acciones suelen tener uno o más elementos Parameter. Cada parámetro tendrá los siguientes atributos:
| Atributo | Descripción |
|---|---|
Name |
El nombre del parámetro. El nombre es único a menos que Action esté sobrecargado. Para obtener más información: consulte Acciones sobrecargadas. |
Type |
El tipo del parámetro. |
Nullable="false" |
Si el parámetro puede aceptar un valor NULL. |
ReturnType
Las acciones pueden devolver valores. Cuando una acción devuelve un valor, tendrá un elemento ReturnType.
| Atributo | Descripción |
|---|---|
Type |
El tipo del parámetro. |
Nullable="false" |
Si el valor puede ser NULL. |
Ejemplos de definición de la acción
Los ejemplos son casos ficticios de definiciones de Action que muestran diferentes patrones de enlace. Cada uno de estos ejemplos devuelve un valor entero.
Acciones sin enlazar
Una acción independiente con un solo parámetro Number entero.
<Action Name="UnBoundActionExample">
<Parameter Name="Number" Type="Edm.Int32" Nullable="false" />
<ReturnType Type="Edm.Int32" Nullable="false" />
</Action>
Acción enlazada a una entidad
Una acción enlazada a la entidad account con un parámetro Number entero.
<Action Name="EntityBoundActionExample" IsBound="true">
<Parameter Name="entity" Type="mscrm.account" Nullable="false" />
<Parameter Name="Number" Type="Edm.Int32" Nullable="false" />
<ReturnType Type="Edm.Int32" Nullable="false" />
</Action>
Acción enlazada a un conjunto de entidades
Una acción enlazada al EntitySet de account con un parámetro Number entero.
<Action Name="EntityCollectionBoundActionExample" IsBound="true">
<Parameter Name="entityset" Type="Collection(mscrm.account)" Nullable="false" />
<Parameter Name="Number" Type="Edm.Int32" Nullable="false" />
<ReturnType Type="Edm.Int32" Nullable="false" />
</Action>
Acciones sobrecargadas
Por lo general, cada acción que encuentre en $metadata será la única acción con ese nombre. Sin embargo, las acciones enlazadas pueden tener múltiples definiciones cuando están enlazadas a diferentes tipos. La acción AddItemCampaign incluida en la solución de marketing es un ejemplo. No puede crear una acción sobrecargada usando la API personalizada.
Para obtener más información: Reglas de acciones sobrecargadas.
Pasos siguientes
Obtenga información sobre las definiciones de funciones.
Consulte también
Tipos y operaciones de API web
Documentos de servicio de la API web
EntityTypes de la API web
Propiedades de API web
Propiedades de navegación de la API web
Funciones de la API web
Tipos complejos y de enumeración de API web
Usar la API web de Dataverse
Especificación de la acción OData 4.0
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).