ПланФикс API task.add — различия между версиями

Материал из ПланФикс
Перейти к: навигация, поиск
(Новая страница: «== task.add Добавление задачи== Добавление: <source lang="xml"> <?xml version="1.0" encoding="UTF-8"?> <request method="task.add"> <accou...»)
 
Строка 1: Строка 1:
−
== task.add Добавление задачи==
+
Функция позволяет создать новую задачу. Формат запроса:
−
Добавление:
 
 
<source lang="xml">
 
<source lang="xml">
 
<?xml version="1.0" encoding="UTF-8"?>
 
<?xml version="1.0" encoding="UTF-8"?>
 
<request method="task.add">
 
<request method="task.add">
−
   <account><!-- имя аккаунта --></account>
+
   <account></account>
−
   <sid><!-- ключ сессии, полученный после аутентификации --></sid>
+
   <sid></sid>
 
   <task>
 
   <task>
−
     <title><!-- Название задачи --></title>
+
     <title></title>
−
     <description><!-- О чем эта задача --></description>
+
     <description></description>
−
     <importance><!-- Срочность  --></importance>
+
     <importance></importance>
−
     <status><!-- Статус --></status>
+
     <status></status>
−
     <checkResult>{true|false}</checkResult><!-- Является ли задача задачей с обязательной проверкой результата -->
+
     <checkResult></checkResult>
−
    <!-- Создатель задачи -->
 
 
     <owner>
 
     <owner>
 
       <id></id>
 
       <id></id>
 
     </owner>
 
     </owner>
−
    <!-- Над задача -->
 
 
     <parent>
 
     <parent>
 
       <id></id>
 
       <id></id>
 
     </parent>
 
     </parent>
−
    <!-- В рамках какого проекта поставлена задача -->
 
 
     <project>
 
     <project>
 
       <id></id>
 
       <id></id>
 
     </project>
 
     </project>
−
    <!-- Контрагент -->
 
 
     <client>
 
     <client>
 
       <id></id>
 
       <id></id>
 
     </client>
 
     </client>
−
     <startTime><!-- Время начала (приступить к работе) --></startTime>
+
     <startTime></startTime>
−
     <endTime><!-- Время окончания (закончить работу До) --></endTime>
+
     <endTime></endTime>
−
     <!-- список исполнителей -->
+
     <workers>
−
    <Workers>
+
       <users>
−
       <!-- список пользователей -->
+
         <id></id>
−
      <Users>
 
−
         <id><!-- идентификатор логина --></id>
 
 
         <id></id>
 
         <id></id>
 
         <!-- ... -->
 
         <!-- ... -->
−
       </Users>
+
       </users>
−
       <Groups>
+
       <groups>
 
         <id></id>
 
         <id></id>
 
         <id></id>
 
         <id></id>
 
         <!-- ... -->
 
         <!-- ... -->
−
       </Groups>
+
       </groups>
−
     </Workers>
+
     </workers>
−
    <!-- периодичность задачи, необязательный параметр -->
 
 
     <periodicity>
 
     <periodicity>
 
       <!-- ежедневно -->
 
       <!-- ежедневно -->
Строка 68: Строка 60:
 
</request>
 
</request>
 
</source>
 
</source>
 +
{| class="wikitable" style="margin-top: 1em; width:100% "
 +
!width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание
 +
|-
 +
|title ||string ||название задачи ||
 +
|-
 +
|description || string||о чем задача, описание ||
 +
|-
 +
|importance || enum||срочность || перечень допустимых значений смотри в разделе [[ПланФикс API:Срочность задачи|срочность задач]]
 +
|-
 +
|status ||enum ||статус задачи || перечень допустимых значений смотри в разделе [[ПланФикс API:Статусы задач|статусы задач]]
 +
|-
 +
|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.users || || корневой элемент списка пользователей, которым поставлена задача ||
 +
|-
 +
|workers.users.id ||int ||идентификатор пользователя которому поставлена задача ||
 +
|-
 +
|workers.groups || ||корневой элемент списка групп, которым поставлена задача ||
 +
|-
 +
|workers.groups.id ||int || идентификатор группы||
 +
|-
 +
|periodicity ||node ||задает периодичность выполнения задачи || смотри описание структуры узла ниже
 +
|-
 +
|}
 
Добавляемые даты могут задаваться в двух форматах. Первый формат короткий, указывается только число, год и месяц. Второй формат - полный, дополнительно указывается время начала/завершения, если того требует задача. Периодичность - не обязательный параметр. Внутри тега '''periodicity''' может быть только один из перечисленных элементов: ''daily'', ''weekly'', ''monthly''.
 
Добавляемые даты могут задаваться в двух форматах. Первый формат короткий, указывается только число, год и месяц. Второй формат - полный, дополнительно указывается время начала/завершения, если того требует задача. Периодичность - не обязательный параметр. Внутри тега '''periodicity''' может быть только один из перечисленных элементов: ''daily'', ''weekly'', ''monthly''.
 +
 +
=== описание параметра periodicity ===
 +
Описание параметра ''daily'', параметры ''weekly'' и ''monthly'' в этом случае не могут быть заданы. Указывает что задача должна повторяться ежедневно, согласно установленным критериям:
 +
{| class="wikitable" style="margin-top: 1em; width:100% "
 +
!width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание
 +
|-
 +
|type ||enum||определяет периодичность || допустимые значения EVERY или EVERY_WORKING, или AFTER_COMPLETE
 +
|-
 +
|shift || int||определяет сдвиг в днях || используется только при значениях type равным  EVERY или AFTER_COMPLETE
 +
|-
 +
|}
 +
Значение EVERY интерпретируется как каждый N-й день, заданный в параметре '''shift'''. EVERY_WORKING - каждый рабочий день.  Значение AFTER_COMPLETE интерпретируется как ставить новую задачу через N-й день после каждого завершения, заданный в параметре '''shift'''.
 +
 +
Описание параметра ''weekly'', параметры ''daily'' и ''monthly'' в этом случае не могут быть заданы. Указывает что задача должна повторяться еженедельно, согласно установленным критериям:
 +
{| class="wikitable" style="margin-top: 1em; width:100% "
 +
!width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание
 +
|-
 +
|type ||enum || определяет периодичность || допустимые значения EVERY или AFTER_COMPLETE
 +
|-
 +
|shift ||int || сдвиг в днях ||
 +
|-
 +
|days ||set/list || перечень дней недели, разделитель символ запятой (,). понедельник имеет индекс 1, воскресение - 7. || используется только при type=AFTER_COMPLETE
 +
|-
 +
|}
 +
Значение AFTER_COMPLETE интерпретируется как: ставить задачу через N-й неделю после каждого завершения, заданную в параметре '''shift'''.
 +
 +
Описание параметра ''monthly'', параметры ''daily'' и ''weekly'' в этом случае не могут быть заданы. Указывает что задача должна повторяться ежемесяно, согласно установленным критериям:
 +
{| class="wikitable" style="margin-top: 1em; width:100% "
 +
!width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание
 +
|-
 +
|type ||enum || периодичность || допустимые значения AFTER_COMPLETE или DAY_OF_MONTH, или BY_CONDITION
 +
|-
 +
|month ||int ||задает месяц в/через который должно действие/задача повторяться ||
 +
|-
 +
|day ||int ||задает день в/через который должна задача повторяться || не используется при type=AFTER_COMPLETE
 +
|-
 +
|dayType ||enum || ||
 +
|-
 +
|}
  
 
Ответ при удачном выполнении операции:
 
Ответ при удачном выполнении операции:

Версия 13:47, 20 августа 2010

Функция позволяет создать новую задачу. Формат запроса: 

<?xml version="1.0" encoding="UTF-8"?>
<request method="task.add">
  <account></account>
  <sid></sid>
  <task>
    <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>
      <users>
        <id></id>
        <id></id>
        <!-- ... -->
      </users>
      <groups>
        <id></id>
        <id></id>
        <!-- ... -->
      </groups>
    </workers>
    <periodicity>
      <!-- ежедневно -->
      <daily>
        <type>{EVERY|EVERY_WORKING|AFTER_COMPLETE}</type>
        <shift></shift>
      </daily>
      <!-- еженедельно -->
      <weekly>
        <type>{EVERY|AFTER_COMPLETE}</type>
        <shift></shift>
        <days><!-- список дней через запятую --></days>
      </weekly>
      <!-- ежемесячно -->
      <monthly>
        <type>{AFTER_COMPLETE|DAY_OF_MONTH|BY_CONDITION}</type>
        <month></month>
        <day></day>
        <dayType></dayType>
      </monthly>
    </periodicity>
  </task>
</request>
Название Тип Значение Примечание
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.users корневой элемент списка пользователей, которым поставлена задача
workers.users.id int идентификатор пользователя которому поставлена задача
workers.groups корневой элемент списка групп, которым поставлена задача
workers.groups.id int идентификатор группы
periodicity node задает периодичность выполнения задачи смотри описание структуры узла ниже

Добавляемые даты могут задаваться в двух форматах. Первый формат короткий, указывается только число, год и месяц. Второй формат - полный, дополнительно указывается время начала/завершения, если того требует задача. Периодичность - не обязательный параметр. Внутри тега periodicity может быть только один из перечисленных элементов: daily, weekly, monthly.

описание параметра periodicity

Описание параметра daily, параметры weekly и monthly в этом случае не могут быть заданы. Указывает что задача должна повторяться ежедневно, согласно установленным критериям:

Название Тип Значение Примечание
type enum определяет периодичность допустимые значения EVERY или EVERY_WORKING, или AFTER_COMPLETE
shift int определяет сдвиг в днях используется только при значениях type равным EVERY или AFTER_COMPLETE

Значение EVERY интерпретируется как каждый N-й день, заданный в параметре shift. EVERY_WORKING - каждый рабочий день. Значение AFTER_COMPLETE интерпретируется как ставить новую задачу через N-й день после каждого завершения, заданный в параметре shift.

Описание параметра weekly, параметры daily и monthly в этом случае не могут быть заданы. Указывает что задача должна повторяться еженедельно, согласно установленным критериям:

Название Тип Значение Примечание
type enum определяет периодичность допустимые значения EVERY или AFTER_COMPLETE
shift int сдвиг в днях
days set/list перечень дней недели, разделитель символ запятой (,). понедельник имеет индекс 1, воскресение - 7. используется только при type=AFTER_COMPLETE

Значение AFTER_COMPLETE интерпретируется как: ставить задачу через N-й неделю после каждого завершения, заданную в параметре shift.

Описание параметра monthly, параметры daily и weekly в этом случае не могут быть заданы. Указывает что задача должна повторяться ежемесяно, согласно установленным критериям:

Название Тип Значение Примечание
type enum периодичность допустимые значения AFTER_COMPLETE или DAY_OF_MONTH, или BY_CONDITION
month int задает месяц в/через который должно действие/задача повторяться
day int задает день в/через который должна задача повторяться не используется при type=AFTER_COMPLETE
dayType enum

Ответ при удачном выполнении операции: 

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
	<task>
		<id></id>
	</task>
</response>


Перейти

Источник — «http://planfix.ru/wiki/index.php?title=ПланФикс_API_task.add&oldid=268»