External Name property

Official Content
This documentation is valid for:
Specifies the external name used when the variable is a service parameter.

Scope

Generators: Java, .NET, .NET Core
Level: Variable

Description

This property lets you define the name of the corresponding parameter to use in the service URL. If the property is not set, the default name for the parameter is the capitalized variable name.

It is available for the Java generator since GeneXus 17 Upgrade 5 and for the .NET and .NET Core generators since GeneXus 17 Upgrade 6.

Runtime/Design time

This property applies only at design-time.

Samples

This property is only valid for variables defined in API objects.

If you have an API object named "API1" and you have defined a GetCustomerDetails service that receives a CustomerNumber as a parameter:

GetCustomerDetail( in:&CustomerNumber, out:&CustomerInfo) =>  .....

To avoid using the full "CustomerNumber" as a parameter name, you can set the ExternalName property for the CustomerNumber variable:  ExternalName = number

The URL for the service call should be:

...API1/GetCustomerDetail?number=33

How to apply changes

To apply the corresponding changes when the property value is configured, execute a Build with this Only of the object.