diff --git a/api-reference/crm/universal/crm-item-add.md b/api-reference/crm/universal/crm-item-add.md index 09094a9c..9175c80f 100644 --- a/api-reference/crm/universal/crm-item-add.md +++ b/api-reference/crm/universal/crm-item-add.md @@ -231,7 +231,37 @@ || **parentId...** [`crm_entity`][1] | Поле-родитель. Элемент другого типа объекта CRM, который привязан к данному элементу. - Каждое такое поле имеет код `parentId + {parentEntityTypeId}` || + Каждое такое поле имеет код `parentId + {parentEntityTypeId}` + || + || **fm** + [`multifield[]`][1] | Массив мультиполей. + + Подробнее о мультиполях можно почитать в разделе [{#T}](../data-types.md#crm_multifield) + + Структура мультиполя: + + - `typeId` — Тип мультиполя. + - `valueType` — Тип значения. + - `value` — Значение. + + Пример: + + ```bash + fm: [ + { + "valueType": "WORK", + "value": "+79999999", + "typeId": "PHONE" + }, + { + "valueType": "WORK", + "value": "bitrix@bitrix.ru", + "typeId": "EMAIL" + } + ] + ``` + По умолчанию — `null` + || |# @@ -559,6 +589,34 @@ Каждое такое поле имеет код `parentId + {parentEntityTypeId}` || + || **fm** + [`multifield[]`][1] | Массив мультиполей. + + Подробнее о мультиполях можно почитать в разделе [{#T}](../data-types.md#crm_multifield) + + Структура мультиполя: + + - `typeId` — Тип мультиполя. + - `valueType` — Тип значения. + - `value` — Значение. + + Пример: + + ```bash + fm: [ + { + "valueType": "WORK", + "value": "+79999999", + "typeId": "PHONE" + }, + { + "valueType": "WORK", + "value": "bitrix@bitrix.ru", + "typeId": "EMAIL" + } + ] + ``` + По умолчанию — `null`|| |# @@ -697,6 +755,35 @@ Каждое такое поле имеет код `parentId + {parentEntityTypeId}` || + || **fm** + [`multifield[]`][1] | Массив мультиполей. + + Подробнее о мультиполях можно почитать в разделе [{#T}](../data-types.md#crm_multifield) + + Структура мультиполя: + + - `typeId` — Тип мультиполя. + - `valueType` — Тип значения. + - `value` — Значение. + + Пример: + + ```bash + fm: [ + { + "valueType": "WORK", + "value": "+79999999", + "typeId": "PHONE" + }, + { + "valueType": "WORK", + "value": "bitrix@bitrix.ru", + "typeId": "EMAIL" + } + ] + + ``` + По умолчанию — `null`|| |# @@ -2001,6 +2088,18 @@ HTTP-статус: **200** [`crm_entity`][1] | Поле-родитель. Элемент другого типа объекта CRM, который привязан к данному элементу. Каждое такое поле имеет код `parentId + {parentEntityTypeId}` + || **fm** + [`multifield`][1] | Массив мультиполей. + + Подробнее о мультиполях можно почитать в разделе [{#T}](../data-types.md#crm_multifield) + + Структура мультиполя: + + - `id` — Уникальный идентификатор. + - `typeId` — Тип мультиполя. + - `valueType` — Тип значения. + - `value` — Значение. + || |# @@ -2324,6 +2423,18 @@ HTTP-статус: **200** [`crm_entity`][1] | Поле-родитель. Элемент другого типа объекта CRM, который привязан к данному элементу. Каждое такое поле имеет код `parentId + {parentEntityTypeId}` + || **fm** + [`multifield`][1] | Массив мультиполей. + + Подробнее о мультиполях можно почитать в разделе [{#T}](../data-types.md#crm_multifield) + + Структура мультиполя: + + - `id` — Уникальный идентификатор. + - `typeId` — Тип мультиполя. + - `valueType` — Тип значения. + - `value` — Значение. + || |# @@ -2458,6 +2569,18 @@ HTTP-статус: **200** [`crm_entity`][1] | Поле-родитель (Элемент другого типа объекта CRM, который привязан к данному элементу). Каждое такое поле имеет код `parentId + {parentEntityTypeId}` + || **fm** + [`multifield`][1] | Массив мультиполей. + + Подробнее о мультиполях можно почитать в разделе [{#T}](../data-types.md#crm_multifield) + + Структура мультиполя: + + - `id` — Уникальный идентификатор. + - `typeId` — Тип мультиполя. + - `valueType` — Тип значения. + - `value` — Значение. + || |# diff --git a/api-reference/crm/universal/crm-item-update.md b/api-reference/crm/universal/crm-item-update.md index 2f467fcf..e936f1c6 100644 --- a/api-reference/crm/universal/crm-item-update.md +++ b/api-reference/crm/universal/crm-item-update.md @@ -170,7 +170,38 @@ || **parentId...** [`crm_entity`][1] | Поле-родитель. Элемент другого типа объекта CRM, который привязан к данному элементу. - Каждое такое поле имеет код `parentId + {parentEntityTypeId}` || + Каждое такое поле имеет код `parentId + {parentEntityTypeId}` + || + || **fm** + [`multifield[]`][1] | Массив мультиполей. + + Подробнее о мультиполях можно почитать в разделе [{#T}](../data-types.md#crm_multifield) + + Структура мультиполя: + + - `id` — Уникальный идентификатор мультиполя. Если не существует мультиполя с данным id, то будет создано новое мультиполе. + - `typeId` — Тип мультиполя. + - `valueType` — Тип значения. + - `value` — Значение. + + Пример: + + ```bash + fm: { + "15": { + "valueType": "WORK", + "value": "+79999999", + "typeId": "PHONE" + }, + "16": { + "valueType": "WORK", + "value": "bitrix@bitrix.ru", + "typeId": "EMAIL" + } + } + ``` + По умолчанию — `null` + || |# @@ -388,6 +419,36 @@ Каждое такое поле имеет код `parentId + {parentEntityTypeId}` || + || **fm** + [`multifield[]`][1] | Массив мультиполей. + + Подробнее о мультиполях можно почитать в разделе [{#T}](../data-types.md#crm_multifield) + + Структура мультиполя: + + - `id` — Уникальный идентификатор мультиполя. Если не существует мультиполя с данным id, то будет создано новое мультиполе. + - `typeId` — Тип мультиполя. + - `valueType` — Тип значения. + - `value` — Значение. + + Пример: + + ```bash + fm: { + "15": { + "valueType": "WORK", + "value": "+79999999", + "typeId": "PHONE" + }, + "16": { + "valueType": "WORK", + "value": "bitrix@bitrix.ru", + "typeId": "EMAIL" + } + } + ``` + По умолчанию — `null` + || |# @@ -476,6 +537,36 @@ Каждое такое поле имеет код `parentId + {parentEntityTypeId}` || + || **fm** + [`multifield[]`][1] | Массив мультиполей. + + Подробнее о мультиполях можно почитать в разделе [{#T}](../data-types.md#crm_multifield) + + Структура мультиполя: + + - `id` — Уникальный идентификатор мультиполя. Если не существует мультиполя с данным id, то будет создано новое мультиполе. + - `typeId` — Тип мультиполя. + - `valueType` — Тип значения. + - `value` — Значение. + + Пример: + + ```bash + fm: { + "15": { + "valueType": "WORK", + "value": "+79999999", + "typeId": "PHONE" + }, + "16": { + "valueType": "WORK", + "value": "bitrix@bitrix.ru", + "typeId": "EMAIL" + } + } + ``` + По умолчанию — `null` + || |# diff --git a/api-reference/crm/universal/user-defined-object-types/b24-toc.yaml b/api-reference/crm/universal/user-defined-object-types/b24-toc.yaml index 53ee9f54..feb20ac5 100644 --- a/api-reference/crm/universal/user-defined-object-types/b24-toc.yaml +++ b/api-reference/crm/universal/user-defined-object-types/b24-toc.yaml @@ -9,6 +9,8 @@ items: href: crm-type-update.md - name: Получить пользовательский тип по id href: crm-type-get.md + - name: Получить пользовательский тип по entityTypeId + href: crm-type-get-by-entity-type-id.md - name: Получить список пользовательских типов href: crm-type-list.md - name: Удалить пользовательский тип diff --git a/api-reference/crm/universal/user-defined-object-types/crm-type-add.md b/api-reference/crm/universal/user-defined-object-types/crm-type-add.md index 4ff53696..c6873360 100644 --- a/api-reference/crm/universal/user-defined-object-types/crm-type-add.md +++ b/api-reference/crm/universal/user-defined-object-types/crm-type-add.md @@ -428,6 +428,7 @@ HTTP-статус: **400**, **403** - [{#T}](./index.md) - [{#T}](./crm-type-update.md) - [{#T}](./crm-type-get.md) +- [{#T}](./crm-type-get-by-entity-type-id.md) - [{#T}](./crm-type-list.md) - [{#T}](./crm-type-delete.md) - [{#T}](./crm-type-fields.md) diff --git a/api-reference/crm/universal/user-defined-object-types/crm-type-delete.md b/api-reference/crm/universal/user-defined-object-types/crm-type-delete.md index 6b99f609..4d6cc127 100644 --- a/api-reference/crm/universal/user-defined-object-types/crm-type-delete.md +++ b/api-reference/crm/universal/user-defined-object-types/crm-type-delete.md @@ -151,6 +151,7 @@ HTTP-статус: **400** - [{#T}](./crm-type-add.md) - [{#T}](./crm-type-update.md) - [{#T}](./crm-type-get.md) +- [{#T}](./crm-type-get-by-entity-type-id.md) - [{#T}](./crm-type-list.md) - [{#T}](./crm-type-fields.md) diff --git a/api-reference/crm/universal/user-defined-object-types/crm-type-fields.md b/api-reference/crm/universal/user-defined-object-types/crm-type-fields.md index c409ba3b..dceea8db 100644 --- a/api-reference/crm/universal/user-defined-object-types/crm-type-fields.md +++ b/api-reference/crm/universal/user-defined-object-types/crm-type-fields.md @@ -366,6 +366,7 @@ HTTP-статус: **400**, **403** - [{#T}](./crm-type-add.md) - [{#T}](./crm-type-update.md) - [{#T}](./crm-type-get.md) +- [{#T}](./crm-type-get-by-entity-type-id.md) - [{#T}](./crm-type-list.md) - [{#T}](./crm-type-delete.md) diff --git a/api-reference/crm/universal/user-defined-object-types/crm-type-get-by-entity-type-id.md b/api-reference/crm/universal/user-defined-object-types/crm-type-get-by-entity-type-id.md new file mode 100644 index 00000000..1b80bd6b --- /dev/null +++ b/api-reference/crm/universal/user-defined-object-types/crm-type-get-by-entity-type-id.md @@ -0,0 +1,227 @@ +# Получить пользовательский тип по entityTypeId crm.type.getByEntityTypeId + +> Scope: [`crm`](../../../scopes/permissions.md) +> +> Кто может выполнять метод: любой пользователь с административным доступом к смарт-процессу, либо пользователем, имеющим право на чтение смарт-процесса + +Метод получает информацию о смарт-процессе с идентификатором типа смарт-процесса `entityTypeId`. + +## Параметры метода + +{% include [Сноска о параметрах](../../../../_includes/required.md) %} + +#| +|| **Название** +`тип` | **Описание** || +|| **entityTypeId*** +[`integer`][1] | Идентификатор типа смарт-процесса. || +|# + +## Примеры кода + +Получить информацию о смарт-процессе с `entityTypeId = 2024`. + +{% include [Сноска о примерах](../../../../_includes/examples.md) %} + +{% list tabs %} + +- cURL (Webhook) + + ```bash + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Accept: application/json" \ + -d '{"entityTypeId":2024}' \ + https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.type.getByEntityTypeId + ``` + +- cURL (OAuth) + + ```bash + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Accept: application/json" \ + -d '{"entityTypeId":2024,"auth":"**put_access_token_here**"}' \ + https://**put_your_bitrix24_address**/rest/crm.type.getByEntityTypeId + ``` + +- JS + + ```js + BX24.callMethod( + 'crm.type.getByEntityTypeId', + { + entityTypeId: 2024, + }, + (result) => { + if (result.error()) + { + console.error(result.error()); + + return; + } + + console.info(result.data()); + }, + ); + ``` + +- PHP + + ```php + require_once('crest.php'); + + $result = CRest::call( + 'crm.type.getByEntityTypeId', + [ + 'entityTypeId' => 2024 + ] + ); + + echo '
'; + print_r($result); + echo ''; + ``` + +{% endlist %} + +## Обработка ответа + +HTTP-статус: **200** + +```json +{ + "result": { + "type": { + "id": 16, + "title": "Смарт-процесс", + "code": "", + "createdBy": 1, + "entityTypeId": 2024, + "customSectionId": null, + "isCategoriesEnabled": "Y", + "isStagesEnabled": "Y", + "isBeginCloseDatesEnabled": "Y", + "isClientEnabled": "Y", + "isUseInUserfieldEnabled": "Y", + "isLinkWithProductsEnabled": "Y", + "isMycompanyEnabled": "Y", + "isDocumentsEnabled": "Y", + "isSourceEnabled": "Y", + "isObserversEnabled": "Y", + "isRecyclebinEnabled": "Y", + "isAutomationEnabled": "Y", + "isBizProcEnabled": "Y", + "isSetOpenPermissions": "Y", + "isPaymentsEnabled": "N", + "isCountersEnabled": "N", + "createdTime": "2024-07-08T14:46:54+02:00", + "updatedTime": "2024-07-08T14:46:54+02:00", + "updatedBy": 1, + "relations": { + "parent": [ + { + "entityTypeId": 3, + "isChildrenListEnabled": "Y", + "isPredefined": "Y" + }, + { + "entityTypeId": 4, + "isChildrenListEnabled": "Y", + "isPredefined": "Y" + }, + { + "entityTypeId": 1, + "isChildrenListEnabled": "Y", + "isPredefined": "N" + }, + { + "entityTypeId": 2, + "isChildrenListEnabled": "Y", + "isPredefined": "N" + }, + { + "entityTypeId": 31, + "isChildrenListEnabled": "Y", + "isPredefined": "N" + } + ], + "child": [ + { + "entityTypeId": 3, + "isChildrenListEnabled": "Y", + "isPredefined": "N" + }, + { + "entityTypeId": 4, + "isChildrenListEnabled": "N", + "isPredefined": "N" + } + ] + }, + "linkedUserFields": { + "CALENDAR_EVENT|UF_CRM_CAL_EVENT": "Y", + "TASKS_TASK|UF_CRM_TASK": "Y", + "TASKS_TASK_TEMPLATE|UF_CRM_TASK": "N" + }, + "customSections": [] + } + }, + "time": { + "start": 1720442829.865672, + "finish": 1720442830.334845, + "duration": 0.46917295455932617, + "processing": 0.13246917724609375, + "date_start": "2024-07-08T14:47:09+02:00", + "date_finish": "2024-07-08T14:47:10+02:00", + "operating": 0 + } +} +``` + +### Возвращаемые данные + +#| +|| **Название** +`тип` | **Описание** || +|| **result** +[`object`][1] | Корневой элемент ответа, содержащий объект [`type`](../../data-types.md#type) с информацией о смарт-процессе || +|| **time** +[`time`][1] | Информация о времени выполнения запроса || +|# + +## Обработка ошибок + +HTTP-статус: **400** + +```json +{ + "error": 0, + "error_description": "Смарт-процесс не найден" +} +``` + +{% include notitle [обработка ошибок](../../../../_includes/error-info.md) %} + +### Возможные коды ошибок +#| +|| **Статус** | **Код** | **Описание** | **Значение** || +|| `403` | `allowed_only_intranet_user` | Действие разрешено только интранет-пользователям | Возникает, если пользователь не является интранет-пользователем || +|| `400` | `ACCESS_DENIED` | Доступ запрещен | Возникает, если у пользователя нет административных прав CRM и нет прав на чтение смарт-процесса || +|| `400` | `0` | Смарт-процесс не найден | Смарт-процесс с переданным `entityTypeId` не найден || +|# + +{% include [системные ошибки](./../../../../_includes/system-errors.md) %} + +## Продолжите изучение + +- [{#T}](./index.md) +- [{#T}](./crm-type-add.md) +- [{#T}](./crm-type-update.md) +- [{#T}](./crm-type-get.md) +- [{#T}](./crm-type-list.md) +- [{#T}](./crm-type-delete.md) +- [{#T}](./crm-type-fields.md) + + +[1]: ../../../data-types.md \ No newline at end of file diff --git a/api-reference/crm/universal/user-defined-object-types/crm-type-get.md b/api-reference/crm/universal/user-defined-object-types/crm-type-get.md index 70013bec..9465474e 100644 --- a/api-reference/crm/universal/user-defined-object-types/crm-type-get.md +++ b/api-reference/crm/universal/user-defined-object-types/crm-type-get.md @@ -2,7 +2,7 @@ > Scope: [`crm`](../../../scopes/permissions.md) > -> Кто может выполнять метод: любой пользователь с административным доступом к разделу CRM +> Кто может выполнять метод: любой пользователь с административным доступом к смарт-процессу, либо пользователем, имеющим право на чтение смарт-процесса Метод получает информацию о смарт-процессе с идентификатором `id`. @@ -207,7 +207,7 @@ HTTP-статус: **400** #| || **Статус** | **Код** | **Описание** | **Значение** || || `403` | `allowed_only_intranet_user` | Действие разрешено только интранет-пользователям | Возникает, если пользователь не является интранет-пользователем || -|| `400` | `ACCESS_DENIED` | Доступ запрещен | Возникает, если у пользователя нет административных прав CRM || +|| `400` | `ACCESS_DENIED` | Доступ запрещен | Возникает, если у пользователя нет административных прав CRM и нет прав на чтение смарт-процесса || || `400` | `0` | Смарт-процесс не найден | Смарт-процесс с переданным `id` не найден || |# @@ -218,6 +218,7 @@ HTTP-статус: **400** - [{#T}](./index.md) - [{#T}](./crm-type-add.md) - [{#T}](./crm-type-update.md) +- [{#T}](./crm-type-get-by-entity-type-id.md) - [{#T}](./crm-type-list.md) - [{#T}](./crm-type-delete.md) - [{#T}](./crm-type-fields.md) diff --git a/api-reference/crm/universal/user-defined-object-types/crm-type-list.md b/api-reference/crm/universal/user-defined-object-types/crm-type-list.md index 34faa1f0..97f89628 100644 --- a/api-reference/crm/universal/user-defined-object-types/crm-type-list.md +++ b/api-reference/crm/universal/user-defined-object-types/crm-type-list.md @@ -406,6 +406,7 @@ HTTP-статус: **400** - [{#T}](./crm-type-add.md) - [{#T}](./crm-type-update.md) - [{#T}](./crm-type-get.md) +- [{#T}](./crm-type-get-by-entity-type-id.md) - [{#T}](./crm-type-delete.md) - [{#T}](./crm-type-fields.md) diff --git a/api-reference/crm/universal/user-defined-object-types/crm-type-update.md b/api-reference/crm/universal/user-defined-object-types/crm-type-update.md index dfb04943..abacabfa 100644 --- a/api-reference/crm/universal/user-defined-object-types/crm-type-update.md +++ b/api-reference/crm/universal/user-defined-object-types/crm-type-update.md @@ -430,6 +430,7 @@ HTTP-статус: **400** - [{#T}](./index.md) - [{#T}](./crm-type-add.md) - [{#T}](./crm-type-get.md) +- [{#T}](./crm-type-get-by-entity-type-id.md) - [{#T}](./crm-type-list.md) - [{#T}](./crm-type-delete.md) - [{#T}](./crm-type-fields.md) diff --git a/api-reference/crm/universal/user-defined-object-types/index.md b/api-reference/crm/universal/user-defined-object-types/index.md index b7224af8..20cf384b 100644 --- a/api-reference/crm/universal/user-defined-object-types/index.md +++ b/api-reference/crm/universal/user-defined-object-types/index.md @@ -20,6 +20,7 @@ - [{#T}](./crm-type-add.md) - [{#T}](./crm-type-update.md) - [{#T}](./crm-type-get.md) +- [{#T}](./crm-type-get-by-entity-type-id.md) - [{#T}](./crm-type-list.md) - [{#T}](./crm-type-delete.md)