Skip to main content

CustomApiParameterAttribute

  • Namespace: PPDS.Plugins
  • Assembly: PPDS.Plugins
  • Kind: Class
  • Base: Attribute

Summary​

Defines a request or response parameter for a Custom API. Apply multiple times to a plugin class to define all input and output parameters. Must be used together with PPDS.Plugins.CustomApiAttribute.

Members​

Constructors​

CustomApiParameterAttribute()​

CustomApiParameterAttribute()

Initializes a new instance of the CustomApiParameterAttribute class.

Properties​

Description​

string Description { get; set; }

Gets or sets a description of the parameter. Stored as metadata in Dataverse.

Direction​

ParameterDirection Direction { get; set; }

Gets or sets whether this is an input (request) or output (response) parameter. Default: Input.

DisplayName​

string DisplayName { get; set; }

Gets or sets the display name of the parameter shown in the Dataverse UI. If not specified, the Name is used.

IsOptional​

bool IsOptional { get; set; }

Gets or sets whether the parameter is optional. Optional parameters do not need to be provided when invoking the API. Default: false (required).

LogicalEntityName​

string LogicalEntityName { get; set; }

Gets or sets the logical name of the entity for EntityReference parameters. Required when Type is EntityReference, Entity, or EntityCollection.

Name​

string Name { get; set; }

Gets or sets the logical name of the parameter used in code. Required.

Type​

ApiParameterType Type { get; set; }

Gets or sets the data type of the parameter. Required.

UniqueName​

string UniqueName { get; set; }

Gets or sets the unique name of the parameter including the publisher prefix. If not specified, the Name is used.