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

• approveByUserId: integer (int64)
  Read Only: true

  Deprecated. As of 23.4.
  The username of the user that approved the item.
• approveByUserName: string
  Read 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: programBudgetChangeCost
  Read 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: string
  Read 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: string
  Allowed 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: string
  Read 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: string
  Read 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.

{
    "title":"ApiEntityProgramBudgetChangeInput",
    "required":[
        "programId"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "status":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>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.",
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DRAFT",
                "PENDING",
                "REJECTED",
                "APPROVED"
            ]
        },
        "description":{
            "maxLength":"4000",
            "minLength":"0",
            "type":"string",
            "description":"Details supporting the change request.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programBudgetChangeCost":{
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>An object containing the cost fields associated with the program budget change.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityProgramBudgetChangeCost"
                }
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "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"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "approveDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>Date the item was approved.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "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"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier for the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a program set by the user who created the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programBudgetId":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The system-generated identifier of a program budget.",
            "format":"int64",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "approveByUserId":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The username of the user that approved the item.",
            "format":"int64",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "approveByUserName":{
            "maxLength":"255",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The name of the user who approved a program budget change.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "lastModifiedById":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The username of the user who last made changes to the item.",
            "format":"int64",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "rejectByUserId":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The username of the user that rejected the item.",
            "format":"int64",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "rejectByUserName":{
            "maxLength":"255",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The name of the user who rejected a program budget change.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "rejectDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>Date the item was rejected.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "submitByUserId":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The username of the user that submitted the item.",
            "format":"int64",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "submitByUserName":{
            "maxLength":"255",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The name of the user who submitted a program budget change.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "submitDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>Date the item was submitted.",
            "format":"date-time",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "withdrawApprovalByUserId":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The username of the user that with withdrew approval of the item.",
            "format":"int64",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "withdrawApprovalByUserName":{
            "maxLength":"255",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The name of the user who withdrew a program budget change.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "withdrawApprovalDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>Date the item was withdrawn.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "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"
            ]
        },
        "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"
            ]
        }
    },
    "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 : 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

{
    "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>An object containing the cost fields associated with the program budget change.",
    "readOnly":true,
    "deprecated":true,
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityProgramBudgetChangeCost"
        }
    ]
}

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.
• costValue: number
  Read 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: string
  Read Only: true

  Maximum Length: 4000

  Deprecated. As of 23.10.
  Provides the error message for why the formula calculation resulted in an error.
• hasException: boolean
  Read 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.

{
    "title":"ApiEntityProgramBudgetChangeConfiguredFieldValueInput",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programBudgetChangeId":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The system-generated identifier of a Program Budget Change.",
            "format":"int64",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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"
            ]
        },
        "columnName":{
            "maxLength":"100",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified UDF column name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "textValue":{
            "maxLength":"4000",
            "type":"string",
            "description":"This holds values for Boolean, List and Text type configured fields.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "dateValue":{
            "type":"string",
            "description":"This holds values for Date type configured fields.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costValue":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "hasException":{
            "type":"boolean",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Determines if formula calculation hit an error calculating a value for this field.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "exceptionMessage":{
            "maxLength":"4000",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Provides the error message for why the formula calculation resulted in an error.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costValueWorkspace1":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>This holds values for Cost type configured fields in the workspace1 currency conversion.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "costValueWorkspace2":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>This holds values for Cost type configured fields in the workspace2 currency conversion.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "costValueWorkspace3":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>This holds values for Cost type configured fields in the workspace3 currency conversion.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "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 : 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.

• programBudgetChangeId

Show Source

• 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.

{
    "title":"ApiEntityProgramBudgetChangeCost",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "totalCost":{
            "type":"number",
            "description":"The cost to be added or subtracted from the program budget.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalCostWorkspace1":{
            "type":"number",
            "description":"The cost to be added or subtracted from the program budget, based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "programBudgetChangeId":{
            "type":"integer",
            "description":"The system-generated identifier of a program budget change.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "totalCostWorkspace2":{
            "type":"number",
            "description":"The cost to be added or subtracted from the program budget, based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalCostWorkspace3":{
            "type":"number",
            "description":"The cost to be added or subtracted from the program budget, based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a ProgramBudgetChangeCost object, a unique ProgramBudgetChangeCost object can be identified by the following combinations of the fields.<ul><li>programBudgetChangeId</li>",
    "readOnly":true,
    "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.
• 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: string
  Read 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: string
  Read 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: string
  Read 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.

{
    "title":"ApiEntityProgramBudgetChangeTransactionInput",
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The status of the transaction. Indicates whether the transaction is approved, pending, draft, or rejected.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DRAFT",
                "PENDING",
                "REJECTED",
                "APPROVED"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "transactionType":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>Specifies whether the budget row is an original, change, or transfer value.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "ORIGINAL",
                "CHANGE",
                "TRANSFER"
            ]
        },
        "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
        },
        "budgetHours":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The number of hours needed to complete the budget details line item. Calculated as Production Rate multiplied by Quantity.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "budgetCostCategoryId":{
            "type":"integer",
            "description":"The type of cost associated with the budget line item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "approveDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The date the transaction was approved.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "changeMode":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>specifies the mode of the program budget change transaction.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "AUTO",
                "MANUAL",
                "CHANGE"
            ]
        },
        "desiredCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"A unique identifier for the budget item (Add Budget Line).",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programBudgetTransactionCost":{
            "description":"The cost data of a program budget transaction.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityProgramBudgetTransactionCostInput"
                }
            ]
        }
    },
    "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

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.
• costValue: number
  Read 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: string
  Read Only: true

  Maximum Length: 4000

  Deprecated. As of 23.10.
  Provides the error message for why the formula calculation resulted in an error.
• hasException: boolean
  Read 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.

{
    "title":"ApiEntityProgramBudgetTransactionConfiguredFieldValueInput",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programBudgetTransactionId":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The system-generated identifier of a Program Budget Transaction.",
            "format":"int64",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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"
            ]
        },
        "columnName":{
            "maxLength":"100",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified UDF column name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "textValue":{
            "maxLength":"4000",
            "type":"string",
            "description":"This holds values for Boolean, List and Text type configured fields.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "dateValue":{
            "type":"string",
            "description":"This holds values for Date type configured fields.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costValue":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "hasException":{
            "type":"boolean",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Determines if formula calculation hit an error calculating a value for this field.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "exceptionMessage":{
            "maxLength":"4000",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Provides the error message for why the formula calculation resulted in an error.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costValueWorkspace1":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>This holds values for Cost type configured fields in the workspace1 currency conversion.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "costValueWorkspace2":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>This holds values for Cost type configured fields in the workspace2 currency conversion.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "costValueWorkspace3":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>This holds values for Cost type configured fields in the workspace3 currency conversion.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "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

• 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.

{
    "title":"ApiEntityProgramBudgetTransactionCostInput",
    "required":[
        "amountCostCOR"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "currentCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The current cost of the associated budget line item.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "unitRate":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The cost per Unit of Measure for the budget line item detail.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "laborRate":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The cost per labor hour of the budget line item detail.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "amountCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.4</i>.</br>The amount that the budget row has changed as the result of transactions.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "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
        },
        "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
        },
        "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
        }
    },
    "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 Using a Program Budget Change ID

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