Create a Program Budget Change

post

/api/restapi/programBudgetChange

Send a request to this endpoint to create a program budget change. An application object will be created using the JSON data provided in the request body.

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json ()
Root 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.
  • programBudgetId
  • programId
  • programCode,workspaceId
  • programCode,workspaceCode
Show Source
Nested Schema : configuredFields
Type: array
The list of configured fields for a program budget change.
Show Source
  • 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 : programBudgetChangeTransactions
Type: array
List of all program budget change transactions of a program budget change.
Show Source
  • 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.
  • programBudgetChangeConfiguredFieldValueId
  • columnDefinitionId
  • columnName
  • columnLabel
Show Source
  • Allowed Values: [ "DELETE" ]
    Provide value for this field during object update to delete the assigned configured field value.
  • Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.
  • Minimum Length: 1
    Maximum Length: 100
    The user-specified UDF column label.
  • Minimum Length: 1
    Maximum Length: 100
    The user-specified UDF column name.
  • This holds values for Date type configured fields.
  • 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.
  • The system generated identifier of a Program Budget Change Configured Field assigned to a Program Budget Change.
  • Maximum Length: 4000
    This holds values for Boolean, List and Text type configured fields.
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.
  • programBudgetTransactionId
Show Source
Nested Schema : configuredFields
Type: array
An object containing configured fields in the form of key-value pairs.
Show Source
  • 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
The cost data of a program budget transaction.
Show Source
  • 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.
  • programBudgetTransactionConfiguredFieldValueId
  • columnDefinitionId
  • columnName
  • columnLabel
Show Source
  • Allowed Values: [ "DELETE" ]
    Provide value for this field during object update to delete the assigned configured field value.
  • Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.
  • Minimum Length: 1
    Maximum Length: 100
    The user-specified UDF column label.
  • Minimum Length: 1
    Maximum Length: 100
    The user-specified UDF column name.
  • This holds values for Date type configured fields.
  • 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.
  • The system generated identifier of a Program Budget Transaction Configured Field assigned to a Program Budget Transaction.
  • Maximum Length: 4000
    This holds values for Boolean, List and Text type configured fields.
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.
  • programBudgetTransactionId
Show Source
Examples

Back to Top

Response

Supported Media Types

201 Response

The object was successfully created.
Body ()
Root Schema : ApiEntityProgramBudgetChange
Type: object
Title: ApiEntityProgramBudgetChange
Show Source
Nested Schema : configuredFields
Type: array
The list of configured fields for a program budget change.
Show Source
Nested Schema : programBudgetChangeCost
An object containing the cost fields associated with the program budget change.
Match All
An object containing the cost fields associated with the program budget change.
Show Source
  • ApiEntityProgramBudgetChangeCost
    Title: ApiEntityProgramBudgetChangeCost
    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
Nested Schema : ApiEntityProgramBudgetChangeConfiguredFieldValue
Type: object
Title: ApiEntityProgramBudgetChangeConfiguredFieldValue
Show Source
Nested Schema : ApiEntityProgramBudgetChangeCost
Type: object
Title: ApiEntityProgramBudgetChangeCost
This entity represents a ProgramBudgetChangeCost object, a unique ProgramBudgetChangeCost object can be identified by the following combinations of the fields.
  • programBudgetChangeId
Show Source
Nested Schema : ApiEntityProgramBudgetChangeTransaction
Type: object
Title: ApiEntityProgramBudgetChangeTransaction
Show Source
Nested Schema : configuredFields
Type: array
The list of configured fields for a program budget change transaction.
Show Source
Nested Schema : programBudgetTransactionCost
The cost data of a program budget transaction.
Match All
The cost data of a program budget transaction.
Show Source
Nested Schema : ApiEntityProgramBudgetTransactionConfiguredFieldValue
Type: object
Title: ApiEntityProgramBudgetTransactionConfiguredFieldValue
Show Source
Nested Schema : ApiEntityProgramBudgetTransactionCost
Type: object
Title: ApiEntityProgramBudgetTransactionCost
Show Source

400 Response

Invalid input for the Program Budget Change service. Verify the request contains valid data, then resubmit the request.
Back to Top