Jump to

• Request
• Response

Batch Update Project Budget Transfers

put

/api/restapi/budgetTransfer/batch

Send a request to this endpoint to update one or more project budget transfers. 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<ApiEntityBudgetTransferInput>

Type: array

Title: List<ApiEntityBudgetTransferInput>

Show Source

• Array of: object ApiEntityBudgetTransferInput
  Title: ApiEntityBudgetTransferInput

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

  • budgetTransferId
  • budgetTransferCode,projectId
  • budgetTransferCode,projectCode,workspaceCode
  • budgetTransferCode,projectBudgetId

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

Nested Schema : ApiEntityBudgetTransferInput

Type: object

Title: ApiEntityBudgetTransferInput

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

• budgetTransferId
• budgetTransferCode,projectId
• budgetTransferCode,projectCode,workspaceCode
• budgetTransferCode,projectBudgetId

Show Source

• budgetItemId: integer (int64)
  The system-generated identifier of a budget item.
• budgetTransactions: array budgetTransactions
  List of all budget transactions for the project budget transfer.
• budgetTransferCode: string
  Minimum Length: 0

  Maximum Length: 60

  The unique identifier of the project budget transfer request.
• budgetTransferId: integer (int64)
  The system-generated identifier of a budget transfer.
• configuredFields: array configuredFields
  The list of configured fields for a budget transfer.
• description: string
  Minimum Length: 0

  Maximum Length: 4000

  Additional information about the transaction.
• projectBudgetId: integer (int64)
  The system-generated identifier of a project budget.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId(required): integer (int64)
  The unique identifier for the project.The project object can also be identified by its unique criteria.
• status: string
  Allowed Values: [ "DRAFT", "PENDING", "REJECTED", "APPROVED" ]

  The state of the project budget transfer request. Pending: The change request is awaiting a decision. Approved: The change request was approved. Rejected: The change request was not approved.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityBudgetTransferInput",
    "required":[
        "projectId"
    ],
    "type":"object",
    "properties":{
        "budgetItemId":{
            "type":"integer",
            "description":"The system-generated identifier of a budget item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "status":{
            "type":"string",
            "description":"The state of the project budget transfer request. Pending: The change request is awaiting a decision. Approved: The change request was approved. Rejected: The change request was not approved.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DRAFT",
                "PENDING",
                "REJECTED",
                "APPROVED"
            ]
        },
        "description":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"Additional information about the transaction.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "budgetTransactions":{
            "type":"array",
            "description":"List of all budget transactions for the project budget transfer.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityBudgetTransferTransactionInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "budgetTransferId":{
            "type":"integer",
            "description":"The system-generated identifier of a budget transfer.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "budgetTransferCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"The unique identifier of the project budget transfer request.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "configuredFields":{
            "type":"array",
            "description":"The list of configured fields for a budget transfer.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityBudgetTransferConfiguredFieldValueInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "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 unique identifier for a project set by the user who created the project.",
            "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 BudgetTransfer object, a unique BudgetTransfer object can be identified by the following combinations of the fields.<ul><li>budgetTransferId</li><li>budgetTransferCode,projectId</li><li>budgetTransferCode,projectCode,workspaceCode</li><li>budgetTransferCode,projectBudgetId</li>",
    "exampleSetFlag":false
}

Nested Schema : budgetTransactions

Type: array

List of all budget transactions for the project budget transfer.

Show Source

• Array of: object ApiEntityBudgetTransferTransactionInput
  Title: ApiEntityBudgetTransferTransactionInput

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

  • budgetTransactionId

{
    "type":"array",
    "description":"List of all budget transactions for the project budget transfer.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityBudgetTransferTransactionInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : configuredFields

Type: array

The list of configured fields for a budget transfer.

Show Source

• Array of: object ApiEntityBudgetTransferConfiguredFieldValueInput
  Title: ApiEntityBudgetTransferConfiguredFieldValueInput

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

  • budgetTransferConfiguredFieldValueId
  • columnDefinitionId
  • columnName
  • columnLabel

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

Nested Schema : ApiEntityBudgetTransferTransactionInput

Type: object

Title: ApiEntityBudgetTransferTransactionInput

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

• budgetTransactionId

Show Source

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

  Provide value for this field during object update to delete the assigned configured field value.
• budgetItemId: integer (int64)
  A unique identifier for the budget item (Change Budget Line).
• budgetTransactionCost: budgetTransactionCost
  The cost of a budget transaction.
• budgetTransactionId: integer (int64)
  The system-generated identifier of a budget transaction.
• budgetTransferId: 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.
• budgetTransferType: string
  Allowed Values: [ "TO", "FROM" ]

  Specifies whether the budget row is transfer from budget record or transfer to budget record.
• configuredFields: array configuredFields
  The list of configured fields for a budget transfer transaction.
• crossEntityBudgetTransactionId: integer (int64)
  The system-generated identifier of a source budget transaction which has cross entity budget item involved.
• crossEntityBudgetTransferId: integer (int64)
  The system-generated identifier of a project budget transfer of an object to which the project budget item is added in a destination transaction of a cross entity transfer.
• crossEntityTransferFromId: integer (int64)
  The system-generated identifier of a budget item added in a cross object transfer. This field is required to be provided in a destination transaction of a cross entity transfer to identify the source budget item. For example, In a program to project Project Budget Transfer, the program budget item ID has to be given in a destination transaction.
• itemCode: string
  Maximum Length: 60

  The system-generated unique identifier for the budget transaction item.
• productionRate: number (double)
  Minimum Value: 0.000010

  The number of hours per unit of measure needed to complete the budget line item.
• quantity: number (double)
  The number of each budget line item needed to complete the work.
• transactionType: string
  Allowed Values: [ "ORIGINAL", "CHANGE", "TRANSFER" ]

  Specifies whether the budget row is an original, change, or transfer value.
• transferFromId(required): integer (int64)
  The unique identifier for the source budget line item. This identifies the ID of the budget item item you are transferring money from through the transfer.
• transferToId: integer (int64)
  The unique identifier for the destination budget line item. This identifies the ID of the budget item you are transferring money to through the transfer.
• unitOfMeasureId: integer (int64)
  The Unit of Measure used for the budget line item detail.

{
    "title":"ApiEntityBudgetTransferTransactionInput",
    "required":[
        "transferFromId"
    ],
    "type":"object",
    "properties":{
        "transactionType":{
            "type":"string",
            "description":"Specifies whether the budget row is an original, change, or transfer value.",
            "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"
            ]
        },
        "budgetItemId":{
            "type":"integer",
            "description":"A unique identifier for the budget item (Change Budget Line).",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "itemCode":{
            "maxLength":60,
            "type":"string",
            "description":"The system-generated unique identifier for the budget transaction item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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
        },
        "budgetTransactionId":{
            "type":"integer",
            "description":"The system-generated identifier of a budget transaction.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "transferToId":{
            "type":"integer",
            "description":"The unique identifier for the destination budget line item. This identifies the ID of the budget item you are transferring money to through the transfer.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "transferFromId":{
            "type":"integer",
            "description":"The unique identifier for the source budget line item. This identifies the ID of the budget item item you are transferring money from through the transfer. ",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "budgetTransferId":{
            "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"
            ]
        },
        "configuredFields":{
            "type":"array",
            "description":"The list of configured fields for a budget transfer transaction.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityBudgetTransactionConfiguredFieldValueInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "budgetTransactionCost":{
            "description":"The cost of a budget transaction.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityBudgetTransactionCostInput"
                }
            ]
        },
        "budgetTransferType":{
            "type":"string",
            "description":"Specifies whether the budget row is transfer from budget record or transfer to budget record.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "TO",
                "FROM"
            ]
        },
        "crossEntityBudgetTransactionId":{
            "type":"integer",
            "description":"The system-generated identifier of a source budget transaction which has cross entity budget item involved.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "crossEntityBudgetTransferId":{
            "type":"integer",
            "description":"The system-generated identifier of a project budget transfer of an object to which the project budget item is added in a destination transaction of a cross entity transfer.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "crossEntityTransferFromId":{
            "type":"integer",
            "description":"The system-generated identifier of a budget item added in a cross object transfer. This field is required to be provided in a destination transaction of a cross entity transfer to identify the source budget item. For example, In a program to project Project Budget Transfer, the program budget item ID has to be given in a destination transaction.",
            "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 BudgetTransferTransaction object, a unique BudgetTransferTransaction object can be identified by the following combinations of the fields.<ul><li>budgetTransactionId</li>",
    "exampleSetFlag":false
}

Nested Schema : budgetTransactionCost

The cost of a budget transaction.

Match All

The cost of a budget transaction.

Show Source

• object ApiEntityBudgetTransactionCostInput
  Title: ApiEntityBudgetTransactionCostInput

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

  • budgetTransactionId

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

Nested Schema : configuredFields

Type: array

The list of configured fields for a budget transfer transaction.

Show Source

• Array of: object ApiEntityBudgetTransactionConfiguredFieldValueInput
  Title: ApiEntityBudgetTransactionConfiguredFieldValueInput

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

  • budgetTransactionConfiguredFieldValueId
  • columnDefinitionId
  • columnName
  • columnLabel

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

Nested Schema : ApiEntityBudgetTransactionCostInput

Type: object

Title: ApiEntityBudgetTransactionCostInput

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

• budgetTransactionId

Show Source

• amountCostProject: number (double)
  The amount that the budget row has changed as the result of transactions. This value is based on the project currency.
• budgetTransactionId: integer (int64)
  The system-generated identifier of a budget transaction.
• laborRateProject: number (double)
  The cost per labor hour of the budget line item detail. This value is based on the project currency.
• unitRateProject: number (double)
  The cost per Unit of Measure for the budget line item detail. This value is based on the project currency.

{
    "title":"ApiEntityBudgetTransactionCostInput",
    "type":"object",
    "properties":{
        "unitRateProject":{
            "type":"number",
            "description":"The cost per Unit of Measure for the budget line item detail. 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 detail. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "budgetTransactionId":{
            "type":"integer",
            "description":"The system-generated identifier of a budget transaction.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "amountCostProject":{
            "type":"number",
            "description":"The amount that the budget row has changed as the result of transactions. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        }
    },
    "description":"This entity represents a BudgetTransactionCost object, a unique BudgetTransactionCost object can be identified by the following combinations of the fields.<ul><li>budgetTransactionId</li>",
    "exampleSetFlag":false
}

Nested Schema : ApiEntityBudgetTransactionConfiguredFieldValueInput

Type: object

Title: ApiEntityBudgetTransactionConfiguredFieldValueInput

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

• budgetTransactionConfiguredFieldValueId
• 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.
• budgetTransactionConfiguredFieldValueId: integer (int64)
  The unique identifier for the Transaction Configured Field.
• 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":"ApiEntityBudgetTransactionConfiguredFieldValueInput",
    "type":"object",
    "properties":{
        "budgetTransactionConfiguredFieldValueId":{
            "type":"integer",
            "description":"The unique identifier for the Transaction 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 BudgetTransactionConfiguredFieldValue object, a unique BudgetTransactionConfiguredFieldValue object can be identified by the following combinations of the fields.<ul><li>budgetTransactionConfiguredFieldValueId</li><li>columnDefinitionId</li><li>columnName</li><li>columnLabel</li>",
    "exampleSetFlag":false
}

Nested Schema : ApiEntityBudgetTransferConfiguredFieldValueInput

Type: object

Title: ApiEntityBudgetTransferConfiguredFieldValueInput

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

• budgetTransferConfiguredFieldValueId
• 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.
• budgetTransferConfiguredFieldValueId: integer (int64)
  The unique identifier for the Project Budget Transfer Configured Field.
• budgetTransferId: integer (int64)
  The system-generated identifier of a budget transfer.
• 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":"ApiEntityBudgetTransferConfiguredFieldValueInput",
    "type":"object",
    "properties":{
        "budgetTransferConfiguredFieldValueId":{
            "type":"integer",
            "description":"The unique identifier for the Project Budget Transfer Configured Field.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "budgetTransferId":{
            "type":"integer",
            "description":"The system-generated identifier of a budget transfer.",
            "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 BudgetTransferConfiguredFieldValue object, a unique BudgetTransferConfiguredFieldValue object can be identified by the following combinations of the fields.<ul><li>budgetTransferConfiguredFieldValueId</li><li>columnDefinitionId</li><li>columnName</li><li>columnLabel</li>",
    "exampleSetFlag":false
}

Examples

Select an example Batch Update Project Budget Transfers to Assign Configured Field Batch Update Project Budget Transfers Using the Budget Transfer 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 Transfer service. Verify the request contains valid data, then resubmit the request.

Back to Top