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

Материал из ПланФикс
Перейти к: навигация, поиск
 
(не показано 9 промежуточных версий 2 участников)
Строка 1: Строка 1:
 +
{{#seo:
 +
|title=ПланФикс API project.add
 +
|titlemode=append
 +
|keywords=планфикс, проекты, апи, api
 +
|description=ПланФикс API project.add
 +
}}
 +
 
Запрос на создание проекта имеет следующий вид:
 
Запрос на создание проекта имеет следующий вид:
 
<source lang="xml">
 
<source lang="xml">
 +
<?xml version="1.0" encoding="UTF-8"?>
 
<request method="project.add">
 
<request method="project.add">
 
   <account></account>
 
   <account></account>
Строка 17: Строка 25:
 
     <hasEndDate></hasEndDate>
 
     <hasEndDate></hasEndDate>
 
     <endDate></endDate>
 
     <endDate></endDate>
 +
    <group>
 +
      <id></id>
 +
    </group>
 +
    <parent>
 +
      <id></id>
 +
    </parent>
 +
    <auditors>
 +
      <id></id>
 +
      <id></id>
 +
      <!-- ... -->
 +
    </auditors>
 +
    <managers>
 +
      <id></id>
 +
      <id></id>
 +
      <!-- ... -->
 +
    </managers>
 +
    <workers>
 +
      <id></id>
 +
      <id></id>
 +
      <!-- ... -->
 +
    </workers>
 +
    <customData>
 +
      <customValue>
 +
        <id></id>
 +
        <value></value>
 +
      </customValue>
 +
      <!-- ... -->
 +
    </customData>
 
   </project>
 
   </project>
 
   <signature></signature>
 
   <signature></signature>
Строка 35: Строка 71:
 
|owner.id || int || идентификатор пользователя, который будет считаться создателем проекта. || допускается значение 0 (ноль). В этом случае будет назначен владельцем пользователь, от имени которого выполняется запрос (определяется по sid)
 
|owner.id || int || идентификатор пользователя, который будет считаться создателем проекта. || допускается значение 0 (ноль). В этом случае будет назначен владельцем пользователь, от имени которого выполняется запрос (определяется по sid)
 
|-
 
|-
−
|client || || ||необязательное параметр
+
|client || || ||необязательный параметр
 
|-
 
|-
 
|client.id || int || идентификатор контрагента || допускается значение 0 (ноль).
 
|client.id || int || идентификатор контрагента || допускается значение 0 (ноль).
Строка 46: Строка 82:
 
|-
 
|-
 
|endDate ||DateTime || ||учитывается только в том случае, если параметр '''hasEndDate''' установлен в ''true''
 
|endDate ||DateTime || ||учитывается только в том случае, если параметр '''hasEndDate''' установлен в ''true''
 +
|-
 +
|group || || ||необязательный параметр
 +
|-
 +
|group.id || int || идентификатор группы проектов ||
 +
|-
 +
|parent|| || ||необязательный параметр
 +
|-
 +
|parent.id || int || идентификатор надпроекта ||
 +
|-
 +
|auditors || || аудиторы проекта ||необязательный параметр
 +
|-
 +
|auditors.id || int || идентификатор аудитора проекта ||
 +
|-
 +
|managers || || менеджеры проекта ||необязательный параметр
 +
|-
 +
|managers.id || int || идентификатор менеджера проекта ||
 +
|-
 +
|workers || || исполнители по умолчанию проекта ||необязательный параметр
 +
|-
 +
|workers.id || int || идентификатор исполнителя по умолчанию проекта ||
 +
|-
 +
|customData|| ||значения пользовательских полей проекта||
 +
|-
 +
|customData.customValue.id|| ||идентификатор пользовательского поля проекта||
 +
|-
 +
|customData.customValue.value|| ||значение пользовательского поля проекта|| (для полей типа набор задач, список сотрудников, набор записей справочника - идентификаторы через запятую в квадратных скобках)
 
|-
 
|-
 
|}
 
|}
Строка 73: Строка 135:
 
</response>
 
</response>
 
</source>
 
</source>
−
{| class="wikitable" style="margin-top: 1em; width:100% "
+
 
−
!width="50"|Значение ''code'' !! Расшифровка
 
−
|-
 
−
|align="center"| 0000|| неизвестная ошибка
 
−
|-
 
−
|align="center"| 0009|| Отсутствует один из обязательных параметров функции
 
−
|-
 
−
|align="center"| 0015 || недопустимое значение параметра
 
−
|-
 
−
|align="center"| 2002 || на выполнение данного запроса отсутствуют права (привилегии)
 
−
|-
 
−
|align="center"| 2003 || ошибка добавления проекта
 
−
|-
 
−
|}
 
  
 
== Перейти ==
 
== Перейти ==
−
*[[ПланФикс API]]
 
 
*[[ПланФикс API:Проекты]]
 
*[[ПланФикс API:Проекты]]
 +
*[[Коды ошибок]]
 +
*[[Список функций]]

Текущая версия на 11:45, 18 ноября 2017

Запрос на создание проекта имеет следующий вид: 

<?xml version="1.0" encoding="UTF-8"?>
<request method="project.add">
  <account></account>
  <sid></sid>
  <project>
    <title></title>
    <description></description>
    <owner>
      <id></id>
    </owner>
    <client>
      <id></id>
    </client>
    <status></status>
    <hidden></hidden>
    <hasEndDate></hasEndDate>
    <endDate></endDate>
    <group>
      <id></id>
    </group>
    <parent>
      <id></id>
    </parent>
    <auditors>
      <id></id>
      <id></id>
      <!-- ... -->
    </auditors>
    <managers>
      <id></id>
      <id></id>
      <!-- ... -->
    </managers>
    <workers>
      <id></id>
      <id></id>
      <!-- ... -->
    </workers>
    <customData>
      <customValue>
        <id></id>
        <value></value>
      </customValue>
      <!-- ... -->
    </customData>
  </project>
  <signature></signature>
</request>

Если не передать автора (owner), или указать id=0, то будет использован в качестве автора пользователь текущей сессии. Контрагент не обязательный параметр. Вызывать функцию имеет право обычный пользователь (не контакт).

Название Тип Значение Примечание
sid string(32) ключ сесии выдается в результате прохождения аутентификации
title string Название проекта
description string Описание проекта которое задает пользователь
owner Данное поле не обязательно. В этом случае будет назначен владельцем пользователь, от имени которого выполняется запрос (определяется по sid)
owner.id int идентификатор пользователя, который будет считаться создателем проекта. допускается значение 0 (ноль). В этом случае будет назначен владельцем пользователь, от имени которого выполняется запрос (определяется по sid)
client необязательный параметр
client.id int идентификатор контрагента допускается значение 0 (ноль).
status enum статус создаваемого проекта перечень допустимых значений для данного поля смотри в разделе статусы проектов
hidden bool скрытый
hasEndDate bool имеет ли дату окончания
endDate DateTime учитывается только в том случае, если параметр hasEndDate установлен в true
group необязательный параметр
group.id int идентификатор группы проектов
parent необязательный параметр
parent.id int идентификатор надпроекта
auditors аудиторы проекта необязательный параметр
auditors.id int идентификатор аудитора проекта
managers менеджеры проекта необязательный параметр
managers.id int идентификатор менеджера проекта
workers исполнители по умолчанию проекта необязательный параметр
workers.id int идентификатор исполнителя по умолчанию проекта
customData значения пользовательских полей проекта
customData.customValue.id идентификатор пользовательского поля проекта
customData.customValue.value значение пользовательского поля проекта (для полей типа набор задач, список сотрудников, набор записей справочника - идентификаторы через запятую в квадратных скобках)


Ответ при успешном создании проекта: 

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <project>
    <id></id>
  </project>
</response>
Название Тип Значение Примечание
project.id int идентификатор созданного проекта

В противном случае будет возвращен ответ с ошибкой: 

<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
  <code></code>
</response>


Перейти

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