Get User Field by ID crm.requisite.userfield.get

Scope: crm

Who can execute the method: any user

The method returns the user field of the requisite by its identifier.

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
integer

Identifier of the user field. Can be obtained using the method crm.requisite.userfield.list

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":235}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.userfield.get
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":235,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.requisite.userfield.get
        
try
        {
        	const response = await $b24.callMethod(
        		'crm.requisite.userfield.get',
        		{
        			id: 235
        		}
        	);
        	
        	const result = response.getData().result;
        	if (result.error())
        	{
        		console.error(result.error());
        	}
        	else
        	{
        		console.dir(result);
        	}
        }
        catch(error)
        {
        	console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.requisite.userfield.get',
                    [
                        'id' => 235
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting user field: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "crm.requisite.userfield.get",
            {
                id: 235
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.requisite.userfield.get',
            [
                'id' => 235
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result": {
                "ID": "235",
                "ENTITY_ID": "CRM_REQUISITE",
                "FIELD_NAME": "UF_CRM_NEWTECH_V1_STRING",
                "USER_TYPE_ID": "string",
                "XML_ID": null,
                "SORT": "100",
                "MULTIPLE": "N",
                "MANDATORY": "N",
                "SHOW_FILTER": "N",
                "SHOW_IN_LIST": "Y",
                "EDIT_IN_LIST": "Y",
                "IS_SEARCHABLE": "N",
                "SETTINGS": {
                    "SIZE": 20,
                    "ROWS": 1,
                    "REGEXP": "",
                    "MIN_LENGTH": 0,
                    "MAX_LENGTH": 0,
                    "DEFAULT_VALUE": ""
                },
                "EDIT_FORM_LABEL": {
                    "en": "PP - String",
                    "de": "PP - String"
                },
                "LIST_COLUMN_LABEL": {
                    "en": "PP - String",
                    "de": "PP - String"
                },
                "LIST_FILTER_LABEL": {
                    "en": "PP - String",
                    "de": "PP - String"
                },
                "ERROR_MESSAGE": {
                    "en": "UF_CRM_NEWTECH_V1_STRING",
                    "de": "UF_CRM_NEWTECH_V1_STRING"
                },
                "HELP_MESSAGE": {
                    "en": "UF_CRM_NEWTECH_V1_STRING",
                    "de": "UF_CRM_NEWTECH_V1_STRING"
                }
            },
            "time": {
                "start": 1717686921.82579,
                "finish": 1717686922.874864,
                "duration": 1.0490741729736328,
                "processing": 0.05396890640258789,
                "date_start": "2024-06-06T17:15:21+02:00",
                "date_finish": "2024-06-06T17:15:22+02:00",
                "operating": 0
            }
        }

Returned Data

Name
type

Description

result
object

Object containing field values describing the user field of the requisite

time
time

Information about the execution time of the request

Description of User Field of the Requisite

Name
type

Description

ID
int

Identifier of the user field

ENTITY_ID
string

Identifier of the entity to which the user field belongs. For requisites, this is always CRM_REQUISITE

FIELD_NAME
string

Symbolic code. For requisites, it always starts with the prefix UF_CRM_

USER_TYPE_ID
string

Data type (string, boolean, double or datetime)

XML_ID
string

External key. Used for exchange operations. Identifier of the object in the external information base.

The purpose of the field may change by the final developer

SORT
int

Sorting

MULTIPLE
char

Multiplicity indicator. Possible values:

  • Y — yes
  • N — no

MANDATORY
char

Mandatory indicator. Possible values:

  • Y — yes
  • N — no

SHOW_FILTER
char

Whether to show in the list filter. Possible values:

  • N — do not show
  • I — exact match
  • E — mask
  • S — substring

SHOW_IN_LIST
char

Whether to show in the list. Possible values:

  • Y — yes
  • N — no

EDIT_IN_LIST
char

Whether to allow editing by the user. Possible values:

  • Y — yes
  • N — no

IS_SEARCHABLE
char

Whether the field values participate in search. Possible values:

  • Y — yes
  • N — no

EDIT_FORM_LABEL
string

Label in the edit form

LIST_COLUMN_LABEL
string

Header in the list

LIST_FILTER_LABEL
string

Filter label in the list

ERROR_MESSAGE
string

Error message

HELP_MESSAGE
string

Help

LIST
uf_enum_element

List elements. For detailed information, see the section Get Field Descriptions for Custom Field Type "Enumeration" (List) crm.userfield.enumeration.fields

SETTINGS
object

Additional settings (dependent on type). For detailed information, see the section Get the settings field descriptions for the custom field type crm.userfield.settings.fields

Error Handling

HTTP status: 40x, 50x

{
            "error": "ERROR_NOT_FOUND",
            "error_description": "The entity with ID '235' is not found."
        }

Name
type

Description

error
string

String error code. It may consist of digits, Latin letters, and underscores

error_description
error_description

Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Errors

Code

Error Text

Description

Empty string

ID is not defined or invalid

The identifier of the user field is not set or has an invalid value

ERROR_NOT_FOUND

The entity with ID '235' is not found

The user field with the specified identifier was not found

Empty string

Access denied

Insufficient access permissions to retrieve the user field

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred, please contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

An internal server error has occurred, please contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

The current method is not allowed to be called using batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

The maximum length of parameters passed to the batch method has been exceeded

401

NO_AUTH_FOUND
Wrong authorization data

Invalid access token or webhook code

400

INVALID_REQUEST
Https required

The methods must be called using the HTTPS protocol

503

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support

403

ACCESS_DENIED
REST API is available only on commercial plans

The REST API is available only on commercial plans

403

INVALID_CREDENTIALS
Invalid request credentials

The user whose access token or webhook was used to call the method lacks permissions

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

The manifest is not available

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires higher privileges than those provided by the webhook token

401

expired_token
The access token provided has expired

The provided access token has expired

403

user_access_error
The user does not have access to the application

The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users

500

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Previous
Update a Custom Requisite Field
Next
Get a List of Custom Requisite Fields by Filter