Skip to main content

ApiParameterType

  • Namespace: PPDS.Plugins
  • Assembly: PPDS.Plugins
  • Kind: Enum
  • Implements: IComparable, IConvertible, IFormattable, ISpanFormattable

Summary​

Specifies the data type of a Custom API request or response parameter. These values correspond to the Dataverse Custom API parameter types.

Members​

Fields​

Boolean​

ApiParameterType Boolean

Boolean (0). A true/false value. Maps to the Dataverse Boolean type.

DateTime​

ApiParameterType DateTime

DateTime (1). A date and time value. Maps to the Dataverse DateTime type.

Decimal​

ApiParameterType Decimal

Decimal (2). A high-precision decimal number. Maps to the Dataverse Decimal type.

Entity​

ApiParameterType Entity

Entity (3). A single entity record. Maps to the Dataverse Entity type.

EntityCollection​

ApiParameterType EntityCollection

Entity collection (4). A collection of entity records. Maps to the Dataverse EntityCollection type.

EntityReference​

ApiParameterType EntityReference

Entity reference (5). A reference to a single entity record by logical name and ID. Maps to the Dataverse EntityReference type.

Float​

ApiParameterType Float

Float (6). A floating-point number. Maps to the Dataverse Float type.

Guid​

ApiParameterType Guid

Guid (12). A globally unique identifier. Maps to the Dataverse Guid type.

Integer​

ApiParameterType Integer

Integer (7). A whole number. Maps to the Dataverse Integer type.

Money​

ApiParameterType Money

Money (8). A monetary value with currency information. Maps to the Dataverse Money type.

Picklist​

ApiParameterType Picklist

Picklist (9). An option set value. Maps to the Dataverse OptionSetValue type.

String​

ApiParameterType String

String (10). A text value. Maps to the Dataverse String type.

StringArray​

ApiParameterType StringArray

String array (11). A collection of text values. Maps to the Dataverse StringArray type.