ПланФикс API project.update — различия между версиями
Материал из ПланФикс
Seva (обсуждение | вклад) |
Seva (обсуждение | вклад) |
||
(не показано 12 промежуточных версий 3 участников) | |||
Строка 1: | Строка 1: | ||
+ | {{#seo: | ||
+ | |title=ПланФикс API project.update | ||
+ | |titlemode=append | ||
+ | |keywords=планфикс, проекты, апи, api | ||
+ | |description=ПланФикс API project.update | ||
+ | }} | ||
+ | |||
Функция обновления данных о проекте. Формат запроса: | Функция обновления данных о проекте. Формат запроса: | ||
− | |||
<source lang="xml"> | <source lang="xml"> | ||
<?xml version="1.0" encoding="UTF-8"?> | <?xml version="1.0" encoding="UTF-8"?> | ||
Строка 8: | Строка 14: | ||
<project> | <project> | ||
<id></id> | <id></id> | ||
+ | <general></general> | ||
<title></title> | <title></title> | ||
<description></description> | <description></description> | ||
Строка 18: | Строка 25: | ||
<status></status> | <status></status> | ||
<hidden></hidden> | <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> | </project> | ||
<signature></signature> | <signature></signature> | ||
Строка 30: | Строка 65: | ||
|- | |- | ||
|id || int || Идентификатор проекта который редактируется || можно получить из функций получения списка или в результате выполнения функции добавления | |id || int || Идентификатор проекта который редактируется || можно получить из функций получения списка или в результате выполнения функции добавления | ||
+ | |- | ||
+ | |general || int || Номер проекта который редактируется || используется при отсутствии параметра id | ||
|- | |- | ||
|title || string || Название проекта || не обязательный параметр | |title || string || Название проекта || не обязательный параметр | ||
Строка 43: | Строка 80: | ||
|client.id || int || идентификатор контрагента || допускается значение 0 (ноль). | |client.id || int || идентификатор контрагента || допускается значение 0 (ноль). | ||
|- | |- | ||
− | |status ||enum || статус | + | |status ||enum || новый статус проекта || перечень допустимых значений для данного поля смотри в разделе константы [[ПланФикс API:Статусы проектов|статусы проектов]]. не обязательный параметр |
|- | |- | ||
|hidden ||bool || скрытый ||не обязательный параметр | |hidden ||bool || скрытый ||не обязательный параметр | ||
Строка 50: | Строка 87: | ||
|- | |- | ||
|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|| ||значение пользовательского поля проекта|| | ||
|- | |- | ||
|} | |} | ||
Строка 69: | Строка 132: | ||
|- | |- | ||
|} | |} | ||
+ | В противном случае будет возвращен ответ с ошибкой: | ||
+ | <source lang="xml"> | ||
+ | <?xml version="1.0" encoding="UTF-8"?> | ||
+ | <response status="error"> | ||
+ | <code></code> | ||
+ | </response> | ||
+ | </source> | ||
+ | |||
− | === Коды ошибок | + | == Перейти == |
+ | *[[ПланФикс API:Проекты]] | ||
+ | *[[Коды ошибок]] | ||
+ | *[[Список функций]] |
Текущая версия на 05:20, 27 августа 2018
Функция обновления данных о проекте. Формат запроса:
<?xml version="1.0" encoding="UTF-8"?>
<request method="project.update">
<account></account>
<sid></sid>
<project>
<id></id>
<general></general>
<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>
Название | Тип | Значение | Примечание |
---|---|---|---|
sid | string(32) | ключ сесии | выдается в результате прохождения аутентификации |
id | int | Идентификатор проекта который редактируется | можно получить из функций получения списка или в результате выполнения функции добавления |
general | int | Номер проекта который редактируется | используется при отсутствии параметра id |
title | string | Название проекта | не обязательный параметр |
description | string | Описание проекта которое задает пользователь | не обязательный параметр |
owner | не обязательный параметр | ||
owner.id | int | идентификатор пользователя, который будет считаться создателем проекта. | допускается значение 0 (ноль). не обязательный параметр |
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>
Название | Тип | Значение | Примечание |
---|---|---|---|
id | int | идентификатор | равен идентификатору переданному в запросе |
В противном случае будет возвращен ответ с ошибкой:
<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
<code></code>
</response>