CustomAPIRequestParameter Table Columns

Note

Unsure about entity vs. table? See Developers: Understand terminology in Microsoft Dataverse.

A custom API isn’t required to have any parameters. There is no specified order for the parameters, they are identified by name.

A parameter is related to a single Custom API. You cannot define multiple Custom APIs to use the same parameter definition. You can define multiple request parameter with the same UniqueName value if they are used by different Custom APIs.

Note

If you define a bound table for your Custom API, the request parameter will be generated for you. You don’t need to create an input parameter for the table when the Custom API is bound to a table.

If you bind your Custom API to a table (entity) collection, there will not be a request parameter generated for you. Binding a Custom API to a entity collection requires that the Custom API be called using the entityset resource path.

Binding to an entity collection only sets the expectation that the scope of the operation will apply more than one table of that type, or that it will return a collection of that type. It does not provide an entity collection input parameter for your plug-in to process.

The table shown below includes columns (attributes) of the Custom API Request Parameter table that you can set.

Display Name
Schema Name
Logical Name
Type Description
Custom API Request Parameter
CustomAPIRequestParameterId
customapirequestparameterid
Unique Identifier
Guid
Unique identifier for custom API request parameter instances.
Cannot be changed after it is saved.
Custom API
CustomAPIId
customapiid
Lookup Unique identifier for the custom API that this custom API request parameter is associated with.
Cannot be changed after it is saved.
Description
Description
description
Text
String
Localized description for custom API request parameter instances. For use when the message parameter is exposed to be called in an app. For example, as a ToolTip.
Display Name
DisplayName
displayname
Text
String
Localized display name for custom API request parameter instances. For use when the message parameter is exposed to be called in an app.
Is Customizable
IsCustomizable
iscustomizable
ManagedProperty Whether the custom api request parameter can be customized or deleted when part of a managed solution.
Is Optional
IsOptional
isoptional
Yes/No
Boolean
Indicates if the custom API request parameter is optional. If it is not optional, it is required to pass a value for this parameter when using the message.
  • Value: 0 Label: No
  • Value: 1 Label: Yes
Cannot be changed after it is saved.
Logical Entity Name
LogicalEntityName
logicalentityname
Text
String
The logical name of the table bound to the custom API request parameter.
Cannot be changed after it is saved.
Name
Name
name
Text
String
The primary name of the custom API request parameter. This will display in the list of custom api request parameters when viewed in the solution. Use this to differentiate this parameter from others that share a common Unique Name.
This naming convention is recommended: {Custom API Unique Name}.{Parameter UniqueName}
Owner
OwnerId
ownerid
Owner A reference to the user or team that owns the API.
Type
Type
type
Choice
Picklist
The data type of the custom API request parameter.
  • Value: 0 Label: Boolean
  • Value: 1 Label: DateTime
  • Value: 2 Label: Decimal
  • Value: 3 Label: Entity
  • Value: 4 Label: EntityCollection
  • Value: 5 Label: EntityReference
  • Value: 6 Label: Float
  • Value: 7 Label: Integer
  • Value: 8 Label: Money
  • Value: 9 Label: Picklist
  • Value: 10 Label: String
  • Value: 11 Label: StringArray
  • Value: 12 Label: Guid
Cannot be changed after it is saved.
Unique Name
UniqueName
uniquename
Text
String
Unique name for the custom API request parameter. This will be the name of the parameter when you call the Custom API.
Cannot be changed after it is saved.

Note

Some values are not valid for update. They cannot be changed after the Custom API Request Parameter is saved. If you need to change one of these values, you must delete the Custom API Request Parameter and re-create it with the changes you want to make.

See also

CustomAPIRequestParameter table reference
Create and use Custom APIs
Create a Custom API with code
Create a Custom API with solution files
Create your own messages