метод REST scope: crm

crm.stagehistory.list

Получить историю движения по стадиям

Кто может выполнять: любой пользователь

Описание

Метод crm.stagehistory.list возвращает записи об истории движения по стадиям для элементов:
- лидов,
- сделок,
- старых счетов,
- новых счетов,
- смарт-процессов.

Параметры

entityTypeId integer необязательный

Идентификатор типа объекта. Может принимать значения:
- 1 — лид,
- 2 — сделка,
- 5 — счет (старый),
- 31 - счет (новый),
- числовой идентификатор пользовательского типа, например 130

order object необязательный

Список для сортировки, где ключ — поле, а значение — ASC или DESC

filter object необязательный

Список для фильтрации. Фильтр поддерживает использование точных значений, массивов значений, а также модификаторы:
- >= — больше либо равно
- > — больше
- <= — меньше либо равно
- < — меньше
- @ — IN, в качестве значения передается массив
- !@ — NOT IN, в качестве значения передается массив
- % — LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки
- =% — LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
- "мол%" — ищет значения, начинающиеся с «мол»
- "%мол" — ищет значения, заканчивающиеся на «мол»
- "%мол%" — ищет значения, где «мол» может быть в любой позиции
- %= — LIKE (аналогично =%)
- !% — NOT LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск идет с обеих сторон
- !=% — NOT LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
- "мол%" — ищет значения, не начинающиеся с «мол»
- "%мол" — ищет значения, не заканчивающиеся на «мол»
- "%мол%" — ищет значения, где подстроки «мол» нет в любой позиции
- !%= — NOT LIKE (аналогично !=%)
- = — равно, точное совпадение (используется по умолчанию)
- != — не равно
- ! — не равно

select object необязательный

Список получаемых полей

start integer необязательный

Сдвиг для постраничной навигации. Логика работы с постраничной навигацией стандартная для списочных методов

Примеры запроса

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityTypeId":2,"order":{"ID":"ASC"},"filter":{"OWNER_ID":1},"select":["ID","STAGE_ID","CREATED_TIME"]}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.stagehistory.list

Ответ

HTTP-статус: 200

{
    "result": {
        "items": [
        {
            "ID": 35,
            "TYPE_ID": 1,
            "OWNER_ID": 21,
            "CREATED_TIME": "2024-04-25T14:59:11+00:00",
            "CATEGORY_ID": 0,
            "STAGE_SEMANTIC_ID": "P",
            "STAGE_ID": "NEW"
        }
        ]
    },
    "total": 1,
    "time": {
        "start": 1724106224.858572,
        "finish": 1724106225.344968,
        "duration": 0.48639607429504395,
        "processing": 0.11864185333251953,
        "date_start": "2024-08-15T22:15:44+00:00",
        "date_finish": "2024-08-15T22:15:45+00:00",
        "operating": 0.11855506896972656
    }
}

Возвращаемые данные

result array

Корневой элемент ответа, содержит массив записей items. Каждый объект — массив с ключами

time time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 401

{
    "error": 0,
    "error_description": "SHIPMENT_DOCUMENT entity is not supported"
}
Код Описание Значение
403 allowed_only_intranet_user Действие разрешено только интранет-пользователям
400 ENTITY_TYPE_NOT_SUPPORTED Entity type TYPE is not supported
400 INVALID_ARG_VALUE Invalid filter: field 'field' is not allowed in filter
400 INVALID_ARG_VALUE Invalid filter: field 'field' has invalid value
400 INVALID_ARG_VALUE Invalid order: field 'field' is not allowed in order
400 INVALID_ARG_VALUE Invalid order: allowed sort directions are ASC, DESC. But got 'orderValue' for field 'field'

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.