Создание

Создание

Операция Create — создаёт проект.


POST /api/v01/Project/rest/Create
Content-Type: application/json


Тело запроса

ПолеТипОбязательностьОписание
ProjectData.ProjectCodestringдаКод проекта
ProjectData.ProjectTextstringдаНазвание
ProjectData.ProjectDescriptionstringнетОписание
ProjectData.ProjectIconstringнетИконка
ProjectData.ProjectIconColorstringнетЦвет иконки
ProjectData.IntegrationIDstringнетВнешний ID
ProjectData.ProjectSchemeIDstringодин из трёхСхема workflow по внутреннему ID
ProjectData.ProjectSchemeCodestringодин из трёхСхема workflow по коду
ProjectData.ProjectSchemeIntegrationIDstringодин из трёхСхема workflow по внешнему ID
ProjectSchemeKeyFieldstringнетИмя ведущего ключа схемы: ID / PartnerCode / IntegrationID. Если не указан — определяется по присутствующим полям
ProjectData.Documentation_F'0' / '1'нетВключить ли модуль документации
ProjectData.HomePageURLstringнет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"
  }
}