метод REST scope: базовый

user.option.get

Получить пользовательские данные, привязанные к приложению

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

Описание

Метод user.option.get получает пользовательские данные, привязанные к приложению. Если ничего не подать на вход, то вернет все записанные через user.option.set свойства.

Параметры

option string необязательный

Один из ключей, сохраненных методом user.option.set.

Если параметр не передан, метод вернет все сохраненные настройки текущего пользователя

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
    "option": "data"
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/user.option.get

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**/user.option.get

Ответ

HTTP-статус: 200

{
    "result": {
        "data": "value",
        "data2": "value2"
    },
    "time": {
        "start": 1722001311.94644,
        "finish": 1722001311.98622,
        "duration": 0.0397801399230957,
        "processing": 0.000041961669921875,
        "date_start": "2024-07-26T13:41:51+00:00",
        "date_finish": "2024-07-26T13:41:51+00:00",
        "operating": 0
    }
}

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

result object

Зависит от параметра option:

  • параметр не передан — объект, где ключ это название настройки, а значение это сохраненное значение. Если настроек нет, объект пустой
  • параметр передан — сохраненное значение ключа
  • параметр передан, но такого ключа нет — null
time time

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

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

HTTP-статус: 400

{
    "error":"AccessException",
    "error_description":"Application context required"
}
Код Описание Значение
AccessException Application context required Метод вызван вне контекста приложения
AccessException User authorization required Пользователь не авторизован

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

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