API task EN: различия между версиями

Материал из WiKi - UserSide
Нет описания правки
(Fix Ukrainian API localization)
 
(не показаны 4 промежуточные версии этого же участника)
Строка 1: Строка 1:
[[API_task_EN|en]] | [[API_task|ru]]
'''en''' | [[API_task_UK|uk]] | [[API task|ru]]


Section '''[[API_EN|API]]''' ERP "UserSide"
Section '''[[API_EN|API]]''' ERP "UserSide"
Строка 27: Строка 27:
  Description: Task creation
  Description: Task creation
   
   
  Obligatory parameters:
  Required parameters:
  work_datedo - date on which the task is scheduled to run
   work_typer - task TYPE ID
   work_typer - task TYPE ID
   
   
Строка 36: Строка 35:
   author_employee_id - ID of the employee author of the task
   author_employee_id - ID of the employee author of the task
   author_operator_id - task author operator ID ''(before version 3.16dev2)''
   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.
   citycode - ''(for version 3.12 and earlier)'' location id. If not specified, it is taken from housecode data.
   customer_id - ''(for version 3.17 and later)'' user ID
   customer_id - ''(for version 3.17 and later)'' customer ID
   deadline_hour - time to complete the task ''(from the date of acceptance. In hours)''
   deadline_hour - time to complete the task ''(from the date of acceptance. In hours)''
  device_id - equipment ID
   division_id - division ID ''(multiple values separated by commas are allowed)''
   division_id - division ID ''(multiple values separated by commas are allowed)''
   dopf_N - value of additional field for field ID N
   dopf_N - value of additional field for field ID N
   employee_id - employee ID ''(several values separated by commas are allowed)''
   employee_id - employee ID ''(several values separated by commas are allowed)''
   fio - client's full name ''(meaning that 'client' is not yet a user)''
   fio - client full name ''(the client is not yet a customer)''
   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
   housecode - ''(for version 3.12 and earlier)'' building id. If not specified, it is taken from customer data - customer_id, or from infrastructure facility data - node_id
   node_id - ''(for version 3.17 and later)'' communication facility ID
  is_high_priority - flag - high priority
   node_id - ''(for version 3.17 and later)'' infrastructure facility ID
   opis - task notes
   opis - task notes
   parent_task_id - ID of parent task
   parent_task_id - ID of parent task
   unit_id - ID of executor ''(multiple values separated by commas are allowed) (up to version 3.16dev2)''
   unit_id - executor ID ''(multiple values separated by commas are allowed) (before version 3.16dev2)''
   usercode - ''(for version 3.16 and earlier)'' user ID
   usercode - ''(for version 3.16 and earlier)'' customer ID
   uzelcode - ''(for version 3.16 and earlier)'' ID of communication facility
   uzelcode - ''(for version 3.16 and earlier)'' infrastructure facility ID
   work_amount - scope of work
   work_amount - scope of work
  work_datedo - date on which the task is scheduled to run


==== add_customer_to_task ====
==== add_customer_to_task ====
''Added in: 3.13.70''
''Added in: 3.13.70''


  Description: Add a user to a task
  Description: Add a customer to a task
   
   
  Required parameters:
  Required parameters:
Строка 66: Строка 68:
  Description: Add equipment to a task
  Description: Add equipment to a task
   
   
  Obligatory parameters:
  Required parameters:
   task_id - task id
   task_id - task id
   device_id - equipment id
   device_id - equipment id
Строка 73: Строка 75:
''Added in: 3.20.17''
''Added in: 3.20.17''


  Description: Adding a communication facility to a task
  Description: Add an infrastructure facility to a task
   
   
  Obligatory parameters:
  Required parameters:
   task_id - task ID
   task_id - task ID
   node_id - communication facility ID
   node_id - infrastructure facility ID


==== change_date_work ====
==== change_date_work ====
Строка 86: Строка 88:
  Description: Change the date and time of the task ''(date on which the work is scheduled)''
  Description: Change the date and time of the task ''(date on which the work is scheduled)''
   
   
  Obligatory parameters:
  Required parameters:
   id - id of the task
   id - id of the task
   value - date
   value - date
  Optional parameters:
  Optional parameters:
   employee_id - id of the initiating employee ''(to be recorded in the task history)''
   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)''
   operator_id - id of the initiating operator ''(to be recorded in the task history) (before version 3.16dev2)''


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


  Description: Changing the state (status) of a task
  Description: Change task state (status)
   
   
  Obligatory parameters:
  Required parameters:
   id - id of the task
   id - id of the task
   state_id - task state id
   state_id - task state id
Строка 104: Строка 106:
   employee_id - id of the employee on whose behalf to change the state
   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)''
   operator_id - id of the operator on whose behalf to change the state ''(before version 3.16dev2)''
  date_hold - date/time until which to postpone the task ''(when moving to a state with the role Postponed)''


==== check_verify_code ====
==== check_verify_code ====
  Description: Checks the verification code to perform the request
  Description: Checks the verification code to perform the request
   
   
  Obligatory parameters:
  Required parameters:
   id - task ID
   id - task ID
   verify_code - verification code
   verify_code - verification code
Строка 117: Строка 120:
  Description: Marks a checklist item in a task
  Description: Marks a checklist item in a task
   
   
  Obligatory parameters:
  Required parameters:
   id - id of checklist item
   id - id of checklist item
   task_id - task id
   task_id - task id
Строка 125: Строка 128:
''Added in: 3.17dev1''
''Added in: 3.17dev1''


  Description: Uncheck a checklist item in a task
  Description: Clear a checklist item in a task
   
   
  Required parameters:
  Required parameters:
Строка 142: Строка 145:
  Description: Add comment
  Description: Add comment
   
   
  Obligatory parameters:
  Required parameters:
   id - task ID
   id - task ID
   comment - text
   comment - text
Строка 148: Строка 151:
   dateadd - date-time of the comment
   dateadd - date-time of the comment
   employee_id - id of the employee on whose behalf the comment is made
   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)''
   operator_id - id of the operator on whose behalf the comment is added ''(before version 3.16dev2)''
   reply_comment_id - id of the comment we are replying to
   reply_comment_id - id of the comment we are replying to


Строка 157: Строка 160:
  Description: Edit comment
  Description: Edit comment
   
   
  Obligatory parameters:
  Required parameters:
   id - comment ID
   id - comment ID
   task_id - task ID
   task_id - task ID
Строка 165: Строка 168:
''Added in: 3.14.35''
''Added in: 3.14.35''


  Description: Deleting a task
  Description: Delete a task
   
   
  Obligatory parameters:
  Required parameters:
   id - id of the task
   id - id of the task


Строка 175: Строка 178:
''Added in: 3.13.36''
''Added in: 3.13.36''


  Description: Adding a division
  Description: Add a division
   
   
  Mandatory parameters:
  Required parameters:
   id - task id
   id - task id
   division_id - id of division
   division_id - id of division
  Optional parameters:
  Optional parameters:
   employee_id - id of the initiating employee ''(to be recorded in the history by the task)''
   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)''
   operator_id - id of the initiating operator ''(to be recorded in the task history) (before version 3.16dev2)''


==== division_delete ====
==== division_delete ====
Строка 189: Строка 192:
''Added in: 3.13.36''
''Added in: 3.13.36''


  Description: Exclusion of division
  Description: Remove a division
   
   
  Obligatory parameters:
  Required parameters:
   id - task id
   id - task id
   division_id - id of division
   division_id - id of division
  Optional parameters:
  Optional parameters:
   employee_id - id of the initiating employee ''(to be recorded in the task history)''
   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)''
   operator_id - id of the initiating operator ''(to be recorded in the task history) (before version 3.16dev2)''


==== edit ====
==== edit ====
Строка 210: Строка 213:
  Description: Task modification
  Description: Task modification
   
   
  Obligatory parameters:
  Required parameters:
   id - task id
   id - task id
  Optional parameters:
  Optional parameters:
   address_id - id of the address unit
   address_id - id of the address unit
  apartment - apartment number
  author_employee_id - id of the employee who authored the task
  customer_name - arbitrary customer name/title ''(without binding to a customer)''
   body - text of the task ''(descriptive part)''
   body - text of the task ''(descriptive part)''
   deadline_hour - time to complete the task ''(from the date of acceptance. In hours)''
   deadline_hour - time to complete the task ''(from the date of acceptance. In hours)''
  is_high_priority - flag - high priority
  job_time_hour - time to complete the task ''(from the start of work. In hours)''
   parent_task_id - id of parent task
   parent_task_id - id of parent task
   type_id - id of the task type
   type_id - id of the task type
Строка 221: Строка 229:
==== employee_add ====
==== employee_add ====
''Added in: 3.16dev2''
''Added in: 3.16dev2''
  Description: Adding an employee
  Description: Add an employee
   
   
  Obligatory parameters:
  Required parameters:
   id - task id
   id - task id
   employee_id - employee id
   employee_id - employee id
  Optional parameters:
  Optional parameters:
   author_employee_id - id of the initiating employee ''(to commit to history by task)''
   author_employee_id - id of the initiating employee ''(to be recorded in the task history)''


==== employee_delete ====
==== employee_delete ====
''Added in: 3.16dev2''
''Added in: 3.16dev2''
  Description: Exclude employee
  Description: Remove an employee
   
   
  Obligatory parameters:
  Required parameters:
   id - task id
   id - task id
   employee_id - employee id
   employee_id - employee id
  Optional parameters:
  Optional parameters:
   author_employee_id - id of the initiating employee ''(to commit to the history by task)''
   author_employee_id - id of the initiating employee ''(to be recorded in the task history)''


==== get_allow_staff ====
==== get_allow_staff ====
''Added in: 3.15.23''
''Added in: 3.15.23''
  Description: List of performers and divisions that are available for assignment to a task ''(according to settings)'''
  Description: List of performers and divisions that are available for assignment to a task ''(according to settings)''
   
   
  Obligatory parameters:
  Required parameters:
   id - task id
   id - task id


Строка 251: Строка 259:
   
   
  Optional parameters:
  Optional parameters:
   id - job type id ''(can be comma separated)''
   id - task type id ''(can be comma separated)''


==== get_catalog_type_group ====
==== get_catalog_type_group ====
Строка 262: Строка 270:
   
   
  Optional parameters:
  Optional parameters:
  type_id - task type id
   state_id - state id ''(can be comma separated)''
   state_id - state id ''(can be comma separated)''


Строка 278: Строка 287:
  Optional parameters ''(but there must be at least one)'':
  Optional parameters ''(but there must be at least one)'':
   id - id of comment ''(can be comma separated)''
   id - id of comment ''(can be comma separated)''
   task_id - id of tasks ''(can be comma separated)''
   task_id - task id ''(can be comma separated)''
   date_add_from - date of adding comment ''(from)''
   date_add_from - comment creation date ''(from)''
   date_add_to - date of adding a comment ''(to)''
   date_add_to - comment creation date ''(to)''
   employee_id - id of the employee-author of the comment
   employee_id - id of the employee-author of the comment
   operator_id - id of operator-author of the comment ''(before version 3.16dev2)''
   operator_id - id of the operator who authored the comment ''(before version 3.16dev2)''


==== get_list ====
==== get_list ====
Строка 322: Строка 331:
  Optional parameters (sampling conditions):
  Optional parameters (sampling conditions):
   address_id - ID of the address object ''(can be comma separated)''
   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)''
  apart - apartment/premises number
   author_employee_id - ID of the employee - author of the task ''(can be comma separated)'''
   author_id - ID of the operator who authored the task ''(comma separated) (before version 3.16dev2)''
   author_employee_id - ID of the employee who authored the task ''(can be comma separated)''
   change_employee_id - ID of the employee - author of the task changes
   change_employee_id - ID of the employee - author of the task changes
   change_operation_type - type of actions to change the task ''(possible values: add_comment, change_state)''
   change_operation_type - type of actions to change the task ''(possible values: add_comment, change_state)''
   closer_employee_id - ID of the employee who closed ''(completed)'' 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)''
   closer_operator_id - ID of the operator who closed ''(completed)'' the task ''(can be comma separated) (before version 3.16dev2)''
   customer_id - ID of the user ''(can be comma separated)''
   customer_id - customer ID ''(can be comma separated)''
   date_add_from - task creation date (from)
   date_add_from - task creation date (from)
   date_add_to - task creation date (to)
   date_add_to - task creation date (to)
Строка 337: Строка 347:
   date_finish_from - date on which the task is executed (from)
   date_finish_from - date on which the task is executed (from)
   date_finish_to - date on which the task is executed (to)
   date_finish_to - date on which the task is executed (to)
  device_id - equipment ID ''(can be comma separated)''
   division_id - division ID ''(can be comma separated)''
   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)''
   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)''
   employee_id - employee ID ''(can be comma separated, use -1 to get tasks without employees)''
   house_id - ID of the work house
   house_id - building ID
   is_expired - flag - output only expired tasks
   is_expired - flag - output only expired tasks
   node_id - ID of the location object
   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)''
   staff_id - executor ID ''(can be comma separated, use -1 to get tasks without executors) (before version 3.16dev2)''
   state_id - task status ID ''(can be comma separated)''
   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 - task coordinates ''(where possible. In lat,lng format. e.g. 40.245218,52.333384)''
   task_position_radius - radius from task_position ''(in meters)''
   task_position_radius - radius from task_position ''(in meters)''
   type_id - task type ID ''(can be comma separated)''
   type_id - task type ID ''(can be comma separated)''
   watcher_id - task observer operator ID ''(comma separated) (up to version 3.16dev2)''
   watcher_id - task observer operator ID ''(comma separated) (before version 3.16dev2)''
   watcher_employee_id - ID of the task observer employee ''(comma separated)''
   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)''
   order_by - sorting field ''(possible variants: date_add, date_change, date_do, date_finish, state_id, type_id)''
Строка 357: Строка 368:
  Description: List of related tasks to the current task (identifiers)
  Description: List of related tasks to the current task (identifiers)
   
   
  Obligatory parameters:
  Required parameters:
   id - task ID
   id - task ID


Строка 368: Строка 379:
''Added in: 3.15.23''
''Added in: 3.15.23''


  Description: Excludes a user from a task
  Description: Remove a customer from a task
   
   
  Obligatory parameters:
  Required parameters:
   task_id - task id
   task_id - task id
   customer_id - id of user
   customer_id - customer id


==== remove_node_from_task ====
==== remove_node_from_task ====
''Added in: 3.20.17''
''Added in: 3.20.17''


  Description: Remove a communication facility from a task
  Description: Remove an infrastructure facility from a task
   
   
  Obligatory parameters:
  Required parameters:
   task_id - task ID
   task_id - task ID
   node_id - communication facility ID
   node_id - infrastructure facility ID


==== set_rate ====
==== set_rate ====
''Added in: 3.12.63''
''Added in: 3.12.63''
  Description: Specifies the individual rate ''(for employees)'' for the task
  Description: Set an individual rate ''(for employees)'' for the task
   
   
  Obligatory parameters:
  Required parameters:
   task_id - task ID
   task_id - task ID
   rate - rate
   rate - rate
Строка 402: Строка 413:
  Description: Information about the task
  Description: Information about the task
   
   
  Obligatory parameters:
  Required parameters:
   id - task id ''(can be comma separated)''
   id - task id ''(can be comma separated)''
  Optional parameters:
  Optional parameters:
   employee_id - id of the employee who is viewing this task ''(to be recorded in the history by task)''
   employee_id - id of the employee who is viewing this task ''(to be recorded in the task history)''
   is_without_comments - flag - do not display comments in the task information
   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)''
   operator_id - id of the operator who is viewing this task ''(to be recorded in the task history) (before version 3.16dev2)''
Строка 414: Строка 425:
''Added in: 3.12.83''
''Added in: 3.12.83''


  Description: Adding an executor
  Description: Add an executor
   
   
  Obligatory parameters:
  Required parameters:
   id - task id
   id - task id
   staff_id - id of the executor
   staff_id - id of the executor
  Optional parameters:
  Optional parameters:
   operator_id - id of the initiating operator ''(to be recorded in the history by the task)''
   operator_id - id of the initiating operator ''(to be recorded in the task history)''


==== (*) staff_delete ====
==== (*) staff_delete ====
Строка 427: Строка 438:
''Added in: 3.12.83''
''Added in: 3.12.83''


  Description: Exclude an executor
  Description: Remove an executor
   
   
  Obligatory parameters:
  Required parameters:
   id - task id
   id - task id
   staff_id - id of the executor
   staff_id - id of the executor
  Optional parameters:
  Optional parameters:
   operator_id - id of the initiating operator ''(to be recorded in the job history)''
   operator_id - id of the initiating operator ''(to be recorded in the task history)''


==== watcher_add ====
==== watcher_add ====
Строка 442: Строка 453:
  Description: Add observer
  Description: Add observer
   
   
  Obligatory parameters:
  Required parameters:
   id - task id
   id - task id
   employee_id - id of observer
   employee_id - id of observer
   staff_id - observer id ''(before 3.16dev2)''
   staff_id - observer id ''(before 3.16dev2)''
  Optional parameters:
  Optional parameters:
   author_employee_id - id of the initiating employee ''(to be recorded in the job history)''
   author_employee_id - id of the initiating employee ''(to be recorded in the task history)''
   operator_id - id of the initiating operator ''(to be recorded in the job history) (before version 3.16dev2)''
   operator_id - id of the initiating operator ''(to be recorded in the task history) (before version 3.16dev2)''


==== watcher_delete ====
==== watcher_delete ====
Строка 455: Строка 466:
''Added in: 3.14.21''
''Added in: 3.14.21''


  Description: Exclusion of observer
  Description: Remove an observer
   
   
  Obligatory parameters:
  Required parameters:
   id - task id
   id - task id
   employee_id - id of observer
   employee_id - id of observer
   staff_id - observer id ''(before 3.16dev2)''
   staff_id - observer id ''(before 3.16dev2)''
  Optional parameters:
  Optional parameters:
   author_employee_id - id of the initiating employee ''(to be recorded in the job history)''
   author_employee_id - id of the initiating employee ''(to be recorded in the task history)''
   operator_id - id of the initiating operator ''(to be recorded in the job history) (before version 3.16dev2)''
   operator_id - id of the initiating operator ''(to be recorded in the task history) (before version 3.16dev2)''
 
==== add_cable_line_to_task ====
''Added in: 3.20.2''
 
Description: Add a cable line to a task
Required parameters:
  task_id - task id
  cable_line_id - cable line id
 
==== add_owner_to_task ====
''Added in: 3.19.19''
 
Description: Add an owner to a task
Required parameters:
  task_id - task id
  owner_id - owner id
 
==== mark_add ====
''Added in: 3.19.24''
Description: Add a mark to a task
Required parameters:
  task_id - task id
  mark_id - mark id
 
==== mark_delete ====
''Added in: 3.19.24''
Description: Delete a mark from a task
Required parameters:
  task_id - task id
  mark_id - mark id
 
==== overview_task ====
''Added in: 3.19.7''
 
Description: Record that an employee has viewed a task
Required parameters:
  task_id - task id
  employee_id - employee id
 
==== remove_cable_line_from_task ====
''Added in: 3.20.2''
 
Description: Remove a cable line from a task
Required parameters:
  task_id - task id
  cable_line_id - cable line id
 
==== remove_owner_from_task ====
''Added in: 3.19.19''
 
Description: Remove an owner from a task
Required parameters:
  task_id - task id
  owner_id - owner id

Текущая версия от 11:38, 10 мая 2026

en | uk | ru

Section API ERP "UserSide"

Purpose: Working with tasks 

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

Subcategories

add

Modified in: 3.18.29 (added deadline_hour parameter)

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

Required parameters:
 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) location id. If not specified, it is taken from housecode data.
 customer_id - (for version 3.17 and later) customer ID
 deadline_hour - time to complete the task (from the date of acceptance. In hours)
 device_id - equipment 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 full name (the client is not yet a customer)
 housecode - (for version 3.12 and earlier) building id. If not specified, it is taken from customer data - customer_id, or from infrastructure facility data - node_id
 is_high_priority - flag - high priority
 node_id - (for version 3.17 and later) infrastructure facility ID
 opis - task notes
 parent_task_id - ID of parent task
 unit_id - executor ID (multiple values separated by commas are allowed) (before version 3.16dev2)
 usercode - (for version 3.16 and earlier) customer ID
 uzelcode - (for version 3.16 and earlier) infrastructure facility ID
 work_amount - scope of work
 work_datedo - date on which the task is scheduled to run

add_customer_to_task

Added in: 3.13.70 

Description: Add a customer to a task

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

add_device_to_task

Added in: 3.19beta1 

Description: Add equipment to a task

Required parameters:
 task_id - task id
 device_id - equipment id

add_node_to_task

Added in: 3.20.17 

Description: Add an infrastructure facility to a task

Required parameters:
 task_id - task ID
 node_id - infrastructure facility ID

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)

Required 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 initiating 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: Change task state (status)

Required 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)
 date_hold - date/time until which to postpone the task (when moving to a state with the role Postponed)

check_verify_code

Description: Checks the verification code to perform the request

Required parameters:
 id - task ID
 verify_code - verification code

checklist_item_check

Added in: 3.17dev1 

Description: Marks a checklist item in a task

Required 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: Clear 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

Required 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 added (before version 3.16dev2)
 reply_comment_id - id of the comment we are replying to

comment_edit

Added in: 3.18beta1 

Description: Edit comment

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

delete

Added in: 3.14.35 

Description: Delete a task

Required 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: Add a division

Required 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 initiating 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: Remove a division

Required 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 initiating operator (to be recorded in the task history) (before version 3.16dev2)

edit

Modified in: 3.18.30 (added deadline_hour parameter)

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

Required parameters:
 id - task id
Optional parameters:
 address_id - id of the address unit
 apartment - apartment number
 author_employee_id - id of the employee who authored the task
 customer_name - arbitrary customer name/title (without binding to a customer)
 body - text of the task (descriptive part)
 deadline_hour - time to complete the task (from the date of acceptance. In hours)
 is_high_priority - flag - high priority
 job_time_hour - time to complete the task (from the start of work. In hours)
 parent_task_id - id of parent task
 type_id - id of the task type

employee_add

Added in: 3.16dev2 

Description: Add an employee

Required parameters:
 id - task id
 employee_id - employee id
Optional parameters:
 author_employee_id - id of the initiating employee (to be recorded in the task history)

employee_delete

Added in: 3.16dev2 

Description: Remove an employee

Required parameters:
 id - task id
 employee_id - employee id
Optional parameters:
 author_employee_id - id of the initiating employee (to be recorded in the task history)

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)

Required parameters:
 id - task id

get_catalog_type

Added in: 3.12.22 

Description: Task types

Optional parameters:
 id - task 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:
 type_id - task type id
 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 - task id (can be comma separated)
 date_add_from - comment creation date (from)
 date_add_to - comment creation date (to)
 employee_id - id of the employee-author of the comment
 operator_id - id of the operator who authored the comment (before version 3.16dev2)

get_list

Modified in: 3.18.30 (added parameters change_operation_type, change_employee_id)

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)
 apart - apartment/premises number
 author_id - ID of the operator who authored the task (comma separated) (before version 3.16dev2)
 author_employee_id - ID of the employee who authored the task (can be comma separated)
 change_employee_id - ID of the employee - author of the task changes
 change_operation_type - type of actions to change the task (possible values: add_comment, change_state)
 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 (completed) the task (can be comma separated) (before version 3.16dev2)
 customer_id - customer ID (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)
 device_id - equipment ID (can be comma separated)
 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 - building ID
 is_expired - flag - output only expired tasks
 node_id - ID of the location object
 staff_id - executor ID (can be comma separated, use -1 to get tasks without executors) (before 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) (before 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)

Required 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: Remove a customer from a task

Required parameters:
 task_id - task id
 customer_id - customer id

remove_node_from_task

Added in: 3.20.17 

Description: Remove an infrastructure facility from a task

Required parameters:
 task_id - task ID
 node_id - infrastructure facility ID

set_rate

Added in: 3.12.63 

Description: Set an individual rate (for employees) for the task

Required 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

Required 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 task history)
 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)

Added in: 3.12.83 

Description: Add an executor

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

(*) staff_delete

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

Added in: 3.12.83 

Description: Remove an executor

Required parameters:
 id - task id
 staff_id - id of the executor
Optional parameters:
 operator_id - id of the initiating operator (to be recorded in the task 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

Required 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 task history)
 operator_id - id of the initiating operator (to be recorded in the task 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: Remove an observer

Required 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 task history)
 operator_id - id of the initiating operator (to be recorded in the task history) (before version 3.16dev2)

add_cable_line_to_task

Added in: 3.20.2 

Description: Add a cable line to a task

Required parameters:
 task_id - task id
 cable_line_id - cable line id

add_owner_to_task

Added in: 3.19.19 

Description: Add an owner to a task

Required parameters:
 task_id - task id
 owner_id - owner id

mark_add

Added in: 3.19.24 

Description: Add a mark to a task
Required parameters:
 task_id - task id
 mark_id - mark id

mark_delete

Added in: 3.19.24 

Description: Delete a mark from a task
Required parameters:
 task_id - task id
 mark_id - mark id

overview_task

Added in: 3.19.7 

Description: Record that an employee has viewed a task

Required parameters:
 task_id - task id
 employee_id - employee id

remove_cable_line_from_task

Added in: 3.20.2 

Description: Remove a cable line from a task

Required parameters:
 task_id - task id
 cable_line_id - cable line id

remove_owner_from_task

Added in: 3.19.19 

Description: Remove an owner from a task

Required parameters:
 task_id - task id
 owner_id - owner id
Источник — https://wiki.userside.eu/index.php?title=API_task_EN&oldid=21544