Get Description of the Fields of the Requisite Template crm.requisite.preset.fields
Scope:
crmWho can execute the method: any user
The method returns a formal description of the fields of the requisite template.
No parameters.
Code Examples
How to Use Examples in Documentation
Searching for templates by country binding:
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.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.fields
try
{
const response = await $b24.callMethod(
"crm.requisite.preset.fields",
{}
);
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.preset.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 requisite preset fields: ' . $e->getMessage();
}
BX24.callMethod(
"crm.requisite.preset.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.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"
},
"ENTITY_TYPE_ID": {
"type": "integer",
"isRequired": true,
"isReadOnly": false,
"isImmutable": true,
"isMultiple": false,
"isDynamic": false,
"title": "Object Type ID"
},
"COUNTRY_ID": {
"type": "integer",
"isRequired": true,
"isReadOnly": false,
"isImmutable": true,
"isMultiple": false,
"isDynamic": false,
"title": "Country ID"
},
"NAME": {
"type": "string",
"isRequired": true,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Name"
},
"DATE_CREATE": {
"type": "datetime",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Creation Date"
},
"DATE_MODIFY": {
"type": "datetime",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Modification Date"
},
"CREATED_BY_ID": {
"type": "user",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Created By"
},
"MODIFY_BY_ID": {
"type": "user",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Modified By"
},
"ACTIVE": {
"type": "char",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Active"
},
"SORT": {
"type": "integer",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Sorting"
},
"XML_ID": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "External Code"
}
},
"time": {
"start": 1716555914.663808,
"finish": 1716555914.996533,
"duration": 0.33272480964660645,
"processing": 0.008843183517456055,
"date_start": "2024-05-24T15:05:14+02:00",
"date_finish": "2024-05-24T15:05:14+02:00",
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
An object in the format |
|
time |
Information about the request execution time |
Description of the Requisite Template Fields
|
Name |
Description |
|
ID |
Identifier of the requisite. Created automatically and unique within the account |
|
ENTITY_TYPE_ID |
Identifier of the parent object's type. Currently, this is only "Requisite" (identifier The identifiers of CRM object types are provided by the method crm.enum.ownertype |
|
COUNTRY_ID |
Identifier of the country corresponding to the set of fields of the requisite template (to get available values, see the method crm.requisite.preset.countries) |
|
DATE_CREATE |
Creation date |
|
DATE_MODIFY |
Modification date. Contains an empty string if the template has not been changed since creation |
|
CREATED_BY_ID |
Identifier of the user who created the requisite |
|
MODIFY_BY_ID |
Identifier of the user who modified the requisite |
|
NAME |
Name of the requisite |
|
XML_ID |
External key. Used for exchange operations. Identifier of the external information base object. The purpose of the field may change by the final developer. Each application ensures the uniqueness of values in this field. It is recommended to use a unique prefix to avoid collisions with other applications. In CRM, values of the form |
|
ACTIVE |
Activity status. Uses values |
|
SORT |
Sorting |
Description of Attributes
|
Name |
Description |
|
type |
Field type |
|
isRequired |
Required attribute. Possible values:
|
|
isReadOnly |
Read-only attribute. Possible values:
|
|
isImmutable |
Immutable attribute. Possible values:
|
|
isMultiple |
Multi-field 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
- Create a Template crm.requisite.preset.add
- Update Requisite Template crm.requisite.preset.update
- Get a list of countries for the template crm.requisite.preset.countries
- Get Requisite Template Fields by ID crm.requisite.preset.get
- Get a list of requisites templates by filter crm.requisite.preset.list
- Delete the CRM Requisite Template `crm.requisite.preset.delete`