View Program Budget Changes by Parent
get
/api/restapi/programBudgetChange/byParent
Send a request to this end point to view all program budget changes under parent with codes matching the code fields in query parameters.
Request
Query Parameters
-
programCode(required): string
Program code under which all the program budget changes have to be found.
This is a required field. -
workspaceCode(required): string
Workspace code under which all the program budget changes have to be found.
This is a required field.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : List<ApiEntityProgramBudgetChange>
Type:
array
Title:
Show Source
List<ApiEntityProgramBudgetChange>
-
Array of:
object ApiEntityProgramBudgetChange
Title:
ApiEntityProgramBudgetChange
Nested Schema : ApiEntityProgramBudgetChange
Type:
object
Title:
Show Source
ApiEntityProgramBudgetChange
-
approveByUserId: integer
(int64)
The username of the user that approved the item.
-
approveByUserName: string
Maximum Length:
255
The name of the user who approved a program budget change. -
approveDate: string
(date-time)
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)
The username of the user who last made changes to the item.
-
link: string
(url)
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:
programBudgetChangeCost
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)
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: integer
(int64)
The unique identifier for the program.
-
rejectByUserId: integer
(int64)
The username of the user that rejected the item.
-
rejectByUserName: string
Maximum Length:
255
The name of the user who rejected a program budget change. -
rejectDate: string
(date-time)
Date the item was rejected.
-
status: string
Allowed Values:
[ "DRAFT", "PENDING", "REJECTED", "APPROVED" ]
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)
The username of the user that submitted the item.
-
submitByUserName: string
Maximum Length:
255
The name of the user who submitted a program budget change. -
submitDate: string
(date-time)
Date the item was submitted.
-
updateDate: string
(date-time)
Date when the record was last updated.
-
withdrawApprovalByUserId: integer
(int64)
The username of the user that with withdrew approval of the item.
-
withdrawApprovalByUserName: string
Maximum Length:
255
The name of the user who withdrew a program budget change. -
withdrawApprovalDate: string
(date-time)
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 ApiEntityProgramBudgetChangeConfiguredFieldValue
Title:
ApiEntityProgramBudgetChangeConfiguredFieldValue
Nested Schema : programBudgetChangeCost
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 ApiEntityProgramBudgetChangeTransaction
Title:
ApiEntityProgramBudgetChangeTransaction
Nested Schema : ApiEntityProgramBudgetChangeConfiguredFieldValue
Type:
object
Title:
Show Source
ApiEntityProgramBudgetChangeConfiguredFieldValue
-
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: number
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)
This holds values for Cost type configured fields in the workspace1 currency conversion.
-
costValueWorkspace2: number
(double)
This holds values for Cost type configured fields in the workspace2 currency conversion.
-
costValueWorkspace3: number
(double)
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: string
Maximum Length:
4000
Provides the error message for why the formula calculation resulted in an error. -
hasException: boolean
Determines if formula calculation hit an error calculating a value for this field.
-
link: string
(url)
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)
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)
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 : ApiEntityProgramBudgetChangeTransaction
Type:
object
Title:
Show Source
ApiEntityProgramBudgetChangeTransaction
-
action: stringAllowed Values:[ "DELETE" ]
Deprecated. As of 23.4.Provide value for this field during object update to delete the assigned configured field value. -
approveDate: string
(date-time)
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)
The number of hours needed to complete the budget details line item. Calculated as Production Rate multiplied by Quantity.
-
changeMode: string
Allowed Values:
[ "AUTO", "MANUAL", "CHANGE" ]
specifies the mode of the program budget change transaction. -
configuredFields: array
configuredFields
The list of configured fields for a program budget change transaction.
-
desiredCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a program budget item to be provided while adding a new program budget item through a program budget change. -
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)
The system-generated identifier of a program budget change.
-
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 for the budget line item. -
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: string
Allowed Values:
[ "DRAFT", "PENDING", "REJECTED", "APPROVED" ]
The status of the transaction. Indicates whether the transaction is approved, pending, draft, or rejected. -
transactionType: string
Allowed Values:
[ "ORIGINAL", "CHANGE", "TRANSFER" ]
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
The list of configured fields for a program budget change transaction.
Show Source
-
Array of:
object ApiEntityProgramBudgetTransactionConfiguredFieldValue
Title:
ApiEntityProgramBudgetTransactionConfiguredFieldValue
Nested Schema : programBudgetTransactionCost
The cost data of a program budget transaction.
Match All
Show Source
-
object
ApiEntityProgramBudgetTransactionCost
Title:
ApiEntityProgramBudgetTransactionCost
Nested Schema : ApiEntityProgramBudgetTransactionConfiguredFieldValue
Type:
object
Title:
Show Source
ApiEntityProgramBudgetTransactionConfiguredFieldValue
-
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: number
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)
This holds values for Cost type configured fields in the workspace1 currency conversion.
-
costValueWorkspace2: number
(double)
This holds values for Cost type configured fields in the workspace2 currency conversion.
-
costValueWorkspace3: number
(double)
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: string
Maximum Length:
4000
Provides the error message for why the formula calculation resulted in an error. -
hasException: boolean
Determines if formula calculation hit an error calculating a value for this field.
-
link: string
(url)
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)
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)
Date when the record was last updated.
Nested Schema : ApiEntityProgramBudgetTransactionCost
Type:
object
Title:
Show Source
ApiEntityProgramBudgetTransactionCost
-
amountCost: number
(double)
The amount that the budget row has changed as the result of transactions.
-
amountCostWorkspace1: number
(double)
The amount that the budget row has changed as the result of transactions, based on the workspace1 currency.
-
amountCostWorkspace2: number
(double)
The amount that the budget row has changed as the result of transactions, based on the workspace2 currency.
-
amountCostWorkspace3: number
(double)
The amount that the budget row has changed as the result of transactions, based on the workspace3 currency.
-
currentCost: number
(double)
The current cost of the associated budget line item.
-
currentCostWorkspace1: number
(double)
The total cost of the program budget, including all transfers and changes, based on the workspace1 currency.
-
currentCostWorkspace2: number
(double)
The total cost of the program budget, including all transfers and changes, based on the workspace2 currency.
-
currentCostWorkspace3: number
(double)
The total cost of the program budget, including all transfers and changes, based on the workspace3 currency.
-
laborRate: number
(double)
The cost per labor hour of the budget line item detail.
-
laborRateWorkspace1: number
(double)
The cost per labor hour of the budget line item based on the workspace1 currency.
-
laborRateWorkspace2: number
(double)
The cost per labor hour of the budget line item based on the workspace2 currency.
-
laborRateWorkspace3: number
(double)
The cost per labor hour of the budget line item based on the workspace3 currency.
-
link: string
(url)
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)
The cost per Unit of Measure for the budget line item detail.
-
unitRateWorkspace1: number
(double)
The cost per Unit of Measure for the budget line item based on the workspace1 currency.
-
unitRateWorkspace2: number
(double)
The cost per Unit of Measure for the budget line item based on the workspace3 currency.
-
unitRateWorkspace3: number
(double)
The cost per Unit of Measure for the budget line item based on the workspace2 currency.
-
updateDate: string
(date-time)
Date when the record was last updated.
204 Response
Successful operation with no content.
404 Response
The requested object does not exist, or you do not have access to it.