Работа с задачами
Получение списка задач
Общее описание
Функция GET /me-open-api/api/taskManagement/tasks?dateFrom={dateTime}&dateTo={dateTime}&subscriberIDs={long}&subscriberGroupIDs={long}&title={string}&statuses={integer}&priorities={integer}&includeUnboundTasks={boolean}&count={integer}&offset={integer}&customFieldExternalIDs={string}&customFieldValues={string}&taskTypeIDs={long}&customStatusIDs={long}?mapObjectID={long}&zoneIDs={long}&zoneGroupIDs={long} позволяет получить задачи по нужным параметрам.
Максимальное количество возвращаемых задач — 1000.
Параметры вызова
Функция имеет следующие параметры:
| Параметр | Описание |
|---|---|
| dateFrom | Дата, время начала периода задач (подробнее о формате времени). |
| dateTo | Дата, время окончания периода задач (подробнее о формате времени). |
| subscriberIDs | ИД Сотрудников. Подробнее о передаче нескольких идентификаторов |
| subscriberGroupIDs | ИД групп Сотрудников. Подробнее о передаче нескольких идентификаторов |
| title | Название задачи. |
| statuses | Статус задач. Существуют следующие значения:
|
| priorities | Приоритет задачи. Существуют следующие значения:
|
| includeUnboundTasks | Признак включения неназначенных задач. Существуют следующие значения:
|
| count | Количество возвращаемых задач (не более 1000). |
| offset | Количество задач, которые необходимо пропустить относительно первой в списке. |
| customFieldExternalIDs | Внешний идентификатор дополнительного поля задачи. Подробнее о передаче нескольких идентификаторов. Должно передаваться вместе с параметром customFieldValues. |
| customFieldValues | Значение дополнительного поля задачи. Подробнее о передаче нескольких идентификаторов. Должно передаваться вместе с параметром customFieldExternalIDs. |
| taskTypeIDs | ИД типов задач. Подробнее о передаче нескольких идентификаторов |
| customStatusID | ИД пользовательских статусов задач. Подробнее о передаче нескольких идентификаторов |
| mapObjectID | ИД объекта. |
| mapObjectWorkScheduleID | ИД расписания |
| zoneIDs | ИД зон. Подробнее о передаче нескольких идентификаторов |
| zoneGroupIDs | ИД групп зон. Подробнее о передаче нескольких идентификаторов |
| includeWorkOrders | Назначения задачи. Существуют следующие значения: true – ответ будет содержать массив с назначением задачи; false – ответ не будет содержать массив с назначением задачи. |
| includeRouteItems | Информация из маршрута. Существуют следующие значения: true – ответ будет содержать массив с информацией из маршрута; false – ответ не будет содержать массив с информацией из маршрута. |
| considerWorkOrders | Искать ли задачи дополнительно по датам назначений. Существуют следующие значения: true – нужно искать задачи дополнительно по датам назначений; false – не нужно искать задачи дополнительно по датам назначений. |
| creationDateFrom | Начальная дата создания |
| creationDateTo | Конечная дата создания |
| mapObjectIDs | ИД объектов |
Результат выполнения
Функция возвращает структуру со следующими параметрами задач:
| Параметр | Описание |
|---|---|
| taskID | ИД задачи |
| subscriberID | ИД Сотрудника |
| deadline | Крайний срок завершения задачи (дата и время, подробнее о формате времени). |
| title | Название задачи |
| description | Описание задачи |
| address | Адрес задачи |
| longitude | Географическая долгота адреса (в градусах) |
| latitude | Географическая широта адреса (в градусах) |
| externalID | Внешний пользовательский ИД задачи |
| clientName | ФИО клиента |
| clientPhone | Телефон клиента |
| clientEmail | Адрес электронной почты клиента |
| priority | Приоритет задачи. Существуют следующие значения:
|
| rank | Ранг задачи. Допустимые значения: от 0 до 100. |
| startDate | Дата начала задачи (подробнее о формате времени). |
| status | Статус задачи. Существуют следующие значения:
|
| taskTypeID | ИД типа задачи |
| customStatusID | ИД пользовательского статуса задачи |
| customStatusReasonID | Ид причины смены пользовательского статуса задачи |
| mapObjectID | ИД объекта |
| mapObjectWorkScheduleID | ИД расписания |
| commentPolicy | Требования к комментарию при завершении задачи. Существуют следующие значения:
|
| serviceTime | Время выполнения задачи |
| startInterval | Интервал начала выполнения задачи |
| preferredPositionInRoute | Порядок задачи в маршруте. Допустимые значения: от 1 до 10. |
| isFixed | Является ли задача закрепленной (нельзя менять время начала выполнения в пределах допустимого времени опоздания, изменять или снимать исполнителя). Существуют следующие значения:
|
| isMandatoryInRoute | Должна ли задача быть обязательно поставлена в маршрут. Существуют следующие значения:
|
| creationDate | Дата и время создания задачи (подробнее о формате времени). |
| includeWorkOrders | Назначения задачи. Существуют следующие значения:
|
| includeRouteItems | Информация из маршрута. Существуют следующие значения:
|
| considerWorkOrders | Искать ли задачи дополнительно по датам назначений. Существуют следующие значения:
|
| Параметры маршрута задачи (массив структур routeItems) | |
| plannedStartDate | Плановая дата начала задачи (подробнее о формате времени). |
| plannedEndDate | Плановая дата окончания задачи (подробнее о формате времени). |
| timeToPoint | Время доезда в минутах до адреса задачи |
| distanceToPoint | Расстояние в метрах до адреса задачи |
| awaitingTime | Время ожидания начала задачи после доезда до адреса задачи |
| Параметры компетенций задачи (competences) | |
| competenceID | ИД компетенции |
| amount | Вес компетенции |
| level | Уровень владения компетенцией |
| Параметры измерений (структура dimensions) | |
| weight | Вес (кг) |
| unit | Юниты |
| width | Ширина (м) |
| height | Высота (м) |
| length | Длина (м) |
| volume | Объем (м3) |
| Параметры дополнительных полей задачи (массив структур customFieldFormItems) | |
| externalID | ИД дополнительного поля |
| name | Название дополнительного поля |
| value | Значение дополнительного поля |
| values | Значения дополнительного поля в случае множественного выбора |
| type | Тип дополнительного поля. Существуют следующие типы:
|
| subType | Подтип поля «Строка». Существуют следующие значения:
|
| Параметры шаблона формы, обязательного для заполнения при отклонении или завершении задачи (массив структур taskFormTemplates) | |
| status | Статус задачи, при переводе в который необходимо заполнить форму. Существуют следующие значения:
|
| taskFormTemplateID | ИД шаблона формы. |
| isRequired | Является ли обязательным заполнение формы. Существуют следующие значения:
|
| Параметры предзаполненных полей (массив структур prefillValues) | |
| externalID | Внешний ИД поля. |
| value | Значение поля. |
| values | Значения колонки в случае множественного выбора |
| Параметры колонок таблицы (массив массивов rows) | |
| externalID | Внешний ИД колонки. |
| name | Название колонки |
| value | Значение колонки |
| values | Значения колонки в случае множественного выбора |
| type | Тип дополнительного поля. Существуют следующие типы:
|
| subtype | Подтип поля «Строка». Существуют следующие значения:
|
| Параметры общей ссылки на местоположение Сотрудника, выполняющего задачу. Получателю ссылки не требуются логин и пароль для просмотра местоположения (структура sharedLink) | |
| isActive | Активность ссылки. Существуют следующие значения:
|
| sharingPeriod | Время действия ссылки, после его окончания просмотр местоположения по ссылке станет недоступным. Существуют следующие значения:
|
| sharingEndDate | Дата и время окончания действия ссылки (если в параметре sharingPeriod передано значение 2) |
| sendToEmail | Отправить ссылку на электронную почту клиента. Электронная почта должна быть указана в параметре clientEmail. Существуют следующие значения:
|
| sendToSMS | Отправить ссылку по SMS клиенту. Телефон клиента должен быть указан в параметре clientPhone. Существуют следующие значения:
|
| Параметры обратной связи (структура feedback) | |
| formInvitationProfileID | ИД профиля обратной связи |
| formTemplateID | ИД формы обратной связи |
| sendToEmail | Отправить форму обратной связи на электронную почту клиента. Электронная почта должна быть указана в параметре clientEmail. Существуют следующие значения:
|
| sendToSMS | Отправить форму обратной связи по SMS клиенту. Телефон клиента должен быть указан в параметре clientPhone. Существуют следующие значения:
|
| Параметры чек-листов (массив структур checklists) | |
| checklistID | ИД чек-листа |
| assetID | ИД актива |
| name | Название чек-листа |
| description | Описание чек-листа |
| isRequired | Является ли заполнение чек-листа обязательным. Существуют следующие значения:
|
| checkListExternalID | Внешний ИД чек-листа |
| type | Тип чек-листа. Существуют следующие значения:
|
| Status | Статус чек-листа. Существуют следующие значения:
|
| creationDate | Дата и время создания чек-листа |
| taskID | ИД задачи, к которой привязан чек-лист |
| lastModificationDate | Дата и время последнего прохождения чек-листа |
| subscriberID | ИД Сотрудника, который заполняет чек-лист |
| latitude | Географическая широта места прохождения чек-листа (в градусах) |
| longitude | Географическая долгота места прохождения чек-листа (в градусах) |
| radius | Радиус погрешности определения места прохождения чек-листа (в метрах) |
| address | Адрес прохождения чек-листа |
| checkListTemplateIDs | ИД шаблонов чек-листов |
| checkListTemplateNames | Названия шаблонов чек-листов |
| maxScore | Максимальная оценка по итогам прохождения чек-листа |
| totalScore | Общая оценка по итогам прохождения чек-листа |
Формат запроса
GET /me-open-api/api/taskManagement/tasks?dateFrom={dateTime}&dateTo={dateTime}&subscriberIDs={long}&subscriberGroupIDs={long}&title={string}&statuses={integer}&priorities={integer}&includeUnboundTasks={boolean}&count={integer}&offset={integer}&customFieldExternalIDs={string}&customFieldValues={string}&taskTypeIDs={long}&customStatusIDs={long}&mapObjectID={long}&mapObjectWorkScheduleID={long} HTTP/1.1
Host: host
Authorization: Bearer tokenПример запроса
GET /me-open-api/api/taskManagement/tasks?dateFrom=2020-10-05T15:45:13+03&dateTo=2020-10-06 T15:45:13+03&subscriberIDs=1&subscriberGroupIDs=1&title=task&statuses=1&priorities=1&includeUnboundTasks=true&count=100&offset=1&customFieldExternalIDs=1&customFieldValues=значение&taskTypeIDs=1&customStatusIDs=1&mapObjectID=1&mapObjectWorkScheduleID=0 HTTP/1.1
Host: track.beeline.ru
Authorization: Bearer tokenФормат ответа
[
{
"taskID": integer,
"routeItems": [
{
"plannedStartDate": "string",
"plannedEndDate": "string",
"timeToPoint": integer,
"distanceToPoint": integer
}
],
"subscriberID": integer,
"deadline": "dateTime",
"title": "string",
"description": "string",
"address": "string",
"longitude": number,
"latitude": number,
"externalID": "string",
"clientName": "string",
"clientPhone": "string",
"clientEmail": "string",
"priority": integer,
"rank": integer,
"startDate": "dateTime",
"status": integer,
"taskTypeID": integer,
"customStatusID": integer,
"customStatusReasonID": integer,
"mapObjectID": integer,
"mapObjectWorkScheduleID": integer,
"commentPolicy": integer,
"competences": [
{
"competenceID": integer,
"amount": number,
"level": integer
}
],
"dimensions": {
"weight": number,
"unit": number,
"width": number,
"height": number,
"length": number,
"volume": number
},
"serviceTime": integer,
"startInterval": integer,
"isMandatoryInRoute": boolean,
"preferredPositionInRoute": integer,
"isFixed": boolean,
"customFieldsFormTemplateID": integer,
"customFieldFormItems": [
{
"externalID": "string",
"name": "string",
"value": "string",
"values": [
"string"
],
"type": "string",
"subtype": integer,
"rows": [
[
{
"externalID": "string",
"name": "string",
"value": "string",
"values": [
"string"
],
"type": "string",
"subtype": integer
}
]
]
}
],
"taskFormTemplates": [
{
"status": integer,
"taskFormTemplateID": integer,
"isRequired": boolean,
"prefillValues": [
{
"externalID": "string",
"value": "string",
"rows": [
[
{
"externalID": "string",
"value": "string"
}
]
]
}
]
}
],
"creationDate": "dateTime",
"sharedLink": {
"isActive": boolean,
"sharingPeriod": integer,
"sharingEndDate": "dateTime",
"sendToEmail": boolean,
"sendToSMS": boolean
},
"feedback": {
"formInvitationProfileID": integer,
"formTemplateID": integer,
"sendToEmail": boolean,
"sendToSMS": boolean
},
"checklists": [
{
"checklistID": integer,
"assetID": integer,
"name": "string",
"description": "string",
"isRequired": boolean,
"checkListExternalID": "string",
"type": integer,
"status": integer,
"creationDate": "date-time",
"taskID": integer,
"lastModificationDate": "date-time",
"subscriberID": integer,
"latitude": number,
"longitude": number,
"radius": integer,
"address": "string",
"checkListTemplateIDs": [
integer
],
"checkListTemplateNames": [
"string"
],
"maxScore": number,
"totalScore": number
}
]
}
]Пример ответа
[
{
"taskID": 1,
"routeItems": [
{
"plannedStartDate": "2024-07-31T09:08:55.988Z",
"plannedEndDate": "2024-07-31T09:08:55.988Z",
"timeToPoint": 60,
"distanceToPoint": 650
}
],
"subscriberID": 1,
"deadline": "2020-10-06T20:00:00+03:00",
"title": "task",
"description": "Описание",
"address": "Россия, Москва, улица Большая Ордынка, 27/6с4",
"longitude": 37.61775044433594,
"latitude": 55.735528725106505,
"externalID": null,
"clientName": "Иванов Иван",
"clientPhone": "79161234567",
"clientEmail": "ivan@ivanov.ru",
"priority": 1,
"rank": 10,
"startDate": "2020-10-06T14:50:00+03:00",
"status": 1,
"taskTypeID": 1,
"customStatusID": 1,
"customStatusReasonID": 1,
"mapObjectID": 1,
"mapObjectWorkScheduleID": 0,
"commentPolicy": 3,
"competences": [
{
"competenceID": 1,
"amount": 5,
"level": 2
}
],
"dimensions": {
"weight": 5,
"unit": 5,
"width": 5,
"height": 5,
"length": 5,
"volume": 5
},
"serviceTime": 12,
"startInterval": 12,
"isMandatoryInRoute": true,
"preferredPositionInRoute": 1,
"isFixed": false,
"customFieldsFormTemplateID": 1,
"customFieldFormItems": [
{
"externalID": "1",
"name": "Лично в руки",
"value": "True",
"type": "Boolean"
}
],
"taskFormTemplates": [
{
"status": 2,
"taskFormTemplateID": 1,
"isRequired": true,
"prefillValues": [
{
"externalID": "85978",
"value": "Значение поля",
"rows": [
[
{
"externalID": "872",
"value": "Значение колонки"
}
]
]
}
]
}
]
"creationDate": "2020-10-06T12:50:00+03:00",
"sharedLink": {
"isActive": true,
"sharingPeriod": 2,
"sharingEndDate": "2022-10-06T12:50:00+03:00",
"sendToEmail": true,
"sendToSMS": true
},
"feedback": {
"formInvitationProfileID": 1,
"formTemplateID": 1,
"sendToEmail": true,
"sendToSMS": true
},
"checklists": [
{
"checklistID": 1,
"assetID": 1,
"name": "Техническое обслуживание здания",
"description": "Дома десятиэтажные",
"isRequired": true,
"checkListExternalID": "6093f666-97db-4722-9bd0-4c9d9ab480e7",
"type": 0,
"status": 2,
"creationDate": "2020-10-19T21:10:39.94+03:00",
"taskID": 1,
"lastModificationDate": "2020-10-20T11:10:39.94+03:00",
"subscriberID": 1,
"latitude": 55.735528725106505,
"longitude": 37.61775044433594,
"radius": 100,
"address": "Россия, Москва, улица Большая Ордынка, 27/6с4",
"checkListTemplateIDs": [
1
],
"checkListTemplateNames": [
"Техническое обслуживание десятиэтажных зданий"
],
"maxScore": 10,
"totalScore": 8
}
]
}
]Получение задачи
Общее описание
Функция GET /me-open-api/api/taskManagement/tasks/{taskID} позволяет получить задачу по ее идентификатору.
Параметры вызова
В запросе используется обязательный параметр taskID — идентификатор задачи.
Результат выполнения
Функция возвращает структуру со следующими параметрами задачи:
| Параметр | Описание |
|---|---|
| taskID | ИД задачи |
| subscriberID | ИД Сотрудника |
| deadline | Крайний срок завершения задачи (дата и время, подробнее о формате времени). |
| title | Название задачи |
| description | Описание задачи |
| address | Адрес задачи |
| longitude | Географическая долгота адреса (в градусах) |
| latitude | Географическая широта адреса (в градусах) |
| externalID | Внешний пользовательский ИД задачи |
| clientName | ФИО клиента |
| clientPhone | Телефон клиента |
| clientEmail | Адрес электронной почты клиента |
| priority | Приоритет задачи. Существуют следующие значения:
|
| rank | Ранг задачи. Допустимые значения: от 0 до 100. |
| startDate | Дата начала задачи (подробнее о формате времени). |
| status | Статус задачи. Существуют следующие значения:
|
| taskTypeID | ИД типа задачи |
| customStatusID | ИД пользовательского статуса задачи |
| customStatusReasonID | Ид причины смены пользовательского статуса задачи |
| mapObjectID | ИД объекта |
| mapObjectWorkScheduleID | ИД расписания |
| commentPolicy | Требования к комментарию при завершении задачи. Существуют следующие значения:
|
| serviceTime | Время выполнения задачи |
| startInterval | Интервал начала выполнения задачи |
| preferredPositionInRoute | Порядок задачи в маршруте. Допустимые значения: от 1 до 10. |
| isFixed | Является ли задача закрепленной (нельзя менять время начала выполнения в пределах допустимого времени опоздания, изменять или снимать исполнителя). Существуют следующие значения:
|
| isMandatoryInRoute | Должна ли задача быть обязательно поставлена в маршрут. Существуют следующие значения:
|
| creationDate | Дата и время создания задачи (подробнее о формате времени). |
| includeWorkOrders | Назначения задачи. Существуют следующие значения:
|
| includeRouteItems | Информация из маршрута. Существуют следующие значения:
|
| considerWorkOrders | Искать ли задачи дополнительно по датам назначений. Существуют следующие значения:
|
| Параметры маршрута задачи (массив структур routeItems) | |
| plannedStartDate | Плановая дата начала задачи (подробнее о формате времени). |
| plannedEndDate | Плановая дата окончания задачи (подробнее о формате времени). |
| timeToPoint | Время доезда в минутах до адреса задачи |
| distanceToPoint | Расстояние в метрах до адреса задачи |
| awaitingTime | Время ожидания начала задачи после доезда до адреса задачи |
| Параметры компетенций задачи (competences) | |
| competenceID | ИД компетенции |
| amount | Вес компетенции |
| level | Уровень владения компетенцией |
| Параметры измерений (структура dimensions) | |
| weight | Вес (кг) |
| unit | Юниты |
| width | Ширина (м) |
| height | Высота (м) |
| length | Длина (м) |
| volume | Объем (м3) |
| Параметры дополнительных полей задачи (массив структур customFieldFormItems) | |
| externalID | ИД дополнительного поля |
| name | Название дополнительного поля |
| value | Значение дополнительного поля |
| values | Значения дополнительного поля в случае множественного выбора |
| type | Тип дополнительного поля. Существуют следующие типы:
|
| subType | Подтип поля «Строка». Существуют следующие значения:
|
| Параметры шаблона формы, обязательного для заполнения при отклонении или завершении задачи (массив структур taskFormTemplates) | |
| status | Статус задачи, при переводе в который необходимо заполнить форму. Существуют следующие значения:
|
| taskFormTemplateID | ИД шаблона формы. |
| isRequired | Является ли обязательным заполнение формы. Существуют следующие значения:
|
| Параметры предзаполненных полей (массив структур prefillValues) | |
| externalID | Внешний ИД поля. |
| value | Значение поля. |
| values | Значения колонки в случае множественного выбора |
| Параметры колонок таблицы (массив массивов rows) | |
| externalID | Внешний ИД колонки. |
| name | Название колонки |
| value | Значение колонки |
| values | Значения колонки в случае множественного выбора |
| type | Тип дополнительного поля. Существуют следующие типы:
|
| subtype | Подтип поля «Строка». Существуют следующие значения:
|
| Параметры общей ссылки на местоположение Сотрудника, выполняющего задачу. Получателю ссылки не требуются логин и пароль для просмотра местоположения (структура sharedLink) | |
| isActive | Активность ссылки. Существуют следующие значения:
|
| sharingPeriod | Время действия ссылки, после его окончания просмотр местоположения по ссылке станет недоступным. Существуют следующие значения:
|
| sharingEndDate | Дата и время окончания действия ссылки (если в параметре sharingPeriod передано значение 2) |
| sendToEmail | Отправить ссылку на электронную почту клиента. Электронная почта должна быть указана в параметре clientEmail. Существуют следующие значения:
|
| sendToSMS | Отправить ссылку по SMS клиенту. Телефон клиента должен быть указан в параметре clientPhone. Существуют следующие значения:
|
| Параметры обратной связи (структура feedback) | |
| formInvitationProfileID | ИД профиля обратной связи |
| formTemplateID | ИД формы обратной связи |
| sendToEmail | Отправить форму обратной связи на электронную почту клиента. Электронная почта должна быть указана в параметре clientEmail. Существуют следующие значения:
|
| sendToSMS | Отправить форму обратной связи по SMS клиенту. Телефон клиента должен быть указан в параметре clientPhone. Существуют следующие значения:
|
| Параметры чек-листов (массив структур checklists) | |
| checklistID | ИД чек-листа |
| assetID | ИД актива |
| name | Название чек-листа |
| description | Описание чек-листа |
| isRequired | Является ли заполнение чек-листа обязательным. Существуют следующие значения:
|
| checkListExternalID | Внешний ИД чек-листа |
| type | Тип чек-листа. Существуют следующие значения:
|
| Status | Статус чек-листа. Существуют следующие значения:
|
| creationDate | Дата и время создания чек-листа |
| taskID | ИД задачи, к которой привязан чек-лист |
| lastModificationDate | Дата и время последнего прохождения чек-листа |
| subscriberID | ИД Сотрудника, который заполняет чек-лист |
| latitude | Географическая широта места прохождения чек-листа (в градусах) |
| longitude | Географическая долгота места прохождения чек-листа (в градусах) |
| radius | Радиус погрешности определения места прохождения чек-листа (в метрах) |
| address | Адрес прохождения чек-листа |
| checkListTemplateIDs | ИД шаблонов чек-листов |
| checkListTemplateNames | Названия шаблонов чек-листов |
| maxScore | Максимальная оценка по итогам прохождения чек-листа |
| totalScore | Общая оценка по итогам прохождения чек-листа |
Формат запроса
GET /me-open-api/api/taskManagement/tasks/{taskID} HTTP/1.1
Host: host
Authorization: Bearer tokenПример запроса
GET /me-open-api/api/taskManagement/tasks/1 HTTP/1.1
Host: track.beeline.ru
Authorization: Bearer tokenФормат ответа
{
"taskID": integer,
"routeItems": [
{
"plannedStartDate": "string",
"plannedEndDate": "string",
"timeToPoint": integer,
"distanceToPoint": integer
}
],
"subscriberID": integer,
"deadline": "dateTime",
"title": "string",
"description": "string",
"address": "string",
"longitude": number,
"latitude": number,
"externalID": "string",
"clientName": "string",
"clientPhone": "string",
"clientEmail": "string",
"priority": integer,
"rank": integer,
"startDate": "dateTime",
"status": integer,
"taskTypeID": integer,
"customStatusID": integer,
"customStatusReasonID": integer,
"mapObjectWorkScheduleID": integer,
"commentPolicy": integer,
"competences": [
{
"competenceID": integer,
"amount": number,
"level": integer
}
],
"dimensions": {
"weight": number,
"unit": number,
"width": number,
"height": number,
"length": number,
"volume": number
},
"serviceTime": integer,
"startInterval": integer,
"isMandatoryInRoute": boolean,
"preferredPositionInRoute": integer,
"isFixed": boolean,
"customFieldsFormTemplateID": integer,
"customFieldFormItems": [
{
"externalID": "string",
"name": "string",
"value": "string",
"values": [
"string"
],
"type": "string",
"subtype": integer,
"rows": [
[
{
"externalID": "string",
"name": "string",
"value": "string",
"values": [
"string"
],
"type": "string",
"subtype": integer
}
]
]
}
],
"taskFormTemplates": [
{
"status": integer,
"taskFormTemplateID": integer,
"isRequired": boolean,
"prefillValues": [
{
"externalID": "string",
"value": "string",
"rows": [
[
{
"externalID": "string",
"value": "string"
}
]
]
}
]
}
]
"creationDate": "dateTime",
"sharedLink": {
"isActive": boolean,
"sharingPeriod": integer,
"sharingEndDate": "dateTime",
"sendToEmail": boolean,
"sendToSMS": boolean
},
"feedback": {
"formInvitationProfileID": integer,
"formTemplateID": integer,
"sendToEmail": boolean,
"sendToSMS": boolean
},
"checklists": [
{
"checklistID": integer,
"assetID": integer,
"name": "string",
"description": "string",
"isRequired": boolean,
"checkListExternalID": "string",
"type": integer,
"status": integer,
"creationDate": "date-time",
"taskID": integer,
"lastModificationDate": "date-time",
"subscriberID": integer,
"latitude": number,
"longitude": number,
"radius": integer,
"address": "string",
"checkListTemplateIDs": [
integer
],
"checkListTemplateNames": [
"string"
],
"maxScore": number,
"totalScore": number
}
]
}Пример ответа
{
"taskID": 1,
"routeItems": [
{
"plannedStartDate": "2024-07-31T09:08:55.988Z",
"plannedEndDate": "2024-07-31T09:08:55.988Z",
"timeToPoint": 60,
"distanceToPoint": 650
}
],
"subscriberID": 1,
"deadline": "2020-10-06T20:00:00+03:00",
"title": "task",
"description": "Описание",
"address": "Россия, Москва, улица Большая Ордынка, 27/6с4",
"longitude": 37.61775044433594,
"latitude": 55.735528725106505,
"externalID": null,
"clientName": "Иванов Иван",
"clientPhone": "79161234567",
"clientEmail": "ivan@ivanov.ru",
"priority": 1,
"rank": 10,
"startDate": "2020-10-06T14:50:00+03:00",
"status": 1,
"taskTypeID": 1,
"customStatusID": 1,
"customStatusReasonID": 1,
"mapObjectID": 1,
"mapObjectWorkScheduleID": 0,
"commentPolicy": 3,
"competences": [
{
"competenceID": 1,
"amount": 13,
"level": 3
}
],
"dimensions": {
"weight": 5,
"unit": 5,
"width": 5,
"height": 5,
"length": 5,
"volume": 5
},
"serviceTime": 12,
"startInterval": 12,
"isMandatoryInRoute": true,
"preferredPositionInRoute": 1,
"isFixed": false,
"customFieldsFormTemplateID": 1,
"customFieldFormItems": [
{
"externalID": "1",
"name": "Лично в руки",
"value": "True",
"type": "Boolean"
}
],
"taskFormTemplates": [
{
"status": 2,
"taskFormTemplateID": 1,
"isRequired": true,
"prefillValues": [
{
"externalID": "85978",
"value": "Значение поля",
"rows": [
[
{
"externalID": "872",
"value": "Значение колонки"
}
]
]
}
]
}
]
"creationDate": "2020-10-06T12:50:00+03:00",
"sharedLink": {
"isActive": true,
"sharingPeriod": 2,
"sharingEndDate": "2022-10-06T12:50:00+03:00",
"sendToEmail": true,
"sendToSMS": true
},
"feedback": {
"formInvitationProfileID": 1,
"formTemplateID": 1,
"sendToEmail": true,
"sendToSMS": true
},
"checklists": [
{
"checklistID": 1,
"assetID": 1,
"name": "Техническое обслуживание здания",
"description": "Дома десятиэтажные",
"isRequired": true,
"checkListExternalID": "6093f666-97db-4722-9bd0-4c9d9ab480e7",
"type": 0,
"status": 2,
"creationDate": "2020-10-19T21:10:39.94+03:00",
"taskID": 1,
"lastModificationDate": "2020-10-20T11:10:39.94+03:00",
"subscriberID": 1,
"latitude": 55.735528725106505,
"longitude": 37.61775044433594,
"radius": 100,
"address": "Россия, Москва, улица Большая Ордынка, 27/6с4",
"checkListTemplateIDs": [
1
],
"checkListTemplateNames": [
"Техническое обслуживание десятиэтажных зданий"
],
"maxScore": 10,
"totalScore": 8
}
]
}Получение задачи по внешнему идентификатору
Общее описание
Функция GET /me-open-api/api/taskManagement/tasks/externalID/{externalID} позволяет получить задачу по ее внешнему идентификатору.
Параметры вызова
В запросе используется обязательный параметр externalID — внешний идентификатор задачи.
Результат выполнения
Функция возвращает структуру со следующими параметрами задачи:
| Параметр | Описание |
|---|---|
| taskID | ИД задачи |
| subscriberID | ИД Сотрудника |
| deadline | Крайний срок завершения задачи (дата и время, подробнее о формате времени). |
| title | Название задачи |
| description | Описание задачи |
| address | Адрес задачи |
| longitude | Географическая долгота адреса (в градусах) |
| latitude | Географическая широта адреса (в градусах) |
| externalID | Внешний пользовательский ИД задачи |
| clientName | ФИО клиента |
| clientPhone | Телефон клиента |
| clientEmail | Адрес электронной почты клиента |
| priority | Приоритет задачи. Существуют следующие значения:
|
| rank | Ранг задачи. Допустимые значения: от 0 до 100. |
| startDate | Дата начала задачи (подробнее о формате времени). |
| status | Статус задачи. Существуют следующие значения:
|
| taskTypeID | ИД типа задачи |
| customStatusID | ИД пользовательского статуса задачи |
| customStatusReasonID | Ид причины смены пользовательского статуса задачи |
| mapObjectID | ИД объекта |
| mapObjectWorkScheduleID | ИД расписания |
| commentPolicy | Требования к комментарию при завершении задачи. Существуют следующие значения:
|
| serviceTime | Время выполнения задачи |
| startInterval | Интервал начала выполнения задачи |
| preferredPositionInRoute | Порядок задачи в маршруте. Допустимые значения: от 1 до 10. |
| isFixed | Является ли задача закрепленной (нельзя менять время начала выполнения в пределах допустимого времени опоздания, изменять или снимать исполнителя). Существуют следующие значения:
|
| isMandatoryInRoute | Должна ли задача быть обязательно поставлена в маршрут. Существуют следующие значения:
|
| creationDate | Дата и время создания задачи (подробнее о формате времени). |
| includeWorkOrders | Назначения задачи. Существуют следующие значения:
|
| includeRouteItems | Информация из маршрута. Существуют следующие значения:
|
| considerWorkOrders | Искать ли задачи дополнительно по датам назначений. Существуют следующие значения:
|
| Параметры маршрута задачи (массив структур routeItems) | |
| plannedStartDate | Плановая дата начала задачи (подробнее о формате времени). |
| plannedEndDate | Плановая дата окончания задачи (подробнее о формате времени). |
| timeToPoint | Время доезда в минутах до адреса задачи |
| distanceToPoint | Расстояние в метрах до адреса задачи |
| awaitingTime | Время ожидания начала задачи после доезда до адреса задачи |
| Параметры компетенций задачи (competences) | |
| competenceID | ИД компетенции |
| amount | Вес компетенции |
| level | Уровень владения компетенцией |
| Параметры измерений (структура dimensions) | |
| weight | Вес (кг) |
| unit | Юниты |
| width | Ширина (м) |
| height | Высота (м) |
| length | Длина (м) |
| volume | Объем (м3) |
| Параметры дополнительных полей задачи (массив структур customFieldFormItems) | |
| externalID | ИД дополнительного поля |
| name | Название дополнительного поля |
| value | Значение дополнительного поля |
| values | Значения дополнительного поля в случае множественного выбора |
| type | Тип дополнительного поля. Существуют следующие типы:
|
| subType | Подтип поля «Строка». Существуют следующие значения:
|
| Параметры шаблона формы, обязательного для заполнения при отклонении или завершении задачи (массив структур taskFormTemplates) | |
| status | Статус задачи, при переводе в который необходимо заполнить форму. Существуют следующие значения:
|
| taskFormTemplateID | ИД шаблона формы. |
| isRequired | Является ли обязательным заполнение формы. Существуют следующие значения:
|
| Параметры предзаполненных полей (массив структур prefillValues) | |
| externalID | Внешний ИД поля. |
| value | Значение поля. |
| values | Значения колонки в случае множественного выбора |
| Параметры колонок таблицы (массив массивов rows) | |
| externalID | Внешний ИД колонки. |
| name | Название колонки |
| value | Значение колонки |
| values | Значения колонки в случае множественного выбора |
| type | Тип дополнительного поля. Существуют следующие типы:
|
| subtype | Подтип поля «Строка». Существуют следующие значения:
|
| Параметры общей ссылки на местоположение Сотрудника, выполняющего задачу. Получателю ссылки не требуются логин и пароль для просмотра местоположения (структура sharedLink) | |
| isActive | Активность ссылки. Существуют следующие значения:
|
| sharingPeriod | Время действия ссылки, после его окончания просмотр местоположения по ссылке станет недоступным. Существуют следующие значения:
|
| sharingEndDate | Дата и время окончания действия ссылки (если в параметре sharingPeriod передано значение 2) |
| sendToEmail | Отправить ссылку на электронную почту клиента. Электронная почта должна быть указана в параметре clientEmail. Существуют следующие значения:
|
| sendToSMS | Отправить ссылку по SMS клиенту. Телефон клиента должен быть указан в параметре clientPhone. Существуют следующие значения:
|
| Параметры обратной связи (структура feedback) | |
| formInvitationProfileID | ИД профиля обратной связи |
| formTemplateID | ИД формы обратной связи |
| sendToEmail | Отправить форму обратной связи на электронную почту клиента. Электронная почта должна быть указана в параметре clientEmail. Существуют следующие значения:
|
| sendToSMS | Отправить форму обратной связи по SMS клиенту. Телефон клиента должен быть указан в параметре clientPhone. Существуют следующие значения:
|
| Параметры чек-листов (массив структур checklists) | |
| checklistID | ИД чек-листа |
| assetID | ИД актива |
| name | Название чек-листа |
| description | Описание чек-листа |
| isRequired | Является ли заполнение чек-листа обязательным. Существуют следующие значения:
|
| checkListExternalID | Внешний ИД чек-листа |
| type | Тип чек-листа. Существуют следующие значения:
|
| Status | Статус чек-листа. Существуют следующие значения:
|
| creationDate | Дата и время создания чек-листа |
| taskID | ИД задачи, к которой привязан чек-лист |
| lastModificationDate | Дата и время последнего прохождения чек-листа |
| subscriberID | ИД Сотрудника, который заполняет чек-лист |
| latitude | Географическая широта места прохождения чек-листа (в градусах) |
| longitude | Географическая долгота места прохождения чек-листа (в градусах) |
| radius | Радиус погрешности определения места прохождения чек-листа (в метрах) |
| address | Адрес прохождения чек-листа |
| checkListTemplateIDs | ИД шаблонов чек-листов |
| checkListTemplateNames | Названия шаблонов чек-листов |
| maxScore | Максимальная оценка по итогам прохождения чек-листа |
| totalScore | Общая оценка по итогам прохождения чек-листа |
Формат запроса
GET /me-open-api/api/taskManagement/tasks/externalID/{externalID} HTTP/1.1
Host: host
Authorization: Bearer tokenПример запроса
GET /me-open-api/api/taskManagement/tasks/externalID/1 HTTP/1.1
Host: track.beeline.ru
Authorization: Bearer tokenФормат ответа
{
"taskID": integer,
"routeItems": [
{
"plannedStartDate": "string",
"plannedEndDate": "string",
"timeToPoint": integer,
"distanceToPoint": integer
}
],
"subscriberID": integer,
"deadline": "dateTime",
"title": "string",
"description": "string",
"address": "string",
"longitude": number,
"latitude": number,
"externalID": "string",
"clientName": "string",
"clientPhone": "string",
"clientEmail": "string",
"priority": integer,
"rank": integer,
"startDate": "dateTime",
"status": integer,
"taskTypeID": integer,
"customStatusID": integer,
"customStatusReasonID": integer,
"mapObjectWorkScheduleID": integer,
"commentPolicy": integer,
"competences": [
{
"competenceID": integer,
"amount": number,
"level": integer
}
],
"dimensions": {
"weight": number,
"unit": number,
"width": number,
"height": number,
"length": number,
"volume": number
},
"serviceTime": integer,
"startInterval": integer,
"isMandatoryInRoute": boolean,
"preferredPositionInRoute": integer,
"isFixed": boolean,
"customFieldsFormTemplateID": integer,
"customFieldFormItems": [
{
"externalID": "string",
"name": "string",
"value": "string",
"values": [
"string"
],
"type": "string",
"subtype": integer,
"rows": [
[
{
"externalID": "string",
"name": "string",
"value": "string",
"values": [
"string"
],
"type": "string",
"subtype": integer
}
]
]
}
],
"taskFormTemplates": [
{
"status": integer,
"taskFormTemplateID": integer,
"isRequired": boolean,
"prefillValues": [
{
"externalID": "string",
"value": "string",
"rows": [
[
{
"externalID": "string",
"value": "string"
}
]
]
}
]
}
]
"creationDate": "dateTime",
"sharedLink": {
"isActive": boolean,
"sharingPeriod": integer,
"sharingEndDate": "dateTime",
"sendToEmail": boolean,
"sendToSMS": boolean
},
"feedback": {
"formInvitationProfileID": integer,
"formTemplateID": integer,
"sendToEmail": boolean,
"sendToSMS": boolean
},
"checklists": [
{
"checklistID": integer,
"assetID": integer,
"name": "string",
"description": "string",
"isRequired": boolean,
"checkListExternalID": "string",
"type": integer,
"status": integer,
"creationDate": "date-time",
"taskID": integer,
"lastModificationDate": "date-time",
"subscriberID": integer,
"latitude": number,
"longitude": number,
"radius": integer,
"address": "string",
"checkListTemplateIDs": [
integer
],
"checkListTemplateNames": [
"string"
],
"maxScore": number,
"totalScore": number
}
]
}Пример ответа
{
"taskID": 1,
"routeItems": [
{
"plannedStartDate": "2024-07-31T09:08:55.988Z",
"plannedEndDate": "2024-07-31T09:08:55.988Z",
"timeToPoint": 60,
"distanceToPoint": 650
}
],
"subscriberID": 1,
"deadline": "2020-10-06T20:00:00+03:00",
"title": "task",
"description": "Описание",
"address": "Россия, Москва, улица Большая Ордынка, 27/6с4",
"longitude": 37.61775044433594,
"latitude": 55.735528725106505,
"externalID": null,
"clientName": "Иванов Иван",
"clientPhone": "79161234567",
"clientEmail": "ivan@ivanov.ru",
"priority": 1,
"rank": 10,
"startDate": "2020-10-06T14:50:00+03:00",
"status": 1,
"taskTypeID": 1,
"customStatusID": 1,
"customStatusReasonID": 1,
"mapObjectID": 1,
"mapObjectWorkScheduleID": 0,
"commentPolicy": 3,
"competences": [
{
"competenceID": 1,
"amount": 13,
"level": 3
}
],
"dimensions": {
"weight": 5,
"unit": 5,
"width": 5,
"height": 5,
"length": 5,
"volume": 5
},
"serviceTime": 12,
"startInterval": 12,
"isMandatoryInRoute": true,
"preferredPositionInRoute": 1,
"isFixed": false,
"customFieldsFormTemplateID": 1,
"customFieldFormItems": [
{
"externalID": "1",
"name": "Лично в руки",
"value": "True",
"type": "Boolean"
}
],
"taskFormTemplates": [
{
"status": 2,
"taskFormTemplateID": 1,
"isRequired": true,
"prefillValues": [
{
"externalID": "85978",
"value": "Значение поля",
"rows": [
[
{
"externalID": "872",
"value": "Значение колонки"
}
]
]
}
]
}
]
"creationDate": "2020-10-06T12:50:00+03:00",
"sharedLink": {
"isActive": true,
"sharingPeriod": 2,
"sharingEndDate": "2022-10-06T12:50:00+03:00",
"sendToEmail": true,
"sendToSMS": true
},
"feedback": {
"formInvitationProfileID": 1,
"formTemplateID": 1,
"sendToEmail": true,
"sendToSMS": true
},
"checklists": [
{
"checklistID": 1,
"assetID": 1,
"name": "Техническое обслуживание здания",
"description": "Дома десятиэтажные",
"isRequired": true,
"checkListExternalID": "6093f666-97db-4722-9bd0-4c9d9ab480e7",
"type": 0,
"status": 2,
"creationDate": "2020-10-19T21:10:39.94+03:00",
"taskID": 1,
"lastModificationDate": "2020-10-20T11:10:39.94+03:00",
"subscriberID": 1,
"latitude": 55.735528725106505,
"longitude": 37.61775044433594,
"radius": 100,
"address": "Россия, Москва, улица Большая Ордынка, 27/6с4",
"checkListTemplateIDs": [
1
],
"checkListTemplateNames": [
"Техническое обслуживание десятиэтажных зданий"
],
"maxScore": 10,
"totalScore": 8
}
]
}Создание задачи
Общее описание
Функция POST /me-open-api/api/taskManagement/tasks позволяет создать одну задачу.
Для создания нескольких задач необходимо использовать функцию POST /me-open-api/api/jobManagement/jobs/tasks.
Параметры вызова
Функция имеет следующие параметры:
| Параметр | Описание |
|---|---|
| subscriberID | ИД Сотрудника |
| deadline | Крайний срок завершения задачи (дата и время, подробнее о формате времени) |
| title | Название задачи (обязательное поле) |
| description | Описание задачи |
| address | Адрес задачи |
| longitude | Географическая долгота адреса (в градусах). Если в запросе переданы параметры mapObjectID, longitude, latitude, то местоположение задачи определяется по значениям, переданным в параметрах latitude, longitude. |
| latitude | Географическая широта адреса (в градусах). Если в запросе переданы параметры mapObjectID, longitude, latitude, то местоположение задачи определяется по значениям, переданным в параметрах latitude, longitude. |
| externalID | Внешний пользовательский ИД задачи |
| clientName | ФИО клиента |
| clientPhone | Телефон клиента |
| clientEmail | Адрес электронной почты клиента |
| priority | Приоритет задачи. Существуют следующие значения:
|
| rank | Ранг задачи. Допустимые значения: от 0 до 100. |
| startDate | Дата начала задачи (обязательное поле). Подробнее о формате времени) |
| status | Статус задачи. Существуют следующие значения:
|
| taskTypeID | ИД типа задачи |
| customStatusID | ИД пользовательского статуса задачи |
| customStatusReasonID | Ид причины смены пользовательского статуса задачи |
| mapObjectID | ИД объекта. Если в запросе переданы параметры mapObjectID, longitude, latitude, то местоположение задачи определяется по значениям, переданным в параметрах latitude, longitude. |
| mapObjectWorkScheduleID | ИД расписания |
| commentPolicy | Требования к комментарию при завершении задачи. Существуют следующие значения:
|
| serviceTime | Время выполнения задачи |
| startInterval | Интервал начала выполнения задачи |
| preferredPositionInRoute | Порядок задачи в маршруте. Допустимые значения: от 1 до 10. |
| isFixed | Является ли задача закрепленной. Существуют следующие значения:
|
| isMandatoryInRoute | Должна ли задача быть обязательно поставлена в маршрут. Существуют следующие значения:
|
| Параметры компетенций задачи (competences) | |
| competenceID | ИД компетенции |
| amount | Вес компетенции |
| level | Уровень владения компетенцией |
| Параметры измерений (структура dimensions) | |
| weight | Вес (кг) |
| unit | Юниты |
| width | Ширина (м) |
| height | Высота (м) |
| length | Длина (м) |
| volume | Объем (м3) |
| Параметры дополнительных полей задачи (массив структур customFieldFormItems) | |
| externalID | ИД дополнительного поля |
| value | Значение дополнительного поля |
| values | Значения поля в случае множественного выбора |
| Параметры шаблонов формы, обязательной при отклонении или завершении задачи (массив структур taskFormTemplates) | |
| status | Статус задачи, при переводе в который необходимо заполнить форму. Возможные значения:
|
| taskFormTemplateID | ИД шаблона формы |
| isRequired | Является ли заполнение формы обязательным. Возможные значения:
|
| Параметры предзаполненных полей (массив структур prefillValues) | |
| externalID | Внешний ИД поля |
| value | Значение поля |
| values | Значения в случае множественного выбора |
| Параметры колонок таблицы (массив массивов rows) | |
| externalID | Внешний ИД колонки |
| value | Значение колонки |
| values | Значения в случае множественного выбора |
| Параметры общей ссылки на местоположение сотрудника (структура sharedLink) | |
| isActive | Активность ссылки:
|
| sharingPeriod | Время действия ссылки:
|
| sharingEndDate | Дата и время окончания действия ссылки (если sharingPeriod = 2) |
| sendToEmail | Отправка ссылки на e-mail клиента:
|
| sendToSMS | Отправка ссылки по SMS:
|
| Параметры обратной связи (структура feedback) | |
| formInvitationProfileID | ИД профиля обратной связи |
| formTemplateID | ИД формы обратной связи |
| sendToEmail | Отправить форму обратной связи на электронную почту клиента. Электронная почта должна быть указана в параметре clientEmail. Существуют следующие значения:
|
| sendToSMS | Отправить форму обратной связи по SMS клиенту. Телефон клиента должен быть указан в параметре clientPhone. Существуют следующие значения:
|
| Параметры чек-листа (массив структур checklists) | |
| assetID | ИД актива |
| isRequired | Является ли заполнение чек-листа обязательным. Существуют следующие значения:
|
| type | Тип чек-листа. Существуют следующие значения:
|
| checkListTemplateIDs | ИД шаблонов чек-листов |
| name | Название чек-листа |
| Description | Описание чек-листа |
Результат выполнения
При успешном выполнении возвращается статус 201.
Функция возвращает структуру со следующими параметрами задачи:
| Параметр | Описание |
|---|---|
| taskID | ИД задачи |
| subscriberID | ИД Сотрудника |
| deadline | Крайний срок завершения задачи (дата и время, подробнее о формате времени). |
| title | Название задачи |
| description | Описание задачи |
| address | Адрес задачи |
| longitude | Географическая долгота адреса (в градусах) |
| latitude | Географическая широта адреса (в градусах) |
| externalID | Внешний пользовательский ИД задачи |
| clientName | ФИО клиента |
| clientPhone | Телефон клиента |
| clientEmail | Адрес электронной почты клиента |
| priority | Приоритет задачи. Существуют следующие значения:
|
| rank | Ранг задачи. Допустимые значения: от 0 до 100. |
| startDate | Дата начала задачи (подробнее о формате времени). |
| status | Статус задачи. Существуют следующие значения:
|
| taskTypeID | ИД типа задачи |
| customStatusID | ИД пользовательского статуса задачи |
| customStatusReasonID | Ид причины смены пользовательского статуса задачи |
| mapObjectID | ИД объекта |
| mapObjectWorkScheduleID | ИД расписания |
| commentPolicy | Требования к комментарию при завершении задачи. Существуют следующие значения:
|
| serviceTime | Время выполнения задачи |
| startInterval | Интервал начала выполнения задачи |
| preferredPositionInRoute | Порядок задачи в маршруте. Допустимые значения: от 1 до 10. |
| isFixed | Является ли задача закрепленной (нельзя менять время начала выполнения в пределах допустимого времени опоздания, изменять или снимать исполнителя). Существуют следующие значения:
|
| isMandatoryInRoute | Должна ли задача быть обязательно поставлена в маршрут. Существуют следующие значения:
|
| creationDate | Дата и время создания задачи (подробнее о формате времени). |
| includeWorkOrders | Назначения задачи. Существуют следующие значения:
|
| includeRouteItems | Информация из маршрута. Существуют следующие значения:
|
| considerWorkOrders | Искать ли задачи дополнительно по датам назначений. Существуют следующие значения:
|
| Параметры маршрута задачи (массив структур routeItems) | |
| plannedStartDate | Плановая дата начала задачи (подробнее о формате времени). |
| plannedEndDate | Плановая дата окончания задачи (подробнее о формате времени). |
| timeToPoint | Время доезда в минутах до адреса задачи |
| distanceToPoint | Расстояние в метрах до адреса задачи |
| awaitingTime | Время ожидания начала задачи после доезда до адреса задачи |
| Параметры компетенций задачи (competences) | |
| competenceID | ИД компетенции |
| amount | Вес компетенции |
| level | Уровень владения компетенцией |
| Параметры измерений (структура dimensions) | |
| weight | Вес (кг) |
| unit | Юниты |
| width | Ширина (м) |
| height | Высота (м) |
| length | Длина (м) |
| volume | Объем (м3) |
| Параметры дополнительных полей задачи (массив структур customFieldFormItems) | |
| externalID | ИД дополнительного поля |
| name | Название дополнительного поля |
| value | Значение дополнительного поля |
| values | Значения дополнительного поля в случае множественного выбора |
| type | Тип дополнительного поля. Существуют следующие типы:
|
| subType | Подтип поля «Строка». Существуют следующие значения:
|
| Параметры шаблона формы, обязательного для заполнения при отклонении или завершении задачи (массив структур taskFormTemplates) | |
| status | Статус задачи, при переводе в который необходимо заполнить форму. Существуют следующие значения:
|
| taskFormTemplateID | ИД шаблона формы. |
| isRequired | Является ли обязательным заполнение формы. Существуют следующие значения:
|
| Параметры предзаполненных полей (массив структур prefillValues) | |
| externalID | Внешний ИД поля. |
| value | Значение поля. |
| values | Значения колонки в случае множественного выбора |
| Параметры колонок таблицы (массив массивов rows) | |
| externalID | Внешний ИД колонки. |
| name | Название колонки |
| value | Значение колонки |
| values | Значения колонки в случае множественного выбора |
| type | Тип дополнительного поля. Существуют следующие типы:
|
| subtype | Подтип поля «Строка». Существуют следующие значения:
|
| Параметры общей ссылки на местоположение Сотрудника, выполняющего задачу. Получателю ссылки не требуются логин и пароль для просмотра местоположения (структура sharedLink) | |
| isActive | Активность ссылки. Существуют следующие значения:
|
| sharingPeriod | Время действия ссылки, после его окончания просмотр местоположения по ссылке станет недоступным. Существуют следующие значения:
|
| sharingEndDate | Дата и время окончания действия ссылки (если в параметре sharingPeriod передано значение 2) |
| sendToEmail | Отправить ссылку на электронную почту клиента. Электронная почта должна быть указана в параметре clientEmail. Существуют следующие значения:
|
| sendToSMS | Отправить ссылку по SMS клиенту. Телефон клиента должен быть указан в параметре clientPhone. Существуют следующие значения:
|
| Параметры обратной связи (структура feedback) | |
| formInvitationProfileID | ИД профиля обратной связи |
| formTemplateID | ИД формы обратной связи |
| sendToEmail | Отправить форму обратной связи на электронную почту клиента. Электронная почта должна быть указана в параметре clientEmail. Существуют следующие значения:
|
| sendToSMS | Отправить форму обратной связи по SMS клиенту. Телефон клиента должен быть указан в параметре clientPhone. Существуют следующие значения:
|
| Параметры чек-листов (массив структур checklists) | |
| checklistID | ИД чек-листа |
| assetID | ИД актива |
| name | Название чек-листа |
| description | Описание чек-листа |
| isRequired | Является ли заполнение чек-листа обязательным. Существуют следующие значения:
|
| checkListExternalID | Внешний ИД чек-листа |
| type | Тип чек-листа. Существуют следующие значения:
|
| Status | Статус чек-листа. Существуют следующие значения:
|
| creationDate | Дата и время создания чек-листа |
| taskID | ИД задачи, к которой привязан чек-лист |
| lastModificationDate | Дата и время последнего прохождения чек-листа |
| subscriberID | ИД Сотрудника, который заполняет чек-лист |
| latitude | Географическая широта места прохождения чек-листа (в градусах) |
| longitude | Географическая долгота места прохождения чек-листа (в градусах) |
| radius | Радиус погрешности определения места прохождения чек-листа (в метрах) |
| address | Адрес прохождения чек-листа |
| checkListTemplateIDs | ИД шаблонов чек-листов |
| checkListTemplateNames | Названия шаблонов чек-листов |
| maxScore | Максимальная оценка по итогам прохождения чек-листа |
| totalScore | Общая оценка по итогам прохождения чек-листа |
Формат запроса
POST /me-open-api/api/taskManagement/tasks HTTP/1.1
Host: host
Authorization: Bearer token
{
"subscriberID": integer,
"deadline": "dateTime",
"title": "string",
"description": "string",
"address": "string",
"longitude": number,
"latitude": number,
"externalID": "string",
"clientName": "string",
"clientPhone": "string",
"clientEmail": "string",
"priority": integer,
"rank": integer,
"startDate": "dateTime",
"status": integer,
"taskTypeID": integer,
"customStatusID": integer,
"customStatusReasonID": integer,
"mapObjectID": integer,
"mapObjectWorkScheduleID": integer,
"commentPolicy": integer,
"competences": [
{
"competenceID": integer,
"amount": number,
"level": integer
}
],
"dimensions": {
"weight": number,
"unit": number,
"width": number,
"height": number,
"length": number,
"volume": number
},
"serviceTime": integer,
"startInterval": integer,
"isMandatoryInRoute": boolean,
"preferredPositionInRoute": integer,
"isFixed": boolean,
"customFieldsFormTemplateID": integer,
"customFieldFormItems": [
{
"externalID": "string",
"value": "string",
"values": [
"string"
],
"rows": [
[
{
"externalID": "string",
"value": "string",
"values": [
"string"
],
}
]
]
}
],
"taskFormTemplates": [
{
"status": integer,
"taskFormTemplateID": integer,
"isRequired": boolean,
"prefillValues": [
{
"externalID": "string",
"value": "string",
"values": [
"string",
]
"rows": [
[
{
"externalID": "string",
"value": "string",
"value": [
"string"
]
}
]
]
}
]
}
],
"sharedLink": {
"isActive": boolean,
"sharingPeriod": integer,
"sharingEndDate": "dateTime",
"sendToEmail": boolean,
"sendToSMS": boolean
},
"feedback": {
"formInvitationProfileID": integer,
"formTemplateID": integer,
"sendToEmail": boolean,
"sendToSMS": boolean
},
"checklists": [
{
"assetID": integer,
"isRequired": boolean,
"type": integer,
"checkListTemplateIDs": [
integer
],
"name": "string",
"description": "string"
}
]
}Пример запроса
POST /me-open-api/api/taskManagement/tasks HTTP/1.1
Host: track.beeline.ru
Authorization: Bearer token
{
"subscriberID": 1,
"deadline": "2020-10-06T20:00:00",
"title": "task",
"description": "Описание",
"address": "Россия, Москва, улица Большая Ордынка, 27/6с4",
"longitude": 37.61775044433594,
"latitude": 55.735528725106505,
"externalID": 2,
"clientName": "Иванов Иван",
"clientPhone": "79161234567",
"clientEmail": "ivan@ivanov.ru",
"priority": 1,
"rank": 10,
"startDate": "2020-10-06T14:50:00",
"status": 0,
"taskTypeID": 1,
"customStatusID": 1,
"customStatusReasonID": 1,
"mapObjectID": 1,
"mapObjectWorkScheduleID": 0,
"commentPolicy": 3,
"competences": [
{
"competenceID": 1,
"amount": 13,
"level": 3
}
],
"dimensions": {
"weight": 5,
"unit": 5,
"width": 5,
"height": 5,
"length": 5,
"volume": 5
},
"serviceTime": 12,
"startInterval": 12,
"isMandatoryInRoute": true,
"preferredPositionInRoute": 1,
"isFixed": false,
"customFieldsFormTemplateID": 1,
"customFieldFormItems": [
{
"externalID": "1",
"value": "True"
}
],
"taskFormTemplates": [
{
"status": 2,
"taskFormTemplateID": 1,
"isRequired": true
},
{
"status": 3,
"taskFormTemplateID": 2,
"isRequired": true
}
],
"sharedLink": {
"isActive": true,
"sharingPeriod": 2,
"sharingEndDate": "2022-10-06T12:50:00+03:00",
"sendToEmail": true,
"sendToSMS": true
},
"feedback": {
"formInvitationProfileID": 1,
"formTemplateID": 1,
"sendToEmail": true,
"sendToSMS": true
},
"checklists": [
{
"assetID": 1,
"isRequired": true,
"type": 0,
"checkListTemplateIDs": [
1
],
"name": "Техническое обслуживание здания",
"description": "Полное тех. Обслуживание"
}
]
}Формат ответа
{
"taskID": integer,
"routeItems": [
{
"plannedStartDate": "string",
"plannedEndDate": "string",
"timeToPoint": integer,
"distanceToPoint": integer
}
],
"subscriberID": integer,
"deadline": "dateTime",
"title": "string",
"description": "string",
"address": "string",
"longitude": number,
"latitude": number,
"externalID": "string",
"clientName": "string",
"clientPhone": "string",
"clientEmail": "string",
"priority": integer,
"rank": integer,
"startDate": "dateTime",
"status": integer,
"taskTypeID": integer,
"customStatusID": integer,
"customStatusReasonID": integer,
"mapObjectID": integer,
"mapObjectWorkScheduleID": integer,
"commentPolicy": integer,
"competences": [
{
"competenceID": integer,
"amount": number,
"level": integer
}
],
"dimensions": {
"weight": number,
"unit": number,
"width": number,
"height": number,
"length": number,
"volume": number
},
"serviceTime": integer,
"startInterval": integer,
"isMandatoryInRoute": boolean,
"preferredPositionInRoute": integer,
"isFixed": boolean,
"customFieldsFormTemplateID": integer,
"customFieldFormItems": [
{
"externalID": "string",
"name": "string",
"value": "string",
"values": [
"string"
],
"type": "string",
"subtype": integer,
"rows": [
[
{
"externalID": "string",
"name": "string",
"value": "string",
"values": [
"string"
],
"type": "string",
"subtype": integer
}
]
]
}
],
"taskFormTemplates": [
{
"status": integer,
"taskFormTemplateID": integer,
"isRequired": boolean,
"prefillValues": [
{
"externalID": "string",
"value": "string",
"rows": [
[
{
"externalID": "string",
"value": "string"
}
]
]
}
]
}
]
"creationDate": "dateTime",
"sharedLink": {
"isActive": boolean,
"sharingPeriod": integer,
"sharingEndDate": "dateTime",
"sendToEmail": boolean,
"sendToSMS": boolean
},
"feedback": {
"formInvitationProfileID": integer,
"formTemplateID": integer,
"sendToEmail": boolean,
"sendToSMS": boolean
},
"checklists": [
{
"checklistID": integer,
"assetID": integer,
"name": "string",
"description": "string",
"isRequired": boolean,
"checkListExternalID": "string",
"type": integer,
"status": integer,
"creationDate": "date-time",
"taskID": integer,
"lastModificationDate": "date-time",
"subscriberID": integer,
"latitude": number,
"longitude": number,
"radius": integer,
"address": "string",
"checkListTemplateIDs": [
integer
],
"checkListTemplateNames": [
"string"
],
"maxScore": number,
"totalScore": number
}
]
}Пример ответа
{
"taskID": 1,
"routeItems": [
{
"plannedStartDate": "2024-07-31T09:08:55.988Z",
"plannedEndDate": "2024-07-31T09:08:55.988Z",
"timeToPoint": 60,
"distanceToPoint": 650
}
],
"subscriberID": 1,
"deadline": "2020-10-06T20:00:00+03:00",
"title": "task",
"description": "Описание",
"address": "Россия, Москва, улица Большая Ордынка, 27/6с4",
"longitude": 37.61775044433594,
"latitude": 55.735528725106505,
"externalID": null,
"clientName": "Иванов Иван",
"clientPhone": "79161234567",
"clientEmail": "ivan@ivanov.ru",
"priority": 1,
"rank": 10,
"startDate": "2020-10-06T14:50:00+03:00",
"status": 1,
"taskTypeID": 1,
"customStatusID": 1,
"customStatusReasonID": 1,
"mapObjectID": 1,
"mapObjectWorkScheduleID": 0,
"commentPolicy": 3,
"competences": [
{
"competenceID": 1,
"amount": 13,
"level": 3
}
],
"dimensions": {
"weight": 5,
"unit": 5,
"width": 5,
"height": 5,
"length": 5,
"volume": 5
},
"serviceTime": 12,
"startInterval": 12,
"isMandatoryInRoute": true,
"preferredPositionInRoute": 1,
"isFixed": false,
"customFieldsFormTemplateID": 1,
"customFieldFormItems": [
{
"externalID": "1",
"name": "Лично в руки",
"value": "True",
"type": "Boolean"
}
],
"taskFormTemplates": [
{
"status": 2,
"taskFormTemplateID": 1,
"isRequired": true,
"prefillValues": [
{
"externalID": "85978",
"value": "Значение поля",
"rows": [
[
{
"externalID": "872",
"value": "Значение колонки"
}
]
]
}
]
}
]
"creationDate": "2020-10-06T12:50:00+03:00",
"sharedLink": {
"isActive": true,
"sharingPeriod": 2,
"sharingEndDate": "2022-10-06T12:50:00+03:00",
"sendToEmail": true,
"sendToSMS": true
},
"feedback": {
"formInvitationProfileID": 1,
"formTemplateID": 1,
"sendToEmail": true,
"sendToSMS": true
},
"checklists": [
{
"checklistID": 1,
"assetID": 1,
"name": "Техническое обслуживание здания",
"description": "Дома десятиэтажные",
"isRequired": true,
"checkListExternalID": "6093f666-97db-4722-9bd0-4c9d9ab480e7",
"type": 0,
"status": 2,
"creationDate": "2020-10-19T21:10:39.94+03:00",
"taskID": 1,
"lastModificationDate": "2020-10-20T11:10:39.94+03:00",
"subscriberID": 1,
"latitude": 55.735528725106505,
"longitude": 37.61775044433594,
"radius": 100,
"address": "Россия, Москва, улица Большая Ордынка, 27/6с4",
"checkListTemplateIDs": [
1
],
"checkListTemplateNames": [
"Техническое обслуживание десятиэтажных зданий"
],
"maxScore": 10,
"totalScore": 8
}
]
}Обновление задачи
Общее описание
Функция PUT /me-open-api/api/taskManagement/tasks/{taskID} позволяет обновить задачу (должны быть переданы все атрибуты задачи для обновления, т.е. задача обновляется полностью).
Параметры вызова
Функция имеет следующие параметры:
| Параметр | Описание |
|---|---|
| subscriberID | ИД Сотрудника |
| deadline | Крайний срок завершения задачи (дата и время, подробнее о формате времени) |
| title | Название задачи (обязательное поле) |
| description | Описание задачи |
| address | Адрес задачи |
| longitude | Географическая долгота адреса (в градусах). Если в запросе переданы параметры mapObjectID, longitude, latitude, то местоположение задачи определяется по значениям, переданным в параметрах latitude, longitude. |
| latitude | Географическая широта адреса (в градусах). Если в запросе переданы параметры mapObjectID, longitude, latitude, то местоположение задачи определяется по значениям, переданным в параметрах latitude, longitude. |
| externalID | Внешний пользовательский ИД задачи |
| clientName | ФИО клиента |
| clientPhone | Телефон клиента |
| clientEmail | Адрес электронной почты клиента |
| priority | Приоритет задачи. Существуют следующие значения:
|
| rank | Ранг задачи. Допустимые значения: от 0 до 100. |
| startDate | Дата начала задачи (обязательное поле). Подробнее о формате времени) |
| status | Статус задачи. Существуют следующие значения:
|
| taskTypeID | ИД типа задачи |
| customStatusID | ИД пользовательского статуса задачи |
| customStatusReasonID | Ид причины смены пользовательского статуса задачи |
| mapObjectID | ИД объекта. Если в запросе переданы параметры mapObjectID, longitude, latitude, то местоположение задачи определяется по значениям, переданным в параметрах latitude, longitude. |
| mapObjectWorkScheduleID | ИД расписания |
| commentPolicy | Требования к комментарию при завершении задачи. Существуют следующие значения:
|
| serviceTime | Время выполнения задачи |
| startInterval | Интервал начала выполнения задачи |
| preferredPositionInRoute | Порядок задачи в маршруте. Допустимые значения: от 1 до 10. |
| isFixed | Является ли задача закрепленной. Существуют следующие значения:
|
| isMandatoryInRoute | Должна ли задача быть обязательно поставлена в маршрут. Существуют следующие значения:
|
| Параметры компетенций задачи (competences) | |
| competenceID | ИД компетенции |
| amount | Вес компетенции |
| level | Уровень владения компетенцией |
| Параметры измерений (структура dimensions) | |
| weight | Вес (кг) |
| unit | Юниты |
| width | Ширина (м) |
| height | Высота (м) |
| length | Длина (м) |
| volume | Объем (м3) |
| Параметры дополнительных полей задачи (массив структур customFieldFormItems) | |
| externalID | ИД дополнительного поля |
| value | Значение дополнительного поля |
| values | Значения поля в случае множественного выбора |
| Параметры шаблонов формы, обязательной при отклонении или завершении задачи (массив структур taskFormTemplates) | |
| status | Статус задачи, при переводе в который необходимо заполнить форму. Возможные значения:
|
| taskFormTemplateID | ИД шаблона формы |
| isRequired | Является ли заполнение формы обязательным. Возможные значения:
|
| Параметры предзаполненных полей (массив структур prefillValues) | |
| externalID | Внешний ИД поля |
| value | Значение поля |
| values | Значения в случае множественного выбора |
| Параметры колонок таблицы (массив массивов rows) | |
| externalID | Внешний ИД колонки |
| value | Значение колонки |
| values | Значения в случае множественного выбора |
| Параметры общей ссылки на местоположение сотрудника (структура sharedLink) | |
| isActive | Активность ссылки:
|
| sharingPeriod | Время действия ссылки:
|
| sharingEndDate | Дата и время окончания действия ссылки (если sharingPeriod = 2) |
| sendToEmail | Отправка ссылки на e-mail клиента:
|
| sendToSMS | Отправка ссылки по SMS:
|
| Параметры обратной связи (структура feedback) | |
| formInvitationProfileID | ИД профиля обратной связи |
| formTemplateID | ИД формы обратной связи |
| sendToEmail | Отправить форму обратной связи на электронную почту клиента. Электронная почта должна быть указана в параметре clientEmail. Существуют следующие значения:
|
| sendToSMS | Отправить форму обратной связи по SMS клиенту. Телефон клиента должен быть указан в параметре clientPhone. Существуют следующие значения:
|
| Параметры чек-листа (массив структур checklists) | |
| assetID | ИД актива |
| isRequired | Является ли заполнение чек-листа обязательным. Существуют следующие значения:
|
| type | Тип чек-листа. Существуют следующие значения:
|
| checkListTemplateIDs | ИД шаблонов чек-листов |
| name | Название чек-листа |
| Description | Описание чек-листа |
Результат выполнения
При успешном выполнении возвращается статус 204.
Формат запроса
PUT /me-open-api/api/taskManagement/tasks/{taskID} HTTP/1.1
Host: host
Authorization: Bearer token
{
"subscriberID": integer,
"deadline": "dateTime",
"title": "string",
"description": "string",
"address": "string",
"longitude": number,
"latitude": number,
"externalID": "string",
"clientName": "string",
"clientPhone": "string",
"clientEmail": "string",
"priority": integer,
"rank": integer,
"startDate": "dateTime",
"status": integer,
"taskTypeID": integer,
"customStatusID": integer,
"customStatusReasonID": integer,
"mapObjectID": integer,
"mapObjectWorkScheduleID": integer,
"commentPolicy": integer,
"competences": [
{
"competenceID": integer,
"amount": number,
"level": integer
}
],
"dimensions": {
"weight": number,
"unit": number,
"width": number,
"height": number,
"length": number,
"volume": number
},
"serviceTime": integer,
"startInterval": integer,
"isMandatoryInRoute": boolean,
"preferredPositionInRoute": integer,
"isFixed": boolean,
"customFieldsFormTemplateID": integer,
"customFieldFormItems": [
{
"externalID": "string",
"value": "string",
"values": [
"string"
],
"rows": [
[
{
"externalID": "string",
"value": "string",
"values": [
"string"
],
}
]
]
}
],
"taskFormTemplates": [
{
"status": integer,
"taskFormTemplateID": integer,
"isRequired": boolean,
"prefillValues": [
{
"externalID": "string",
"value": "string",
"values": [
"string",
]
"rows": [
[
{
"externalID": "string",
"value": "string",
"value": [
"string"
]
}
]
]
}
]
}
],
"sharedLink": {
"isActive": boolean,
"sharingPeriod": integer,
"sharingEndDate": "dateTime",
"sendToEmail": boolean,
"sendToSMS": boolean
},
"feedback": {
"formInvitationProfileID": integer,
"formTemplateID": integer,
"sendToEmail": boolean,
"sendToSMS": boolean
},
"checklists": [
{
"assetID": integer,
"isRequired": boolean,
"type": integer,
"checkListTemplateIDs": [
integer
],
"name": "string",
"description": "string"
}
]
}Пример запроса
PUT /me-open-api/api/taskManagement/tasks/1 HTTP/1.1
Host: track.beeline.ru
Authorization: Bearer token
{
"subscriberID": 1,
"deadline": "2020-10-06T20:00:00",
"title": "task",
"description": "Описание",
"address": "Россия, Москва, улица Большая Ордынка, 27/6с4",
"longitude": 37.61775044433594,
"latitude": 55.735528725106505,
"externalID": 2,
"clientName": "Иванов Иван",
"clientPhone": "79161234567",
"clientEmail": "ivan@ivanov.ru",
"priority": 1,
"rank": 10,
"startDate": "2020-10-06T14:50:00",
"status": 0,
"taskTypeID": 1,
"customStatusID": 1,
"customStatusReasonID": 1,
"mapObjectID": 1,
"mapObjectWorkScheduleID": integer,
"commentPolicy": 3,
"competences": [
{
"competenceID": 1,
"amount": 13,
"level": 3
}
],
"dimensions": {
"weight": 5,
"unit": 5,
"width": 5,
"height": 5,
"length": 5,
"volume": 5
},
"serviceTime": 12,
"startInterval": 12,
"isMandatoryInRoute": true,
"preferredPositionInRoute": 1,
"isFixed": false,
"customFieldsFormTemplateID": 1,
"customFieldFormItems": [
{
"externalID": "1",
"value": "True"
}
],
"taskFormTemplates": [
{
"status": 2,
"taskFormTemplateID": 1,
"isRequired": true
},
{
"status": 3,
"taskFormTemplateID": 2,
"isRequired": true
}
],
"sharedLink": {
"isActive": true,
"sharingPeriod": 2,
"sharingEndDate": "2022-10-06T12:50:00+03:00",
"sendToEmail": true,
"sendToSMS": true
},
"feedback": {
"formInvitationProfileID": 1,
"formTemplateID": 1,
"sendToEmail": true,
"sendToSMS": true
},
"checklists": [
{
"assetID": 1,
"isRequired": true,
"type": 0,
"checkListTemplateIDs": [
1
],
"name": "Техническое обслуживание здания",
"description": "Полное тех. Обслуживание"
}
]
}Изменение задачи
Общее описание
Функция PATCH /me-open-api/api/taskManagement/tasks/{taskID} позволяет изменить только часть параметров задачи по ее идентификатору.
Параметры вызова
Функция имеет следующие параметры:
| Параметр | Описание |
|---|---|
| subscriberID | ИД Сотрудника |
| deadline | Крайний срок завершения задачи (дата и время, подробнее о формате времени) |
| title | Название задачи (обязательное поле) |
| description | Описание задачи |
| address | Адрес задачи |
| longitude | Географическая долгота адреса (в градусах). Если в запросе переданы параметры mapObjectID, longitude, latitude, то местоположение задачи определяется по значениям, переданным в параметрах latitude, longitude. |
| latitude | Географическая широта адреса (в градусах). Если в запросе переданы параметры mapObjectID, longitude, latitude, то местоположение задачи определяется по значениям, переданным в параметрах latitude, longitude. |
| externalID | Внешний пользовательский ИД задачи |
| clientName | ФИО клиента |
| clientPhone | Телефон клиента |
| clientEmail | Адрес электронной почты клиента |
| priority | Приоритет задачи. Существуют следующие значения:
|
| rank | Ранг задачи. Допустимые значения: от 0 до 100. |
| startDate | Дата начала задачи (обязательное поле). Подробнее о формате времени) |
| status | Статус задачи. Существуют следующие значения:
|
| taskTypeID | ИД типа задачи |
| customStatusID | ИД пользовательского статуса задачи |
| customStatusReasonID | Ид причины смены пользовательского статуса задачи |
| mapObjectID | ИД объекта. Если в запросе переданы параметры mapObjectID, longitude, latitude, то местоположение задачи определяется по значениям, переданным в параметрах latitude, longitude. |
| mapObjectWorkScheduleID | ИД расписания |
| commentPolicy | Требования к комментарию при завершении задачи. Существуют следующие значения:
|
| serviceTime | Время выполнения задачи |
| startInterval | Интервал начала выполнения задачи |
| preferredPositionInRoute | Порядок задачи в маршруте. Допустимые значения: от 1 до 10. |
| isFixed | Является ли задача закрепленной. Существуют следующие значения:
|
| isMandatoryInRoute | Должна ли задача быть обязательно поставлена в маршрут. Существуют следующие значения:
|
| Параметры компетенций задачи (competences) | |
| competenceID | ИД компетенции |
| amount | Вес компетенции |
| level | Уровень владения компетенцией |
| Параметры измерений (структура dimensions) | |
| weight | Вес (кг) |
| unit | Юниты |
| width | Ширина (м) |
| height | Высота (м) |
| length | Длина (м) |
| volume | Объем (м3) |
| Параметры дополнительных полей задачи (массив структур customFieldFormItems). При изменении дополнительного поля необходимо передавать все дополнительные поля. | |
| externalID | ИД дополнительного поля |
| value | Значение дополнительного поля |
| values | Значения поля в случае множественного выбора |
| Параметры шаблонов формы, обязательной при отклонении или завершении задачи (массив структур taskFormTemplates) | |
| status | Статус задачи, при переводе в который необходимо заполнить форму. Возможные значения:
|
| taskFormTemplateID | ИД шаблона формы |
| isRequired | Является ли заполнение формы обязательным. Возможные значения:
|
| Параметры предзаполненных полей (массив структур prefillValues) | |
| externalID | Внешний ИД поля |
| value | Значение поля |
| values | Значения в случае множественного выбора |
| Параметры колонок таблицы (массив массивов rows) | |
| externalID | Внешний ИД колонки |
| value | Значение колонки |
| values | Значения в случае множественного выбора |
| Параметры общей ссылки на местоположение сотрудника (структура sharedLink) | |
| isActive | Активность ссылки:
|
| sharingPeriod | Время действия ссылки:
|
| sharingEndDate | Дата и время окончания действия ссылки (если sharingPeriod = 2) |
| sendToEmail | Отправка ссылки на e-mail клиента:
|
| sendToSMS | Отправка ссылки по SMS:
|
| Параметры обратной связи (структура feedback) | |
| formInvitationProfileID | ИД профиля обратной связи |
| formTemplateID | ИД формы обратной связи |
| sendToEmail | Отправить форму обратной связи на электронную почту клиента. Электронная почта должна быть указана в параметре clientEmail. Существуют следующие значения:
|
| sendToSMS | Отправить форму обратной связи по SMS клиенту. Телефон клиента должен быть указан в параметре clientPhone. Существуют следующие значения:
|
| Параметры чек-листа (массив структур checklists) | |
| assetID | ИД актива |
| isRequired | Является ли заполнение чек-листа обязательным. Существуют следующие значения:
|
| type | Тип чек-листа. Существуют следующие значения:
|
| checkListTemplateIDs | ИД шаблонов чек-листов |
| name | Название чек-листа |
| Description | Описание чек-листа |
Результат выполнения
При успешном выполнении возвращается статус 204.
Формат запроса
PATCH /me-open-api/api/taskManagement/tasks/{taskID} HTTP/1.1
Host: host
Authorization: Bearer token
{
"subscriberID": integer,
"deadline": "dateTime",
"title": "string",
"description": "string",
"address": "string",
"longitude": number,
"latitude": number,
"externalID": "string",
"clientName": "string",
"clientPhone": "string",
"clientEmail": "string",
"priority": integer,
"rank": integer,
"startDate": "dateTime",
"status": integer,
"taskTypeID": integer,
"customStatusID": integer,
"customStatusReasonID": integer,
"mapObjectID": integer,
"mapObjectWorkScheduleID": integer,
"commentPolicy": integer,
"competences": [
{
"competenceID": integer,
"amount": number,
"level": integer
}
],
"dimensions": {
"weight": number,
"unit": number,
"width": number,
"height": number,
"length": number,
"volume": number
},
"serviceTime": integer,
"startInterval": integer,
"isMandatoryInRoute": boolean,
"preferredPositionInRoute": integer,
"isFixed": boolean,
"customFieldsFormTemplateID": integer,
"customFieldFormItems": [
{
"externalID": "string",
"value": "string",
"values": [
"string"
],
"rows": [
[
{
"externalID": "string",
"value": "string",
"values": [
"string"
],
}
]
]
}
],
"taskFormTemplates": [
{
"status": integer,
"taskFormTemplateID": integer,
"isRequired": boolean,
"prefillValues": [
{
"externalID": "string",
"value": "string",
"values": [
"string",
]
"rows": [
[
{
"externalID": "string",
"value": "string",
"value": [
"string"
]
}
]
]
}
]
}
],
"sharedLink": {
"isActive": boolean,
"sharingPeriod": integer,
"sharingEndDate": "dateTime",
"sendToEmail": boolean,
"sendToSMS": boolean
},
"feedback": {
"formInvitationProfileID": integer,
"formTemplateID": integer,
"sendToEmail": boolean,
"sendToSMS": boolean
},
"checklists": [
{
"assetID": integer,
"isRequired": boolean,
"type": integer,
"checkListTemplateIDs": [
integer
],
"name": "string",
"description": "string"
}
]
}Пример запроса
PATCH /me-open-api/api/taskManagement/tasks/1 HTTP/1.1
Host: track.beeline.ru
Authorization: Bearer token
{
"deadline": "2020-10-10T20:00:00",
"clientName": "Петров Петр",
"clientPhone": "79151234567",
"priority": 2,
"rank": 40,
"startDate": "2020-10-10T14:50:00",
"mapObjectID": 5,
"mapObjectWorkScheduleID": 0,
"commentPolicy": 2,
"competences": [
{
"competenceID": 1,
"amount": 30,
"level": 3
}
],
"serviceTime": 60,
"startInterval": 60,
"isMandatoryInRoute": true,
"preferredPositionInRoute": 1,
"isFixed": true,
"customFieldsFormTemplateID": 1,
"customFieldFormItems": [
{
"externalID": "1",
"value": "False"
}
],
"checklists": [
{
"assetID": 1,
"isRequired": true,
"type": 0,
"checkListTemplateIDs": [
1
],
"name": "Техническое обслуживание здания",
"description": "Полное тех. Обслуживание"
}
]
}Удаление задачи
Общее описание
Функция DELETE /me-open-api/api/taskManagement/tasks/{taskID} позволяет удалить задачу по ее идентификатору.
Параметры вызова
В запросе используется обязательный параметр taskID — идентификатор задачи.
Результат выполнения
При успешном выполнении возвращается статус 204.
Формат запроса
DELETE /me-open-api/api/taskManagement/tasks/{taskID} HTTP/1.1
Host: host
Authorization: Bearer tokenПример запроса
DELETE /me-open-api/api/taskManagement/tasks/1 HTTP/1.1
Host: track.beeline.ru
Authorization: Bearer tokenУдаление задачи по внешнему идентификатору
Общее описание
Функция DELETE /me-open-api/api/taskManagement/tasks/externalID/{externalID} позволяет удалить задачу по ее идентификатору.
Параметры вызова
В запросе используется обязательный параметр externalID — внешний идентификатор задачи.
Результат выполнения
При успешном выполнении возвращается статус 204.
Формат запроса
DELETE /me-open-api/api/taskManagement/externalID/{externalID} HTTP/1.1
Host: host
Authorization: Bearer tokenПример запроса
DELETE /me-open-api/api/taskManagement/tasks/externalID/1 HTTP/1.1
Host: track.beeline.ru
Authorization: Bearer tokenПолучение комментариев к задачам
Общее описание
Функция GET /me-open-api/api/taskManagement/taskComments?taskIDs={long}&subscriberIDs={long}&from={dateTime}&to={dateTime} позволяет получить комментарии к задачам.
Параметры вызова
Функция имеет следующие параметры:
| Параметр | Описание |
|---|---|
| taskIDs | ИД задач. Подробнее о передаче нескольких идентификаторов |
| subscriberIDs | ИД Сотрудников. Подробнее о передаче нескольких идентификаторов |
| from | Дата и время начала периода комментариев (подробнее о формате времени) |
| to | Дата и время окончания периода комментариев (подробнее о формате времени) |
Результат выполнения
Функция возвращает массив структур со следующими параметрами комментариев:
| Параметр | Описание |
|---|---|
| taskCommentID | ИД комментария |
| subscriberID | ИД Сотрудника |
| taskID | ИД задачи |
| timestamp | Время изменения задачи (подробнее о формате времени) |
| serverTimestamp | Время изменения задачи по времени сервера |
| newStatus | Новый статус задачи. Возможные значения:
|
| oldStatus | Прежний статус задачи. Возможные значения:
|
| Comment | Комментарий |
| isCheckin | Отметка о местоположении:
|
| Address | Адрес местоположения изменения задачи |
| longitude | Географическая долгота |
| latitude | Географическая широта |
| changedBy | Имя Сотрудника, изменившего задачу |
| attachmentURNs | URN прикреплённого файла (подробнее о скачивании файла) |
| Информация о вышедшем крайнем сроке выполнения задачи (структура deadlineExpiration) | |
| expirationDate | Дата и время крайнего срока (подробнее о формате времени) |
| Информация об изменении Сотрудника, выполняющего задачу (структура subscriberChange) | |
| oldSubscriberID | ИД предыдущего Сотрудника |
| newSubscriberID | ИД нового Сотрудника |
| Информация об изменении пользовательского статуса (структура customStatusChange) | |
| oldCustomStatusID | ИД предыдущего пользовательского статуса |
| oldCustomStatusName | Название предыдущего пользовательского статуса |
| newCustomStatusID | ИД нового пользовательского статуса |
| newCustomStatusName | Название нового пользовательского статуса |
| reasonID | ИД причины смены пользовательского статуса |
Формат запроса
GET /me-open-api/api/taskManagement/taskComments?taskIDs={long}&subscriberIDs={long}&from={dateTIme}&to={dateTime} HTTP/1.1
Host: host
Authorization: Bearer tokenПример запроса
GET /me-open-api/api/taskManagement/taskComments?taskIDs=1&subscriberIDs=1&from=2020-11-10&to=2020-11-20 HTTP/1.1
Host: track.beeline.ru
Authorization: Bearer tokenФормат ответа
[
{
"taskCommentID": integer,
"subscriberID": integer,
"taskID": integer,
"timestamp": "dateTime",
"serverTimestamp": "dateTime",
"newStatus": integer,
"oldStatus": integer,
"comment": "string",
"isCheckin": boolean,
"address": "string",
"longitude": number,
"latitude": number,
"changedBy": "string",
"attachmentURNs": [
"string",
"string"
],
"details": {
"deadlineExpiration": {
"expirationDate": "string"
},
"subscriberChange": {
"oldSubscriberID": integer,
"newSubscriberID": integer
},
"customStatusChange": {
"oldCustomStatusID": integer,
"oldCustomStatusName": "string",
"newCustomStatusID": integer,
"newCustomStatusName": "string",
"reasonID": integer
}
}
}
]Пример ответа
[
{
"taskCommentID": 1,
"subscriberID": 1,
"taskID": 1,
"timestamp": "2020-11-19T11:50:23+03:00",
"serverTimestamp": "2020-11-19T11:50:23+03:00",
"newStatus": 2,
"oldStatus": 1,
"isCheckin": false,
"longitude": 37.5668602276783,
"latitude": 55.7694248249114,
"changedBy": "Десятова Марина",
"attachmentURNs": [],
"details": {
"deadlineExpiration": {
"expirationDate": "2020-11-19T11:50:23+03:00"
},
"subscriberChange": {
"oldSubscriberID": null,
"newSubscriberID": 2
},
"customStatusChange": {
"oldCustomStatusID": 106,
"oldCustomStatusName": "В пути",
"newCustomStatusID": 107,
"newCustomStatusName": "string",
"reasonID": null
}
}
},
{
"taskCommentID": 2,
"subscriberID": 2,
"taskID": 1,
"timestamp": "2020-11-19T13:31:03+03:00",
"serverTimestamp": "2020-11-19T13:27:36+03:00",
"newStatus": 2,
"oldStatus": 2,
"comment": "Фото",
"isCheckin": false,
"address": "г. Москва, ул. Туристская, 10К1, район ст.м.Сходненская",
"longitude": 37.4285033,
"latitude": 55.8528188,
"changedBy": "Сидоров Дмитрий",
"attachmentURNs": [
"m1Atk",
"XmwkV"
],
"details": {
"subscriberChange": {
"oldSubscriberID": null,
"newSubscriberID": 2
},
"customStatusChange": {
"oldCustomStatusID": null,
"oldCustomStatusName": null,
"newCustomStatusID": 8,
"newCustomStatusName": "Отправлен",
"reasonID": null
}
}
}
]Получение комментариев к задаче
Общее описание
Функция GET /me-open-api/api/taskManagement/tasks/{taskID}/taskComments позволяет получить комментарии к задаче по её идентификатору.
Параметры вызова
В запросе используется обязательный параметр taskID — идентификатор задачи.
Результат выполнения
Функция возвращает массив структур со следующими параметрами комментариев:
| Параметр | Описание |
|---|---|
| taskCommentID | ИД комментария |
| subscriberID | ИД Сотрудника |
| taskID | ИД задачи |
| timestamp | Время изменения задачи (подробнее о формате времени) |
| serverTimestamp | Время изменения задачи по времени сервера |
| newStatus | Новый статус задачи. Возможные значения:
|
| oldStatus | Прежний статус задачи. Возможные значения:
|
| Comment | Комментарий |
| isCheckin | Отметка о местоположении:
|
| Address | Адрес местоположения изменения задачи |
| longitude | Географическая долгота |
| latitude | Географическая широта |
| changedBy | Имя Сотрудника, изменившего задачу |
| attachmentURNs | URN прикреплённого файла (подробнее о скачивании файла) |
| Информация о вышедшем крайнем сроке выполнения задачи (структура deadlineExpiration) | |
| expirationDate | Дата и время крайнего срока (подробнее о формате времени) |
| Информация об изменении Сотрудника, выполняющего задачу (структура subscriberChange) | |
| oldSubscriberID | ИД предыдущего Сотрудника |
| newSubscriberID | ИД нового Сотрудника |
| Информация об изменении пользовательского статуса (структура customStatusChange) | |
| oldCustomStatusID | ИД предыдущего пользовательского статуса |
| oldCustomStatusName | Название предыдущего пользовательского статуса |
| newCustomStatusID | ИД нового пользовательского статуса |
| newCustomStatusName | Название нового пользовательского статуса |
| reasonID | ИД причины смены пользовательского статуса |
Формат запроса
GET /me-open-api/api/taskManagement/tasks/{taskID}/taskComments HTTP/1.1
Host: host
Authorization: Bearer tokenПример запроса
GET /me-open-api/api/taskManagement/tasks/1/taskComments HTTP/1.1
Host: track.beeline.ru
Authorization: Bearer tokenФормат ответа
[
{
"taskCommentID": integer,
"subscriberID": integer,
"taskID": integer,
"timestamp": "dateTime",
"serverTimestamp": "dateTime",
"newStatus": integer,
"oldStatus": integer,
"comment": "string",
"isCheckin": boolean,
"address": "string",
"longitude": number,
"latitude": number,
"changedBy": "string",
"attachmentURNs": [
"string",
"string"
]
"details": {
"deadlineExpiration": {
"expirationDate": "string"
},
"subscriberChange": {
"oldSubscriberID": integer,
"newSubscriberID": integer
},
"customStatusChange": {
"oldCustomStatusID": integer,
"oldCustomStatusName": "string",
"newCustomStatusID": integer,
"newCustomStatusName": "string",
"reasonID": integer
}
}
}
]Пример ответа
[
{
"taskCommentID": 1,
"subscriberID": 1,
"taskID": 1,
"timestamp": "2020-11-19T11:50:23+03:00",
"serverTimestamp": "2020-11-19T11:50:23+03:00",
"newStatus": 2,
"oldStatus": 1,
"isCheckin": false,
"longitude": 37.5668602276783,
"latitude": 55.7694248249114,
"changedBy": "Сидоров Дмитрий",
"attachmentURNs": [],
"details": {
"deadlineExpiration": {
"expirationDate": "2020-11-19T11:50:23+03:00"
},
"subscriberChange": {
"oldSubscriberID": null,
"newSubscriberID": 1
},
"customStatusChange": {
"oldCustomStatusID": 106,
"oldCustomStatusName": "В пути",
"newCustomStatusID": 107,
"newCustomStatusName": "string",
"reasonID": null
}
}
}
]Добавление комментария к задаче
Общее описание
Функция POST /v6/api/taskManagement/tasks/{taskID}/taskComments позволяет добавить комментарий к задаче.
Параметры вызова
Функция имеет следующие параметры:
| Параметр | Описание |
|---|---|
| taskID | ИД задачи (обязательный параметр) |
| taskStatus | Статус задачи. Существуют следующие значения:
|
| comment | Комментарий к задаче |
| isChekin | Отметка о местоположении. Существуют следующие значения:
|
Результат выполнения
Функция возвращает структуру со следующими параметрами комментария:
| Параметр | Описание |
|---|---|
| taskCommentID | ИД комментария |
| subscriberID | ИД Сотрудника |
| taskID | ИД задачи |
| timestamp | Время изменения задачи (подробнее о формате времени) |
| serverTimestamp | Время изменения задачи по времени сервера |
| newStatus | Новый статус задачи. Возможные значения:
|
| oldStatus | Прежний статус задачи. Возможные значения:
|
| Comment | Комментарий |
| isCheckin | Отметка о местоположении:
|
| Address | Адрес местоположения изменения задачи |
| longitude | Географическая долгота |
| latitude | Географическая широта |
| changedBy | Имя Сотрудника, изменившего задачу |
| attachmentURNs | URN прикреплённого файла (подробнее о скачивании файла) |
| Информация о вышедшем крайнем сроке выполнения задачи (структура deadlineExpiration) | |
| expirationDate | Дата и время крайнего срока (подробнее о формате времени) |
| Информация об изменении Сотрудника, выполняющего задачу (структура subscriberChange) | |
| oldSubscriberID | ИД предыдущего Сотрудника |
| newSubscriberID | ИД нового Сотрудника |
| Информация об изменении пользовательского статуса (структура customStatusChange) | |
| oldCustomStatusID | ИД предыдущего пользовательского статуса |
| oldCustomStatusName | Название предыдущего пользовательского статуса |
| newCustomStatusID | ИД нового пользовательского статуса |
| newCustomStatusName | Название нового пользовательского статуса |
| reasonID | ИД причины смены пользовательского статуса |
Формат запроса
POST /v6/api/taskManagement/tasks/{taskID}/taskComments HTTP/1.1
Host: host
Authorization: Bearer token
{
"taskStatus": integer,
"comment": "string",
"customStatusID": integer,
"customStatusReasonID": integer
}Пример запроса
POST /v6/api/taskManagement/tasks/1/taskComments HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token
{
"taskStatus": 2,
"comment": "Комментарий",
"customStatusID": 110,
"customStatusReasonID": 1
}Формат ответа
{
"taskCommentID": integer,
"taskID": integer,
"timestamp": "dateTime",
"serverTimestamp": "dateTime",
"newStatus": integer,
"oldStatus": integer,
"comment": "string",
"isCheckin": boolean,
"address": "string",
"longitude": number,
"latitude": number,
"changedBy": "string",
"attachmentURNs": [
"string",
"string"
],
"details": {
"deadlineExpiration": {
"expirationDate": "string"
},
"subscriberChange": {
"oldSubscriberID": integer,
"newSubscriberID": integer
},
"customStatusChange": {
"oldCustomStatusID": integer,
"oldCustomStatusName": "string",
"newCustomStatusID": integer,
"newCustomStatusName": "string",
"reasonID": integer
}
}
}Пример ответа
{
"taskCommentID": 1,
"taskID": 1,
"timestamp": "2020-11-19T16:01:39+03:00",
"serverTimestamp": "2020-11-19T15:58:15+03:00",
"newStatus": 5,
"oldStatus": 2,
"comment": "Комментарий",
"isCheckin": true,
"address": "г. Москва, пер. Тишинский Большой, 43/20, район ст.м.Улица 1905 года",
"longitude": 37.5668602276783,
"latitude": 55.7694248249114,
"changedBy": "Десятова Марина",
"attachmentURNs": [],
"details": {
"subscriberChange": {
"oldSubscriberID": null,
"newSubscriberID": 1
},
"customStatusChange": {
"oldCustomStatusID": 107,
"oldCustomStatusName": "В работе",
"newCustomStatusID": 108,
"newCustomStatusName": "Не выполнен",
"reasonID": 1
}
}
}Получение профилей приглашений на заполнение форм обратной связи
Общее описание
Функция GET /me-open-api/api/taskManagement/forms/invitations/profiles позволяет получить профили приглашений на заполнение форм обратной связи.
Параметры вызова
Функция не имеет дополнительных параметров.
Результат выполнения
Функция возвращает структуру со следующими параметрами графиков работы:
| Параметр | Описание |
|---|---|
| profileID | ИД профиля приглашения на заполнение формы обратной связи |
| creationDate | Дата создания профиля приглашения на заполнение формы обратной связи (подробнее о формате времени см. раздел 2.6). |
| title | Название профиля приглашения на заполнение формы обратной связи |
| isDefault | Профиль по умолчанию. Существуют следующие значения:
|
Формат запроса
GET /me-open-api/api/taskManagement/forms/invitations/profiles HTTP/1.1
Host: host
Authorization: Bearer tokenПример запроса
GET /me-open-api/api/taskManagement/forms/invitations/profiles HTTP/1.1
Host: track.beeline.ru
Authorization: Bearer tokenФормат ответа
[
{
"profileID": integer,
"creationDate": "datetime",
"title": "string",
"isDefault": boolean
}
]Пример ответа
[
{
"profileID": 1,
"creationDate": "2022-11-17T10:50:30+03:00",
"title": "Отзыв",
"isDefault": true
},
{
"profileID": 2,
"creationDate": "2022-11-17T10:50:30+03:00",
"title": "Пожелания",
"isDefault": false
}
]Получение файлов, прикрепленных к задаче
Общее описание
Функция GET /me-open-api/api/taskManagement/tasks/{taskID}/attachments позволяет получить файлы, прикрепленные к задаче.
Параметры вызова
В запросе используется обязательный параметр taskID — идентификатор задачи.
Результат выполнения
Функция возвращает массив структур со следующими параметрами файлов, прикрепленных к задаче:
| Параметр | Описание |
|---|---|
| taskAttachmentID | ИД файла, прикрепленного к задаче |
| urn | URN файла, прикрепленного к задаче. Подробнее о скачивании файла |
| fileSize | Размер файла (в байтах) |
| fileName | Имя файла |
| creationDate | Дата и время прикрепления файла к задаче (подробнее о формате времени). |
| contentType | MIME-тип файла |
Формат запроса
GET /me-open-api/api/taskManagement/tasks/{taskID}/attachments HTTP/1.1
Host: host
Authorization: Bearer tokenПример запроса
GET /me-open-api/api/taskManagement/tasks/1/attachments HTTP/1.1
Host: track.beeline.ru
Authorization: Bearer tokenФормат ответа
{
"taskAttachments": [
{
"taskAttachmentID": integer,
"urn": "string",
"fileSize": integer,
"fileName": "string",
"creationDate": "dateTime",
"contentType": "string"
}
]
}Пример ответа
{
"taskAttachments": [
{
"taskAttachmentID": 1,
"urn": "eJPMa",
"fileSize": 50192,
"fileName": "Счет 276385 от 17.02.2023 – платежка.pdf",
"creationDate": "2023-02-27T14:29:11.99+03:00",
"contentType": "application/pdf"
}
]
}Получение прикрепленного к задаче файла
Общее описание
Функция GET /me-open-api/api/taskManagement/tasks/attachments/{taskAttachmentID} позволяет получить файл, прикрепленный к задаче.
Параметры вызова
В запросе используется обязательный параметр taskAttachmentID — идентификатор файла, прикрепленного к задаче.
Результат выполнения
Функция возвращает структуру со следующими параметрами файла, прикрепленного к задаче:
| Параметр | Описание |
|---|---|
| taskAttachmentID | ИД файла, прикрепленного к задаче |
| urn | URN файла, прикрепленного к задаче. Подробнее о скачивании файла |
| fileSize | Размер файла (в байтах) |
| fileName | Имя файла |
| creationDate | Дата и время прикрепления файла к задаче (подробнее о формате времени). |
| contentType | MIME-тип файла |
Формат запроса
GET /me-open-api/api/taskManagement/tasks/attachments/{taskAttachmentID} HTTP/1.1
Host: host
Authorization: Bearer tokenПример запроса
GET /me-open-api/api/taskManagement/tasks/attachments/1 HTTP/1.1
Host: track.beeline.ru
Authorization: Bearer tokenФормат ответа
{
"taskAttachmentID": integer,
"urn": "string",
"fileSize": integer,
"fileName": "string",
"creationDate": "dateTime",
"contentType": "string"
}Пример ответа
{
"taskAttachmentID":1,
"urn": "eJPMa",
"fileSize": 50192,
"fileName": "Счет 276385 от 17.02.2023 – платежка.pdf",
"creationDate": "2023-02-27T14:29:11.99+03:00",
"contentType": "application/pdf"
}Прикрепление файла к задаче
Общее описание
Функция POST /me-open-api/api/taskManagement/tasks/{taskID}/attachments позволяет прикрепить файл к задаче.
Пример запроса
Функция имеет следующие параметры:
| Параметр | Описание |
|---|---|
| taskID | ИД задачи |
| Параметры, указываемые для передаваемого файла | |
| filename | Название файла с расширением, например, file.txt |
| Content-Type | MIME-тип файла |
| file content | Содержимое файла |
Результат выполнения
При успешном выполнении возвращается статус 201.
Функция возвращает структуру со следующими параметрами файла, прикрепленного к задаче:
| Параметр | Описание |
|---|---|
| taskAttachmentID | ИД файла, прикрепленного к задаче |
| urn | URN файла, прикрепленного к задаче. Подробнее о скачивании файла |
| fileSize | Размер файла (в байтах) |
| fileName | Имя файла |
| creationDate | Дата и время прикрепления файла к задаче (подробнее о формате времени). |
| contentType | MIME-тип файла |
Формат запроса
POST /me-open-api/api/taskManagement/tasks/{taskID}/attachments HTTP/1.1
Host: host
Authorization: Bearer token
Content-Length: {length}
Content-Type: multipart/form-data; boundary={boundary}
--{boundary}
Content-Disposition: form-data; name="file"; filename="{filename.ext}"
Content-Type: application/octet-stream
{file content}
--{boundary}–Пример запроса
POST /me-open-api/api/taskManagement/tasks/1/attachments HTTP/1.1
Host: track.beeline.ru
Authorization: Bearer token
Content-Length: 50425
Content-Type: multipart/form-data; boundary=------JcAMToDcoRQh45mt
------JcAMToDcoRQh45mt
Content-Disposition: form-data; name="file"; filename="Счет 276385 от 17.02.2023 – платежка.pdf"
Content-Type: application/pdf
{содержимое файла}
------JcAMToDcoRQh45mt–Формат ответа
{
"taskAttachmentID": integer,
"urn": "string",
"fileSize": integer,
"fileName": "string",
"creationDate": "dateTime",
"contentType": "string"
}Пример ответа
{
"taskAttachmentID":1,
"urn": "eJPMa",
"fileSize": 50192,
"fileName": "Счет 276385 от 17.02.2023 – платежка.pdf",
"creationDate": "2023-02-27T14:29:11.99+03:00",
"contentType": "application/pdf"
}Удаление файла, прикрепленного к задаче
Общее описание
Функция DELETE /me-open-api/api/taskManagement/tasks/{taskID}/attachments/{taskAttachmentID} позволяет удалить файл, прикрепленный к задаче.
Пример запроса
Функция имеет следующие параметры:
| Параметр | Описание |
|---|---|
| taskID | ИД задачи |
| taskAttachmentID | ИД файла, прикрепленного к задаче |
Результат выполнения
При успешном выполнении возвращается статус 204.
Формат запроса
DELETE /me-open-api/api/taskManagement/tasks/{taskID}/attachments/{taskAttachmentID} HTTP/1.1
Host: host
Authorization: Bearer tokenПример запроса
DELETE /me-open-api/api/taskManagement/tasks/1/attachments/1 HTTP/1.1
Host: track.beeline.ru
Authorization: Bearer tokenПолучение настроек общей ссылки по идентификатору задачи
Общее описание
Функция GET /me-open-api/api/taskManagement/tasks/{taskID}/taskSharing позволяет получить настройки общей ссылки по идентификатору задачи.
Параметры вызова
В запросе используется обязательный параметр taskID — идентификатор задачи.
Результат выполнения
Функция возвращает структуру со следующими параметрами настроек общей ссылки:
| Параметр | Описание |
|---|---|
| sharingURL | URL общей ссылки задачи |
| sharingPeriod | Время действия ссылки, после его окончания просмотр местоположения по ссылке станет недоступным. Существуют следующие значения:
|
| sharingEndDate | Дата и время окончания действия ссылки (если в параметре sharingPeriod передано значение 2) |
| sendToEmail | Нужно ли отправить ссылку на электронную почту клиента. Существуют следующие значения:
|
| sendToSMS | Нужно ли отправить ссылку по SMS клиенту. Существуют следующие значения:
|
Формат запроса
GET /me-open-api/api/taskManagement/tasks/{taskID}/taskSharing HTTP/1.1
Host: host
Authorization: Bearer tokenПример запроса
GET /me-open-api/api/taskManagement/tasks/1/taskSharing HTTP/1.1
Host: track.beeline.ru
Authorization: Bearer tokenФормат ответа
{
"sharingURL": "string",
"sharingPeriod": integer,
"sharingEndDate": "string",
"sendToEmail": boolean,
"sendToSMS": boolean
}Пример ответа
{
"sharingURL": "https://tracking.mpoisk.ru/t/a6b9f75157994f60b6ec988fed2cd992",
"sharingPeriod": 2,
"sharingEndDate": "2023-07-25T10:57:26.607Z",
"sendToEmail": true,
"sendToSMS": true
}Обновление настроек общей ссылки для задачи
Общее описание
Функция PUT /me-open-api/api/taskManagement/tasks/{taskID}/taskSharing позволяет обновить настройки общей ссылки для задачи.
Параметры вызова
Функция имеет следующие параметры:
| Параметр | Описание |
|---|---|
| taskID | ИД задачи |
| isActive | Активность ссылки. Существуют следующие значения:
|
| sharingPeriod | Время действия ссылки, после его окончания просмотр местоположения по ссылке станет недоступным. Существуют следующие значения:
|
| sharingEndDate | Дата и время окончания действия ссылки (если в параметре sharingPeriod передано значение 2) |
| sendToEmail | Нужно ли отправить ссылку на электронную почту клиента. Существуют следующие значения:
|
| sendToSMS | Нужно ли отправить ссылку по SMS клиенту. Существуют следующие значения:
|
Результат выполнения
При успешном выполнении возвращается статус 200.
Формат запроса
PUT /me-open-api/api/taskManagement/tasks/{taskID}/taskSharing HTTP/1.1
Host: host
Authorization: Bearer token
{
"isActive": boolean,
"sharingPeriod": integer,
"sharingEndDate": "string",
"sendToEmail": boolean,
"sendToSMS": boolean
}Пример запроса для создания общей ссылки
PUT /me-open-api/api/taskManagement/tasks/1/taskSharing HTTP/1.1
Host: track.beeline.ru
Authorization: Bearer token
{
"isActive": true,
"sharingPeriod": 2,
"sharingEndDate": "2023-07-25T10:57:26.607Z",
"sendToEmail": true,
"sendToSMS": true
}Пример запроса для отключения общей ссылки
PUT /me-open-api/api/taskManagement/tasks/1/taskSharing HTTP/1.1
Host: track.beeline.ru
Authorization: Bearer token
{
"isActive": false
}