Create

Operation: Create

Creates a project.


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


Request body

FieldTypeRequiredDescription
ProjectData.ProjectCodestringyesProject code
ProjectData.ProjectTextstringyesName
ProjectData.ProjectDescriptionstringnoDescription
ProjectData.ProjectIconstringnoIcon
ProjectData.ProjectIconColorstringnoIcon color
ProjectData.IntegrationIDstringnoExternal ID
ProjectData.ProjectSchemeIDstringone of threeWorkflow scheme by internal ID
ProjectData.ProjectSchemeCodestringone of threeWorkflow scheme by code
ProjectData.ProjectSchemeIntegrationIDstringone of threeWorkflow scheme by external ID
ProjectSchemeKeyFieldstringnoScheme leading key name: ID / PartnerCode / IntegrationID. If not provided — determined from the present fields
ProjectData.Documentation_F'0' / '1'noWhether to enable the documentation module
ProjectData.HomePageURLstringnoHome page URL
ProjectData.HiddenMembers_F'0' / '1'noHide members


Validation

  • A workflow scheme must be specified: at least one of ProjectSchemeID / ProjectSchemeCode / ProjectSchemeIntegrationID.
  • If ProjectSchemeKeyField is provided, the corresponding field must be populated.
  • Without ProjectData — HTTP 500, "Wrong parameters".


Response

{
  "status": "Success",
  "statusCode": 200,
  "details": {
    "ProjectID": "0000000123",
    "ProjectCode": "PROJ"
  }
}


Example

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

{
  "ProjectData": {
    "ProjectCode": "PROJ",
    "ProjectText": "Project Alpha",
    "ProjectSchemeCode": "SCRUM",
    "Documentation_F": "1",
    "HomePageURL": "https://wiki.company/proj"
  }
}