Home > Aria Crescendo Documentation > Aria Crescendo admintools api > create_supp_obj_field_m
create_supp_obj_field_m
create_supp_obj_field_m
Creates a supplemental product field for specified client.
Input Arguments
| Req | Field Name | Field Type | Max Length | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
 |
client_no | long | 22 | Aria-assigned unique identifier indicating the Aria client providing service to this account. | ||||||||
|
auth_key | string | 32 | Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor. | ||||||||
|
field_name | string | 300 | Name of the product field. Translatable. | ||||||||
| description | string | 3000 | Description of the product field. Translatable. | |||||||||
| min_no_sel | string | Minimum number of selections | ||||||||||
| max_no_sel | int | Maximum number of selections allowed | ||||||||||
| datatype | string | 30 | date, number, string | |||||||||
| form_input_type | string | 10 | checkbox, radio, select, text, textarea | |||||||||
| use_allowed_vals_ind | string | 1 | Allowed values for specific datatype. Eg Yes/No for Radio form_input_type | |||||||||
| option_value | string | 1000 | Values that are passed as options. The options should be | separated. Eg: 1|2|3 | |||||||||
| option_value_order | string | The order in which the values should be set. The options should be | separated. Eg: 1|2|3 | ||||||||||
| allow_instance_override | int | Specifies whether the product field should be saved on the product catalog or plan instance or the plan unit instance. Currently only be honored for "Plan" type fields.
Allowable values for allow_instance_override:
|
||||||||||
| assign_field_categories | array | |||||||||||
 field_category_no |
int | 100 | Specifies the field category no | |||||||||
| OR | ||||||||||||
| field_category_name |
string | 100 | Specifies the field category name | |||||||||
| field_category_directive |
int | 100 | Specifies the field category directive. 1 to add and 2 to remove an field category | |||||||||
| object_type | string array | Object Types - Plan, Inventory Item, Service Code, Usage Type |
Output Arguments
| Field Name | Field Type | Description |
|---|---|---|
| error_code | long | Aria-assigned error identifier. 0 indicates no error |
| error_msg | string | Textual description of any error that occurred. "OK" if there was no error. |
| field_no | string | Aria assigned unique number to identify this field |
- © Copyright 2023 Aria Developer Central