25.6
The following updates were made for 25.6.
As part of our ongoing effort to enhance the clarity and consistency of our API documentation, we have made the following changes to our tags:
- 'Work Manager Task' has been renamed to 'Task'.
- 'Work Manager Task Commitment' has been renamed to 'Task Commitment'.
- 'Work Manager Task Dependency' has been renamed to 'Task Handoff'.
These updates are reflected in the API summary and description sections. The API endpoints, request and response structures, and field definitions remain unchanged.
Added
Fields
| Field Name | ApiEntity Name | Tag Name | Comments |
| projectCode | ApiEntityProjectCashFlow | Project Cashflows | |
| workspaceCode | ApiEntityProjectCashFlow | Project Cashflows | |
| projectCode | ApiEntityProjectCashFlowInput | Project Cashflows | |
| workspaceCode | ApiEntityProjectCashFlowInput | Project Cashflows | |
| userLocale | ApiEntityExternallySourcedUser | User | |
| userType | ApiEntityExternallySourcedUser | User |
Entities
| ApiEntity Name | Tag Name | Comments |
| ApiEntityResourcePlanningScenario | Resource Planning Scenario | |
| ApiEntityResourcePlanningScenarioInput | Resource Planning Scenario | |
| ApiEntityResourcePlanningScenarioStatusInput | Resource Planning Scenario | |
| ApiEntityResourcePlanProject | Resource Planning Scenario | |
| ApiEntityResourceRoleData | Resource Planning Scenario | |
| ApiEntityRoleDataPeriod | Resource Planning Scenario | |
| ApiEntityRoleDataPeriodCost | Resource Planning Scenario | |
| ApiEntityApplicationUserInput | User | |
| ApiEntityUserProductInput | User |
Endpoints
| Endpoint | HTTP Method | Tag Name | ApiEntity Name | Comments |
| /projectCashflows/{projectPhaseFinancialId} | GET | Project Cashflows | ApiEntityProjectCashFlow | |
| /projectCashflows/batch | DELETE | Project Cashflows | ||
| /projectCashflows/batch | POST | Project Cashflows | ApiEntityProjectCashFlowInput | |
| /projectCashflows/batch | PUT | Project Cashflows | ApiEntityProjectCashFlowInput | |
| /projectCashflows/project/{projectId} | GET | Project Cashflows | ApiEntityProjectCashFlow | |
| /projectCashflows/syncBatch | POST | Project Cashflows | ApiEntityProjectCashFlowInput | |
| /resourcePlanningScenario | POST | Resource Planning Scenario | ApiEntityResourcePlanningScenarioInput | |
| /resourcePlanningScenario/{scenarioId} | DELETE | Resource Planning Scenario | ||
| /resourcePlanningScenario/{scenarioId} | GET | Resource Planning Scenario | ApiEntityResourcePlanningScenario | |
| /resourcePlanningScenario/batch | DELETE | Resource Planning Scenario | ||
| /resourcePlanningScenario/updateScenarioStatus | PUT | Resource Planning Scenario | ApiEntityResourcePlanningScenarioStatusInput | |
| /user | PUT | User | ApiEntityApplicationUserInput |
Modified
Fields
| Field Name | ApiEntity Name | Tag Name | Comments |
| jobType | ApiEntityJobDetail | Action | MIGRATE_BUDGET_TRANSFER_FORM_PROJECT_FIELDS was removed from the list of allowed values for the field. |
| settingName | ApiEntityApplicationUserSetting | User | DataDateInPageBanners was added to the list of allowed values for the field. |
| settingName | ApiEntityApplicationUserSettingInput | User | DataDateInPageBanners was added to the list of allowed values for the field. |
| productName | ApiEntityUserProduct | User | FIELD, RISK were removed from the list of allowed values for the field. |
| description | ApiEntityPreExecutionValidationProblem | Workflow | WBS_DELETE_SUCCESS_DESCRIPTION, WBS_DELETE_FAILURE_DESCRIPTION were removed from the list of allowed values for the field and PROGRAM_COST_INSUFFICIENT_VIEW_PRIVILEGES, INVESTOR_MAP_CHART_RENDER_ERROR, DISABLE_SUBCATEGORY_MESSAGE, ENABLE_SUBCATEGORY_MESSAGE were added to the list of allowed values for the field. |
| type | ApiEntityPreExecutionValidationProblem | Workflow | WBS_DELETE_SUCCESS_DESCRIPTION, WBS_DELETE_FAILURE_DESCRIPTION were removed from the list of allowed values for the field and PROGRAM_COST_INSUFFICIENT_VIEW_PRIVILEGES, INVESTOR_MAP_CHART_RENDER_ERROR, DISABLE_SUBCATEGORY_MESSAGE, ENABLE_SUBCATEGORY_MESSAGE were added to the list of allowed values for the field. |