Update a Program Budget Item
put
/api/restapi/programBudgetItem
Send a request to this endpoint to update a program budget item. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : ApiEntityProgramBudgetItemInput
Type:
object
Title:
ApiEntityProgramBudgetItemInput
This entity represents a ProgramBudgetItem object, a unique ProgramBudgetItem object can be identified by the following combinations of the fields.
Show Source
- programBudgetItemId
- programBudgetItemCode, programId
- programBudgetItemCode, programCode, workspaceCode
-
abbreviation: string
Minimum Length:
1
Maximum Length:10
The abbreviated name of a cost category. -
budgetHours: number(double)Read Only:true
Deprecated. As of 23.4.The number of hours needed to complete the budget item. Calculated as Production Rate multiplied by Quantity. -
cbsCodes: array
cbsCodes
List of cbs codes in hierarchy for the CBS which needs to be associated with the item. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.
-
cbsTemplateCodeId: integer
(int64)
The unique identifier of the CBS Code.
-
configuredFields: array
configuredFields
An object containing configured fields in the form of key-value pairs.
-
costCategoryId: integer
(int64)
The type of cost associated with the budget item.
-
costCategoryName: string
Minimum Length:
1
Maximum Length:255
The cost category assigned to this budget item. -
productionRate: number
(double)
Minimum Value:
0.000010
The number of hours per unit of measure needed to complete the budget item. -
programBudgetChangeId: integer(int64)Read Only:true
Deprecated. As of 23.4.Indicates whether the budget item originated in a budget change. -
programBudgetId: integer(int64)Read Only:true
Deprecated. As of 23.4.The ID of the program budget. -
programBudgetItemCode: string
Minimum Length:
0
Maximum Length:60
The unique identifier of the program budget item. -
programBudgetItemCost:
programBudgetItemCost
Contains Program Budget Item cost related fields.
-
programBudgetItemId: integer
(int64)
The system-generated identifier for a budget.
-
programBudgetItemName: string
Minimum Length:
0
Maximum Length:255
The name of the budget item. -
programCode: string
Maximum Length:
60
The unique identifier for a program set by the user who created the program. -
programId: integer
(int64)
The unique identifier for the program.
-
quantity: number
(double)
The number of each budget item needed to complete the work.
-
sourceId: string
Maximum Length:
255
The unique identifier of program budget item data in an external source. -
unitsOfMeasureId: integer
(int64)
The Unit of Measure used for the budget item.
-
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace. -
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : cbsCodes
Type:
array
List of cbs codes in hierarchy for the CBS which needs to be associated with the item. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.
Show Source
Nested Schema : configuredFields
Type:
array
An object containing configured fields in the form of key-value pairs.
Show Source
-
Array of:
object ApiEntityProgramBudgetItemConfiguredFieldValueInput
Title:
ApiEntityProgramBudgetItemConfiguredFieldValueInput
This entity represents a ProgramBudgetItemConfiguredFieldValue object, a unique ProgramBudgetItemConfiguredFieldValue object can be identified by the following combinations of the fields.- programBudgetItemConfiguredFieldValueId
- columnDefinitionId
- columnName
- columnLabel
Nested Schema : programBudgetItemCost
Contains Program Budget Item cost related fields.
Match All
Show Source
-
object
ApiEntityProgramBudgetItemCostInput
Title:
ApiEntityProgramBudgetItemCostInput
Nested Schema : ApiEntityProgramBudgetItemConfiguredFieldValueInput
Type:
object
Title:
ApiEntityProgramBudgetItemConfiguredFieldValueInput
This entity represents a ProgramBudgetItemConfiguredFieldValue object, a unique ProgramBudgetItemConfiguredFieldValue object can be identified by the following combinations of the fields.
Show Source
- programBudgetItemConfiguredFieldValueId
- columnDefinitionId
- columnName
- columnLabel
-
action: string
Allowed Values:
[ "DELETE" ]
Provide value for this field during object update to delete the assigned configured field value. -
columnDefinitionId: integer
(int64)
Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.
-
columnLabel: string
Minimum Length:
1
Maximum Length:100
The user-specified UDF column label. -
columnName: string
Minimum Length:
1
Maximum Length:100
The user-specified UDF column name. -
costValue: numberRead Only:true
Deprecated. As of 23.10.This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record. -
costValueWorkspace1: number(double)Read Only:true
Deprecated. As of 23.10.This holds values for Cost type configured fields in the workspace1 currency conversion. -
costValueWorkspace2: number(double)Read Only:true
Deprecated. As of 23.10.This holds values for Cost type configured fields in the workspace2 currency conversion. -
costValueWorkspace3: number(double)Read Only:true
Deprecated. As of 23.10.This holds values for Cost type configured fields in the workspace3 currency conversion. -
dateValue: string
(date-time)
This holds values for Date type configured fields.
-
exceptionMessage: stringRead Only:true
Maximum Length:4000
Deprecated. As of 23.10.Provides the error message for why the formula calculation resulted in an error. -
hasException: booleanRead Only:true
Deprecated. As of 23.10.Determines if formula calculation hit an error calculating a value for this field. -
link: string(url)Read Only:true
Deprecated. As of 23.10.The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
numberValue: number
This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.
-
programBudgetItemConfiguredFieldValueId: integer
(int64)
The unique identifier for the Budget Item Configured Field.
-
programBudgetItemId: integer(int64)Read Only:true
Deprecated. As of 23.11.The system-generated identifier for a budget. -
textValue: string
Maximum Length:
4000
This holds values for Boolean, List and Text type configured fields. -
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated.
Nested Schema : ApiEntityProgramBudgetItemCostInput
Type:
object
Title:
Show Source
ApiEntityProgramBudgetItemCostInput
-
currentCost: number(double)Read Only:true
Deprecated. As of 23.4.The current cost of the budget line item. -
laborRate: number(double)Read Only:true
Deprecated. As of 23.4.The cost per labor hour of the budget line item. -
laborRateCOR: number
(double)
The cost per labor hour of the budget line item. This is an input field, will not be a part of response.
-
link: string(url)Read Only:true
Deprecated. As of 23.4.The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
originalCost: number(double)Read Only:true
Minimum Value:0
Deprecated. As of 23.4.The original cost of the budget line item. -
originalCostCOR: number
(double)
Minimum Value:
0
The original cost of the budget line item. This is an input field, will not be a part of response. -
programBudgetItemId: integer
(int64)
The system-generated identifier for a budget.
-
unitRate: number(double)Read Only:true
Deprecated. As of 23.4.The cost per Unit of Measure for the budget line item. -
unitRateCOR: number
(double)
The cost per Unit of Measure for the budget line item. This is an input field, will not be a part of response.
-
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.4.Date when the record was last updated.
Examples
Back to Top
Response
204 Response
Successful operation with no content.
400 Response
Invalid input for the Program Budget Item service. Verify the request contains valid data, then resubmit the request.