метод REST
scope: placement
userfieldtype.delete
Удалить зарегистрированный тип пользовательских полей
Описание
Метод userfieldtype.delete удаляет зарегистрированный приложением тип пользовательских полей. Возвращает _true_ или ошибку с описанием причины.
Параметры
USER_TYPE_ID
string
обязательный
Строковый код типа
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"USER_TYPE_ID": "test"
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/userfieldtype.delete
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"USER_TYPE_ID": "test",
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/userfieldtype.delete
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
try {
const response = await $b24.actions.v2.call.make<boolean>({
method: 'userfieldtype.delete',
params: {
USER_TYPE_ID: 'test',
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Deleted:', result)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function deleteUserFieldType() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'userfieldtype.delete',
params: {
USER_TYPE_ID: 'test',
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Deleted:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', deleteUserFieldType)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.userfieldtype.delete(
user_type_id="test",
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$userTypeId = 'example_user_type_id'; // Replace with the actual user type ID
$result = $serviceBuilder
->getPlacementScope()
->userFieldType()
->delete($userTypeId);
if ($result->isSuccess()) {
print($result->getCoreResponse()->getResponseData()->getResult()[0]);
} else {
print("Error occurred while deleting user field type.");
}
} catch (\Throwable $e) {
print("Exception: " . $e->getMessage());
}
BX24.callMethod(
'userfieldtype.delete',
{
USER_TYPE_ID: 'test'
},
function(result)
{
if(result.error())
console.error(result.error());
else
console.log(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'userfieldtype.delete',
[
'USER_TYPE_ID' => 'test'
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "userfieldtype.delete", b24.Params{
"USER_TYPE_ID": "test",
})
if err != nil {
return fmt.Errorf("userfieldtype.delete: %w", err)
}
var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("выполнено:", ok)
Ответ
HTTP-статус: 200
{
"result":true,
"time":{
"start":1724421710.397825,
"finish":1724421711.040353,
"duration":0.6425280570983887,
"processing":5.888938903808594e-5,
"date_start":"2024-08-23T16:01:50+02:00",
"date_finish":"2024-08-23T16:01:51+02:00",
"operating":0
}
}
Возвращаемые данные
result
boolean
Результат удаления типа пользовательских полей
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error":"ERROR_NOT_FOUND",
"error_description":"User Field Type not found"
}
| Код | Описание | Значение |
|---|---|---|
ERROR_ARGUMENT |
Argument 'USER_TYPE_ID' is null or empty | Не задан USER_TYPE_ID |
ERROR_NOT_FOUND |
User Field Type not found | Не найдено пользовательское поле с указанным USER_TYPE_ID |

