Создание
Создание
Операция Create — создаёт проект.
POST /api/v01/Project/rest/Create Content-Type: application/json
Тело запроса
| Поле | Тип | Обязательность | Описание |
|---|---|---|---|
ProjectData.ProjectCode | string | да | Код проекта |
ProjectData.ProjectText | string | да | Название |
ProjectData.ProjectDescription | string | нет | Описание |
ProjectData.ProjectIcon | string | нет | Иконка |
ProjectData.ProjectIconColor | string | нет | Цвет иконки |
ProjectData.IntegrationID | string | нет | Внешний ID |
ProjectData.ProjectSchemeID | string | один из трёх | Схема workflow по внутреннему ID |
ProjectData.ProjectSchemeCode | string | один из трёх | Схема workflow по коду |
ProjectData.ProjectSchemeIntegrationID | string | один из трёх | Схема workflow по внешнему ID |
ProjectSchemeKeyField | string | нет | Имя ведущего ключа схемы: ID / PartnerCode / IntegrationID. Если не указан — определяется по присутствующим полям |
ProjectData.Documentation_F | '0' / '1' | нет | Включить ли модуль документации |
ProjectData.HomePageURL | string | нет | URL домашней страницы |
ProjectData.HiddenMembers_F | '0' / '1' | нет | Скрыть участников |
Валидация
- Должна быть указана схема workflow: хотя бы один из
ProjectSchemeID/ProjectSchemeCode/ProjectSchemeIntegrationID. - Если указан
ProjectSchemeKeyField, соответствующее поле должно быть заполнено. - Без
ProjectData—HTTP 500,"Wrong parameters".
Ответ
{
"status": "Success",
"statusCode": 200,
"details": {
"ProjectID": "0000000123",
"ProjectCode": "PROJ"
}
}
Пример
POST /api/v01/Project/rest/Create
Content-Type: application/json
{
"ProjectData": {
"ProjectCode": "PROJ",
"ProjectText": "Проект Альфа",
"ProjectSchemeCode": "SCRUM",
"Documentation_F": "1",
"HomePageURL": "https://wiki.company/proj"
}
}