Update
Operation: Update
Updates a project.
POST /api/v01/Project/rest/Update Content-Type: application/json
Request body
| Field | Type | Required | Description |
|---|---|---|---|
ProjectData.ProjectID / ProjectCode / IntegrationID | string | one of three | Project key |
ProjectKeyField | string | no | Leading key name |
ProjectData.Language | string | no | Record language |
ProjectData.ProjectText | string | no | Name |
ProjectData.ProjectDescription | string | no | Description |
ProjectData.ProjectIcon | string | no | Icon |
ProjectData.ProjectIconColor | string | no | Icon color |
ProjectData.ProjectSchemeID / ProjectSchemeCode / ProjectSchemeIntegrationID | string | no | Change the workflow scheme |
ProjectSchemeKeyField | string | no | Scheme leading key name |
ProjectData.ProjectTypeID | string | no | Project type |
ProjectData.ProjectTypeText | string | no | Type text |
ProjectData.ProjectCategoryID | string | no | Category |
ProjectData.ProjectCategoryText | string | no | Category text |
ProjectData.StartDate | string YYYY-MM-DD | no | Start date |
ProjectData.EndDate | string YYYY-MM-DD | no | End date |
ProjectData.Documentation_F | '0' / '1' | no | Documentation module |
ProjectData.HomePageURL | string | no | Home page URL |
ProjectData.HiddenMembers_F | '0' / '1' | no | Hide members |
ProjectData.OpenPeriodDays | number | no | Open period for time logging, days |
ProjectData.MaximumHoursDay | number | no | Hours-per-day limit |
Validation
- One of the project keys must be present.
- Without
ProjectDataor without a specified key —HTTP 500,"Wrong parameters".
Response
{
"status": "Success",
"statusCode": 200,
"details": {
"ProjectID": "0000000123",
"ProjectCode": "PROJ"
}
}