Create
Operation: Create
Creates a project.
POST /api/v01/Project/rest/Create Content-Type: application/json
Request body
| Field | Type | Required | Description |
|---|---|---|---|
ProjectData.ProjectCode | string | yes | Project code |
ProjectData.ProjectText | string | yes | Name |
ProjectData.ProjectDescription | string | no | Description |
ProjectData.ProjectIcon | string | no | Icon |
ProjectData.ProjectIconColor | string | no | Icon color |
ProjectData.IntegrationID | string | no | External ID |
ProjectData.ProjectSchemeID | string | one of three | Workflow scheme by internal ID |
ProjectData.ProjectSchemeCode | string | one of three | Workflow scheme by code |
ProjectData.ProjectSchemeIntegrationID | string | one of three | Workflow scheme by external ID |
ProjectSchemeKeyField | string | no | Scheme leading key name: ID / PartnerCode / IntegrationID. If not provided — determined from the present fields |
ProjectData.Documentation_F | '0' / '1' | no | Whether to enable the documentation module |
ProjectData.HomePageURL | string | no | Home page URL |
ProjectData.HiddenMembers_F | '0' / '1' | no | Hide members |
Validation
- A workflow scheme must be specified: at least one of
ProjectSchemeID/ProjectSchemeCode/ProjectSchemeIntegrationID. - If
ProjectSchemeKeyFieldis 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"
}
}