list_supp_obj_fields_m
Summary
| API Name | list_supp_obj_fields_m |
|---|---|
| Class | administration_services_m |
| Update Version | 5.6 |
Description
List product fields
Inputs
| Name | Type | Length | Required | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| client_no | long | 12 | Yes |
Aria-assigned unique identifier indicating the Aria client providing service to this account. |
||||||
| auth_key | string | 32 | Yes |
Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor. |
||||||
| field_selection | object | Yes |
The field_selection associated with this method. |
|||||||
| field_categories | object | Yes |
The field_categories associated with this method. |
|||||||
| locale_no | long | 38 | No |
Aria-assigned unique identifier of the locale used for translations. Alternative field: locale_name |
||||||
| locale_name | string | 32 | No |
Name of the locale to which the translations belong. Alternative field: locale_no |
||||||
| include_translations | string | 5 | No |
Setting this flag as True will fetch the translated fields in all the locales defined. If not passed it defaults to False. Allowed values:
|
field_selection fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| field_no | long | 100 | No |
Specifies the field no Alternative field: field_name |
| field_name | string | 100 | No |
Specifies the field name Alternative field: field_no |
field_categories fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| field_category_no | long | 100 | No |
Specifies the field category no Alternative field: field_category_name |
| field_category_name | string | 100 | No |
Specifies the field category name Alternative field: field_category_no |
Outputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| error_code | long | No |
Aria-assigned error identifier. 0 indicates no error |
|
| error_msg | string | No |
Textual description of any error that occurred. "OK" if there was no error. |
|
| field_details | object | No |
List of fields |
field_details.field_categories fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| field_category_no | long | No | ||
| field_category_name | string | No |
field_details.object_values fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| ObjectType | string | No |
The type of object |
|
| ObjectId | long | No |
The system defined ID of the object (e.g. plan_no) |
|
| ValueText | string | No |
The value associated with this object |
|
| Primacy | string | No |
The field value definition order |
field_details.supp_obj_field_translations.allowed_values_t fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| value | string | No |
Specifies the allowed value |
field_details.supp_obj_field_translations fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| locale_name | string | 32 | No |
Name of the locale to which the translations belong. Alternative field: locale_no |
| locale_no | long | 38 | No |
Aria-assigned unique identifier of the locale used for translations. Alternative field: locale_name |
| field_no | long | No |
The system defined ID of the field |
|
| field_name | string | No |
The client defined ID of the field |
|
| description | string | No |
The description provided for the field |
|
| allowed_values_t | object | No |
List of allowed values for this field |
field_details fields
| Name | Type | Length | Required | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| field_no | long | No |
The system defined ID of the field |
|||||||||
| field_name | string | No |
The client defined ID of the field |
|||||||||
| description | string | No |
The description provided for the field |
|||||||||
| datatype | string | No |
The type of data that this field will store |
|||||||||
| min_no_sel | string | No |
The minimum number of values that can be entered for this field |
|||||||||
| max_no_sel | string | No |
The maximum number of values that can be entered for this field |
|||||||||
| form_input_type | string | No |
The type of input to present for this field |
|||||||||
| allowed_values | string | No |
A hash array of values that are allowed to be input for this field |
|||||||||
| associated_types | string | No |
A string array of object types that can be associated |
|||||||||
| required_in_types | string | No |
A string array of object types that are required |
|||||||||
| field_categories | object | No |
The same array as above, except both fields will be populated |
|||||||||
| object_values | object | No |
The object_values associated with this method. |
|||||||||
| allow_instance_override | int | No |
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. Allowed values:
|
|||||||||
| supp_obj_field_translations | object | No |
Array that contains all the translated values for a given locale |