Config

List all additional attributes

Work with additional attributes of Customer profile.Returns a list of Customer profile additional attributes.

get/portal/profile/additional-attributes

Request

  • Base URL: https://demo.splynx.com/api/2.0
  • URL: https://demo.splynx.com/api/2.0/portal/profile/additional-attributes
  • Auth: HTTP basic

Response

namestring required

Field name

titlestring required

Field title

typestring required

Type. Values: 'string' for 'String', 'integer' for 'Integer', 'decimal' for 'Decimal', 'numeric' for 'Numeric', 'date' for 'Date', 'datetime' for 'Datetime', 'boolean' for 'Boolean', 'select' for 'Select', 'select_multiple' for 'Select multiple', 'password' for 'Password', 'file' for 'File', 'relation' for 'Relation' and 'relation_multiple' for 'Relation multiple'

positionnumber

Position

default_valuestring

Default value

min_lengthstring

Min

max_lengthstring

Max

is_requirednumber required

Required. Values: 0 or 1

is_uniquenumber required

Unique. Values: 0 or 1

is_addnumber required

Add. Values: 0 or 1

show_in_listnumber required

Show in list. Values: 0 or 1

searchablenumber required

Searchable. Values: 0 or 1

readonlynumber required

Readonly. Values: 0 or 1

disablednumber required

Disabled. Values: 0 or 1

hiddennumber

Hidden. Values: 0 or 1

select_valuesstring

Select values separated by comma. Required for AF with select types

relation_modulestring

Relation module name. Can be any of modules (look in Parameters). Required for AF with select types

set_default_valuenumber

Set default value for all items. Values: 0 or 1

addonstring

Addon

addon_uristring

Addon URI

addon_input_typestring

Addon input type. Values: '', 'button', 'text', 'text_plus_button'. Default: ''

decimalsnumber

Decimals. Default: 2. Required for AF with decimal type

valuesstring[]

Allowed actions for customer with this attribute

can_be_editedboolean

Whether this attribute can be edited

Example response

[
  {
    "name": "remark",
    "title": "Remark",
    "type": "string",
    "position": 1,
    "default_value": "none",
    "min_length": "1",
    "max_length": "128",
    "is_required": 0,
    "is_unique": 0,
    "is_add": 1,
    "show_in_list": 0,
    "searchable": 0,
    "readonly": 0,
    "disabled": 0,
    "hidden": 0,
    "select_values": "",
    "relation_module": "",
    "set_default_value": 1,
    "addon": "",
    "addon_uri": "",
    "addon_input_type": "",
    "decimals": 2,
    "values": [
      "view",
      "edit"
    ],
    "can_be_edited": true
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.