Jump to

• Request
• Response

Batch Update Project Budget Items

put

/api/restapi/budgetItem/batch

Send a request to this endpoint to update one or more project budget items. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : List<ApiEntityBudgetItemInput>

Type: array

Title: List<ApiEntityBudgetItemInput>

Show Source

• Array of: object ApiEntityBudgetItemInput
  Title: ApiEntityBudgetItemInput

  This entity represents a BudgetItem object, a unique BudgetItem object can be identified by the following combinations of the fields.

  • budgetItemId
  • budgetItemCode,projectId
  • budgetItemCode,projectCode,workspaceCode

{
    "title":"List<ApiEntityBudgetItemInput>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityBudgetItemInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityBudgetItemInput

Type: object

Title: ApiEntityBudgetItemInput

This entity represents a BudgetItem object, a unique BudgetItem object can be identified by the following combinations of the fields.

• budgetItemId
• budgetItemCode,projectId
• budgetItemCode,projectCode,workspaceCode

Show Source

• abbreviation: string
  Minimum Length: 1

  Maximum Length: 10

  The abbreviated name of a cost category.
• budgetItemCode: string
  Minimum Length: 0

  Maximum Length: 60

  The unique identifier of the project budget item.
• budgetItemCost: budgetItemCost
  Contains Budget Item cost related fields.
• budgetItemId: integer (int64)
  The system-generated identifier of a budget item.
• cbsCodes: array cbsCodes
  List of cbs codes in hierarchy for the CBS which needs to be associated with the item. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.
• cbsSheetCodeId(required): integer (int64)
  The unique identifier of the CBS Code.
• configuredFields: array configuredFields
  The list of configured fields for a budget item.
• costCategoryId: integer (int64)
  The type of cost associated with the budget item.
• costCategoryName: string
  Minimum Length: 1

  Maximum Length: 255

  The cost category assigned to this budget item.
• itemName(required): string
  Minimum Length: 0

  Maximum Length: 255

  The name of the budget item.
• productionRate: number (double)
  Minimum Value: 0.000010

  The number of hours per unit of measure needed to complete the budget item.
• projectBudgetId: integer (int64)
  The system-generated identifier of a project budget.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The project associated with this budget item.
• projectId(required): integer (int64)
  The unique identifier for the project.The project object can also be identified by its unique criteria.
• quantity: number (double)
  The number of each budget item needed to complete the work.
• sourceId: string
  Maximum Length: 255

  The unique identifier of budget item data in an external source.
• unitsOfMeasureId: integer (int64)
  The Unit of Measure used for the budget item.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityBudgetItemInput",
    "required":[
        "cbsSheetCodeId",
        "itemName",
        "projectId"
    ],
    "type":"object",
    "properties":{
        "budgetItemId":{
            "type":"integer",
            "description":"The system-generated identifier of a budget item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "quantity":{
            "type":"number",
            "description":"The number of each budget 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 item.",
            "format":"double",
            "exampleSetFlag":false
        },
        "costCategoryId":{
            "type":"integer",
            "description":"The type of cost associated with the budget item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "cbsCodes":{
            "type":"array",
            "description":"List of cbs codes in hierarchy for the CBS which needs to be associated with the item. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.",
            "writeOnly":true,
            "exampleSetFlag":false,
            "items":{
                "type":"string",
                "writeOnly":true,
                "exampleSetFlag":false,
                "types":[
                    "string"
                ]
            },
            "types":[
                "array"
            ]
        },
        "budgetItemCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"The unique identifier of the project budget item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "itemName":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"The name of the budget item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "configuredFields":{
            "type":"array",
            "description":"The list of configured fields for a budget item.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityBudgetItemConfiguredFieldValueInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "costCategoryName":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"The cost category assigned to this budget item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "abbreviation":{
            "maxLength":10,
            "minLength":1,
            "type":"string",
            "description":"The abbreviated name of a cost category.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "budgetItemCost":{
            "description":"Contains Budget Item cost related fields.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityBudgetItemCostInput"
                }
            ]
        },
        "unitsOfMeasureId":{
            "type":"integer",
            "description":"The Unit of Measure used for the budget item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "cbsSheetCodeId":{
            "type":"integer",
            "description":"The unique identifier of the CBS Code.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "sourceId":{
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier of budget item data in an external source.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectBudgetId":{
            "type":"integer",
            "description":"The system-generated identifier of a project budget.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The project associated with this budget item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a BudgetItem object, a unique BudgetItem object can be identified by the following combinations of the fields.<ul><li>budgetItemId</li><li>budgetItemCode,projectId</li><li>budgetItemCode,projectCode,workspaceCode</li>",
    "exampleSetFlag":false
}

Nested Schema : budgetItemCost

Contains Budget Item cost related fields.

Match All

Contains Budget Item cost related fields.

Show Source

• object ApiEntityBudgetItemCostInput
  Title: ApiEntityBudgetItemCostInput

{
    "description":"Contains Budget Item cost related fields.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityBudgetItemCostInput"
        }
    ]
}

Nested Schema : cbsCodes

Type: array

List of cbs codes in hierarchy for the CBS which needs to be associated with the item. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.

Show Source

• Array of: string

{
    "type":"array",
    "description":"List of cbs codes in hierarchy for the CBS which needs to be associated with the item. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.",
    "writeOnly":true,
    "exampleSetFlag":false,
    "items":{
        "type":"string",
        "writeOnly":true,
        "exampleSetFlag":false,
        "types":[
            "string"
        ]
    },
    "types":[
        "array"
    ]
}

Nested Schema : configuredFields

Type: array

The list of configured fields for a budget item.

Show Source

• Array of: object ApiEntityBudgetItemConfiguredFieldValueInput
  Title: ApiEntityBudgetItemConfiguredFieldValueInput

  This entity represents a BudgetItemConfiguredFieldValue object, a unique BudgetItemConfiguredFieldValue object can be identified by the following combinations of the fields.

  • budgetItemConfiguredFieldValueId
  • columnDefinitionId
  • columnName
  • columnLabel

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

Nested Schema : ApiEntityBudgetItemCostInput

Type: object

Title: ApiEntityBudgetItemCostInput

Show Source

• budgetItemId(required): integer (int64)
  The system-generated identifier of a budget item.
• laborRateProject: number (double)
  The cost per labor hour of the budget line item. This value is based on the project currency.
• originalCostProject: number (double)
  The original cost of the budget line item. This value is based on the project currency.
• unitRateProject: number (double)
  The cost per Unit of Measure for the budget line item. This value is based on the project currency.

{
    "title":"ApiEntityBudgetItemCostInput",
    "required":[
        "budgetItemId"
    ],
    "type":"object",
    "properties":{
        "budgetItemId":{
            "type":"integer",
            "description":"The system-generated identifier of a budget item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "unitRateProject":{
            "type":"number",
            "description":"The cost per Unit of Measure for the budget line item. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "laborRateProject":{
            "type":"number",
            "description":"The cost per labor hour of the budget line item. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "originalCostProject":{
            "type":"number",
            "description":"The original cost of the budget line item. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityBudgetItemConfiguredFieldValueInput

Type: object

Title: ApiEntityBudgetItemConfiguredFieldValueInput

This entity represents a BudgetItemConfiguredFieldValue object, a unique BudgetItemConfiguredFieldValue object can be identified by the following combinations of the fields.

• budgetItemConfiguredFieldValueId
• 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.
• budgetItemConfiguredFieldValueId: integer (int64)
  The unique identifier for the Budget Item Configured Field.
• budgetItemId: integer (int64)
  The system-generated identifier for an Budget.
• 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.
• textValue: string
  Maximum Length: 4000

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

{
    "title":"ApiEntityBudgetItemConfiguredFieldValueInput",
    "type":"object",
    "properties":{
        "budgetItemId":{
            "type":"integer",
            "description":"The system-generated identifier for an Budget.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "budgetItemConfiguredFieldValueId":{
            "type":"integer",
            "description":"The unique identifier for the Budget Item Configured Field.",
            "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 BudgetItemConfiguredFieldValue object, a unique BudgetItemConfiguredFieldValue object can be identified by the following combinations of the fields.<ul><li>budgetItemConfiguredFieldValueId</li><li>columnDefinitionId</li><li>columnName</li><li>columnLabel</li>",
    "exampleSetFlag":false
}

Examples

Select an example Batch Update Project Budget Items to Assign Configured Field Batch Update Project Budget Items Using Budget Item IDs

Back to Top

Response

200 Response

A collection of object IDs mapped to a canonical link of the object with corresponding warning messages if any warnings were generated while processing the update request. For example - {"links":{"1":"https://[host]:[port]/api/restapi/[object]/1","2":"https://[host]:[port]/api/restapi/[object]/2"},"warnings":[{"primaryKeyName":"objectIdFieldName","uniqueFieldName":"object_code_01","uniqueFieldValue":"objectCodeFieldName","primaryKeyValue":1,"warningMessages":["warning_message_1","warning_message_2"]}]}

400 Response

Invalid input for the Project Budget Item service. Verify the request contains valid data, then resubmit the request.

Back to Top