API task EN

en | ru

Section API ERP "UserSide"

Purpose: Working with tasks

Additional parameters:
action - request subcategory (possible value: see below)

Subcategories

add

Modified in: 3.17dev1 (removed usercode, uzelcode parameters and added customer_id, node_id parameters)

Modified in: 3.16dev2 (removed unit_id, author_operator_id parameters and added employee_id, author_employee_id parameters)

Modified in: 3.12.84 (added parent_task_id parameter)

Modified in: 3.12.38 (added unit_id, division_id parameters)

Modified in: 3.12.26 (added work_amount parameter)

Modified in: 3.12beta31 (added author_operator_id parameter)

Description: Task creation

Obligatory parameters:
 work_datedo - date on which the task is scheduled to run
 work_typer - task TYPE ID

Optional parameters:
 apart - flat number
 address_id - (for version 3.13 and later) address unit id
 author_employee_id - ID of the employee author of the task
 author_operator_id - task author operator ID (before version 3.16dev2)
 citycode - (for version 3.12 and earlier) the id of the location. If not specified, it is taken from the housecode data.
 customer_id - (for version 3.17 and later) user ID
 division_id - division ID (multiple values separated by commas are allowed)
 dopf_N - value of additional field for field ID N
 employee_id - employee ID (several values separated by commas are allowed)
 fio - client's full name (meaning that 'client' is not yet a user)
 housecode - (for version 3.12 and earlier) the building id. If not specified, it is taken from the user data - customer_id, or from the communication facility data - node_id
 node_id - (for version 3.17 and later) communication facility ID
 opis - task notes
 parent_task_id - ID of parent task
 unit_id - ID of executor (multiple values separated by commas are allowed) (up to version 3.16dev2)
 usercode - (for version 3.16 and earlier) user ID
 uzelcode - (for version 3.16 and earlier) ID of communication facility
 work_amount - scope of work

add_customer_to_task

Added in: 3.13.70

Description: Add a user to a task

Required parameters:
 task_id - task id
 customer_id - id of user

change_date_work

Modified in: 3.16dev2 (excluded operator_id parameter, added employee_id parameter)

Added in: 3.12.83

Description: Change the date and time of the task (date on which the work is scheduled)

Obligatory parameters:
 id - id of the task
 value - date
Optional parameters:
 employee_id - id of the initiating employee (to be recorded in the task history)
 operator_id - id of the initiator operator (to be recorded in the task history) (before version 3.16dev2)

change_state

Modified in: 3.16dev2 (excluded operator_id parameter, added employee_id parameter)

Description: Changing the state (status) of a task

Obligatory parameters:
 id - id of the task
 state_id - task state id
Optional parameters:
 employee_id - id of the employee on whose behalf to change the state
 operator_id - id of the operator on whose behalf to change the state (before version 3.16dev2)

check_verify_code

Description: Checks the verification code to perform the request

Obligatory parameters:
 id - task ID
 verify_code - verification code

checklist_item_check

Added in: 3.17dev1

Description: Marks a checklist item in a task

Obligatory parameters:
 id - id of checklist item
 task_id - task id
 employee_id - id of the employee on whose behalf the item is marked

checklist_item_uncheck

Added in: 3.17dev1

Description: Uncheck a checklist item in a task

Required parameters:
 id - id of checklist item
 task_id - task id

comment_add

Modified in: 3.17dev1 (added dateadd parameter)

Modified in: 3.16.19 (added reply_comment_id parameter)

Modified in: 3.16dev2 (removed operator_id parameter, added employee_id parameter)

Modified in: 3.12.89 (added author_operator_id parameter)

Description: Add comment

Obligatory parameters:
 id - task ID
 comment - text
Optional parameters:
 dateadd - date-time of the comment
 employee_id - id of the employee on whose behalf the comment is made
 operator_id - id of the operator on whose behalf the comment is (before version 3.16dev2)
 reply_comment_id - id of the comment we are replying to

comment_edit

Added in: 3.18beta1

Description: Edit comment

Obligatory parameters:
 id - comment ID
 task_id - task ID
 body - text

delete

Added in: 3.14.35

Description: Deleting a task

Obligatory parameters:
 id - id of the task

division_add

Modified in: 3.16dev2 (excluded operator_id parameter, added employee_id parameter)

Added in: 3.13.36

Description: Adding a division

Mandatory parameters:
 id - task id
 division_id - id of division
Optional parameters:
 employee_id - id of the initiating employee (to be recorded in the history by the task)
 operator_id - id of the initiator operator (to be recorded in the task history) (before version 3.16dev2)

division_delete

Modified in: 3.16dev2 (excluded operator_id parameter, added employee_id parameter)

Added in: 3.13.36

Description: Exclusion of division

Obligatory parameters:

 id - task id
 division_id - id of division
Optional parameters:
 employee_id - id of the initiating employee (to be recorded in the task history)
 operator_id - id of the initiator operator (to be recorded in the task history) (before version 3.16dev2)

edit

Modified in: 3.18beta1 (added address_id parameter)

Modified in: 3.16dev3 (added type_id parameter)

Modified in: 3.15.12 (added parent_task_id parameter)

Added in: 3.13.18

Description: Task modification

Obligatory parameters:
 id - task id
Optional parameters:
 address_id - id of the address unit
 body - text of the task (descriptive part)
 parent_task_id - id of parent task
 type_id - id of the task type

employee_add

Added in: 3.16dev2

Description: Adding an employee

Obligatory parameters:
 id - task id
 employee_id - employee id
Optional parameters:
 author_employee_id - id of the initiating employee (to commit to history by task)

employee_delete

Added in: 3.16dev2

Description: Exclude employee

Obligatory parameters:
 id - task id
 employee_id - employee id
Optional parameters:
 author_employee_id - id of the initiating employee (to commit to the history by task)

get_allow_staff

Added in: 3.15.23

Description: List of performers and divisions that are available for assignment to a task (according to settings)'

Obligatory parameters:
 id - task id

get_catalog_type

Added in: 3.12.22

Description: Task types

Optional parameters:
 id - job type id (can be comma separated)

get_catalog_type_group

Added in: 3.16dev3

Description: Task type groups

get_catalog_state

Added in: 3.12.22

Description: Task state classifier

Optional parameters:
 state_id - state id (can be comma separated)

get_comment

Modified in: 3.16dev2 (excluded operator_id parameter, added employee_id parameter)

Modified in: 3.14.67 (added id parameter)

Modified in: 3.14.53 (added operator_id parameter)

Modified in: 3.13.50 (added date_add_from and date_add_to parameters)

Added in: 3.12.75

Description: Comments

Optional parameters (but there must be at least one):
 id - id of comment (can be comma separated)
 task_id - id of tasks (can be comma separated)
 date_add_from - date of adding comment (from)
 date_add_to - date of adding a comment (to)
 employee_id - id of the employee-author of the comment
 operator_id - id of operator-author of the comment (before version 3.16dev2)

get_list

Modified in: 3.18beta1 (added address_id parameter)

Modified in: 3.16dev3 (added task_position, task_position_radius parameters, excluded possible customer_id and house_id values from order_by parameter)

Modified in: 3.16dev2 (removed parameters closer_operator_id, staff_id, author_id, watcher_id, added parameters closer_employee_id, employee_id, author_employee_id, watcher_employee_id)

Modified in: 3.15.23 (added is_expired parameter)

Modified in: 3.14.71 (added node_id parameter)

Modified in: 3.14.62 (added closer_operator_id parameter)

Modified in: 3.14.56 (added division_id_with_staff parameter)

Modified in: 3.14.41 (added possible value -1 to staff_id parameter)

Modified in: 3.13.29 (added date_change_from, date_change_to parameters)

Modified in: 3.13.28 (added date_change to order_by parameter)

Modified in: 3.12.91 (added watcher_id parameter)

Modified at: 3.12.83 (added author_id parameter)

Modified at: 3.12.78 (added order_by, limit, offset parameters)

Modified at: 3.12.62 (added customer_id parameter)

Modified in: 3.12.24 (added date_do_from, date_do_to parameters)

Modified in: 3.12beta29 (added house_id parameter)

Description: List of tasks (identifiers)

Optional parameters (sampling conditions):
 address_id - ID of the address object (can be comma separated)
 author_id - ID of operator - task author (comma separated) (up to version 3.16dev2)
 author_employee_id - ID of the employee - author of the task (can be comma separated)'
 closer_employee_id - ID of the employee who closed (completed) the task (can be comma separated)'
 closer_operator_id - ID of the operator who closed the (completed) task (can be comma separated) (before version 3.16dev2)
 customer_id - ID of the user (can be comma separated)
 date_add_from - task creation date (from)
 date_add_to - task creation date (to)
 date_change_from - task update date (from)
 date_change_to - task update date (to)
 date_do_from - date on which the task is scheduled to be executed (from)
 date_do_to - date on which the task is scheduled to be executed (to)
 date_finish_from - date on which the task is executed (from)
 date_finish_to - date on which the task is executed (to)
 division_id - division ID (can be comma separated)
 division_id_with_staff - division ID (including tasks of employees of this division) (can be comma separated)
 employee_id - employee ID (can be comma separated, use -1 to get tasks without employees)
 house_id - ID of the work house
 is_expired - flag - output only expired tasks
 node_id - ID of the location object
 staff_id - ID of executor (can be comma separated, use -1 to get tasks without executors) (up to version 3.16dev2)
 state_id - task status ID (can be comma separated)
 task_position - task coordinates (where possible. In lat,lng format. e.g. 40.245218,52.333384)
 task_position_radius - radius from task_position (in meters)
 type_id - task type ID (can be comma separated)
 watcher_id - task observer operator ID (comma separated) (up to version 3.16dev2)
 watcher_employee_id - ID of the task observer employee (comma separated)
 order_by - sorting field (possible variants: date_add, date_change, date_do, date_finish, state_id, type_id)
 limit - record sampling limit
 offset - sampling offset

get_related_task_id

Description: List of related tasks to the current task (identifiers)

Obligatory parameters:
 id - task ID

get_typical_comments

Added in: 3.14.70

Description: Get list of typical comments

remove_customer_from_task

Added in: 3.15.23

Description: Excludes a user from a task

Obligatory parameters:
 task_id - task id
 customer_id - id of user

set_rate

Added in: 3.12.63

Description: Specifies the individual rate (for employees) for the task

Obligatory parameters:
 task_id - task ID
 rate - rate

show

Modified in: 3.16dev2 (excluded operator_id parameter, added employee_id parameter)

Modified in: 3.13.29 (the id parameter can be a comma separated list)

Modified in: 3.13.25 (added is_without_comments parameter)

Modified in: 3.12.64 (added operator_id parameter)

Description: Information about the task

Obligatory parameters:
 id - task id (can be comma separated)
Optional parameters:
 employee_id - id of the employee who is viewing this task (to be recorded in the history by task)
 is_without_comments - flag - do not display comments in the task information
 operator_id - id of the operator who is viewing this task (to be recorded in the task history) (before version 3.16dev2)

(*) staff_add

Deprecated in: 3.16dev2 (use API->task->employee_add|employee_add)

Added in: 3.12.83

Description: Adding an executor

Obligatory parameters:
 id - task id
 staff_id - id of the executor
Optional parameters:
 operator_id - id of the initiating operator (to be recorded in the history by the task)

(*) staff_delete

Deprecated in: 3.16dev2 (use API->task->employee_delete)

Added in: 3.12.83

Description: Exclude an executor

Obligatory parameters:
 id - task id
 staff_id - id of the executor
Optional parameters:
 operator_id - id of the initiating operator (to be recorded in the job history)

watcher_add

Modified in: 3.16dev2 (removed staff_id, operator_id parameters, added employee_id, author_employee_id parameters)

Added in: 3.14.21

Description: Add observer

Obligatory parameters:
 id - task id
 employee_id - id of observer
 staff_id - observer id (before 3.16dev2)
Optional parameters:
 author_employee_id - id of the initiating employee (to be recorded in the job history)
 operator_id - id of the initiating operator (to be recorded in the job history) (before version 3.16dev2)

watcher_delete

Modified in: 3.16dev2 (removed staff_id, operator_id parameters, added employee_id, author_employee_id parameters)

Added in: 3.14.21

Description: Exclusion of observer

Obligatory parameters:
 id - task id
 employee_id - id of observer
 staff_id - observer id (before 3.16dev2)
Optional parameters:
 author_employee_id - id of the initiating employee (to be recorded in the job history)
 operator_id - id of the initiating operator (to be recorded in the job history) (before version 3.16dev2)