Home > Aria Crescendo Documentation > Aria Crescendo admintools api > list_supp_obj_fields_m

list_supp_obj_fields_m

List product fields

Input Arguments

Req Field Name Field Type Max Length Description
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
required-icon.png field_selection array    
  brd_arrow.giffield_no int 100 Specifies the field no
  OR      
  brd_arrow.giffield_name string 100 Specifies the field name
required-icon.png field_categories array    
  brd_arrow.giffield_category_no int 100 Specifies the field category no
  OR      
  brd_arrow.giffield_category_name string 100 Specifies the field category name
  locale_no int 38 Aria-assigned unique identifier of the locale used for translations.
  OR      
  locale_name string 32 Name of the locale to which the translations belong.
  include_translations string 1 Setting this flag as True will fetch the translated fields in all the locales defined. If not passed it defaults to False.

Allowable values for include_translations:

Values Description
true Translated fields will be fetched in all the locales defined.
false Translation information will not be fetched.

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_details hash List of fields
brd_arrow.gif field_no int The system defined ID of the field
brd_arrow.gif field_name string The client defined ID of the field
brd_arrow.gif description string The description provided for the field
brd_arrow.gif datatype int The type of data that this field will store
brd_arrow.gif min_no_sel int The minimum number of values that can be entered for this field
brd_arrow.gif max_no_sel int The maximum number of values that can be entered for this field
brd_arrow.gif form_input_type string The type of input to present for this field
brd_arrow.gif allowed_values hash  
brd_arrow.gif value string A hash array of values that are allowed to be input for this field
brd_arrow.gif associated_types string A string array of object types that can be associated
brd_arrow.gif field_categories hash The same array as above, except both fields will be populated
brd_arrow.gif field_category_no int  
brd_arrow.gif field_category_name string  
brd_arrow.gif object_values hash  
brd_arrow.gif object_type string The type of object
brd_arrow.gif object_id long The system defined ID of the object (e.g. plan_no)
brd_arrow.gif value_text string The value associated with this object
brd_arrow.gif primacy long The field value definition order
brd_arrow.gif 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:

Values Description
0 For a plan in the product catalog
1 For a specific instance of a plan assigned to an account
2 For a specific unit of a plan assigned to an account
brd_arrow.gif supp_obj_field_translations hash Array that contains all the translated values for a given locale
brd_arrow.gif locale_name string Name of the locale
brd_arrow.gif locale_no int Aria-assigned unique identifier of the locale used for translations.
brd_arrow.gif field_no int The system defined ID of the field
brd_arrow.gif field_name string The client defined ID of the field
brd_arrow.gif description string The description provided for the field
brd_arrow.gif allowed_values_t hash List of allowed values for this field
brd_arrow.gif value string Specifies the allowed value
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®