crm.item.details.configuration.forceCommonScopeForAll
Установить общую карточку для всех пользователей
Описание
Метод crm.item.details.configuration.forceCommonScopeForAll принудительно устанавливает общую карточку элементов для всех пользователей, удаляя их личную настройку карточки элемента.
Параметры
entityTypeId
integer
обязательный
Идентификатор системного или пользовательского типа объектов CRM
extras
object
необязательный
Дополнительные параметры. Возможные значения и их структура описана ниже
extras
Смарт-процесс
необязательный
categoryId
Сделка
необязательный
dealCategoryId
Лид
необязательный
leadCustomerType
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityTypeId":2,"extras":{"dealCategoryId":9}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.item.details.configuration.forceCommonScopeForAll
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityTypeId":2,"extras":{"dealCategoryId":9},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.item.details.configuration.forceCommonScopeForAll
// 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: 'crm.item.details.configuration.forceCommonScopeForAll',
params: {
entityTypeId: 2,
extras: {
dealCategoryId: 9,
},
},
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('Force common scope result:', 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 forceCommonScopeForAll() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.item.details.configuration.forceCommonScopeForAll',
params: {
entityTypeId: 2,
extras: {
dealCategoryId: 9,
},
},
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('Force common scope result:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', forceCommonScopeForAll)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.item.details.configuration.force_common_scope_for_all(
entity_type_id=2,
extras={
"dealCategoryId": 9,
},
).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 {
$response = $b24Service
->core
->call(
'crm.item.details.configuration.forceCommonScopeForAll',
[
'entityTypeId' => 2,
'extras' => [
'dealCategoryId' => 9,
],
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
return;
}
echo 'Success: ' . print_r($result->data(), true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error: ' . $e->getMessage();
}
BX24.callMethod(
'crm.item.details.configuration.forceCommonScopeForAll',
{
entityTypeId: 2,
extras: {
dealCategoryId: 9,
},
},
(result) => {
if (result.error())
{
console.error(result.error());
return;
}
console.info(result.data());
},
);
require_once('crest.php');
$result = CRest::call(
'crm.item.details.configuration.forceCommonScopeForAll',
[
'entityTypeId' => 2,
'extras' => [
'dealCategoryId' => 9,
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.item.details.configuration.forceCommonScopeForAll", b24.Params{
"entityTypeId": 2,
"extras": b24.Params{
"dealCategoryId": 9,
},
})
if err != nil {
return fmt.Errorf("crm.item.details.configuration.forceCommonScopeForAll: %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": 1720687903.685834,
"finish": 1720687904.076471,
"duration": 0.3906371593475342,
"processing": 0.02508091926574707,
"date_start": "2024-07-11T10:51:43+02:00",
"date_finish": "2024-07-11T10:51:44+02:00",
"operating": 0
}
}
Возвращаемые данные
result
boolean
Корневой элемент ответа. Возвращает true в случае успеха
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": "",
"error_description": "Parameter 'entityTypeId' is not defined"
}
| Код | Описание | Значение |
|---|---|---|
| — | Parameter 'entityTypeId' is not defined | Не передан обязательный параметр entityTypeId |
| — | The entity type 'entityTypeName' is not supported in current context. |
Метод не поддерживает данный тип сущности |
| — | Access denied. | У пользователя нет административных прав |

