ПланФикс API task.update — различия между версиями
Материал из ПланФикс
								
												
				Seva (обсуждение | вклад)  | 
				Seva (обсуждение | вклад)   | 
				||
| Строка 47: | Строка 47: | ||
         <!-- ... -->  |          <!-- ... -->  | ||
       </delGroups>  |        </delGroups>  | ||
| − |      </workers>  | + |      </workers>      | 
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
   </task>  |    </task>  | ||
   <signature></signature>  |    <signature></signature>  | ||
| Строка 135: | Строка 104: | ||
|-  | |-  | ||
|workers.delGroups.id ||int || идентификатор группы||  | |workers.delGroups.id ||int || идентификатор группы||  | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|-  | |-  | ||
|}  | |}  | ||
| − | Добавляемые даты могут задаваться в двух форматах. Первый формат короткий, указывается только число, год и месяц. Второй формат - полный, дополнительно указывается время начала/завершения, если того требует задача  | + | Добавляемые даты могут задаваться в двух форматах. Первый формат короткий, указывается только число, год и месяц. Второй формат - полный, дополнительно указывается время начала/завершения, если того требует задача.  | 
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Все параметры, за исключением '''id''', являются не обязательными и если они опущены, то не происходит обновление информации данного параметра  | Все параметры, за исключением '''id''', являются не обязательными и если они опущены, то не происходит обновление информации данного параметра  | ||
| − | |||
Ответ при удачном выполнении функции:  | Ответ при удачном выполнении функции:  | ||
Версия 09:09, 26 мая 2012
Функция обновления информации задачи. Формат запроса:
<?xml version="1.0" encoding="UTF-8"?>
<request method="task.update">
  <account></account>
  <sid></sid>
  <task>
    <id></id>
    <title></title>
    <description></description>
    <importance></importance>
    <status></status>
    <checkResult></checkResult>
    <owner>
      <id></id>
    </owner>
    <parent>
      <id></id>
    </parent>
    <project>
      <id></id>
    </project>
    <client>
      <id></id>
    </client>
    <startTime></startTime>
    <endTime></endTime>
    <workers>
      <addUsers>
        <id></id>
        <id></id>
        <!-- ... -->
      </addUsers>
      <addGroups>
        <id></id>
        <id></id>
        <!-- ... -->
      </addGroups>
      <delUsers>
        <id></id>
        <id></id>
        <!-- ... -->
      </delUsers>
      <delGroups>
        <id></id>
        <id></id>
        <!-- ... -->
      </delGroups>
    </workers>    
  </task>
  <signature></signature>
</request>| Название | Тип | Значение | Примечание | 
|---|---|---|---|
| id | int | идентификатор обновляемой задачи | обязательный параметр | 
| title | string | название задачи | |
| description | string | о чем задача, описание | |
| importance | enum | срочность | перечень допустимых значений смотри в разделе срочность задач | 
| status | enum | статус задачи | перечень допустимых значений смотри в разделе статусы задач | 
| checkResult | bool | является ли задача задачей с обязательной проверкой результата | |
| owner | создатель задачи | необязательное поле. Если не указано - берется пользователь от имени которого выполняется функция | |
| owner.id | int | идентификатор пользователя | |
| parent | над задача | необязательное поле | |
| parent.id | int | идентификатор задачи, которая будет являться над задачей | допустимо значение 0 (ноль) | 
| project | в рамках какого проекта поставлена задача | ||
| project.id | int | идентификатор проекта | |
| client | контрагент | необязательный параметр | |
| client.id | int | идентификатор контрагента | допустимо значение 0 | 
| startTime | DateTime | время начала работы | в интерфейсе ПланФикс поле приступить к работе | 
| endTime | DateTime | время окончания задачи | в интерфейсе ПланФикс поле закончить работу До | 
| workers | корневой элемент списка исполнителей задачи | ||
| workers.addUsers | корневой элемент списка пользователей, которые подключаются к задаче | ||
| workers.addUsers.id | int | идентификатор пользователя, который подключается к задаче | |
| workers.addGroups | корневой элемент списка групп, которые подключаются к задаче поставлена задача | ||
| workers.addGroups.id | int | идентификатор группы | |
| workers.delUsers | корневой элемент списка пользователей, которые удаляются из списка исполнителей | ||
| workers.delUsers.id | int | идентификатор пользователя, который удаляется из списка исполнителей | |
| workers.delGroups | корневой элемент списка групп, которые удаляются из списка исполнителей | ||
| workers.delGroups.id | int | идентификатор группы | 
Добавляемые даты могут задаваться в двух форматах. Первый формат короткий, указывается только число, год и месяц. Второй формат - полный, дополнительно указывается время начала/завершения, если того требует задача.
Все параметры, за исключением id, являются не обязательными и если они опущены, то не происходит обновление информации данного параметра
Ответ при удачном выполнении функции:
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <task>
    <id></id>
  </task>
</response>| Название | Тип | Значение | Примечание | 
|---|---|---|---|
| task.id | int | идентификатор обновляемой задачи | 
В противном случае будет возвращен ответ с ошибкой:
<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
  <code></code>
</response>