Главная

api.tasks

Работа с задачами

Methods

api.tasks.addFactTaskPhotos(factTaskId, files) → Array.<String>
api.tasks.createPlanTask(planTaskData)Result
api.tasks.deletePlanTask(planTaskId) → Boolean
api.tasks.editPlanTask(planTaskData)Result
api.tasks.editTaskFact(factTask)Result
api.tasks.factTaskList(planTaskId, date, positionId) → Array.<FactTask>
api.tasks.finishTask(taskFactId)Result
api.tasks.outcomeList()Result
api.tasks.outletList(positionIdList, defaultIdList)Result
api.tasks.planTask(planTaskId)Result
api.tasks.planTaskList(date, positionId) → Array.<PlanTask>
api.tasks.planTasksOnOutlet(outletId, date, positionId)Result
api.tasks.planTasksOnRoute(date, positionId)Result
api.tasks.positionList(defaultIdList)Result
api.tasks.scheduleTypeList()Result
api.tasks.startTask(planTaskId, outletId)Result
api.tasks.taskTitle(planTaskId) → String
api.tasks.taskTypeList()Result

Methods description

addFactTaskPhotos(factTaskId, files) → Array.<String>

Добавить фотографии к фактической задаче

Parameters:
Name Type Description
factTaskId ID

Идентификатор фактической задачи

files Array.<String>

Пути до фотографий

Return:
Array.<String> -

Пути до зарегистрированных фотографий

createPlanTask(planTaskData)Result

Создать плановую задачу

Parameters:
Name Type Description
planTaskData PlanTask

Структура новой плановой задачи. Поле id должно быть пустым

Return:
Result -

Результат выполнения операции.
В поле value - вновь созданная задача (type PlanTask)

deletePlanTask(planTaskId) → Boolean

Удалить плановую задачу, созданную текущей позицией

Parameters:
Name Type Description
planTaskId ID

Идентификатор плановой задачи

Return:
Boolean -

Признак успеха операции

editPlanTask(planTaskData)Result

Редактировать плановую задачу

Parameters:
Name Type Description
planTaskData PlanTask

Структура измененной плановой задачи

Return:
Result -

Результат выполнения операции.
В поле value - признак успеха выполнения операции (type Boolean)

editTaskFact(factTask)Result

Редактировать фактическую задачу

Parameters:
Name Type Description
factTask FactTask

Структура измененной фактической задачи

Return:
Result -

Результат выполнения операции.
В поле value - признак успеха выполнения операции (type Boolean)

factTaskList(planTaskId, date, positionId) → Array.<FactTask>

Вернуть список фактических задач для плановой

Parameters:
Name Type Description
planTaskId ID

Идентификатор плановой задачи

date Date

День, который должен входить в период выполнения задач

positionId ID

Идентификатор позиции

Return:
Array.<FactTask> -

Список фактических задач

finishTask(taskFactId)Result

Завершить выполнение задачи

Parameters:
Name Type Description
taskFactId ID

Идентификатор фактической задачи

Return:
Result -

Результат выполнения операции.
В поле value - признак успеха выполнения операции (type Boolean)

outcomeList()Result

Получить список типов исходов задач (по дистрибьютору маршрута и ЦО)

Return:
Result -

Результат выполнения операции.
В поле value - список объектов с полями id и title (type Array)

outletList(positionIdList, defaultIdList)Result

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

Parameters:
Name Type Argument Description
positionIdList Array.<ID>

Идентификаторы позиций для выбора торговых точек

defaultIdList Array.<ID> optional 

Идентификаторы торговых точек по-умолчанию, которые будут расположены в начале списка

Return:
Result -

Результат выполнения операции.
В поле value - список объектов с полями id и title (type Array)

planTask(planTaskId)Result

Получить структуру плановой задачи

Parameters:
Name Type Description
planTaskId ID

Идентификатор плановой задачи

Return:
Result -

Результат выполнения операции.
В поле value - структура плановой задачи (type PlanTask)

planTaskList(date, positionId) → Array.<PlanTask>

Получить список плановых задач

Parameters:
Name Type Description
date Date

День, который должен входить в период выполнения задач

positionId ID

Идентификатор позиции

Return:
Array.<PlanTask> -

Список плановых задач

planTasksOnOutlet(outletId, date, positionId)Result

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

Parameters:
Name Type Description
outletId ID

Идентификатор торговой точки

date Date

Дата, которая должна входить в период выполнения задач

positionId ID

Идентификатор позиции

Return:
Result -

Результат выполнения операции.
В поле value - список плановых задач (type PlanTaskList)

planTasksOnRoute(date, positionId)Result

Получить список плановых задач на указанную дату на маршруты позиции

Parameters:
Name Type Description
date Date

Дата, которая должна входить в период выполнения задач

positionId ID

Идентификатор позиции

Return:
Result -

Результат выполнения операции.
В поле value - список плановых задач (type PlanTaskList)

positionList(defaultIdList)Result

Получить список позиций, на которые можно назначить задачу от текущей позиции

Parameters:
Name Type Argument Description
defaultIdList Array.<ID> optional 

Идентификаторы позиций по-умолчанию, которые будут расположены в начале списка

Return:
Result -

Результат выполнения операции.
В поле value - список объектов с полями id, title и subtitle (type Array)

scheduleTypeList()Result

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

Return:
Result -

Результат выполнения операции.
В поле value - список типов периодичности (type TaskTypeList)

startTask(planTaskId, outletId)Result

Запустить выполнение задачи

Parameters:
Name Type Argument Description
planTaskId ID

Идентификатор плановой задачи

outletId ID optional 

Идентификатор торговой точки

Return:
Result -

Результат выполнения операции.
В поле value - идентификатор начатой фактической задачи (type ID)

taskTitle(planTaskId) → String

Получить название задачи

Parameters:
Name Type Description
planTaskId ID

Идентификатор задача

Return:
String

taskTypeList()Result

Получить список типов задач

Return:
Result -

Результат выполнения операции.
В поле value - список типов задач (type TaskTypeList)


Documentation generated by JSDoc 3.5.5 on Tue Jun 09 2020 17:19:02 GMT+0200 (EET)