CustomAPIResponseProperty Table Columns

Note

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

The object returned for your Custom API message will include any response properties you define. It is not required for a Custom API Action to return any value, but it must return a value if defined as a Function.

Important

A Custom API that represents a function with no response properties is not valid and will not appear in the Web API $metadata service document. If you try to use it, you will get a 404 Not Found error similar to this:

{"error":{"code":"0x8006088a","message":"Resource not found for the segment 'your_function_name'."}}.

You must also set the data to be returned in the plug-in for the function. If no data is set to be returned by the plug-in, the operation will return 204 No Content.

If there is only a single Entity or EntityCollection response property defined, the response will be of that type. If there are multiple parameters, or one or more parameter of a simple type, the API will return a complex type where each response property will be a property of that complex type.

For example, if your Custom API Unique name is sample_CustomAPIExample, it will return a complex type named sample_CustomAPIExampleResponse with properties for each response property you define.

The table below includes columns (attributes) of the Custom API Response Property table that you can set.

Display Name
Schema Name
Logical Name
Type Description
Custom API Response Property
CustomAPIResponsePropertyId
customapiresponsepropertyid
Unique Identifier
Guid
Unique identifier for custom API response property instances.
Cannot be changed after it is saved.
Custom API
CustomAPIId
customapiid
Lookup Unique identifier for the custom API that this custom API response property is associated with.
Cannot be changed after it is saved.
Description
Description
description
Text
String
Localized description for custom API response property 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 response property instances. For use when the message parameter is exposed to be called in an app.
Is Customizable
IsCustomizable
iscustomizable
ManagedProperty Whether the custom api response property can be customized or deleted when part of a managed solution.
Logical Entity Name
LogicalEntityName
logicalentityname
Text
String
The logical name of the table bound to the custom API response property .
Cannot be changed after it is saved.
Name
Name
name
String The primary name of the custom API response property . 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}.{Property UniqueName}
Owner
OwnerId
ownerid
Owner A reference to the user or team that owns the API.
Type
Type
``
Picklist The data type of the custom API response property
  • 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 response property . 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 Response Property is saved. If you need to change one of these values, you must delete the Custom API Response Property and re-create it with the changes you want to make.

See also

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