tasks.flow.Flow.get
Получить поток
Описание
Метод tasks.flow.Flow.get возвращает данные потока по его идентификатору.
Параметры
flowId
integer
обязательный
Идентификатор потока, данные которого нужно получить.
Получить идентификатор можно методом создания нового потока tasks.flow.Flow.create или методом получения задачи tasks.task.get для задачи из потока
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"flowId": 517
}' \
https://your-domain.bitrix24.com/rest/_USER_ID_/_CODE_/tasks.flow.Flow.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-d '{
"flowId": 517
}' \
https://your-domain.bitrix24.com/rest/tasks.flow.Flow.get
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type FlowGetResult = {
id: number,
creatorId: number,
ownerId: number,
groupId: number,
templateId: number,
efficiency: number,
active: boolean,
plannedCompletionTime: number,
activity: ISODate | null,
name: string,
description: string,
distributionType: string,
responsibleList: string[][],
demo: boolean,
responsibleCanChangeDeadline: boolean,
matchWorkTime: boolean,
taskControl: boolean,
notifyAtHalfTime: boolean,
notifyOnQueueOverflow: number | null,
notifyOnTasksInProgressOverflow: number | null,
notifyWhenEfficiencyDecreases: number | null,
taskCreators: string[][],
team: string[][],
trialFeatureEnabled: boolean,
}
try {
const response = await $b24.actions.v2.call.make<FlowGetResult>({
method: 'tasks.flow.Flow.get',
params: {
flowId: 517,
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Flow:', result.id, result.name, result.active)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function getFlow() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'tasks.flow.Flow.get',
params: {
flowId: 517,
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Flow:', result.id, result.name, result.active)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getFlow)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.tasks.flow.flow.get(
flow_id=517,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'tasks.flow.Flow.get',
[
'flowId' => 517
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Нужная вам логика обработки данных
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting flow: ' . $e->getMessage();
}
BX24.callMethod(
'tasks.flow.Flow.get',
{
flowId: 517
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
}
);
require_once('crest.php'); // подключение CRest PHP SDK
$flowId = 517;
// выполнение запроса к REST API
$result = CRest::call(
'tasks.flow.Flow.get',
[
'flowId' => $flowId
]
);
// Обработка ответа от Битрикс24
if ($result['error']) {
echo 'Error: '.$result['error_description'];
} else {
print_r($result['result']);
}
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "tasks.flow.Flow.get", b24.Params{
"flowId": 517,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("tasks.flow.Flow.get: %w", err)
}
var item struct {
ID b24.ID `json:"id"`
CreatorID b24.ID `json:"creatorId"`
OwnerID b24.ID `json:"ownerId"`
GroupID b24.ID `json:"groupId"`
TemplateID b24.ID `json:"templateId"`
Efficiency int `json:"efficiency"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.CreatorID)
Ответ
HTTP-статус: 200
{
"result": {
"id": 517,
"creatorId": 1,
"ownerId": 1,
"groupId": 178,
"templateId": 0,
"efficiency": 0,
"active": true,
"plannedCompletionTime": 7200,
"activity": "2024-09-02T15:27:29+00:00",
"name": "Updated Flow Name",
"description": "Updated description",
"distributionType": "manually",
"responsibleList": [
[
"user",
"3"
]
],
"demo": false,
"responsibleCanChangeDeadline": true,
"matchWorkTime": true,
"taskControl": false,
"notifyAtHalfTime": false,
"notifyOnQueueOverflow": 10,
"notifyOnTasksInProgressOverflow": 50,
"notifyWhenEfficiencyDecreases": null,
"taskCreators": [
[
"meta-user",
"all-users"
]
],
"team": [
[
"user",
"3"
]
],
"trialFeatureEnabled": false
}
}
Возвращаемые данные
result
object
Объект с данными потока
id
integer
Идентификатор потока
creatorId
integer
Идентификатор создателя потока. Только для чтения
ownerId
integer
Идентификатор администратора потока
groupId
integer
Идентификатор группы, к которой привязан поток
templateId
integer
Идентификатор шаблона, по которому создаются задачи в потоке
efficiency
integer
Эффективность потока в процентах. Только для чтения
active
boolean
Статус активности потока
plannedCompletionTime
integer
Планируемое время выполнения задачи в секундах
activity
string
Дата и время последней активности в потоке. Только для чтения
name
string
Название потока
description
string
Описание потока
distributionType
string
Тип распределения задач в потоке
responsibleList
array
Список ответственных за задачи в потоке. Для ручного распределения это модератор потока
demo
boolean
Является ли поток демонстрационным. Системный параметр. Только для чтения
responsibleCanChangeDeadline
boolean
Может ли ответственный менять дедлайн задачи
matchWorkTime
boolean
Пропускать ли выходные и праздничные дни при расчете крайнего срока задачи
taskControl
boolean
Отправлять ли выполненную задачу постановщику для проверки
notifyAtHalfTime
boolean
Уведомлять ли исполнителя на половине срока задачи
notifyOnQueueOverflow
integer
Количество задач в очереди, при превышении которого будет отправлено уведомление администратору потока (если null, то уведомления выключены)
notifyOnTasksInProgressOverflow
integer
Количество задач в работе, при превышении которого будет отправлено уведомление администратору потока (если null, то уведомления выключены)
notifyWhenEfficiencyDecreases
integer
Эффективность в процентах, при снижении до которой будет отправлено уведомление администратору потока (если null, то уведомления выключены)
taskCreators
object
Список пользователей, которые могут добавлять задачи в поток в формате {"<тип-объекта>": "<идентификатор-объекта>"}. Например, [{"user": 3}, {"department": "17:F"}].
Элемент {"meta-user": "all-users"} означает, что задачи могут добавлять все пользователи
team
object
Команда потока.
Для ручного распределения это все участники проекта, к которому привязан поток, кроме модератора.
Для распределения по очереди и самостоятельного распределения команда та же, что и в responsibleList
trialFeatureEnabled
boolean
Включен ли демонстрационный период для потока. Системный параметр. Только для чтения
Обработка ошибок
HTTP-статус: 400
{
"error": "0",
"error_description": "Flow not found"
}
| Код | Описание | Значение |
|---|---|---|
0 |
Доступ запрещен или поток не найден | Тариф портала не позволяет работать с потоками или у пользователя нет прав на получение данных потока |
0 |
Unknown error |
Неизвестная ошибка |
0 |
Flow not found |
Поток не найден |

