Acciones de API web

En el documento $metadata CSDL, encontrará Action elementos que describen las operaciones que cambian los datos.

Cada acción tiene un Name atributo . Este nombre formará parte de la dirección URL cuando use HTTPPOST, enviando los parámetros definidos para la acción en el cuerpo de la solicitud. Más información: Usar acciones web API.

Acciones vinculadas

Las acciones pueden tener un IsBound="true" atributo . Esto significa que es una acción enlazada . Las acciones sin el IsBound atributo no están enlazados. 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 del servicio

Parámetros

Las acciones suelen tener uno o varios Parameter elementos. Cada parámetro tendrá los siguientes atributos:

Atributo	Description
Name	El nombre del parámetro. El nombre es único a menos que Action se sobrecargue. Más información: Acciones sobrecargadas.
Type	El tipo del parámetro.
Nullable="false"	Si el parámetro puede aceptar un valor NULL.

TipoDeRetorno

Las acciones pueden devolver valores. Cuando una acción devuelve un valor, tendrá un ReturnType elemento .

Atributo	Description
Type	El tipo del parámetro.
Nullable="false"	Si el valor puede ser NULL.

Ejemplos de definición de acciones

A continuación se muestran algunos ejemplos ficticios de definiciones que muestran diferentes patrones de Action enlace. Cada uno de estos ejemplos devuelve un valor entero.

Acciones sin enlazar

Una acción unbound con un único parámetro entero Number .

<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 account entidad con un único parámetro entero Number .

<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 account EntitySet con un único parámetro entero Number .

<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

Normalmente, cada acción que encuentre en el $metadata será la única acción con ese nombre. Sin embargo, las acciones enlazadas pueden tener varias definiciones cuando se enlazan a tipos diferentes. La AddItemCampaign acción incluida en la solución de marketing es un ejemplo. No se puede crear una acción sobrecargada mediante la API personalizada.

Más información: Reglas de sobrecarga de acciones

Pasos siguientes

Obtenga información sobre las definiciones de función.

Definiciones de función

Consulte también

Operaciones y tipos de API web
Documentos del servicio API web
Web API EntityTypes
Propiedades de api web
Propiedades de navegación de api web
Funciones de API web
Tipos complejos y enumeración de API web
Usar la API web de Dataverse
Especificación de acción de OData 4.0