Batch Update Program Budget Changes
put
/api/restapi/programBudgetChange/batch
Send a request to this endpoint to update one or more program budget changes. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : List<ApiEntityProgramBudgetChangeInput>
Type:
array
Title:
Show Source
List<ApiEntityProgramBudgetChangeInput>
-
Array of:
object ApiEntityProgramBudgetChangeInput
Title:
ApiEntityProgramBudgetChangeInput
This entity represents a ProgramBudgetChange object, a unique ProgramBudgetChange object can be identified by the following combinations of the fields.- programBudgetId
- programId
- programCode,workspaceId
- programCode,workspaceCode
Nested Schema : ApiEntityProgramBudgetChangeInput
Type:
object
Title:
ApiEntityProgramBudgetChangeInput
This entity represents a ProgramBudgetChange object, a unique ProgramBudgetChange object can be identified by the following combinations of the fields.
Show Source
- programBudgetId
- programId
- programCode,workspaceId
- programCode,workspaceCode
-
approveByUserId: integer(int64)Read Only:true
Deprecated. As of 23.4.The username of the user that approved the item. -
approveByUserName: stringRead Only:true
Maximum Length:255
Deprecated. As of 23.4.The name of the user who approved a program budget change. -
approveDate: string(date-time)Read Only:true
Deprecated. As of 23.4.Date the item was approved. -
configuredFields: array
configuredFields
The list of configured fields for a program budget change.
-
description: string
Minimum Length:
0
Maximum Length:4000
Details supporting the change request. -
lastModifiedById: integer(int64)Read Only:true
Deprecated. As of 23.4.The username of the user who last made changes to the item. -
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. -
programBudgetChangeCode: string
Maximum Length:
60
The unique identifier of the program budget change request. -
programBudgetChangeCost:programBudgetChangeCostRead Only:true
Deprecated. As of 23.4.An object containing the cost fields associated with the program budget change. -
programBudgetChangeId: integer
(int64)
The system-generated identifier of a program budget change.
-
programBudgetChangeTransactions: array
programBudgetChangeTransactions
List of all program budget change transactions of a program budget change.
-
programBudgetId: integer(int64)Read Only:true
Deprecated. As of 23.4.The system-generated identifier of a program budget. -
programCode: string
Maximum Length:
60
The unique identifier for a program set by the user who created the program. -
programId(required): integer
(int64)
The unique identifier for the program.
-
rejectByUserId: integer(int64)Read Only:true
Deprecated. As of 23.4.The username of the user that rejected the item. -
rejectByUserName: stringRead Only:true
Maximum Length:255
Deprecated. As of 23.4.The name of the user who rejected a program budget change. -
rejectDate: string(date-time)Read Only:true
Deprecated. As of 23.4.Date the item was rejected. -
status: stringAllowed Values:[ "DRAFT", "PENDING", "REJECTED", "APPROVED" ]
Deprecated. As of 23.4.The state of the program budget change request. Pending: The change request is awaiting a decision. Approved: The change request was approved. Rejected: The change request was not approved. -
submitByUserId: integer(int64)Read Only:true
Deprecated. As of 23.4.The username of the user that submitted the item. -
submitByUserName: stringRead Only:true
Maximum Length:255
Deprecated. As of 23.4.The name of the user who submitted a program budget change. -
submitDate: string(date-time)Deprecated. As of 23.4.Date the item was submitted. -
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.4.Date when the record was last updated. -
withdrawApprovalByUserId: integer(int64)Read Only:true
Deprecated. As of 23.4.The username of the user that with withdrew approval of the item. -
withdrawApprovalByUserName: stringRead Only:true
Maximum Length:255
Deprecated. As of 23.4.The name of the user who withdrew a program budget change. -
withdrawApprovalDate: string(date-time)Read Only:true
Deprecated. As of 23.4.Date the item was withdrawn. -
workspaceCode: string
Maximum Length:
60
The user-specified identifier of a workspace. -
workspaceId: integer
(int64)
The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.
Nested Schema : configuredFields
Type:
array
The list of configured fields for a program budget change.
Show Source
-
Array of:
object ApiEntityProgramBudgetChangeConfiguredFieldValueInput
Title:
ApiEntityProgramBudgetChangeConfiguredFieldValueInput
This entity represents a ProgramBudgetChangeConfiguredFieldValue object, a unique ProgramBudgetChangeConfiguredFieldValue object can be identified by the following combinations of the fields.- programBudgetChangeConfiguredFieldValueId
- columnDefinitionId
- columnName
- columnLabel
Nested Schema : programBudgetChangeCost
Read Only:
true
Deprecated. As of 23.4.An object containing the cost fields associated with the program budget change.
Match All
Show Source
-
object
ApiEntityProgramBudgetChangeCost
Title:
ApiEntityProgramBudgetChangeCost
Read Only:true
This entity represents a ProgramBudgetChangeCost object, a unique ProgramBudgetChangeCost object can be identified by the following combinations of the fields.- programBudgetChangeId
Nested Schema : programBudgetChangeTransactions
Type:
array
List of all program budget change transactions of a program budget change.
Show Source
-
Array of:
object ApiEntityProgramBudgetChangeTransactionInput
Title:
ApiEntityProgramBudgetChangeTransactionInput
This entity represents a ProgramBudgetChangeTransaction object, a unique ProgramBudgetChangeTransaction object can be identified by the following combinations of the fields.- programBudgetTransactionId
Nested Schema : ApiEntityProgramBudgetChangeConfiguredFieldValueInput
Type:
object
Title:
ApiEntityProgramBudgetChangeConfiguredFieldValueInput
This entity represents a ProgramBudgetChangeConfiguredFieldValue object, a unique ProgramBudgetChangeConfiguredFieldValue object can be identified by the following combinations of the fields.
Show Source
- programBudgetChangeConfiguredFieldValueId
- 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.
-
programBudgetChangeConfiguredFieldValueId: integer
(int64)
The system generated identifier of a Program Budget Change Configured Field assigned to a Program Budget Change.
-
programBudgetChangeId: integer(int64)Read Only:true
Deprecated. As of 23.11.The system-generated identifier of a Program Budget Change. -
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 : ApiEntityProgramBudgetChangeCost
Type:
object
Title:
ApiEntityProgramBudgetChangeCost
Read Only:
true
This entity represents a ProgramBudgetChangeCost object, a unique ProgramBudgetChangeCost object can be identified by the following combinations of the fields.
Show Source
- programBudgetChangeId
-
link: string
(url)
Read Only:
true
The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
programBudgetChangeId: integer
(int64)
The system-generated identifier of a program budget change.
-
totalCost: number
(double)
The cost to be added or subtracted from the program budget.
-
totalCostWorkspace1: number
(double)
The cost to be added or subtracted from the program budget, based on the workspace1 currency.
-
totalCostWorkspace2: number
(double)
The cost to be added or subtracted from the program budget, based on the workspace2 currency.
-
totalCostWorkspace3: number
(double)
The cost to be added or subtracted from the program budget, based on the workspace3 currency.
-
updateDate: string
(date-time)
Read Only:
true
Date when the record was last updated.
Nested Schema : ApiEntityProgramBudgetChangeTransactionInput
Type:
object
Title:
ApiEntityProgramBudgetChangeTransactionInput
This entity represents a ProgramBudgetChangeTransaction object, a unique ProgramBudgetChangeTransaction object can be identified by the following combinations of the fields.
Show Source
- programBudgetTransactionId
-
action: string
Allowed Values:
[ "DELETE" ]
Provide value for this field during object update to delete the assigned configured field value. -
approveDate: string(date-time)Read Only:true
Deprecated. As of 23.4.The date the transaction was approved. -
budgetCbsTemplateCodeId: integer
(int64)
The name of the CBS Code associated with the budget line item.
-
budgetCostCategoryId: integer
(int64)
The type of cost associated with the budget line item.
-
budgetHours: number(double)Read Only:true
Deprecated. As of 23.4.The number of hours needed to complete the budget details line item. Calculated as Production Rate multiplied by Quantity. -
changeMode: stringRead Only:true
Allowed Values:[ "AUTO", "MANUAL", "CHANGE" ]
Deprecated. As of 23.4.specifies the mode of the program budget change transaction. -
configuredFields: array
configuredFields
An object containing configured fields in the form of key-value pairs.
-
desiredCode: string
Minimum Length:
0
Maximum Length:60
A unique identifier for the budget item (Add Budget Line). -
productionRate: number
(double)
Minimum Value:
0.000010
The number of hours per unit of measure needed to complete the budget line item. -
programBudgetChangeId: integer
(int64)
This is an intermediary field that the system uses to calculate other values. It does not correspond to any field users can see in the user interface.
-
programBudgetItemId: integer
(int64)
A unique identifier for the budget item (Change Budget Line).
-
programBudgetItemName: string
Maximum Length:
255
The name of the budget item. -
programBudgetTransactionCode: string
Maximum Length:
60
The unique identifier of the program budget line item detail. -
programBudgetTransactionCost:
programBudgetTransactionCost
The cost data of a program budget transaction.
-
programBudgetTransactionId: integer
(int64)
The system-generated identifier for a transaction.
-
quantity: number
(double)
The number of each budget line item needed to complete the work.
-
status: stringRead Only:true
Allowed Values:[ "DRAFT", "PENDING", "REJECTED", "APPROVED" ]
Deprecated. As of 23.4.The status of the transaction. Indicates whether the transaction is approved, pending, draft, or rejected. -
transactionType: stringRead Only:true
Allowed Values:[ "ORIGINAL", "CHANGE", "TRANSFER" ]
Deprecated. As of 23.4.Specifies whether the budget row is an original, change, or transfer value. -
unitOfMeasureId: integer
(int64)
The Unit of Measure used for the budget line item detail.
Nested Schema : configuredFields
Type:
array
An object containing configured fields in the form of key-value pairs.
Show Source
-
Array of:
object ApiEntityProgramBudgetTransactionConfiguredFieldValueInput
Title:
ApiEntityProgramBudgetTransactionConfiguredFieldValueInput
This entity represents a ProgramBudgetTransactionConfiguredFieldValue object, a unique ProgramBudgetTransactionConfiguredFieldValue object can be identified by the following combinations of the fields.- programBudgetTransactionConfiguredFieldValueId
- columnDefinitionId
- columnName
- columnLabel
Nested Schema : programBudgetTransactionCost
The cost data of a program budget transaction.
Match All
Show Source
-
object
ApiEntityProgramBudgetTransactionCostInput
Title:
ApiEntityProgramBudgetTransactionCostInput
This entity represents a ProgramBudgetTransactionCost object, a unique ProgramBudgetTransactionCost object can be identified by the following combinations of the fields.- programBudgetTransactionId
Nested Schema : ApiEntityProgramBudgetTransactionConfiguredFieldValueInput
Type:
object
Title:
ApiEntityProgramBudgetTransactionConfiguredFieldValueInput
This entity represents a ProgramBudgetTransactionConfiguredFieldValue object, a unique ProgramBudgetTransactionConfiguredFieldValue object can be identified by the following combinations of the fields.
Show Source
- programBudgetTransactionConfiguredFieldValueId
- 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.
-
programBudgetTransactionConfiguredFieldValueId: integer
(int64)
The system generated identifier of a Program Budget Transaction Configured Field assigned to a Program Budget Transaction.
-
programBudgetTransactionId: integer(int64)Read Only:true
Deprecated. As of 23.11.The system-generated identifier of a Program Budget Transaction. -
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 : ApiEntityProgramBudgetTransactionCostInput
Type:
object
Title:
ApiEntityProgramBudgetTransactionCostInput
This entity represents a ProgramBudgetTransactionCost object, a unique ProgramBudgetTransactionCost object can be identified by the following combinations of the fields.
Show Source
- programBudgetTransactionId
-
amountCost: number(double)Read Only:true
Deprecated. As of 23.4.The amount that the budget row has changed as the result of transactions. -
amountCostCOR(required): number
(double)
The amount that the budget row has changed as the result of transactions. This is an input field, will not be a part of response.
-
currentCost: number(double)Read Only:true
Deprecated. As of 23.4.The current cost of the associated budget line item. -
laborRate: number(double)Read Only:true
Deprecated. As of 23.4.The cost per labor hour of the budget line item detail. -
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. -
programBudgetTransactionId: integer
(int64)
The system-generated identifier for a transaction.
-
unitRate: number(double)Read Only:true
Deprecated. As of 23.4.The cost per Unit of Measure for the budget line item detail. -
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
200 Response
A collection of object IDs mapped to a canonical link of the object with corresponding warning messages if any warnings were generated while processing the update request. For example - {"links":{"1":"https://[host]:[port]/api/restapi/[object]/1","2":"https://[host]:[port]/api/restapi/[object]/2"},"warnings":[{"primaryKeyName":"objectIdFieldName","uniqueFieldName":"object_code_01","uniqueFieldValue":"objectCodeFieldName","primaryKeyValue":1,"warningMessages":["warning_message_1","warning_message_2"]}]}
400 Response
Invalid input for the Program Budget Change service. Verify the request contains valid data, then resubmit the request.