Get Description of Custom Fields for the Requisite Template crm.requisite.preset.field.fields
Scope:
crmWho can execute the method: any user
This method returns a formal description of the fields that describe the customizable field of the requisite template.
No parameters.
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.preset.field.fields
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.requisite.preset.field.fields
try
{
const response = await $b24.callMethod(
'crm.requisite.preset.field.fields',
{}
);
const result = response.getData().result;
console.dir(result);
}
catch( error )
{
console.error('Error:', error);
}
try {
$response = $b24Service
->core
->call(
'crm.requisite.preset.field.fields',
[]
);
$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 fetching preset field fields: ' . $e->getMessage();
}
BX24.callMethod(
"crm.requisite.preset.field.fields",
{},
function(result)
{
if(result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'crm.requisite.preset.field.fields',
[]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP Status: 200
{
"result": {
"ID": {
"type": "integer",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "ID"
},
"FIELD_NAME": {
"type": "string",
"isRequired": true,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Name"
},
"FIELD_TITLE": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Title in Template"
},
"SORT": {
"type": "integer",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Sorting"
},
"IN_SHORT_LIST": {
"type": "char",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Show in Short List"
}
},
"time": {
"start": 1716823643.597269,
"finish": 1716823643.949143,
"duration": 0.35187387466430664,
"processing": 0.012942075729370117,
"date_start": "2024-05-27T17:27:23+02:00",
"date_finish": "2024-05-27T17:27:23+02:00",
"operating": 0
}
}
Returned Data
|
Title |
Description |
|
result |
An object in the format |
|
time |
Information about the request execution time |
Description of Fields Describing the Customizable Field of the Requisite Template
|
Title |
Description |
|
ID |
Field identifier. Created automatically and unique within the template |
|
FIELD_NAME |
Field name |
|
FIELD_TITLE |
Alternative field name for the requisite. The alternative name is displayed in various forms for filling out requisites. Depending on the specific form, the alternative name may or may not be used |
|
SORT |
Sorting. Order in the list of template fields |
|
IN_SHORT_LIST |
Show in short list. Deprecated field, currently not used. Retained for backward compatibility. Can take values |
Description of Attributes
|
Title |
Description |
|
type |
Field type |
|
isRequired |
"Required" attribute. Possible values:
|
|
isReadOnly |
"Read-only" attribute. Possible values:
|
|
isImmutable |
"Immutable" attribute. Possible values:
|
|
isMultiple |
"Multiple" attribute. Possible values:
|
|
isDynamic |
"Custom" attribute. Possible values:
|
|
title |
Field identifier |
Error Handling
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not allowed to be called using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The methods must be called using the HTTPS protocol |
|
|
|
The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans |
|
|
|
The user whose access token or webhook was used to call the method lacks permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
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 |
|
|
|
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
- Add a Custom Field to the CRM Requisite Template crm.requisite.preset.field.add
- Update Custom Field of a Given Requisite Template crm.requisite.preset.field.update
- Get Fields Available for Addition to the Requisite Template crm.requisite.preset.field.availabletoadd
- Get Custom Field of Requisite Template by ID crm.requisite.preset.field.get
- Get a list of all customizable fields for a specified CRM requisites template crm.requisite.preset.field.list
- Delete Custom Field from CRM Requisite Template crm.requisite.preset.field.delete