20.7
The following updates were made for 20.7.
Added
Fields
| Field Name | ApiEntity Name | Tag Name | Comments |
| approveByUserName | ApiEntityBudgetChange | Budget Change | |
| changeMode | ApiEntityBudgetChangeTransaction | Budget Change | |
| rejectByUserName | ApiEntityBudgetChange | Budget Change | |
| submitByUserName | ApiEntityBudgetChange | Budget Change | |
| withdrawApprovalByUseName | ApiEntityBudgetChange | Budget Change | |
| approveByUserName | ApiEntityBudgetTransfer | Budget Transfer | |
| rejectByUserName | ApiEntityBudgetTransfer | Budget Transfer | |
| submitByUserName | ApiEntityBudgetTransfer | Budget Transfer | |
| withdrawApprovalByUserName | ApiEntityBudgetTransfer | Budget Transfer | |
| approvalDate | ApiEntityChangeRequest | Change Request | |
| rejectedByUserId | ApiEntityChangeRequest | Change Request | |
| rejectedDate | ApiEntityChangeRequest | Change Request | |
| reopenedByUserId | ApiEntityChangeRequest | Change Request | |
| withdrawnApprovalByUserId | ApiEntityChangeRequest | Change Request | |
| withdrawnApprovalDate | ApiEntityChangeRequest | Change Request | |
| review | ApiEntityPortfolioProject | Portfolio Project | |
| approveByUserName | ApiEntityProjectBudget | Project Budget | |
| rejectByUserName | ApiEntityProjectBudget | Project Budget | |
| submitByUserName | ApiEntityProjectBudget | Project Budget | |
| withdrawApprovalByUserName | ApiEntityProjectBudget | Project Budget | |
| projectId | ApiEntityProjectResourceWorkRate | Project Resource Work Rate | |
| resourceClass | ApiEntityProjectResourceWorkRate | Project Resource Work Rate | |
| associationType | ApiEntityRuleOfCredit | Rule Of Credit | |
| pushDownType | ApiEntityRuleOfCredit | Rule Of Credit | |
| workspaceCode | ApiEntityRuleOfCredit | Rule Of Credit | |
| rejectedByUserId | ApiEntityScopeItemAssignmentChangeRequest | Work Package Change Request | |
| rejectedDate | ApiEntityScopeItemAssignmentChangeRequest | Work Package Change Request | |
| reopenedByUserId | ApiEntityScopeItemAssignmentChangeRequest | Work Package Change Request | |
| reopenedDate | ApiEntityScopeItemAssignmentChangeRequest | Work Package Change Request | |
| rejectedByUserId | ApiEntityScopeItemAssignmentTransferRequest | Work Package Change Request | |
| rejectedDate | ApiEntityScopeItemAssignmentTransferRequest | Work Package Change Request | |
| reopenedByUserId | ApiEntityScopeItemAssignmentTransferRequest | Work Package Change Request | |
| reopenedDate | ApiEntityScopeItemAssignmentTransferRequest | Work Package Change Request | |
| rejectedByUserId | ApiEntityScopeItemChangeRequest | Scope Item Change Request | |
| rejectedDate | ApiEntityScopeItemChangeRequest | Scope Item Change Request | |
| reopenedByUserId | ApiEntityScopeItemChangeRequest | Scope Item Change Request | |
| reopenedDate | ApiEntityScopeItemChangeRequest | Scope Item Change Request | |
| rejectedByUserId | ApiEntityWorkPackageChangeRequest | Work Package Change Request | |
| rejectedDate | ApiEntityWorkPackageChangeRequest | Work Package Change Request | |
| reopenedByUserId | ApiEntityWorkPackageChangeRequest | Work Package Change Request | |
| reopenedDate | ApiEntityWorkPackageChangeRequest | Work Package Change Request |
Endpoints
| Endpoint | HTTP Method | Tag Name | ApiEntity Name | Comments |
| /ruleOfCredit | POST | Rule Of Credit | ApiEntityRuleOfCredit | |
| /ruleOfCredit | PUT | Rule Of Credit | ApiEntityRuleOfCredit | |
| /ruleOfCredit/{rocId} | DELETE | Rule Of Credit | ApiEntityRuleOfCredit | |
| /ruleOfCredit/{rocId} | GET | Rule Of Credit | ApiEntityRuleOfCredit | |
| /ruleOfCredit/batch | DELETE | Rule Of Credit | ApiEntityRuleOfCredit | |
| /ruleOfCredit/batch | POST | Rule Of Credit | ApiEntityRuleOfCredit | |
| /ruleOfCredit/batch | PUT | Rule Of Credit | ApiEntityRuleOfCredit | |
| /ruleOfCredit/replicateObjectInWorkspaces/roc/{rocId}/workspace/{workspaceId} | POST | Rule Of Credit | ApiEntityRuleOfCredit | |
| /ruleOfCredit/ROCMilestone/{rocId} | GET | Rule Of Credit | ApiEntityRuleOfCredit | |
| /ruleOfCredit/workspace/{workspaceId} | GET | Rule Of Credit | ApiEntityRuleOfCredit | |
| /ruleOfCredit/workspace/code/{workspaceCode} | GET | Rule Of Credit | ApiEntityRuleOfCredit |
Modified
Fields
| Field Name | ApiEntity Name | Tag Name | Comments |
| segmentDefaultValue | ApiEntityCBSSheetSegment | CBS Segment | This field is now optional for creating a project segment. |
| segmentDefaultValue | ApiEntityCBSTemplateSegment | CBS Segment | This field is now optional for creating a workspace segment. |
Endpoints
| Endpoint | HTTP Method | Tag Name | ApiEntity Name | Comments |
| /activity | PUT | Activity | ApiEntityActivity | A new response header field 'warnings' was added. This field will be populated if warning messages are generated while processing ApiEntityActivityConfiguredFieldValue entity. |
| /activity/batch | PUT | Activity | ApiEntityActivity | A new response payload field 'warnings' was added. This field will be populated if warning messages are generated while processing ApiEntityActivityConfiguredFieldValue entity. See Example 1 in the below table. |
| /assignment | PUT | Assignment | ApiEntityAssignment | A new response header field 'warnings' was added. This field will be populated if warning messages are generated while processing ApiEntityAssignmentConfiguredFieldValue entity. |
| /assignment/batch | PUT | Assignment | ApiEntityAssignment | A new response payload field 'warnings' was added. This field will be populated if warning messages are generated while processing ApiEntityAssignmentConfiguredFieldValue entity. See Example 1 in the below table. |
| /budgetChange | PUT | Budget Change | ApiEntityBudgetChange | A new response header field 'warnings' was added. This field will be populated if warning messages are generated while processing any of the following entities: ApiEntityBudgetChangeConfiguredFieldValue, ApiEntityBudgetTransactionConfiguredFieldValue |
| /budgetChange/batch | PUT | Budget Change | ApiEntityBudgetChange | A new response payload field 'warnings' was added. This field will be populated if warning messages are generated while processing any of the following entities : ApiEntityBudgetChangeConfiguredFieldValue, ApiEntityBudgetTransactionConfiguredFieldValue. See Example 1 in the below table. |
| /budgetItem | PUT | Budget Item | ApiEntityBudgetItemConfiguredFieldValue | A new response header field 'warnings' was added. This field will be populated if warning messages are generated while processing ApiEntityBudgetItemConfiguredFieldValue entity. |
| /budgetItem/batch | PUT | Budget Item | ApiEntityBudgetItemConfiguredFieldValue | A new response payload field 'warnings' was added. This field will be populated if warning messages are generated while processing ApiEntityBudgetItemConfiguredFieldValue entity. See Example 1 in the below table. |
| /budgetTransfer | PUT | Budget Transfer | ApiEntityBudgetTransferConfiguredFieldValue | A new response header field 'warnings' was added. This field will be populated if warning messages are generated while processing any of the following entities: ApiEntityBudgetTransferConfiguredFieldValue, ApiEntityBudgetTransactionConfiguredFieldValue |
| /budgetTransfer/batch | PUT | Budget Transfer | ApiEntityBudgetTransferConfiguredFieldValue | A new response payload field 'warnings' was added. This field will be populated if warning messages are generated while processing any of the following entities : ApiEntityBudgetTransferConfiguredFieldValue, ApiEntityBudgetTransactionConfiguredFieldValue. See Example 1 in the below table. |
| /cbs/project | PUT | CBS | ApiEntityCBSSheetRowConfiguredFieldValue | A new response header field 'warnings' was added. This field will be populated if warning messages are generated while processing ApiEntityCBSSheetRowConfiguredFieldValue entity. |
| /cbs/workspace | PUT | CBS | ApiEntityCBSTemplateRowConfiguredFieldValue | A new response header field 'warnings' was added. This field will be populated if warning messages are generated while processing ApiEntityCBSTemplateRowConfiguredFieldValue entity. |
| /changeEstimate | PUT | Change Estimate | ApiEntityChangeEstimateConfiguredFieldValue | A new response header field 'warnings' was added. This field will be populated if warning messages are generated while processing ApiEntityChangeEstimateConfiguredFieldValue entity. This row should not be reflected in the Documentation as Contracts, Commitments, Change Estimate, Change Event, Change Order, Payment Application, RFI, Submittal APIs were deprecated in 20.6. |
| /changeEstimate/batch | PUT | Change Estimate | ApiEntityChangeEstimateConfiguredFieldValue | A new response payload field 'warnings' was added. This field will be populated if warning messages are generated while processing ApiEntityChangeEstimateConfiguredFieldValue entity. See Example 1 in the below table. This row should not be reflected in the Documentation as Contracts, Commitments, Change Estimate, Change Event, Change Order, Payment Application, RFI, Submittal APIs were deprecated in 20.6. |
| /changeEvent | PUT | Change Event | ApiEntityChangeEventConfiguredFieldValue | A new response header field 'warnings' was added. This field will be populated if warning messages are generated while processing ApiEntityChangeEventConfiguredFieldValue entity. This row should not be reflected in the Documentation as Contracts, Commitments, Change Estimate, Change Event, Change Order, Payment Application, RFI, Submittal APIs were deprecated in 20.6. |
| /changeEvent/batch | PUT | Change Event | ApiEntityChangeEventConfiguredFieldValue | A new response payload field 'warnings' was added. This field will be populated if warning messages are generated while processing ApiEntityChangeEventConfiguredFieldValue entity. See Example 1 in the below table. This row should not be reflected in the Documentation as Contracts, Commitments, Change Estimate, Change Event, Change Order, Payment Application, RFI, Submittal APIs were deprecated in 20.6. |
| /changeOrder | PUT | Change Order | ApiEntityChangeOrderConfiguredFieldValue | A new response header field 'warnings' was added. This field will be populated if warning messages are generated while processing ApiEntityChangeOrderConfiguredFieldValue entity. This row should not be reflected in the Documentation as Contracts, Commitments, Change Estimate, Change Event, Change Order, Payment Application, RFI, Submittal APIs were deprecated in 20.6. |
| /changeOrder/batch | PUT | Change Order | ApiEntityChangeOrderConfiguredFieldValue | a new response payload field 'warnings' was added. This field will be populated if warning messages are generated while processing ApiEntityChangeOrderConfiguredFieldValue entity. See Example 1 in the below table. This row should not be reflected in the Documentation as Contracts, Commitments, Change Estimate, Change Event, Change Order, Payment Application, RFI, Submittal APIs were deprecated in 20.6. |
| /commitment | PUT | Commitment | ApiEntityCommitmentConfiguredFieldValue | A new response header field 'warnings' was added. This field will be populated if warning messages are generated while processing ApiEntityCommitmentConfiguredFieldValue entity. This row should not be reflected in the Documentation as Contracts, Commitments, Change Estimate, Change Event, Change Order, Payment Application, RFI, Submittal APIs were deprecated in 20.6. |
| /commitment/batch | PUT | Commitment | ApiEntityCommitmentConfiguredFieldValue | A new response payload field 'warnings' was added. This field will be populated if warning messages are generated while processing ApiEntityCommitmentConfiguredFieldValue entity. See Example 1 in the below table. This row should not be reflected in the Documentation as Contracts, Commitments, Change Estimate, Change Event, Change Order, Payment Application, RFI, Submittal APIs were deprecated in 20.6. |
| /contract | PUT | Contract | ApiEntityContractConfiguredFieldValue | A new response header field 'warnings' was added. This field will be populated if warning messages are generated while processing ApiEntityContractConfiguredFieldValue entity. This row should not be reflected in the Documentation as Contracts, Commitments, Change Estimate, Change Event, Change Order, Payment Application, RFI, Submittal APIs were deprecated in 20.6. |
| /contract/batch | PUT | Contract | ApiEntityContractConfiguredFieldValue | A new response payload field 'warnings' was added. This field will be populated if warning messages are generated while processing ApiEntityContractConfiguredFieldValue entity. See Example 1 in the below table. This row should not be reflected in the Documentation as Contracts, Commitments, Change Estimate, Change Event, Change Order, Payment Application, RFI, Submittal APIs were deprecated in 20.6. |
| /customLogItem | PUT | Custom Log Item | ApiEntityCustomLogItemConfiguredFieldValue | A new response header field 'warnings' was added. This field will be populated if warning messages are generated while processing ApiEntityCustomLogItemConfiguredFieldValue entity. |
| /customLogItem/batch | PUT | Custom Log Item | ApiEntityCustomLogItemConfiguredFieldValue | A new response payload field 'warnings' was added. This field will be populated if warning messages are generated while processing ApiEntityCustomLogItemConfiguredFieldValue entity. See Example 1 in the below table. |
| /document/file | PUT | Document | ApiEntityDocumentConfiguredFieldValue | A new response header field 'warnings' was added. This field will be populated if warning messages are generated while processing ApiEntityDocumentConfiguredFieldValue entity. |
| /funds/portfolio | PUT | Funds | ApiEntityFundConfiguredFieldValue | A new response header field 'warnings' was added. This field will be populated if warning messages are generated while processing ApiEntityFundConfiguredFieldValue entity. |
| /funds/portfolio/batch | PUT | Funds | ApiEntityFundConfiguredFieldValue | A new response payload field 'warnings' was added. This field will be populated if warning messages are generated while processing ApiEntityFundConfiguredFieldValue entity. See Example 1 below. |
| /funds/project | PUT | Funds | ApiEntityFundConfiguredFieldValue | A new response header field 'warnings' was added. This field will be populated if warning messages are generated while processing ApiEntityFundConfiguredFieldValue entity. |
| /funds/project/batch | PUT | Funds | ApiEntityFundConfiguredFieldValue | A new response payload field 'warnings' was added. This field will be populated if warning messages are generated while processing ApiEntityFundConfiguredFieldValue entity. See Example 1 below. |
| /funds/workspace | PUT | Funds | ApiEntityFundConfiguredFieldValue | A new response header field 'warnings' was added. This field will be populated if warning messages are generated while processing ApiEntityFundConfiguredFieldValue entity. |
| /funds/workspace/batch | PUT | Funds | ApiEntityFundConfiguredFieldValue | A new response payload field 'warnings' was added. This field will be populated if warning messages are generated while processing ApiEntityFundConfiguredFieldValue entity. See Example 1 below. |
| /idea | PUT | Idea | ApiEntityIdeaConfiguredFieldValue | A new response header field 'warnings' was added. This field will be populated if warning messages are generated while processing ApiEntityIdeaConfiguredFieldValue entity. |
| /idea/batch | PUT | Idea | ApiEntityIdeaConfiguredFieldValue | A new response payload field 'warnings' was added. This field will be populated if warning messages are generated while processing ApiEntityIdeaConfiguredFieldValue entity. See Example 1 below. |
| /paymentApplication | PUT | Payment Application | ApiEntityPaymentApplicationConfiguredFieldValue | A new response header field 'warnings' was added. This field will be populated if warning messages are generated while processing ApiEntityPaymentApplicationConfiguredFieldValue entity. |
| /paymentApplication/batch | PUT | Payment Application | ApiEntityPaymentApplicationConfiguredFieldValue | A new response payload field 'warnings' was added. This field will be populated if warning messages are generated while processing ApiEntityPaymentApplicationConfiguredFieldValue entity. See Example 1 below. |
| /portfolio | PUT | Portfolio | ApiEntityPortfolioConfiguredFieldValue | A new response header field 'warnings' was added. This field will be populated if warning messages are generated while processing ApiEntityPortfolioConfiguredFieldValue entity. |
| /portfolio/batch | PUT | Portfolio | ApiEntityPortfolioConfiguredFieldValue | A new response payload field 'warnings' was added. This field will be populated if warning messages are generated while processing ApiEntityPortfolioConfiguredFieldValue entity. See Example 1 below. |
| /project | PUT | Project | ApiEntityProjectConfiguredFieldValue | A new response header field 'warnings' was added. This field will be populated if warning messages are generated while processing ApiEntityProjectConfiguredFieldValue entity. |
| /project/batch | PUT | Project | ApiEntityProjectConfiguredFieldValue | A new response payload field 'warnings' was added. This field will be populated if warning messages are generated while processing ApiEntityProjectConfiguredFieldValue entity. See Example 1 below. |
| /projectActuals | PUT | Project Actuals | ApiEntityProjectActualsConfiguredFieldValue | A new response header field 'warnings' was added. This field will be populated if warning messages are generated while processing ApiEntityProjectActualsConfiguredFieldValue entity. |
| /projectActuals/batch | PUT | Project Actuals | ApiEntityProjectActualsConfiguredFieldValue | A new response payload field 'warnings' was added. This field will be populated if warning messages are generated while processing ApiEntityProjectActualsConfiguredFieldValue entity. See Example 1 below. |
| /projectRisk | PUT | Project Risk | ApiEntityProjectRiskConfiguredFieldValue | A new response header field 'warnings' was added. This field will be populated if warning messages are generated while processing ApiEntityProjectRiskConfiguredFieldValue entity. |
| /projectRisk/batch | PUT | Project Risk | ApiEntityProjectRiskConfiguredFieldValue | A new response payload field 'warnings' was added. This field will be populated if warning messages are generated while processing ApiEntityProjectRiskConfiguredFieldValue entity. See Example 1 below. |
| /rfi | PUT | RFI | ApiEntityRfiConfiguredFieldValue | A new response header field 'warnings' was added. This field will be populated if warning messages are generated while processing ApiEntityRfiConfiguredFieldValue entity. This row should not be reflected in the Documentation as Contracts, Commitments, Change Estimate, Change Event, Change Order, Payment Application, RFI, Submittal APIs were deprecated in 20.6. |
| /rfi/batch | PUT | RFI | ApiEntityRfiConfiguredFieldValue | A new response payload field 'warnings' was added. This field will be populated if warning messages are generated while processing ApiEntityRfiConfiguredFieldValue entity. See Example 1 below. This row should not be reflected in the Documentation as Contracts, Commitments, Change Estimate, Change Event, Change Order, Payment Application, RFI, Submittal APIs were deprecated in 20.6. |
| /scopeItem | PUT | Scope Item | ApiEntityScopeItemConfiguredFieldValue | A new response header field 'warnings' was added. This field will be populated if warning messages are generated while processing ApiEntityScopeItemConfiguredFieldValue entity. |
| /scopeItemAssignment | PUT | Scope Item Assignment | ApiEntityScopeItemAssignmentConfiguredFieldValue | A new response header field 'warnings' was added. This field will be populated if warning messages are generated while processing ApiEntityScopeItemAssignmentConfiguredFieldValue entity. |
| /submittal | PUT | Submittal | ApiEntitySubmittalConfiguredFieldValue | A new response header field 'warnings' was added. This field will be populated if warning messages are generated while processing ApiEntitySubmittalConfiguredFieldValue entity. This row should not be reflected in the Documentation as Contracts, Commitments, Change Estimate, Change Event, Change Order, Payment Application, RFI, Submittal APIs were deprecated in 20.6. |
| /submittal/batch | PUT | Submittal | ApiEntitySubmittalConfiguredFieldValue | A new response payload field 'warnings' was added. This field will be populated if warning messages are generated while processing ApiEntitySubmittalConfiguredFieldValue entity. See Example 1 below. This row should not be reflected in the Documentation as Contracts, Commitments, Change Estimate, Change Event, Change Order, Payment Application, RFI, Submittal APIs were deprecated in 20.6. |
| /wbs | PUT | WBS | ApiEntityWBSConfiguredFieldValue | A new response header field 'warnings' was added. This field will be populated if warning messages are generated while processing ApiEntityWBSConfiguredFieldValue entity. |
| /workManagerTask | PUT | Work Manager Task | ApiEntityWorkManagerTaskConfiguredFieldValue | A new response header field 'warnings' was added. This field will be populated if warning messages are generated while processing ApiEntityWorkManagerTaskConfiguredFieldValue entity. |
| /workManagerTask/batch | PUT | Work Manager Task | ApiEntityWorkManagerTaskConfiguredFieldValue | A new response payload field 'warnings' was added. This field will be populated if warning messages are generated while processing ApiEntityWorkManagerTaskConfiguredFieldValue entity. See Example 1 below. |
| /workPackage | PUT | Work Package | ApiEntityWorkPackageConfiguredFieldValue | A new response header field 'warnings' was added. This field will be populated if warning messages are generated while processing ApiEntityWorkPackageConfiguredFieldValue entity. |
Example 1
{"warnings":[{"primaryKeyName":"id","primaryKeyValue":1,"uniqueFieldName":"code","uniqueFieldValue":"code01","warningMessages":["Deletion failed for a nested object. The configured field with column name UDFColName does not exist or has been deleted.","Deletion failed for a nested object. The configured field with column label UDFColLabel does not exist or has been deleted.","Deletion failed for a nested object. The configured field with id 10 does not exist or has been deleted."]}]}