crm.requisite.userfield.add

Scope: catalog Permissions to execute: for all

crm.requisite.userfield.add(fields)

Creates new user field for requisites.

System limitation for field name - 20 characters. Prefix UF_CRM_is always added to the user field name. As a result, the actual name length - 13 characters.

Parameters

Parameter Description

fields Set of fields - is an array (“updated field"=>”value”[, ...]), containing user file description. Full description of fields can be returned by calling crm.userfield.fields method.

LIST

Parameter	Description
fields	Set of fields - is an array (“updated field"=>”value”[, ...]), containing user file description. Full description of fields can be returned by calling crm.userfield.fields method.
LIST	Contains set of values for custom field List. Specified when creating/updating a field. Each value is an array containing fields: VALUE - list item value. Field is required when creating a new item. SORT - sorting. DEF - if Y, list item is a default value. A field with multiple values van have DEF=Y. For non-multiple value, first value is a default value. XML_ID - external value code. Parameter is considered only when updating already existing list item value e учитывается только при обновлении уже существующих значений элемента списка. ID - value identifier. If specified, its deemed as an update of existing list item and not creation of a new one. Useful only when calling methods `.userfield.update`. DEL* - if set as Y, existing list item will be deleted. Applied, if ID parameter is complete.

Contains set of values for custom field List. Specified when creating/updating a field. Each value is an array containing fields:

VALUE - list item value. Field is required when creating a new item.
SORT - sorting.
DEF - if Y, list item is a default value. A field with multiple values van have DEF=Y. For non-multiple value, first value is a default value.
XML_ID - external value code. Parameter is considered only when updating already existing list item value e учитывается только при обновлении уже существующих значений элемента списка.
ID - value identifier. If specified, its deemed as an update of existing list item and not creation of a new one. Useful only when calling methods *.userfield.update.
DEL - if set as Y, existing list item will be deleted. Applied, if ID parameter is complete.

Example

BX24.callMethod(
    "crm.requisite.userfield.add", 
    {
        fields: 
        {
            "ENTITY_ID": "CRM_REQUISITE",
            "FIELD_NAME": "MY_STRING",
            "EDIT_FORM_LABEL": "My string",            
            "USER_TYPE_ID": "string",
            "XML_ID": "MY_STRING",
            "SETTINGS": { "DEFAULT_VALUE": "Hello, world!" }
        }
    }, 
    function(result) 
    {
        if(result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);