метод REST scope: sale

sale.status.getFields

Получить доступные поля статусов

Кто может выполнять: администратор

Описание

Метод sale.status.getFields возвращает доступные поля статусов.

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

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**/sale.status.getfields

Ответ

HTTP-статус: 200

{
    "result":{
        "status":{
            "color":{
                "isImmutable":false,
                "isReadOnly":false,
                "isRequired":false,
                "type":"string"
            },
            "id":{
                "isImmutable":true,
                "isReadOnly":false,
                "isRequired":true,
                "type":"string"
            },
            "notify":{
                "isImmutable":false,
                "isReadOnly":false,
                "isRequired":false,
                "type":"string"
            },
            "sort":{
                "isImmutable":false,
                "isReadOnly":false,
                "isRequired":false,
                "type":"integer"
            },
            "type":{
                "isImmutable":false,
                "isReadOnly":false,
                "isRequired":true,
                "type":"char"
            },
            "xmlId":{
                "isImmutable":false,
                "isReadOnly":false,
                "isRequired":false,
                "type":"string"
            }
        }
    },
    "time":{
        "start":1712147353.206979,
        "finish":1712147353.46492,
        "duration":0.25794100761413574,
        "processing":0.005347013473510742,
        "date_start":"2024-04-03T15:29:13+03:00",
        "date_finish":"2024-04-03T15:29:13+03:00"
    }
}

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

result object

Корневой элемент ответа

status object

Объект в формате {"field_1": "value_1", ... "field_N": "value_N"}, где field — идентификатор поля объекта sale_status, а value — объект типа rest_field_description

time time

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

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

HTTP-статус: 400

{
    "error":0,
    "error_description":"error"
}
Код Описание Значение
200040300010 Недостаточно прав для чтения доступных полей статусов
0 Другие ошибки (например, фатальные ошибки)

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

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