Use this tab to define the fields you want to send through the API endpoint using a custom menu item.
Use the Field Definitions tab toolbar to display the grid's contents or to insert or delete rows in the grid.
Option |
Description |
API Field Mapping |
Click the drop-down arrow to display the following options:
|
Insert |
Click this option to add a new row below the currently selected row. |
Delete |
Click this option to delete the currently selected row. |
Use the Field Definitions tab to define the fields for a custom menu item. All of these fields are required.
Field |
Description |
Field Label |
Use this field to specify a name for the field. You can enter up to 50 characters. |
API Property Name |
Use this field to specify the name that reflects a property or argument for the API endpoint. You can enter up to 60 characters. This must be unique for each API field row; otherwise, PM Compass will display the message "API Property Name must be unique" when you click the OK button. |
Required |
Use this checkbox to specify whether the field is required. By default, this checkbox is selected. |
Data Type |
Use this field to specify the data type of the API field. Your options are:
By default, this field is set to Character, allowing you to enter up to 200 characters. |
Param Type |
Use this field to specify the type of parameter used to pass data to an API endpoint. Your options are:
By default, this field is set to Body. |