Получить стадии канбана
Получает информацию о стадиях Канбана или Моего плана
- Параметры
- Расширенный вызов ?
Функция ПолучитьСтадииКанбана(Знач URL, Знач IDСущности = 0, Знач КакАдминистратор = Ложь, Знач Токен = "") Экспорт
| Параметр | CLI опция | Тип | Обяз. | Назначение |
|---|---|---|---|---|
| URL | --url | Строка | ✔ | URL внешнего вебхука или адрес Bitrix24 при использовании токена |
| IDСущности | --entityid | Строка, Число | ✖ | ID группы или пользователя владельца канбан. Свой по умолчанию |
| КакАдминистратор | --admin | Булево | ✖ | Позволяет получать стадии без проверки прав (для администраторов) |
| Токен | --token | Строка | ✖ | Токен авторизации, если используется не вебхук |
Возвращаемое значение
Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrix24
| Параметр | Описание |
|---|---|
| proxy | ИнтернетПрокси или структура полей Протокол, Сервер, Порт, Пользователь, Пароль, ИспользоватьАутентификациюОС |
| timeout | Таймаут выполнения запроса |
| adv_response | Оформляет ответ в виде полной структуры HTTP-ответа с полями code, body и headers |
| retries | Число попыток отправки HTTP-запроса при коде 5** или внутренних ошибках клиента |
| dontwait | Создает фоновое задание и возвращает его данные (только для 1С и OneScript) |
подсказка
Метод в документации API: task.stages.get
Пример использования для 1С:Предприятие/OneScript
URL = "https://b24-ar17wx.bitrix24.by/rest/1/av5...";
Результат = OPI_Bitrix24.ПолучитьСтадииКанбана(URL, , Истина);
URL = "b24-ar17wx.bitrix24.by";
Токен = "a5b00469006e9f06006b12e400000001000...";
Результат = OPI_Bitrix24.ПолучитьСтадииКанбана(URL, , , Токен);
- Bash
- CMD/Bat
oint bitrix24 ПолучитьСтадииКанбана \
--url "b24-ar17wx.bitrix24.by" \
--token "***"
oint bitrix24 ПолучитьСтадииКанбана ^
--url "b24-ar17wx.bitrix24.by" ^
--token "***"
Результат
{
"result": {
"142": {
"ID": "142",
"TITLE": "Новое имя стадии стадии",
"SORT": "100",
"COLOR": "000000",
"SYSTEM_TYPE": "NEW",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null,
"CAN_SORT_ITEMS": true
},
"20": {
"ID": "20",
"TITLE": "Новая стадия",
"SORT": "200",
"COLOR": "0026FF",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"24": {
"ID": "24",
"TITLE": "Название",
"SORT": "300",
"COLOR": "75d900",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"16": {
"ID": "16",
"TITLE": "Новая стадия",
"SORT": "400",
"COLOR": "0026FF",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"18": {
"ID": "18",
"TITLE": "Новая стадия 2",
"SORT": "500",
"COLOR": "0026FF",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"12": {
"ID": "12",
"TITLE": "Новая стадия",
"SORT": "600",
"COLOR": "0026FF",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"14": {
"ID": "14",
"TITLE": "Новая стадия 2",
"SORT": "700",
"COLOR": "0026FF",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"8": {
"ID": "8",
"TITLE": "Новая стадия",
"SORT": "800",
"COLOR": "0026FF",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"10": {
"ID": "10",
"TITLE": "Новая стадия 2",
"SORT": "900",
"COLOR": "0026FF",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"6": {
"ID": "6",
"TITLE": "Новая стадия",
"SORT": "1000",
"COLOR": "0026FF",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"4066": {
"ID": "4066",
"TITLE": "Новая стадия",
"SORT": "1100",
"COLOR": "0026FF",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"4068": {
"ID": "4068",
"TITLE": "Новая стадия 2",
"SORT": "1200",
"COLOR": "0026FF",
"SYSTEM_TYPE": "",
"ENTITY_ID": "1",
"ENTITY_TYPE": "U",
"ADDITIONAL_FILTER": [],
"TO_UPDATE": [],
"TO_UPDATE_ACCESS": null
},
"2836": {
"ID": "2836",
"TITLE": "Новая стадия",
...