Jump to

• Request
• Response

Update a Program Budget Change

put

/api/restapi/programBudgetChange

Send a request to this endpoint to update a program budget change. 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

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

• 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.
• programBudgetChangeCode: string
  Maximum Length: 60

  The unique identifier of the program budget change request.
• 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.
• 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.
• 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.

{
    "title":"ApiEntityProgramBudgetChangeInput",
    "required":[
        "programId"
    ],
    "type":"object",
    "properties":{
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "description":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"Details supporting the change request.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "configuredFields":{
            "type":"array",
            "description":"The list of configured fields for a program budget change.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityProgramBudgetChangeConfiguredFieldValueInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "programCode":{
            "maxLength":60,
            "type":"string",
            "description":"The unique identifier for a program set by the user who created the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programBudgetChangeCode":{
            "maxLength":60,
            "type":"string",
            "description":"The unique identifier of the program budget change request.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programBudgetChangeId":{
            "type":"integer",
            "description":"The system-generated identifier of a program budget change.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programBudgetChangeTransactions":{
            "type":"array",
            "description":"List of all program budget change transactions of a program budget change.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityProgramBudgetChangeTransactionInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier for the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "maxLength":60,
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a ProgramBudgetChange object, a unique ProgramBudgetChange object can be identified by the following combinations of the fields.<ul><li>programBudgetId</li><li>programId</li><li>programCode,workspaceId</li><li>programCode,workspaceCode</li>",
    "exampleSetFlag":false
}

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

{
    "type":"array",
    "description":"The list of configured fields for a program budget change.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityProgramBudgetChangeConfiguredFieldValueInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

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

{
    "type":"array",
    "description":"List of all program budget change transactions of a program budget change.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityProgramBudgetChangeTransactionInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

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

• 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.
• dateValue: string (date-time)
  This holds values for Date type configured fields.
• 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.
• textValue: string
  Maximum Length: 4000

  This holds values for Boolean, List and Text type configured fields.

{
    "title":"ApiEntityProgramBudgetChangeConfiguredFieldValueInput",
    "type":"object",
    "properties":{
        "programBudgetChangeConfiguredFieldValueId":{
            "type":"integer",
            "description":"The system generated identifier of a Program Budget Change Configured Field assigned to a Program Budget Change.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "columnDefinitionId":{
            "type":"integer",
            "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "numberValue":{
            "type":"number",
            "description":"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.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "columnLabel":{
            "maxLength":100,
            "minLength":1,
            "type":"string",
            "description":"The user-specified UDF column label.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "textValue":{
            "maxLength":4000,
            "type":"string",
            "description":"This holds values for Boolean, List and Text type configured fields.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "columnName":{
            "maxLength":100,
            "minLength":1,
            "type":"string",
            "description":"The user-specified UDF column name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "dateValue":{
            "type":"string",
            "description":"This holds values for Date type configured fields.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "action":{
            "type":"string",
            "description":"Provide value for this field during object update to delete the assigned configured field value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        }
    },
    "description":"This entity represents a ProgramBudgetChangeConfiguredFieldValue object, a unique ProgramBudgetChangeConfiguredFieldValue object can be identified by the following combinations of the fields.<ul><li>programBudgetChangeConfiguredFieldValueId</li><li>columnDefinitionId</li><li>columnName</li><li>columnLabel</li>",
    "exampleSetFlag":false
}

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

• action: string
  Allowed Values: [ "DELETE" ]

  Provide value for this field during object update to delete the assigned configured field value.
• 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.
• 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.
• unitOfMeasureId: integer (int64)
  The Unit of Measure used for the budget line item detail.

{
    "title":"ApiEntityProgramBudgetChangeTransactionInput",
    "type":"object",
    "properties":{
        "unitOfMeasureId":{
            "type":"integer",
            "description":"The Unit of Measure used for the budget line item detail.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "quantity":{
            "type":"number",
            "description":"The number of each budget line item needed to complete the work.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "productionRate":{
            "minimum":"0.000010",
            "type":"number",
            "description":"The number of hours per unit of measure needed to complete the budget line item.",
            "format":"double",
            "exampleSetFlag":false
        },
        "budgetCostCategoryId":{
            "type":"integer",
            "description":"The type of cost associated with the budget line item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "budgetCbsTemplateCodeId":{
            "type":"integer",
            "description":"The name of the CBS Code associated with the budget line item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programBudgetItemId":{
            "type":"integer",
            "description":"A unique identifier for the budget item (Change Budget Line).",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programBudgetItemName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the budget item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programBudgetTransactionCode":{
            "maxLength":60,
            "type":"string",
            "description":"The unique identifier of the program budget line item detail.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programBudgetTransactionId":{
            "type":"integer",
            "description":"The system-generated identifier for a transaction.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programBudgetTransactionCost":{
            "description":"The cost data of a program budget transaction.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityProgramBudgetTransactionCostInput"
                }
            ]
        },
        "desiredCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"A unique identifier for the budget item (Add Budget Line).",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "configuredFields":{
            "type":"array",
            "description":"An object containing configured fields in the form of key-value pairs.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityProgramBudgetTransactionConfiguredFieldValueInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "programBudgetChangeId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "action":{
            "type":"string",
            "description":"Provide value for this field during object update to delete the assigned configured field value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        }
    },
    "description":"This entity represents a ProgramBudgetChangeTransaction object, a unique ProgramBudgetChangeTransaction object can be identified by the following combinations of the fields.<ul><li>programBudgetTransactionId</li>",
    "exampleSetFlag":false
}

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

{
    "type":"array",
    "description":"An object containing configured fields in the form of key-value pairs.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityProgramBudgetTransactionConfiguredFieldValueInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : programBudgetTransactionCost

The cost data of a program budget transaction.

Match All

The cost data of a program budget transaction.

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

{
    "description":"The cost data of a program budget transaction.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityProgramBudgetTransactionCostInput"
        }
    ]
}

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

• 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.
• dateValue: string (date-time)
  This holds values for Date type configured fields.
• 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.
• textValue: string
  Maximum Length: 4000

  This holds values for Boolean, List and Text type configured fields.

{
    "title":"ApiEntityProgramBudgetTransactionConfiguredFieldValueInput",
    "type":"object",
    "properties":{
        "programBudgetTransactionConfiguredFieldValueId":{
            "type":"integer",
            "description":"The system generated identifier of a Program Budget Transaction Configured Field assigned to a Program Budget Transaction.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "columnDefinitionId":{
            "type":"integer",
            "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "numberValue":{
            "type":"number",
            "description":"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.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "columnLabel":{
            "maxLength":100,
            "minLength":1,
            "type":"string",
            "description":"The user-specified UDF column label.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "textValue":{
            "maxLength":4000,
            "type":"string",
            "description":"This holds values for Boolean, List and Text type configured fields.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "columnName":{
            "maxLength":100,
            "minLength":1,
            "type":"string",
            "description":"The user-specified UDF column name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "dateValue":{
            "type":"string",
            "description":"This holds values for Date type configured fields.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "action":{
            "type":"string",
            "description":"Provide value for this field during object update to delete the assigned configured field value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        }
    },
    "description":"This entity represents a ProgramBudgetTransactionConfiguredFieldValue object, a unique ProgramBudgetTransactionConfiguredFieldValue object can be identified by the following combinations of the fields.<ul><li>programBudgetTransactionConfiguredFieldValueId</li><li>columnDefinitionId</li><li>columnName</li><li>columnLabel</li>",
    "exampleSetFlag":false
}

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

• 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.
• 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.
• programBudgetTransactionId: integer (int64)
  The system-generated identifier for a transaction.
• 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.

{
    "title":"ApiEntityProgramBudgetTransactionCostInput",
    "required":[
        "amountCostCOR"
    ],
    "type":"object",
    "properties":{
        "programBudgetTransactionId":{
            "type":"integer",
            "description":"The system-generated identifier for a transaction.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "unitRateCOR":{
            "type":"number",
            "description":"The cost per Unit of Measure for the budget line item. This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "amountCostCOR":{
            "type":"number",
            "description":"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.",
            "format":"double",
            "exampleSetFlag":false
        },
        "laborRateCOR":{
            "type":"number",
            "description":"The cost per labor hour of the budget line item. This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        }
    },
    "description":"This entity represents a ProgramBudgetTransactionCost object, a unique ProgramBudgetTransactionCost object can be identified by the following combinations of the fields.<ul><li>programBudgetTransactionId</li>",
    "exampleSetFlag":false
}

Examples

Select an example Update a Program Budget Change to Assign a Boolean Configured Field Update a Program Budget Change Using a Program Budget Change ID Update a Program Budget Change by Removing a Configured Field

Back to Top

Response

204 Response

Successful operation with no content.

400 Response

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

Back to Top